API参考

初始化

获取sdk版本号

+ CRIMClient.getInstance().sdkVersion

• 返回值：版本号字符串

获取当前已登录用户的userID

+ CRIMClient.getInstance().getLoginUserID;

• 返回值：登录用户的userID

初始化SDK

- CRIMClient.getInstance().initSDKWithConfig

• 返回值：初始化结果

• 参数：

设置连接监听

- CRIMClient.getInstance().setConnListener

• 返回值：初始化结果

• 参数：

反初始化SDK

- CRIMClient.getInstance().unInitSDK

• 返回值：无

添加消息监听

- CRIMClient.getInstance().messageManager.setAdvancedMsgListener

• 返回值：无

设置好友关系监听器

- CRIMClient.getInstance().friendshipManager.setOnFriendshipListener

• 返回值：无

设置会话监听器

- CRIMClient.getInstance().conversationManager.setOnConversationListener

• 返回值：无

设置组监听器

- CRIMClient.getInstance().groupManager.setOnGroupListener

• 返回值：无

设置心跳间隔

- CRIMClient.getInstance().setHeartbeatInterval;

• 返回值：无

• 参数：

登录

使用appId登录

- CRIMClient.getInstance().login

• 返回值：无

• 参数：

使用token登录

- CRIMClient.getInstance().login

• 返回值：无

• 参数：

获取登录状态

- CRIMClient.getInstance().getLoginStatus;

• 返回值：登录状态: 1:Logout, 2:Logging, 3:Logged

登出

- CRIMClient.getInstance().logout;

• 返回值：无

• 参数：

用户

根据userID批量查询用户信息

- CRIMClient.getInstance().userInfoManager.getUsersInfo(OnBase<List<UserInfo>> base, List<String> uidList)

• 返回值：无

• 参数：

修改当前登录用户信息

- CRIMClient.getInstance().userInfoManager.setSelfInfo(OnBase<String> base, String nickname, String faceURL, int gender, int appMangerLevel, String phoneNumber, long birth, String email, String ex)

• 返回值：无

• 参数：

相关回调请参考:

• onSelfInfoUpdated

获取当前登录用户信息

- CRIMClient.getInstance().userInfoManager.getSelfInfo(OnBase<UserInfo> base)

• 返回值：无

• 参数：

订阅指定用户的在线状态

调用订阅用户的在线状态接口，可以订阅用户的在线状态，触发订阅者的onUserStatusChanged回调。

- CRIMClient.getInstance().userInfoManager.subscribeUsersStatus

• 返回值：无

• 参数：

取消订阅用户的在线状态

- CRIMClient.getInstance().unsubscribeUsersStatus

• 返回值：无

• 参数：

获取所有已订阅用户的在线状态

- CRIMClient.getInstance().getSubscribeUsersStatus

• 返回值：无

• 参数：

获取指定用户的在线状态

- CRIMClient.getInstance().getUserStatus

• 返回值：无

• 参数：

会话

获取会话列表

- CRIMClient.getInstance().conversationManager.getAllConversationList(OnBase<List<ConversationInfo>> base)

• 返回值：无

• 参数：

分页获取会话列表

- CRIMClient.getInstance().conversationManager.getConversationListSplit(OnBase<List<ConversationInfo>> base, long offset, long count)

• 返回值：无

• 参数：

获取一个会话

如果不存在会自动创建

- CRIMClient.getInstance().conversationManager.getOneConversation(OnBase<ConversationInfo> base, String sourceId, int sessionType)

• 返回值：无

• 参数：

获取多个会话列表

- CRIMClient.getInstance().conversationManager.getMultipleConversation(OnBase<List<ConversationInfo>> base, List<String> conversationIDs)

• 返回值：无

• 参数：

本地删除一个会话

- CRIMClient.getInstance().conversationManager.deleteConversationAndDeleteAllMsg(OnBase<String> base, String conversionID)

• 返回值：无

• 参数：

清空一个会话

本地 & 服务器

- CRIMClient.getInstance().conversationManager.clearConversationAndDeleteAllMsg(OnBase<String> base, String conversionID)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

设置会话的草稿

- CRIMClient.getInstance().setConversationDraft

• 返回值：无

• 参数：

置顶会话

- CRIMClient.getInstance().conversationManager.pinConversation(OnBase<String> base, String conversationID, boolean isPinned) 

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

获取总的消息未读数

- CRIMClient.getInstance().conversationManager.getTotalUnreadMsgCount

• 返回值：无

• 参数：

获取会话免打扰状态

- CRIMClient.getInstance().conversationManager.getConversationRecvMsgOpt(OnBase<List<NotDisturbInfo>> base, List<String> conversationIDs)

