API概述
API主要模块包括:
| 单例模式 |
| 获取单例 |
| SDK接口 |
| 基础函数 |
| 登录 |
| 用户 |
| 会话 |
| 好友 |
| 群组 |
| 消息 |
获取单例
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| getSDK | 获取单例 |
基础函数
| 方式 | 接口 | 描述 |
|---|---|---|
| 引用 | ||
| sdkVersion | 获取SDK版本号 | |
| 主调 | ||
| getLoginUserID | 获取当前已登录用户的userID |
登录
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| login | 登录 | |
| getLoginStatus | 获取登录状态 | |
| logout | 登出 | |
| 回调 | ||
| OnConnectFailed | SDK 连接服务器失败 | |
| OnConnectSuccess | SDK 已经成功连接到服务器 | |
| OnConnecting | SDK 正在连接到服务器 | |
| OnKickedOffline | 当前用户被踢下线 | |
| OnUserTokenExpired | token过期通知 | |
| OnUserTokenInvalid | token无效通知 |
用户
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| getUsersInfo | 查询用户信息 | |
| setSelfInfo | 修改当前登录用户信息 | |
| getSelfUserInfo | 获取当前登录用户信息 | |
| subscribeUsersStatus | 订阅指定用户的在线状态 | |
| unsubscribeUsersStatus | 取消订阅用户的在线状态 | |
| getSubscribeUsersStatus | 获取所有已订阅用户的在线状态 | |
| getUserStatus | 获取指定用户的在线状态 | |
| 回调 | ||
| OnSelfInfoUpdated | 个人信息变更通知 | |
| OnUserStatusChanged | 用户状态改变 |
会话
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| getAllConversationList | 获取会话列表 | |
| getConversationListSplit | 分页获取会话列表 | |
| getOneConversation | 获取单个会话 | |
| getMultipleConversation | 获取多个会话列表 | |
| deleteConversationAndDeleteAllMsg | 本地删除一个会话 | |
| clearConversationAndDeleteAllMsg | 清空一个会话 | |
| setConversationDraft | 设置会话的草稿 | |
| getTotalUnreadMsgCount | 获取总的消息未读数 | |
| markConversationMsgAsRead | 标记会话已读 | |
| hideConversation | 隐藏指定会话 | |
| hideAllConversations | 隐藏所有会话 | |
| 回调 | ||
| OnSyncServerStart | 同步服务器会话开始 | |
| OnSyncServerFinish | 同步服务器会话完成 | |
| OnSyncServerFailed | 同步服务器会话失败 | |
| OnNewConversation | 有新的会话 | |
| OnConversationChanged | 某些会话的关键信息发生变化 | |
| OnTotalUnreadMsgCountChanged | 会话未读总数变更通知 |
好友
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| addFriend | 添加好友 | |
| getFriendReqListAsRecipient | 获取收到的好友申请 | |
| getFriendReqListAsApplicant | 发出的好友申请 | |
| acceptFriendReq | 同意某人的好友申请 | |
| refuseFriendReq | 拒绝好友申请 | |
| addBlack | 加入黑名单 | |
| getBlackList | 获取黑名单 | |
| removeBlack | 移除黑名单 | |
| getSpecifiedFriendsInfo | 获取指定好友列表的相关信息 | |
| getFriendList | 获取所有好友的相关信息 | |
| getFriendListPage | 获取所有好友的相关信息(分页) | |
| checkFriend | 检查是否好友关系 | |
| updateFriends | 修改好友信息 | |
| deleteFriend | 删除好友 | |
| searchFriends | 本地搜索好友 | |
| 回调 | ||
| OnBlackAdded | 黑名单新增通知 | |
| OnBlackDeleted | 黑名单删除通知 | |
| OnFriendReqAdded | 好友申请通知 | |
| OnFriendReqRejected | 好友申请被拒绝 | |
| OnFriendReqAccepted | 好友申请被接受 | |
| OnFriendReqDeleted | 好友申请被删除 | |
| OnFriendAdded | 好友新增通知 | |
| OnFriendDeleted | 好友删除通知 | |
| OnFriendInfoChanged | 好友资料变更通知 |
群组
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| createGrp | 创建群 | |
| joinGrp | 申请加入群组 | |
| quitGrp | 退群 | |
| getUsersInGrp | 获取成员是否在群内 | |
| getJoinedGrpList | 获取已加入的群列表 | |
| getJoinedGrpListPage | 获取已加入的群列表(分页) | |
| getSpecifiedGrpsInfo | 获取指定群资料 | |
| setGrpInfo | 更新群资料 | |
| getGrpMemberList | 获取群成员列表 | |
| getSpecifiedGrpMembersInfo | 获取群内指定群成员信息 | |
| kickGrpMember | 踢出群 | |
| transferGrpOwner | 转让群主 | |
| inviteUserToGrp | 邀请入群 | |
| getGrpReqListAsRecipient | 获取收到的群成员申请进群列表 | |
| getGrpReqListAsApplicant | 获取发出的入群申请列表 | |
| acceptGrpReq | 同意某人进入某群 | |
| refuseGrpReq | 拒绝某人进入某群 | |
| dismissGrp | 解散群 | |
| changeGrpMemberMute | 禁言某群成员 | |
| changeGrpMute | 设置群禁言状态 | |
| searchGrps | 搜索群 | |
| setGrpMemberInfo | 设置群成员信息 | |
| getGrpMemberListByJoinTimeFilter | 根据加入时间分页获取组成员列表 | |
| getGrpMemberOwnerAndAdmin | 获取管理者和拥有者 | |
| searchGrpMembers | 搜索群成员 | |
| 回调 | ||
| OnGrpMemberAdded | 有新成员加入群 | |
| OnGrpMemberDeleted | 有成员离开群 | |
| OnGrpMemberInfoChanged | 某成员信息发生变更 | |
| OnJoinedGrpAdded | 群组有增加通知 | |
| OnJoinedGrpDeleted | 群组有减少通知 | |
| OnGrpInfoChanged | 群信息修改通知 | |
| OnGrpReqAccepted | 群申请被接受通知 | |
| OnGrpReqAdded | 有人申请加群通知 | |
| OnGrpReqDeleted | 群申请有删除通知 | |
| OnGrpReqRejected | 群申请有拒绝通知 | |
| OnGrpDismissed | 群解散通知 |
消息
| 方式 | 接口 | 描述 |
|---|---|---|
| 主调 | ||
| createTextMsg | 创建文本消息 | |
| createTextAtMsg | 创建@文本消息 | |
| createImageMsgByFile | 创建图片消息 | |
| createSoundMsgByFile | 创建音频消息 | |
| createVideoMsgByFile | 创建视频消息 | |
| createFileMsgByFile | 创建文件消息 | |
| createMergerMsg | 创建合并消息 | |
| createForwardMsg | 创建转发消息 | |
| createLocationMsg | 创建位置消息 | |
| createQuoteMsg | 创建引用消息 | |
| createCardMsg | 创建名片消息 | |
| createCustomMsg | 创建自定义消息 | |
| createFaceMsg | 创建动图消息 | |
| sendMsg | 发送消息 | |
| revokeMsg | 撤回一条消息 | |
| typingStatusUpdate | 单聊正在输入消息 | |
| deleteMsgFromLocalStorage | 从本地删除一条消息 | |
| deleteMsg | 删除一条消息 | |
| deleteAllMsgFromLocal | 从本地删除所有消息 | |
| deleteAllMsgFromLocalAndSvr | 删除所有消息 | |
| insertSingleMsgToLocalStorage | 插入一条单聊消息到本地 | |
| insertGrpMsgToLocalStorage | 插入一条群聊消息到本地 | |
| searchLocalMsgs | 查找本地消息 | |
| uploadFile | 上传文件 | |
| getAdvancedHistoryMsgList | 获取历史消息 | |
| getAdvancedHistoryMsgListReverse | 反向获取历史消息 | |
| 回调 | ||
| OnRecvNewMsgs | 收到新消息 | |
| OnRecv1v1ReadReceipt | 单聊消息已读回执 | |
| OnRecvGrpReadReceipt | 群聊消息已读回执 | |
| OnNewRecvMsgRevoked | 收到消息撤回 | |
| OnMsgDeleted | 收到消息删除 |