IM即时通讯

API概述

API主要模块包括:初始化、登录、用户、会话、好友、群组、消息

初始化

方法 描述 所属文件
sdkVersion 获取sdk版本号 CRIMManager.h
getLoginUserID 获取当前已登录用户的userID CRIMManager.h
initSDKWithConfig 初始化SDK CRIMManager+Connection.h
unInitSDK 反初始化SDK CRIMManager+Connection.h

登录

方法 描述 所属文件
login 使用appId登录 CRIMManager+Login.h
login 使用token登录 CRIMManager+Login.h
getLoginStatus 获取登录状态 CRIMManager+Login.h
logout 登出 CRIMManager+Login.h

用户

方法 描述 所属文件
getUsersInfo 根据userID批量查询用户信息 CRIMManager+User.h
setSelfInfo 修改当前登录用户信息 CRIMManager+User.h
getSelfInfo 获取当前登录用户信息 CRIMManager+User.h
subscribeUsersStatus 订阅指定用户的在线状态 CRIMManager+User.h
unsubscribeUsersStatus 取消订阅用户的在线状态 CRIMManager+User.h
getSubscribeUsersStatus 获取所有已订阅用户的在线状态 CRIMManager+User.h
getUserStatus 获取指定用户的在线状态 CRIMManager+User.h

会话

方法 描述 所属文件
getAllConversationList 获取会话列表 CRIMManager+Conversation.h
getConversationListSplit 分页获取会话列表 CRIMManager+Conversation.h
getOneConversation 获取一个会话,如果不存在会自动创建 CRIMManager+Conversation.h
getMultipleConversation 获取多个会话列表 CRIMManager+Conversation.h
getConversationIDBySessionType 根据会话类型获取会话 ID CRIMManager+Conversation.h
deleteConversationAndDeleteAllMsg 本地删除一个会话 CRIMManager+Conversation.h
clearConversationAndDeleteAllMsg 清空一个会话 本地 & 服务器 CRIMManager+Conversation.h
setConversationDraft 设置会话的草稿 CRIMManager+Conversation.h
pinConversation 置顶会话 CRIMManager+Conversation.h
getTotalUnreadMsgCount 获取总的消息未读数 CRIMManager+Conversation.h
setConversationRecvMsgOpt 设置会话免打扰状态 CRIMManager+Conversation.h
setConversationPrivateChat 设置私聊, 可做“阅后即焚”功能 CRIMManager+Conversation.h
setConversationEx 设置会话扩展信息 CRIMManager+Conversation.h
resetConversationGrpAtType 重置at标志位 CRIMManager+Conversation.h
hideConversation 隐藏指定会话,不删除聊天记录 CRIMManager+Conversation.h
hideAllConversations 隐藏所有会话,不删除聊天记录 CRIMManager+Conversation.h
markConversationMsgAsRead 清空未读数 CRIMManager+Conversation.h
searchConversation 通过会话名称搜索 CRIMManager+Conversation.h
changeInputStates 改变输入状态 CRIMManager+Conversation.h
getInputstates 获取输入状态 CRIMManager+Conversation.h

好友

方法 描述 所属文件
addFriend 添加好友 CRIMManager+Friend.h
getFriendReqListAsRecipient 获取收到的好友申请 CRIMManager+Friend.h
getFriendReqListAsApplicant 发出的好友申请 CRIMManager+Friend.h
acceptFriendReq 同意某人的好友申请 CRIMManager+Friend.h
refuseFriendReq 拒绝好友申请 CRIMManager+Friend.h
addToBlackList 加入黑名单 CRIMManager+Friend.h
getBlackList 获取黑名单 CRIMManager+Friend.h
removeFromBlackList 移除黑名单 CRIMManager+Friend.h
getSpecifiedFriendsInfo 获取指定好友列表的相关信息 CRIMManager+Friend.h
getFriendList 获取所有好友的相关信息 CRIMManager+Friend.h
getFriendListPage 分页获取好友的相关信息 CRIMManager+Friend.h
checkFriend 检查是否好友关系 CRIMManager+Friend.h
setFriendRemark 设置好友备注 CRIMManager+Friend.h
setFriendEx 本地搜索好友 CRIMManager+Friend.h
setFriendIsPinned 本地搜索好友 CRIMManager+Friend.h
deleteFriend 删除好友 CRIMManager+Friend.h
searchFriends 本地搜索好友 CRIMManager+Friend.h

群组