• 返回值：无

• 参数：

设置会话免打扰状态

- CRIMClient.getInstance().conversationManager.setConversationRecvMsgOpt(OnBase<String> base, String conversationID, long status)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

设置私聊

可做“阅后即焚”功能

- CRIMClient.getInstance().conversationManager.setConversationPrivateChat(OnBase<String> base, String conversionID, boolean isPrivate) 

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

设置私聊时间

可做“阅后即焚”时间设置功能

- CRIMClient.getInstance().conversationManager.setConversationBurnDuration(OnBase<String> base, String conversationID, int burnDuration)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

重置at标准位

- CRIMClient.getInstance().conversationManager.resetConversationGrpAtType

• 返回值：无

• 参数：

隐藏指定会话

不删除聊天记录；如果有新消息到达，会话会再次出现。

- CRIMClient.getInstance().conversationManager.hideConversation(OnBase<String> base, String conversationID)

• 返回值：无

• 参数：

隐藏所有会话

不删除聊天记录；如果有新消息到达，会话会再次出现。

- CRIMClient.getInstance().conversationManager.hideAllConversations(OnBase<String> base)

• 返回值：无

• 参数：

全局设置消息提示

- CRIMClient.getInstance().conversationManager.setGlobalRecvMsgOpt

• 返回值：无

• 参数：

好友

添加好友

- CRIMClient.getInstance().friendshipManager.addFriend(OnBase<String> base, String userID, String reqMessage)

• 返回值：无

• 参数：

相关回调请参考:

• onFriendReqAdded

获取收到的好友申请

既哪些人申请加我为好友

- CRIMClient.getInstance().friendshipManager.getFriendReqListAsRecipient(OnBase<List<FriendReqInfo>> base)

• 返回值：无

• 参数：

发出的好友申请

- CRIMClient.getInstance().friendshipManager.getFriendReqListAsApplicant(OnBase<List<FriendReqInfo>> base)

• 返回值：无

• 参数：

同意某人的好友申请

- CRIMClient.getInstance().friendshipManager.acceptFriendReq(OnBase<String> base, String userID, String handleMsg)

• 返回值：无

• 参数：

相关回调请参考:

• onFriendReqAccepted
• onFriendAdded

拒绝好友申请

- CRIMClient.getInstance().friendshipManager.refuseFriendReq( OnBase<String> base, String userID, String msg)

• 返回值：无

• 参数：

相关回调请参考:

• onFriendReqRejected

加入黑名单

- CRIMClient.getInstance().friendshipManager.addToBlacklist(OnBase<String> base, String userID)

• 返回值：无

• 参数：

相关回调请参考:

• onBlackAdded

获取黑名单

- CRIMClient.getInstance().friendshipManager.getBlackList(OnBase<List<UserInfo>> base)

• 返回值：无

• 参数：

移除黑名单

- CRIMClient.getInstance().friendshipManager.removeFromBlacklist(OnBase<String> base, String userID)

• 返回值：无

• 参数：

相关回调请参考:

• onBlackDeleted

获取指定好友列表的相关信息

- CRIMClient.getInstance().friendshipManager.getSpecifiedFriendsInfo(OnBase<List<UserInfo>> base, List<String> uidList)

• 返回值：无

• 参数：

获取所有好友的相关信息

- CRIMClient getInstance().friendshipManager.getFriendList(OnBase<List<UserInfo>> base)

• 返回值：无

• 参数：

检查是否好友关系

即是否在登录用户的好友列表中。注意：好友是双向关系。result为1表示好友（并且不是黑名单）

- CRIMClient.getInstance().friendshipManager.checkFriend(OnBase<List<FriendshipInfo>> base, List<String> uidList)

• 返回值：无

• 参数：

设置好友备注

- CRIMClient.getInstance().friendshipManager.setFriendRemark(OnBase<String> base, String userID, String remark)

• 返回值：无

• 参数：

相关回调请参考:

• onFriendInfoChanged
• onConversationChanged

删除好友

好友是双向关系，此函数仅仅删除自己的好友

- CRIMClient.getInstance().friendshipManager.deleteFriend(OnBase<String> base, String friendUserID)

• 返回值：无

• 参数：

相关回调请参考:

• onFriendDeleted

本地搜索好友

- CRIMClient.getInstance().friendshipManager.searchFriends(OnBase<List<FriendInfo>> base, List<String> keywordList, boolean isSearchUserID, boolean isSearchNickname, boolean isSearchRemark)

• 返回值：无

• 参数：

群组

创建群

