diff --git a/README.md b/README.md index d231a70..3b5a023 100644 --- a/README.md +++ b/README.md @@ -164,99 +164,99 @@ OpenIM.iMManager.logout(); #### OpenIM.iMManager -| 方法 | 描述 | -| ---------------- | ------------------- | -| initSDK | 初始化sdk | -| unInitSDK | | -| login | 登录 | -| logout | 登出 | -| getLoginStatus | 登录状态 | -| getLoginUid | 当前uid | -| getLoginUserInfo | 当前用户信息 | -| setSelfInfo | 修改资料 | -| getUsersInfo | 根据uid获取用户资料 | -| forceReConn | 强制重连 | +| 方法 | 描述 | 参数说明 | +| ---------------- | ------------------- | ------------------------------------------------------------ | +| initSDK | 初始化sdk | platform:平台(IMPlatform)
ipApi:接口地址
ipWs:WebSocket地址
dbPath:数据本地存储路径以目录结尾 | +| unInitSDK | | | +| login | 登录 | uid:当前用户userID
token:用户的token | +| logout | 登出 | | +| getLoginStatus | 登录状态 | | +| getLoginUid | 当前uid | | +| getLoginUserInfo | 当前用户信息 | | +| setSelfInfo | 修改资料 | info(UserInfo):用户信息 | +| getUsersInfo | 根据uid获取用户资料 | uidList:userId列表 | +| forceReConn | 强制重连 | | #### 会话管理:OpenIM.iMManager.conversationManager -| 方法 | 描述 | -| ----------------------- | ------------------------------------------------------------ | -| setConversationListener | 会话监听 | -| getAllConversationList | 获取所有会话 | -| getSingleConversation | 获取单个会话sourceID(String):单聊值为userID,群聊值为groupID;sessionType(int):单聊值为1,群聊值为2 | -| getMultipleConversation | 获取多个会话 | -| deleteConversation | 删除会话 | -| setConversationDraft | 会话草稿 | -| pinConversation | 会话置顶 | +| 方法 | 描述 | 参数说明 | +| ----------------------- | ------------ | ------------------------------------------------------------ | +| setConversationListener | 会话监听 | | +| getAllConversationList | 获取所有会话 | | +| getSingleConversation | 获取单个会话 | sourceID:单聊值为userID,群聊值为groupID;
sessionType:单聊值为1,群聊值为2 | +| getMultipleConversation | 获取多个会话 | conversationIDList:会话id列表 | +| deleteConversation | 删除会话 | conversationID:会话id | +| setConversationDraft | 会话草稿 | draftText:草稿 | +| pinConversation | 会话置顶 | isPinned:true置顶,false取消置顶 | #### 好友关系管理:OpenIM.iMManager.friendshipManager -| 方法 | 描述 | -| ------------------------ | --------------------------------------------------- | -| setFriendshipListener | 关系监听 | -| getFriendsInfo | 获取好友信息 | -| addFriend | 添加朋友 | -| getFriendApplicationList | 获取好友申请列表 | -| getFriendList | 获取好友列表 | -| setFriendInfo | 修改朋友备注 {"uid" : "userId", "comment" : "备注"} | -| addToBlackList | 加入黑名单 | -| getBlackList | 获取黑名单列表 | -| deleteFromBlackList | 从黑名单移除 | -| checkFriend | 检查好友关系 | -| deleteFromFriendList | 移除好友 | -| acceptFriendApplication | 接受好友申请 | -| refuseFriendApplication | 拒绝好友申请 | +| 方法 | 描述 | 参数说明 | +| ------------------------ | ---------------- | -------------------------------------------------------- | +| setFriendshipListener | 关系监听 | | +| getFriendsInfo | 获取好友信息 | uidList:要查询的用户的userID集合 | +| addFriend | 添加朋友 | uid:对方的userID
reason:添加理由 | +| getFriendApplicationList | 获取好友申请列表 | | +| getFriendList | 获取好友列表 | | +| setFriendInfo | 修改朋友备注 | info(UserInfo):{"uid" : "userId", "comment" : "备注"} | +| addToBlackList | 加入黑名单 | | +| getBlackList | 获取黑名单列表 | | +| deleteFromBlackList | 从黑名单移除 | | +| checkFriend | 检查好友关系 | | +| deleteFromFriendList | 移除好友 | | +| acceptFriendApplication | 接受好友申请 | | +| refuseFriendApplication | 拒绝好友申请 | | #### 消息管理:OpenIM.iMManager.messageManager -| 方法 | 描述 | -| --------------------------------- | ---------------------------------------------- | -| addAdvancedMsgListener | 添加消息监听 | -| removeAdvancedMsgListener | 移除消息监听 | -| setMsgSendProgressListener | 消息发送进度监听 | -| sendMessage | 发送消息,单聊useID, 群聊groupID | -| getHistoryMessageList | 获取历史消息,startMsg分页传列表里的第一条消息 | -| revokeMessage | 消息撤回 | -| deleteMessageFromLocalStorage | 删除消息 | -| insertSingleMessageToLocalStorage | 插入消息 | -| findMessages | 根据消息id查询消息 | -| markSingleMessageHasRead | 标记消息为已读 | -| markGroupMessageHasRead | 标记消息为已读 | -| createTextMessage | 创建文本消息 | -| createTextAtMessage | 创建at消息,atUserList为at的userId列表 | -| createImageMessage | 创建图片消息 | -| createSoundMessage | 创建语音消息 | -| createVideoMessage | 创建视频消息 | -| createFileMessage | 创建文件消息 | -| createMergerMessage | 创建合并消息 | -| createForwardMessage | 创建转发消息 | -| getTotalUnreadMsgCount | 获取消息未读数 | +| 方法 | 描述 | 参数说明 | +| --------------------------------- | ------------------ | ------------------------------------------------------------ | +| addAdvancedMsgListener | 添加消息监听 | | +| removeAdvancedMsgListener | 移除消息监听 | | +| setMsgSendProgressListener | 消息发送进度监听 | | +| sendMessage | 发送消息 | message:消息对象
userID:单聊的用户id
groupID:群聊的组id
onlineUserOnly:仅在线用户 | +| getHistoryMessageList | 获取历史消息 | startMsg:列表里的第一条消息
userID:单聊的用户id
groupID:群聊的组id
count:每页size | +| revokeMessage | 消息撤回 | | +| deleteMessageFromLocalStorage | 删除消息 | | +| insertSingleMessageToLocalStorage | 插入消息 | | +| findMessages | 根据消息id查询消息 | messageIDList:消息id集合 | +| markSingleMessageHasRead | 标记消息为已读 | | +| markGroupMessageHasRead | 标记消息为已读 | | +| createTextMessage | 创建文本消息 | text:输入的内容 | +| createTextAtMessage | 创建at消息 | atUidList:被@的用户id集合 | +| createImageMessage | 创建图片消息 | imagePath:路径 | +| createSoundMessage | 创建语音消息 | soundPath:路径
duration:时长 | +| createVideoMessage | 创建视频消息 | videoPath:路径
videoType:视频类型
duration:时长
snapshotPath:缩略图 | +| createFileMessage | 创建文件消息 | filePath:路径
fileName:文件名 | +| createMergerMessage | 创建合并消息 | | +| createForwardMessage | 创建转发消息 | | +| getTotalUnreadMsgCount | 获取消息未读数 | | #### 组管理: OpenIM.iMManager.groupManager -| 方法 | 描述 | -| ----------------------- | ------------------ | -| setGroupListener | 设置组关系监听 | -| inviteUserToGroup | 邀请进组 | -| kickGroupMember | 剔除组成员 | -| getGroupMembersInfo | 获取组成员信息 | -| getGroupMemberList | 获取组成员 | -| getJoinedGroupList | 获取已加入的群组 | -| isJoinedGroup | 判断是否已加入群组 | -| createGroup | 创建群 | -| setGroupInfo | 设置群资料 | -| getGroupsInfo | 获取群信息 | -| joinGroup | 加入群 | -| quitGroup | 退出群 | -| transferGroupOwner | 群权限转移 | -| getGroupApplicationList | 获取群申请列表 | -| acceptGroupApplication | 接受群邀请 | -| refuseGroupApplication | 拒绝群邀请 | +| 方法 | 描述 | 参数说明 | +| ----------------------- | ------------------ | ------------------------------------------------------------ | +| setGroupListener | 设置组关系监听 | | +| inviteUserToGroup | 邀请进组 | groupId:组id
uidList:被邀请的用户id集合
reason:说明 | +| kickGroupMember | 剔除组成员 | uidList:被剔除的用户id集合 | +| getGroupMembersInfo | 获取组成员信息 | uidList:成员id集合 | +| getGroupMemberList | 获取组成员 | | +| getJoinedGroupList | 获取已加入的群组 | | +| isJoinedGroup | 判断是否已加入群组 | | +| createGroup | 创建群 | groupInfo:组信息对象
list:组成员角色列表 | +| setGroupInfo | 设置群资料 | | +| getGroupsInfo | 获取群信息 | | +| joinGroup | 加入群 | | +| quitGroup | 退出群 | | +| transferGroupOwner | 群权限转移 | | +| getGroupApplicationList | 获取群申请列表 | | +| acceptGroupApplication | 接受群邀请 | | +| refuseGroupApplication | 拒绝群邀请 | |