方法 描述 所属文件
createGrp 创建群 CRIMManager+Group.h
joinGrp 申请加入群组 CRIMManager+Group.h
quitGrp 退群 CRIMManager+Group.h
getJoinedGrpList 获取已加入的群列表 CRIMManager+Group.h
getJoinedGrpListPage 分页获取已加入的群列表 CRIMManager+Group.h
getSpecifiedGrpsInfo 获取指定群资料 CRIMManager+Group.h
setGrpInfo 更新群资料 CRIMManager+Group.h
getGrpMemberList 获取群成员列表 CRIMManager+Group.h
getSpecifiedGrpMembersInfo 获取群内指定群成员信息 CRIMManager+Group.h
kickGrpMember 踢出群 CRIMManager+Group.h
transferGrpOwner 转让群主 CRIMManager+Group.h
inviteUserToGrp 邀请入群 CRIMManager+Group.h
getGrpReqListAsRecipient 获取收到的群成员申请进群列表 CRIMManager+Group.h
getGrpReqListAsApplicant 发出的入群申请 CRIMManager+Group.h
acceptGrpReq 同意某人进入某群 CRIMManager+Group.h
refuseGrpReq 拒绝某人进入某群 CRIMManager+Group.h
dismissGrp 解散群 CRIMManager+Group.h
changeGrpMemberMute 禁言群成员 CRIMManager+Group.h
changeGrpMute 设置群禁言状态 CRIMManager+Group.h
searchGrps 搜索群 CRIMManager+Group.h
setGrpMemberNickname 设置群成员昵称 CRIMManager+Group.h
setGrpMemberRoleLevel 修改群成员身份 CRIMManager+Group.h
getGrpMemberListByJoinTimeFilter 根据加入时间分页获取组成员列表 CRIMManager+Group.h
setGrpVerification 进群验证设置选项 CRIMManager+Group.h
getGrpMemberOwnerAndAdmin 获取管理者和拥有者 CRIMManager+Group.h
setGrpApplyMemberFriend 群成员之间是否可添加好友 CRIMManager+Group.h
setGrpLookMemberInfo 设置能否查看群成员信息 CRIMManager+Group.h
searchGrpMembers 搜索群成员 CRIMManager+Group.h
getUsersInGrp 搜索群成员 CRIMManager+Group.h

消息

方法 描述 所属文件
isSelf 是否是发送出去的消息 CRIMManager+Message.h
createTextMsg 创建文本消息 CRIMManager+Message.h
createAtAllFlag 创建@所有人标识 CRIMManager+Message.h
createTextAtMsg 创建@文本消息 CRIMManager+Message.h
createTextAtAllMsg 创建@全体成员文本消息 CRIMManager+Message.h
createImageMsgFromFullPath 通过本地图片路径创建图片消息 CRIMManager+Message.h
createImageMsgByURL 通过图片URL创建图片消息 CRIMManager+Message.h
createSoundMsgFromFullPath 通过本地音频路径创建音频消息 CRIMManager+Message.h
createSoundMsgByURL 通过音频URL创建音频消息 CRIMManager+Message.h
createVideoMsgFromFullPath 通过本地视频路径创建视频消息 CRIMManager+Message.h
createVideoMsgByURL 通过视频URL创建视频消息 CRIMManager+Message.h
createFileMsgFromFullPath 通过本地文件路径创建文件消息 CRIMManager+Message.h
createFileMsgByURL 通过文件URL创建文件消息 CRIMManager+Message.h
createMergerMsg 创建合并消息 CRIMManager+Message.h
createForwardMsg 创建转发消息 CRIMManager+Message.h
createLocationMsg 创建位置消息 CRIMManager+Message.h
createQuoteMsg 创建引用消息 CRIMManager+Message.h
createCardMsg 创建名片消息 CRIMManager+Message.h
createCustomMsg 创建自定义消息 CRIMManager+Message.h
createFaceMsgWithIndex 创建动图消息 CRIMManager+Message.h
sendMsg 发送消息 CRIMManager+Message.h
revokeMsg 撤回一条消息 CRIMManager+Message.h
typingStatusUpdate 单聊正在输入消息 CRIMManager+Message.h
markMsgAsReadByMsgID 标记消息已读 CRIMManager+Message.h
deleteMsgFromLocalStorage 从本地删除一条消息 CRIMManager+Message.h
deleteMsg 删除一条消息 本地&服务器 CRIMManager+Message.h
deleteAllMsgFromLocal 从本地删除所有消息 CRIMManager+Message.h
deleteAllMsgFromLocalAndSvr 删除所有消息 本地&服务器 CRIMManager+Message.h
insertSingleMsgToLocalStorage 插入一条单聊消息到本地 CRIMManager+Message.h
insertGrpMsgToLocalStorage 插入一条群聊消息到本地 CRIMManager+Message.h
searchLocalMsgs 查找本地消息 CRIMManager+Message.h
uploadFile 独立上传文件到初始化sdk的objectStorage CRIMManager+Message.h
setGlobalRecvMsgOpt 全局设置消息提示 CRIMManager+Message.h
getAdvancedHistoryMsgList 获取历史消息 CRIMManager+Message.h
getAdvancedHistoryMsgListReverse 反向获取历史消息 CRIMManager+Message.h
setAppBadge 设置角标使用,告知服务器 客户端现有的数量 CRIMManager+Message.h