Skip to content

Android IMSDK 接口变化(v2 v3 v4)

rexchang edited this page May 30, 2019 · 2 revisions

包路径调整

IMSDKv3 版本之后对包路径进行了调整,由原来的 com.tencent 调整为 com.tencent.imsdk 。例如,类 TIMManager 在 v2 版本时类路径为 com.tencent.TIMManager,而在 v3 及 v4 版本的类路径为 com.tencent.imsdk.TIMManager

模块接口调整

相比 IMSDKv2 版本,IMSDKv3 版本进行了模块功能调整。原来的 imsdk.jar 只保留了基本的功能,一些高级功能分离到了相应的扩展包中。调整后原来的 imsdk.jar 变成了如下几个包:

基础功能包 —— imsdk.jar 消息扩展包 —— imsdk_msg_ext.jar 群组扩展包 —— imsdk_group_ext.jar 资料关系链扩展包 —— imsdk_sns_ext.jar

相比 IMSDKv3 版本,IMSDKv4 版本对模块进行了更进一步的调整,将所有的 jar 包做了合并,仅保留一个 jar 包,建议通过 AAR 方式直接引用。

同时,配合着模块功能的调整,接口也有相应的优化与调整。这里只列出名字变更或者移到其他类的接口,参数变更请参考下载好的 SDK 包中的 API Javadoc 文档。具体见下表:

v2类 v2接口 v3类 v3接口 v4类 v4接口
TIMManager configOfflinePushSettings TIMManager setOfflinePushSettings TIMManager setOfflinePushSettings
TIMManager disableCrashReport

setLogPrintEnable

setLogLevel

setLogListenCallbackLevel

setLogListener

setSoLibPath

setAccountType
TIMSdkConfig enableCrashReport

enableLogPrint

setLogLevel

setLogCallbackLevel

setLogListener

setSoLibPath

setAccountType
TIMSdkConfig enableCrashReport 已移除

enableLogPrint

setLogLevel

setLogCallbackLevel

setLogListener

setSoLibPath 已移除

setAccountType 已移除
TIMManager setConnectionListener

initFriendshipSettings

setGroupEventListener

initGroupSettings

setRefreshListener

setUploadProgressListener

setUserStatusListener
TIMUserConfig setConnectionListener

setFriendshipSettings

setGroupEventListener

setGroupSettings

setRefreshListener

setUploadProgressListener

setUserStatusListener
TIMUserConfig setConnectionListener

setFriendshipSettings 已移除

setGroupEventListener

setGroupSettings

setRefreshListener

setUploadProgressListener

setUserStatusListener

setRecentContactNotifyEnabled 已移除

setStorageEnabled 已移除

setRecentContactEnabled 已移除

setFriendshipStorageEnabled 已移除

setGroupStorageEnabled 已移除
TIMManager disableAutoReport

enableReadReceipt

disableRecentContact

disableRecentContactNotify

disableStorage

setMessageReceiptListener
TIMUserConfigMsgExt enableAutoReport

enableReadReceipt

enableRecentContact

enableRecentContactNotify

enableStorage

setMessageReceiptListener
TIMUserConfigMsgExt enableAutoReport

enableReadReceipt

enableRecentContact 已移除

enableRecentContactNotify 已移除

enableStorage 已移除

setMessageReceiptListener
TIMManager enableFriendshipStorage

setFriendshipProxyListener
TIMUserConfigSnsExt enableFriendshipStorage

setFriendshipProxyListener
TIMFriendshipManager v4版本重构了v3版本的资料与关系链,变化见附表
TIMManager enableGroupInfoStorage

setGroupAssistantListener
TIMUserConfigGroupExt enableGroupStorage

setGroupAssistantListener
TIMUserConfig
TIMManager initLogSettings

setGroupMemberUpdateListener

getConversationByIndex
TIMManager 已废弃 TIMManager 已废弃
TIMManager deleteConversation

deleteConversationAndLocalMsgs

getConversationCount

getConversationList