-  CRIMClient.getInstance().groupManager.createGrp(List<String> memberUserIDs, List<String> adminUserIDs,GrpInfo groupInfo, String ownerUserID, OnBase<GrpInfo> callBack)

• 返回值：无

• 参数：

相关回调请参考:

• onJoinedGrpAdded
• onGrpMemberAdded

申请加入群组

- CRIMClient.getInstance().groupManager.joinGrp

• 返回值：无

• 参数：

相关回调请参考:

• onJoinedGrpAdded
• onGrpMemberAdded
• onGrpReqAdded

退群

- CRIMClient.getInstance().groupManager.quitGrp(OnBase<String> base, String groupID)

• 返回值：无

• 参数：

相关回调请参考:

• onJoinedGrpDeleted
• onGrpMemberDeleted

获取已加入的群列表

- CRIMClient.getInstance().groupManager.getJoinedGrpList

• 返回值：无

• 参数：

获取指定群资料

获取指定群的资料，支持批量获取。

- CRIMClient.getInstance().groupManager.getSpecifiedGrpsInfo(OnBase<List<GrpInfo>> base, List<String> groupsID)

• 返回值：无

• 参数：

更新群资料

更新群头像、群名称、群公告、群简介等群资料，仅群主和管理员有权限。

- CRIMClient.getInstance().groupManager.setGrpInfo(GrpInfo groupInfo, OnBase<String> callBack)

• 返回值：无

• 参数：

相关回调请参考:

• onGrpInfoChanged

获取群成员列表

- CRIMClient.getInstance().groupManager.getGrpMemberList(OnBase<List<GroupMembersInfo>> base, String groupId, int filter, int offset, int count)

• 返回值：无

• 参数：

获取群内指定群成员信息

获取群内指定的群成员信息，仅本群成员可调用。

- CRIMClient.getInstance().groupManager.getSpecifiedGrpMembersInfo(OnBase<List<GroupMembersInfo>> base, String groupId, List<String> uidList) 

• 返回值：无

• 参数：

踢出群

- CRIMClient.getInstance().groupManager.kickGrpMember(OnBase<String> base, String groupId, List<String> uidList, String reason)

• 返回值：无

• 参数：

相关回调请参考:

• onJoinedGrpDeleted
• onGrpMemberDeleted

转让群主

只有群主能操作

- CRIMClient.getInstance().groupManager.transferGrpOwner(OnBase<String> base, String groupID, String uid) 

• 返回值：无

• 参数：

相关回调请参考:

• onGrpMemberInfoChanged

邀请入群

群组成员可邀请其他用户加入群组，无须对方同意，支持批量邀请。

- CRIMClient.getInstance().groupManager.inviteUserToGrp(OnBase<String> base, String groupId, List<String> userIDs, String reason) 

• 返回值：无

• 参数：

相关回调请参考:

• onJoinedGrpAdded
• onGrpMemberAdded
• onGrpReqAdded

获取收到的群成员申请进群列表

作为群主或者管理员可操作

- CRIMClient.getInstance().groupManager.getGrpReqListAsRecipient

• 返回值：无

• 参数：

发出的入群申请

- CRIMClient.getInstance().groupManager.getGrpReqListAsApplicant(OnBase<List<GrpReqInfo>> base)

• 返回值：无

• 参数：

同意某人进入某群

管理员或者群主操作

- CRIMClient.getInstance().groupManager.acceptGrpReq(OnBase<String> base, String groupID, String fromUserID, String handleMsg) 

• 返回值：无

• 参数：

拒绝某人进入某群

管理员或者群主操作

- CRIMClient.getInstance().groupManager.refuseGrpReq(OnBase<String> base, String groupID, String fromUserID, String handleMsg)

• 返回值：无

• 参数：

解散群

- CRIMClient.getInstance().groupManager.dismissGrp(OnBase<String> base, String groupID)

• 返回值：无

• 参数：

相关回调请参考:

• onGrpDismissed

禁言群成员

- CRIMClient.getInstance().groupManager.changeGrpMemberMute(OnBase<String> base, String groupID, String userID, long seconds)

• 返回值：无

• 参数：

设置群禁言状态

群主或管理员可以设置群禁言状态，禁言后仅群主和管理员可以发言。

- CRIMClient.getInstance().groupManager.changeGrpMute(onbase,groupID,isMute);

• 返回值：无

• 参数：

相关回调请参考:

• onGrpInfoChanged

搜索群

通过群名称或者群ID

- CRIMClient.getInstance().groupManager.searchGrps

• 返回值：无

• 参数：

设置群成员昵称

