API概述
API主要模块包括：初始化、登录、用户、会话、好友、群组、消息
初始化
| 方法 | 描述 | 所属文件 |
|---|---|---|
| sdkVersion | 获取sdk版本号 | CRIMClient |
| getLoginUserID | 获取当前已登录用户的userID | CRIMClient |
| initSDKWithConfig | 初始化SDK | CRIMClient |
| unInitSDK | 反初始化SDK | CRIMClient |
| setHeartbeatInterval | 设置心跳间隔 | CRIMClient |
登录
| 方法 | 描述 | 所属文件 |
|---|---|---|
| login | 使用appId或token登录 | CRIMClient |
| getLoginStatus | 获取登录状态 | CRIMClient |
| logout | 登出 | CRIMClient |
用户
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getUsersInfo | 根据userID批量查询用户信息 | CRIMClient+UserInfoManager |
| setSelfInfo | 修改当前登录用户信息 | CRIMClient+UserInfoManager |
| getSelfInfo | 获取当前登录用户信息 | CRIMClient+UserInfoManager |
| subscribeUsersStatus | 订阅指定用户的在线状态 | CRIMClient+UserInfoManager |
| unsubscribeUsersStatus | 取消订阅用户的在线状态 | CRIMClient+UserInfoManager |
| getSubscribeUsersStatus | 获取所有已订阅用户的在线状态 | CRIMClient+UserInfoManager |
| getUserStatus | 获取指定用户的在线状态 | CRIMClient+UserInfoManager |
会话
| 方法 | 描述 | 所属文件 |
|---|---|---|
| getAllConversationList | 获取会话列表 | CRIMClient+ConversationManager |
| getConversationListSplit | 分页获取会话列表 | CRIMClient+ConversationManager |
| getOneConversation | 获取一个会话，如果不存在会自动创建 | CRIMClient+ConversationManager |
| getMultipleConversation | 获取多个会话列表 | CRIMClient+ConversationManager |
| deleteConversationAndDeleteAllMsg | 本地删除一个会话 | CRIMClient+ConversationManager |
| clearConversationAndDeleteAllMsg | 清空一个会话 本地 & 服务器 | CRIMClient+ConversationManager |
| setConversationDraft | 设置会话的草稿 | CRIMClient+ConversationManager |
| pinConversation | 置顶会话 | CRIMClient+ConversationManager |
| getTotalUnreadMsgCount | 获取总的消息未读数 | CRIMClient+ConversationManager |
| getConversationRecvMsgOpt | 获取会话免打扰状态 | CRIMClient+ConversationManager |
| setConversationRecvMsgOpt | 设置会话免打扰状态 | CRIMClient+ConversationManager |
| setConversationPrivateChat | 设置私聊, 可做“阅后即焚”功能 | CRIMClient+ConversationManager |
| setConversationBurnDuration | 设置私聊, 可做“阅后即焚”时间设置功能 | CRIMClient+ConversationManager |
| resetConversationGrpAtType | 重置at标准位 | CRIMClient+ConversationManager |
| hideConversation | 隐藏指定会话，不删除聊天记录 | CRIMClient+ConversationManager |
| hideAllConversations | 隐藏所有会话，不删除聊天记录 | CRIMClient+ConversationManager |
| setGlobalRecvMsgOpt | 全局设置消息提示 | CRIMClient+ConversationManager |
好友
| 方法 | 描述 | 所属文件 |
|---|---|---|
| addFriend | 添加好友 | CRIMClient+Friend.h |
| getFriendReqListAsRecipient | 获取收到的好友申请 | CRIMClient+FriendshipManager |
| getFriendReqListAsApplicant | 发出的好友申请 | CRIMClient+FriendshipManager |
| acceptFriendReq | 同意某人的好友申请 | CRIMClient+FriendshipManager |
| refuseFriendReq | 拒绝好友申请 | CRIMClient+FriendshipManager |
| addToBlacklist | 加入黑名单 | CRIMClient+FriendshipManager |
| getBlackList | 获取黑名单 | CRIMClient+FriendshipManager |
| removeFromBlacklist | 移除黑名单 | CRIMClient+FriendshipManager |
| getSpecifiedFriendsInfo | 获取指定好友列表的相关信息 | CRIMClient+FriendshipManager |
| getFriendList | 获取所有好友的相关信息 | CRIMClient+FriendshipManager |
| checkFriend | 检查是否好友关系 | CRIMClient+FriendshipManager |
| setFriendRemark | 设置好友备注 | CRIMClient+FriendshipManager |
| deleteFriend | 删除好友 | CRIMClient+FriendshipManager |
| searchFriends | 本地搜索好友 | CRIMClient+FriendshipManager |
群组
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createGrp | 创建群 | CRIMClient+GrpManager |
| joinGrp | 申请加入群组 | CRIMClient+GrpManager |
| quitGrp | 退群 | CRIMClient+GrpManager |
| getJoinedGrpList | 获取已加入的群列表 | CRIMClient+GrpManager |
| getSpecifiedGrpsInfo | 获取指定群资料 | CRIMClient+GrpManager |
| setGrpInfo | 更新群资料 | CRIMClient+GrpManager |
| getGrpMemberList | 获取群成员列表 | CRIMClient+GrpManager |
| getSpecifiedGrpMembersInfo | 获取群内指定群成员信息 | CRIMClient+GrpManager |
| kickGrpMember | 踢出群 | CRIMClient+GrpManager |
| transferGrpOwner | 转让群主 | CRIMClient+GrpManager |
| inviteUserToGrp | 邀请入群 | CRIMClient+GrpManager |
| getGrpReqListAsRecipient | 获取收到的群成员申请进群列表 | CRIMClient+GrpManager |
| getGrpReqListAsApplicant | 发出的入群申请 | CRIMClient+GrpManager |
| acceptGrpReq | 同意某人进入某群 | CRIMClient+GrpManager |
| refuseGrpReq | 拒绝某人进入某群 | CRIMClient+GrpManager |
| dismissGrp | 解散群 | CRIMClient+GrpManager |
| changeGrpMemberMute | 禁言或取消禁言某群成员 | CRIMClient+GrpManager |
| changeGrpMute | 设置群禁言状态 | CRIMClient+GrpManager |
| changeGrpMemberMute | 禁言群成员 | CRIMClient+GrpManager |
| searchGrps | 搜索群 | CRIMClient+GrpManager |
| setGrpMemberNickname | 设置群成员昵称 | CRIMClient+GrpManager |
| setGrpMemberRoleLevel | 修改群成员身份 | CRIMClient+GrpManager |
| getGrpMemberListByJoinTimeFilter | 根据加入时间分页获取组成员列表 | CRIMClient+GrpManager |
| setGrpVerification | 进群验证设置选项 | CRIMClient+GrpManager |
| getGrpMemberOwnerAndAdmin | 获取管理者和拥有者 | CRIMClient+GrpManager |
| setGrpApplyMemberFriend | 群成员之间是否可添加好友 | CRIMClient+GrpManager |
| setGrpLookMemberInfo | 设置能否查看群成员信息 | CRIMClient+GrpManager |
| searchGrpMembers | 搜索群成员 | CRIMClient+GrpManager |
消息
| 方法 | 描述 | 所属文件 |
|---|---|---|
| createTextMsg | 创建文本消息 | CRIMClient+MsgManager |
| createTextAtMsg | 创建@文本消息 | CRIMClient+MsgManager |
| createImageMsgFromFullPath | 通过本地图片路径创建图片消息 | CRIMClient+MsgManager |
| createImageMsgByURL | 通过图片URL创建图片消息 | CRIMClient+MsgManager |
| createSoundMsgFromFullPath | 通过本地音频路径创建音频消息 | CRIMClient+MsgManager |
| createSoundMsgByURL | 通过音频URL创建音频消息 | CRIMClient+MsgManager |
| createVideoMsgFromFullPath | 通过本地视频路径创建视频消息 | CRIMClient+MsgManager |
| createVideoMsgByURL | 通过视频URL创建视频消息 | CRIMClient+MsgManager |
| createFileMsgFromFullPath | 通过本地文件路径创建文件消息 | CRIMClient+MsgManager |
| createFileMsgByURL | 通过文件URL创建文件消息 | CRIMClient+MsgManager |
| createForwardMsg | 创建转发消息 | CRIMClient+MsgManager |
| createLocationMsg | 创建位置消息 | CRIMClient+MsgManager |
| createQuoteMsg | 创建引用消息 | CRIMClient+MsgManager |
| createCardMsg | 创建名片消息 | CRIMClient+MsgManager |
| createCustomMsg | 创建自定义消息 | CRIMClient+MsgManager |
| createFaceMsgWithIndex | 创建动图消息 | CRIMClient+MsgManager |
| sendMsg | 发送消息 | CRIMClient+MsgManager |
| revokeMsg | 撤回一条消息 | CRIMClient+MsgManager |
| typingStatusUpdate | 单聊正在输入消息 | CRIMClient+MsgManager |
| markMsgAsReadByMsgID | 标记消息已读 | CRIMClient+MsgManager |
| deleteMsgFromLocalStorage | 从本地删除一条消息 | CRIMClient+MsgManager |
| deleteMsg | 删除一条消息 本地&服务器 | CRIMClient+MsgManager |
| deleteAllMsgFromLocal | 从本地删除所有消息 | CRIMClient+MsgManager |
| deleteAllMsgFromLocalAndSvr | 删除所有消息 本地&服务器 | CRIMClient+MsgManager |
| insertSingleMsgToLocalStorage | 插入一条单聊消息到本地 | CRIMClient+MsgManager |
| insertGrpMsgToLocalStorage | 插入一条群聊消息到本地 | CRIMClient+MsgManager |
| searchLocalMsgs | 查找本地消息 | CRIMClient+MsgManager |
| uploadFile | 独立上传文件到初始化sdk的objectStorage | CRIMClient |
| getAdvancedHistoryMsgList | 获取历史消息 | CRIMClient+MsgManager |
| getAdvancedHistoryMsgListReverse | 反向获取历史消息 | CRIMClient+MsgManager |
| setAppBadge | 设置角标使用，告知服务器 客户端现有的数量 | CRIMClient+MsgManager |
| markConversationMsgAsRead | 清空未读数 | CRIMClient+MsgManager |