initStorage

sendMessageToMultiUsers
TIMManagerExt deleteConversation

deleteConversationAndLocalMsgs

getConversationCount

getConversationList

initStorage

sendMessageToMultiUsers
TIMManagerExt deleteConversation

deleteConversationAndLocalMsgs

getConversationCount

getConversationList

initStorage

sendMessageToMultiUsers

getInstanceById 已移除
TIMConversation 所有接口 TIMConversation 仅保留以下接口,其他接口均由 TIMConversationExt 提供

getType

getPeer

sendMessage

sendOnlineMessage
TIMConversation 仅保留以下接口,其他接口均由 TIMConversationExt 提供

getType

getPeer

sendMessage

sendOnlineMessage
TIMMessage getCustomInt

getCustomStr

hasGap

isPeerReaded

isRead

remove

setCustomInt

setCustomStr

convertToImportedMsg

setSender

setTimestamp
TIMMessageExt getCustomInt

getCustomStr

hasGap

isPeerReaded

isRead

remove

setCustomInt

setCustomStr

convertToImportedMsg

setSender

setTimestamp
TIMMessageExt getCustomInt

getCustomStr

hasGap 已移除

isPeerReaded

isRead

remove

setCustomInt

setCustomStr

convertToImportedMsg

setSender

setTimestamp
TIMFileElem

TIMImageElem

TIMSoundElem
所有接口 TIMFileElem

TIMImageElem

TIMSoundElem

TIMUgcElem
上传下载方式仅保留指定文件路径的方式,废弃 byte 数组方式 TIMFileElem

TIMImageElem

TIMSoundElem

TIMVideoElem
上传下载方式仅保留指定文件路径的方式,废弃 byte 数组方式,相比 v3 版本变更 TIMUgcElem 为 TIMVideoElem
TIMGroupManager 所有接口 TIMGroupManager 仅保留以下接口,其他接口均由 TIMGroupManagerExt 提供

applyJoinGroup

createGroup

deleteGroup

quitGroup
TIMGroupManager 仅保留以下接口,其他接口均由 TIMGroupManagerExt 提供

applyJoinGroup

createGroup

deleteGroup

quitGroup
TIMGroupManager modifyGroupAddOpt

modifyGroupCustomInfo

modifyGroupFaceUrl

modifyGroupIntroduction

modifyGroupName

modifyGroupNotification

modifyGroupSearchable

modifyGroupVisible
TIMGroupManagerExt modifyGroupInfo TIMGroupManagerExt modifyGroupInfo

getGroupDetailInfo 已移除

getGroupPublicInfo 已移除

增加 getGroupInfo

增加 queryGroupInfo
TIMGroupManager modifyGroupMemberInfoSetCustomInfo

modifyGroupMemberInfoSetNameCard

modifyGroupMemberInfoSetRole

modifyGroupMemberInfoSetSilence

ModifyReceiveMessageOpt
TIMGroupManagerExt modifyMemberInfo TIMGroupManagerExt modifyMemberInfo
TIMFriendshipManager 所有接口 TIMFriendshipManager 仅保留以下接口,其他接口均由 TIMFriendshipManagerExt 提供

getSelfProfile

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

setBirthday

setCustomInfo

setFaceUrl

setGender

setLanguage

setLocation

setNickName

setSelfSignature
TIMFriendshipManager modifyProfile TIMFriendshipManager v4版本重构了v3版本的资料与关系链,变化见附表
TIMFriendshipManager setFriendCustom

setFriendRemark
TIMFriendshipManagerExt modifySnsProfile TIMFriendshipManager v4版本重构了v3版本的资料与关系链,变化见附表
TIMFriendshipProxyListener 所有接口 TIMFriendshipProxyListener 所有与好友分组相关回调及 OnProxyStatusChange 已废弃 TIMFriendshipListener v4版本重构了v3版本的资料与关系链,变化见附表

附表:IMSDKv3 升级 IMSDKv4 关系链与资料接口变更

功能 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