API 概述
API 主要模块包括:初始化、登录、用户、会话、好友、群组、消息
初始化
| 方法 | 描述 | 所属类 |
|---|---|---|
| getLoginUserID | 获取当前已登录用户的 userID | IMManager |
| initSDK | 初始化 SDK | IMManager |
| unInitSDK | 反初始化 SDK | IMManager |
登录
| 方法 | 描述 | 所属类 |
|---|---|---|
| login | 登录(支持 appID/appSecret 或 token 方式) | IMManager |
| getLoginStatus | 获取登录状态 | IMManager |
| logout | 登出 | IMManager |
用户
| 方法 | 描述 | 所属类 |
|---|---|---|
| getUsersInfo | 根据 userID 批量查询用户信息 | UserManager |
| setSelfInfo | 修改当前登录用户信息 | UserManager |
| getSelfInfo | 获取当前登录用户信息 | UserManager |
| subscribeUsersStatus | 订阅指定用户的在线状态 | UserManager |
| unsubscribeUsersStatus | 取消订阅用户的在线状态 | UserManager |
| getSubscribeUsersStatus | 获取所有已订阅用户的在线状态 | UserManager |
| getUserStatus | 获取指定用户的在线状态 | UserManager |
会话
| 方法 | 描述 | 所属类 |
|---|---|---|
| getAllConversationList | 获取会话列表 | ConversationManager |
| getConversationListSplit | 分页获取会话列表 | ConversationManager |
| getOneConversation | 获取一个会话,如果不存在会自动创建 | ConversationManager |
| getMultipleConversation | 获取多个会话列表 | ConversationManager |
| getConversationIDBySessionType | 根据会话类型获取会话 ID | ConversationManager |
| deleteConversationAndDeleteAllMsg | 本地删除一个会话及其消息 | ConversationManager |
| clearConversationAndDeleteAllMsg | 清空一个会话(本地 & 服务器) | ConversationManager |
| setConversationDraft | 设置会话的草稿 | ConversationManager |
| pinConversation | 置顶会话 | ConversationManager |
| getTotalUnreadMsgCount | 获取总的消息未读数 | ConversationManager |
| setConversationRecvMsgOpt | 设置会话免打扰状态 | ConversationManager |
| setConversationPrivateChat | 设置私聊(阅后即焚) | ConversationManager |
| setConversationBurnDuration | 设置阅后即焚时长 | ConversationManager |
| setConversation | 批量设置会话属性 | ConversationManager |
| resetConversationGrpAtType | 重置 at 标志位 | ConversationManager |
| hideConversation | 隐藏指定会话,不删除聊天记录 | ConversationManager |
| hideAllConversations | 隐藏所有会话,不删除聊天记录 | ConversationManager |
| markConversationMsgAsRead | 清空指定会话未读数 | ConversationManager |
| markAllConversationMsgAsRead | 清空所有会话未读数 | ConversationManager |
好友
| 方法 | 描述 | 所属类 |
|---|---|---|
| addFriend | 添加好友 | FriendshipManager |
| getFriendReqListAsRecipient | 获取收到的好友申请 | FriendshipManager |
| getFriendReqListAsApplicant | 获取发出的好友申请 | FriendshipManager |
| acceptFriendReq | 同意某人的好友申请 | FriendshipManager |
| refuseFriendReq | 拒绝好友申请 | FriendshipManager |
| addBlacklist | 加入黑名单 | FriendshipManager |
| getBlacklist | 获取黑名单 | FriendshipManager |
| removeBlacklist | 移除黑名单 | FriendshipManager |
| getFriendsInfo | 获取指定好友列表的相关信息 | FriendshipManager |
| getFriendList | 获取所有好友的相关信息 | FriendshipManager |
| getFriendListPage | 分页获取好友的相关信息 | FriendshipManager |
| checkFriend | 检查是否好友关系 | FriendshipManager |
| setFriendRemark | 设置好友备注 | FriendshipManager |
| deleteFriend | 删除好友 | FriendshipManager |
| searchFriends | 本地搜索好友 | FriendshipManager |
| updateFriends | 批量更新好友信息 | FriendshipManager |
群组
| 方法 | 描述 | 所属类 |
|---|---|---|
| createGrp | 创建群 | GrpManager |
| joinGrp | 申请加入群组 | GrpManager |
| quitGrp | 退群 | GrpManager |
| getJoinedGrpList | 获取已加入的群列表 | GrpManager |
| getGrpsInfo | 获取指定群资料 | GrpManager |
| setGrpInfo | 更新群资料 | GrpManager |
| getGrpMemberList | 获取群成员列表 | GrpManager |
| getGrpMembersInfo | 获取群内指定群成员信息 | GrpManager |
| kickGrpMember | 踢出群 | GrpManager |
| transferGrpOwner | 转让群主 | GrpManager |
| inviteUserToGrp | 邀请入群 | GrpManager |
| getGrpReqListAsRecipient | 获取收到的群成员申请进群列表 | GrpManager |
| getGrpReqListAsApplicant | 获取发出的入群申请 | GrpManager |
| acceptGrpReq | 同意某人进入某群 | GrpManager |
| refuseGrpReq | 拒绝某人进入某群 | GrpManager |
| dismissGrp | 解散群 | GrpManager |
| changeGrpMemberMute | 禁言群成员 | GrpManager |
| changeGrpMute | 设置群禁言状态 | GrpManager |
| searchGrps | 搜索群 | GrpManager |
| setGrpMemberNickname | 设置群成员昵称 | GrpManager |
| setGrpMemberRoleLevel | 修改群成员身份 | GrpManager |
| getGrpMemberListByJoinTime | 根据加入时间分页获取群成员列表 | GrpManager |
| setGrpVerification | 进群验证设置选项 | GrpManager |
| getGrpOwnerAndAdmin | 获取管理者和拥有者 | GrpManager |
| setGrpApplyMemberFriend | 群成员之间是否可添加好友 | GrpManager |
| setGrpLookMemberInfo | 设置能否查看群成员信息 | GrpManager |
| searchGrpMembers | 搜索群成员 | GrpManager |
| setGrpMemberInfo | 设置群成员信息 | GrpManager |
| isJoinedGrp | 判断是否已加入某群 | GrpManager |
消息
| 方法 | 描述 | 所属类 |
|---|---|---|
| createTextMsg | 创建文本消息 | MsgManager |
| createTextAtMsg | 创建 at 文本消息 | MsgManager |
| getAtAllTag | 获取 at 所有人标识 | MsgManager |
| createImageMsgFromFullPath | 通过本地图片路径创建图片消息 | MsgManager |
| createImageMsgByURL | 通过图片 URL 创建图片消息 | MsgManager |
| createSoundMsgFromFullPath | 通过本地音频路径创建音频消息 | MsgManager |
| createSoundMsgByURL | 通过音频 URL 创建音频消息 | MsgManager |
| createVideoMsgFromFullPath | 通过本地视频路径创建视频消息 | MsgManager |
| createVideoMsgByURL | 通过视频 URL 创建视频消息 | MsgManager |
| createFileMsgFromFullPath | 通过本地文件路径创建文件消息 | MsgManager |
| createFileMsgByURL | 通过文件 URL 创建文件消息 | MsgManager |
| createMergerMsg | 创建合并消息 | MsgManager |
| createForwardMsg | 创建转发消息 | MsgManager |
| createLocationMsg | 创建位置消息 | MsgManager |
| createQuoteMsg | 创建引用消息 | MsgManager |
| createCardMsg | 创建名片消息 | MsgManager |
| createCustomMsg | 创建自定义消息 | MsgManager |
| createFaceMsg | 创建动图(表情)消息 | MsgManager |
| createAdvancedTextMsg | 创建高级文本消息 | MsgManager |
| createAdvancedQuoteMsg | 创建高级引用消息 | MsgManager |
| sendMsg | 发送消息 | MsgManager |
| revokeMsg | 撤回一条消息 | MsgManager |
| typingStatusUpdate | 单聊正在输入消息 | MsgManager |
| markMsgsAsReadByMsgID | 标记消息已读 | MsgManager |
| deleteMsgFromLocalStorage | 从本地删除一条消息 | MsgManager |
| deleteMsgFromLocalAndSvr | 删除一条消息(本地 & 服务器) | MsgManager |
| deleteAllMsgFromLocal | 从本地删除所有消息 | MsgManager |
| deleteAllMsgFromLocalAndSvr | 删除所有消息(本地 & 服务器) | MsgManager |
| insertSingleMsgToLocalStorage | 插入一条单聊消息到本地 | MsgManager |
| insertGroupMsgToLocalStorage | 插入一条群聊消息到本地 | MsgManager |
| searchLocalMsgs | 查找本地消息 | MsgManager |
| findMsgList | 根据消息 ID 列表查找消息 | MsgManager |
| setMsgLocalEx | 设置消息本地扩展字段 | MsgManager |
| uploadFile | 独立上传文件 | MsgManager |
| getAdvancedHistoryMsgList | 获取历史消息 | MsgManager |
| getAdvancedHistoryMsgListReverse | 反向获取历史消息 | MsgManager |
| setAppBadge | 设置角标,告知服务器客户端现有的数量 | MsgManager |