群主可以修改管理员和普通成员的昵称，管理员可以修改普通成员的昵称。

- CRIMClient.getInstance().groupManager.setGrpMemberNickname(OnBase<String> base, String groupID, String userID, String groupNickname)

• 返回值：无

• 参数：

相关回调请参考:

• onGrpMemberInfoChanged

修改群成员身份

群主可以修改管理员和普通成员的身份，管理员可以修改普通成员的身份。

- CRIMClient.getInstance().groupManager.setGrpMemberRoleLevel(OnBase<String> base, String groupID, String userID, long roleLevel)

• 返回值：无

• 参数：

相关回调请参考:

• onGrpMemberInfoChanged

根据加入时间分页获取组成员列表

- CRIMClient.getInstance().groupManager.getGrpMemberListByJoinTimeFilter

• 返回值：无

• 参数：

进群验证设置选项

-  CRIMClient.getInstance().groupManager.setGrpVerification(OnBase<String> base, String groupID, int needVerification) 

• 返回值：无

• 参数：

获取管理者和拥有者

- CRIMClient.getInstance().groupManager.getGrpMemberOwnerAndAdmin

• 返回值：无

• 参数：

群成员之间是否可添加好友

- CRIMClient.getInstance().groupManager.setGrpApplyMemberFriend:

• 返回值：无

• 参数：

设置能否查看群成员信息

- CRIMClient.getInstance().groupManager.setGrpLookMemberInfo:

• 返回值：无

• 参数：

搜索群成员

- CRIMClient.getInstance().groupManager.searchGrpMembers(OnBase<List<GroupMembersInfo>> base, String groupID, List<String> keywordList, boolean isSearchUserID,boolean isSearchMemberNickname, int offset, int count) 

• 返回值：无

• 参数：

消息

发送消息

-  CRIMClient.getInstance().messageManager.sendMsg(OnMsgSendCallback base, Message message, String recvUid, String recvGid, OfflinePushInfo offlinePushInfo)

• 返回值：无

• 参数：

创建文本消息

-  CRIMClient.getInstance().messageManager.createTextMsg(String text)

• 返回值：Message

• 参数：

创建@文本消息

+ CRIMClient.getInstance().messageManager.createTextAtMsg

• 返回值：消息结构体Message

• 参数：

通过本地图片路径创建图片消息

使用此接口可文件路径参数需用绝对路径

- CRIMClient.getInstance().messageManager.createImageMsgFromFullPath(String imagePath)

• 返回值：消息结构体Message

• 参数：

通过图片URL创建图片消息

例如：自行上传的文件，然后使用返回的url构造消息

- CRIMClient.getInstance().messageManager.createImageMsgByURL(PictureInfo sourcePicture, PictureInfo bigPicture, PictureInfo snapshotPicture)

• 返回值：消息结构体Message

• 参数：

通过本地音频路径创建音频消息

使用此接口可文件路径参数需用绝对路径

+ CRIMClient.getInstance().messageManager.createSoundMsgFromFullPath

• 返回值：消息结构体Message

• 参数：

通过音频URL创建音频消息

例如：自行上传的文件，然后使用返回的url构造消息

+ CRIMClient.getInstance().messageManager.createSoundMsgByURL

• 返回值：消息结构体Message

• 参数：

通过本地视频路径创建视频消息

使用此接口可文件路径参数需用绝对路径

+ CRIMClient.getInstance().messageManager.createVideoMsgFromFullPath

• 返回值：消息结构体Message

• 参数：

通过视频URL创建视频消息

例如：自行上传的文件，然后使用返回的url构造消息

+ CRIMClient.getInstance().messageManager.createVideoMsgByURL

• 返回值：消息结构体Message

• 参数：

通过本地文件路径创建文件消息

使用此接口可文件路径参数需用绝对路径

+ CRIMClient.getInstance().messageManager.createFileMsgFromFullPath

• 返回值：消息结构体Message

• 参数：

通过文件URL创建文件消息

例如：自行上传的文件，然后使用返回的url构造消息

+ CRIMClient.getInstance().messageManager.createFileMsgByURL

• 返回值：消息结构体Message

• 参数：

创建合并消息

- CRIMClient.getInstance().messageManager.createMergerMsg(List<Message> messageList, String title, List<String> summaryList)

• 返回值：消息结构体Message

• 参数：

创建转发消息

- CRIMClient.getInstance().messageManager.createForwardMsg(Message message)

• 返回值：消息结构体Message

• 参数：

创建位置消息

- CRIMClient.etInstance().messageManager.createLocationMsg(double latitude, double longitude, String description)

• 返回值：消息结构体Message

• 参数：

