Skip to content

iOS IMSDK 接口变化(v2 v3 v4)

rexchang edited this page May 30, 2019 · 2 revisions

主要接口变更

IMSDKv3 版本之后,优化了 SDK 的初始化流程和较多的模块接口,与 IMSDKv2 接口逻辑不变。具体接口变更请参考如下表格。

模块 v2 接口 v3 接口 v4接口
初始化 TIMManager initSdk:

disableCrashReport

initLogSettings:

setLogLevel:

setLogListener:

setLogListenerLevel:

setDBPath:

setConnListener:
initSdk: initSdk:

disableCrashReport 已移除

accountType 已移除
初始化 TIMManager disableStorage

disableAutoReport

enableReadReceipt

disableRecentContact

disableRecentContactNotify

enableFriendshipProxy

enableGroupAssistant

initFriendshipSetting:

initGroupSetting:

setUserStatusListener:

setRefreshListener:

setReceiptListener:

setMessageUpdateListener:

setUploadProgressListener:

setFriendProxyListener:

setGroupAssistantListener:
setUserConfig: setUserConfig:

disableStorage 已移除

disableRecentContact 已移除

disableRecentContact 已移除

enableFriendshipProxy 已移除

enableGroupAssistant 已移除

friendProfileOpt 已移除
TIMGroupManager 接口名首字母大写 接口名首字母小写 接口名首字母小写
TIMGroupManager GetGroupPublicInfoV2:flags:custom:succ:fail: setUserConfig: 配置需要拉取的资料字段

getGroupPublicInfo:succ:fail:
setUserConfig: 配置需要拉取的资料字段

getGroupPublicInfo:succ:fail: 已移除

getGroupInfo: 已移除

增加 queryGroupInfo:
TIMGroupManager GetGroupMemberV2:flags:

custom:nextSeq:succ:fail:
getGroupMembers:ByFilter:flags:custom:nextSeq:succ:fail: getGroupMembers:ByFilter:flags:custom:nextSeq:succ:fail:
消息 TIMSoundElem、TIMFileElem

TIMImageElem

TIMMessage delFromStorage
仅保留指定文件路径方式上传和下载资源

仅保留指定文件路径方式下载资源

TIMMessage remove
仅保留指定文件路径方式上传和下载资源

仅保留指定文件路径方式下载资源

TIMMessage remove

getRecvOpt 已移除

TIMUgcElem 变更为 TIMVideoElem
回调 TIMGroupAssistantListener

TIMGroupMemberListener

TIMFriendshipProxyListener
TIMGroupListener

TIMGroupEventListener 接口名首字母小写

TIMFriendshipListener 接口名首字母小写
TIMGroupListener 已移除
TIMFriendshipManager 接口名首字母大写 接口名首字母小写 v4版本重构了v3版本的资料与关系链,变化见附表
TIMFriendshipManager SetNickname:succ:fail:

SetAllowType:succ:fail:

SetAllowType:succ:fail:

SetFaceURL:succ:fail:

SetSelfSignature:succ:fail:

SetGender:succ:fail:

SetBirthday:succ:fail:

SetLocation:succ:fail:

SetLanguage:succ:fail:

SetCustom:succ:fail:

modifySelfProfile:profile:succ:fail: v4版本重构了v3版本的资料与关系链,变化见附表
TIMFriendshipManager GetFriendListV2:custom:meta:succ:fail: setUserConfig: 配置需要拉取的资料字段

getFriendList:succ:fail:
v4版本重构了v3版本的资料与关系链,变化见附表
TIMFriendshipProxy GetFriendList

GetFriendsProfile:

GetFriendGroupList

GetFriendGroup:
TIMFriendshipManager

getFriendsProfile:

getFriendGroup:
v4版本重构了v3版本的资料与关系链,变化见附表

关系链与资料接口变更

功能 v3 v4
设置自己的资料 modifySelfProfile modifySelfProfile
获取自己的资料 getSelfProfile getSelfProfile
在缓存中查询自己的资料 querySelfProfile
获取指定用户资料 getUsersProfile getUsersProfile
在缓存中查询的资料 queryUserProfile
添加好友 addFriend addFriend
删除好友 delFriend deleteFriends
修改好友 modifyFriend
设置好友自定义属性 setFriendCustom
设置好友备注 setFriendRemark
获取好友列表 getFriendList getFriendList
增量获取好友列表 getFriendListByPage
获取指定好友资料 getFriendsProfile
响应对方好友邀请 doResponse doResponse
添加用户到黑名单 addBlackList addBlackList
把用户从黑名单中删除 delBlackList deleteBlackList
获取黑名单列表 getBlackList getBlackList
通过网络获取未决请求列表 getPendencyFromServer getPendencyList
未决删除 deletePendency deletePendency
未决请求已读上报 pendencyReport pendencyReport
推荐好友已读上报 recommendReport
推荐好友删除 deleteRecommend
已决删除 deleteDecide
未决请求和好友推荐拉取 getFutureFriends
按昵称信息搜索用户资料 searchUser
新建好友分组 createFriendGroup createFriendGroup
删除好友分组 deleteFriendGroup deleteFriendGroup
添加好友到一个好友分组 addFriendsToFriendGroup addFriendsToFriendGroup
从好友分组中删除好友 delFriendsFromFriendGroup deleteFriendsFromFriendGroup
修改好友分组的名称 renameFriendGroup renameFriendGroup
获取指定的好友分组信息 getFriendGroups getFriendGroups
检查指定用户的好友关系 checkFriends checkFriends
获取指定好友资料 getFriendsProfile
获取指定好友分组 getFriendGroup