创建引用消息

+ CRIMClient.getInstance().messageManager.createQuoteMsg(String text, Message message)

• 返回值：消息结构体Message

• 参数：

创建名片消息

+ CRIMClient.getInstance().messageManager.createCardMsg

• 返回值：消息结构体Message

• 参数：

创建自定义消息

- CRIMClient.getInstance().messageManager.createCustomMsg(String data, String extension) 

• 返回值：消息结构体Message

• 参数：

创建动图消息

+ CRIMClient.getInstance().messageManager.createFaceMsgWithIndex

• 返回值：消息结构体Message

• 参数：

发送消息

发送消息需要先构造消息实例，支持构造的消息类型有普通文本、图片、视频、文件、音频、地理位置、引用、转发、@xxx等消息，构造完消息后调用SDK的发送接口即可完成消息的发送

- CRIMClient.getInstance().messageManager.sendMsg

• 返回值：无

• 参数：

撤回一条消息

- CRIMClient.getInstance().messageManager.revokeMsg(OnBase<String> callBack, String conversationID, String clientMsgID)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged
• onRecvMsgRevokedV2

单聊正在输入消息

- CRIMClient.getInstance().messageManager.typingStatusUpdate

• 返回值：无

• 参数：

标记消息已读

调用标记已读接口，可以把消息标记为已读，如果是单聊会话内的消息，还会给消息的发送方发送已读回执，触发发送方的onRecv1v1ReadReceipt回调。

- CRIMClient getInstance()..messageManager.markMsgAsReadByMsgID(String conversationID, List<String> clientMsgIDs, OnBase<String> callBack) 

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged
• onRecv1v1ReadReceipt

从本地删除一条消息

- CRIMClient.getInstance().messageManager.deleteMsgFromLocalStorage(String conversationID, String clientMsgID, OnBase<String> callBack)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

删除一条消息

本地 & 服务器

- CRIMClient.getInstance().messageManager.deleteMsg(String conversationID, String clientMsgID, OnBase<String> callBack)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

从本地删除所有消息

- CRIMClient.getInstance().messageManager.deleteAllMsgFromLocal(OnBase<String> base);

• 返回值：无

• 参数：

删除所有消息

本地 & 服务器

- CRIMClient.getInstance().messageManager.deleteAllMsgFromLocalAndSvr(OnBase<String> base)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

插入一条单聊消息到本地

- CRIMClient.getInstance().messageManager.insertSingleMsgToLocalStorage(OnBase<String> base, Message message, String receiver, String sender) 

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

插入一条群聊消息到本地

- CRIMClient.getInstance().messageManager.insertGrpMsgToLocalStorage(OnBase<String> base, Message message, String groupID, String senderID) 

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged

查找本地消息

- CRIMClient.getInstance().messageManager.searchLocalMsgs(OnBase<SearchResult> base, 
String conversationID, 
List<String> keywordList, 
int keywordListMatchType,
List<String> senderUserIDList, 
List<Integer> messageTypeList, 
int searchTimePosition, 
int searchTimePeriod, 
int pageIndex, 
int count) 

• 返回值：无

• 参数：

独立上传文件到初始化sdk的storageDir

发送多媒体消息不需调用此函数，其在sdk内部自动上传

- CRIMClient.getInstance().uploadFile

• 返回值：无

• 参数：

获取历史消息

从最新一条消息开始获取会话中的历史聊天记录。

CRIMClient.getInstance().messageManager.getAdvancedHistoryMsgList(OnBase<AdvancedMsg> callBack, String conversationID, Message startMsg, int count) 

• 返回值：无

• 参数：

反向获取历史消息

反向获取会话中的历史聊天记录，可用于定位消息上下文时后向下拉取历史消息。

- CRIMClient.getInstance().messageManager.getAdvancedHistoryMsgListReverse(OnBase<AdvancedMsg> callBack, String conversationID, Message startMsg, int count)

• 返回值：无

• 参数：

设置角标

告知服务器 客户端现有的数量

- CRIMClient.getInstance().messageManager.setAppBadge:

• 返回值：无

• 参数：

清空未读数

调用标记已读接口，可以把会话内的消息标记为已读，对于群聊和通知会话，调用该接口可以清除未读计数，对于单聊会话，不仅会清除未读计数，还会给消息的发送方发送已读回执，触发发送方的onRecv1v1ReadReceipt回调。

- CRIMClient.getInstance().messageManager.markConversationMsgAsRead(String conversationID, OnBase<String> callback)

• 返回值：无

• 参数：

相关回调请参考:

• onConversationChanged
• onRecv1v1ReadReceipt