linkdood-web-sdk 0.1.0

package/docs/md/action/auth.md

@@ -0,0 +1,45 @@
+## 鉴权接口
+
+| 返回                                              | 接口                                | 描述     |
+| ------------------------------------------------- | ----------------------------------- | -------- |
+| [LoginResult](../model/LoginResult.md)            | login(account, password, loginType) | 登录     |
+| [CommonDataResult](../model/CommonDataResult.md)  | logout()                            | 登出     |
+| [LoginResult](../model/LoginResult.md)            | relogin()                           | 重新登出  |
+| [CommonDataResult](../model/CommonDataResult.md)  | changePwd(oldPwd, newPwd)           | 修改密码  |
+
+### 方法详细信息
+__ __
+
+####[LoginResult](../model/LoginResult.md) login(account, password, loginType)
+```markdown
+描述
+    用户登录
+参数
+    account - 用户名
+    password - 密码
+    loginType - 帐号类型: 1：手机号 2：第三方关联,3：邮箱 4：用户ID,6：豆豆号，7:使用自定义拓展字段来进行登陆, 8:emm的sso登录，95:验证码注册加登录，96:验证码登录， 97：更换设备时短信验证登录 99:SAML认证用户 -1：传用户ID但票验证
+```    
+
+    
+####[CommonDataResult](../model/CommonDataResult.md) logout()
+```markdown
+描述
+    用户退出
+```    
+
+        
+####[LoginResult](../model/LoginResult.md) relogin()
+```markdown
+描述 
+    用户重新登录
+```    
+    
+        
+####[CommonDataResult](../model/CommonDataResult.md) changePwd(oldPwd, newPwd)
+```markdown
+描述
+    用户修改密码
+参数
+    oldPwd - 原密码
+    newPwd - 新密码
+```     

package/docs/md/action/buddy.md

@@ -0,0 +1,93 @@
+## 联系人服务接口
+
+| 返回                                                        | 接口                                              | 描述                                   |
+| ----------------------------------------------------------- | ------------------------------------------------- | ------------------------------------ |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)            | addBuddy(userID, message)                         | 添加好友                              |
+| [CommonDataResult](../model/CommonDataResult.md)            | removeBuddy(userID)                               | 删除好友                               |
+| [CommonDataResult](../model/CommonDataResult.md)            | addInBlackList(userID)                            | 加入到黑名单                           |
+| [CommonDataResult](../model/CommonDataResult.md)            | editBuddyRemark(userID, remark)                   | 修改好友备注                           |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)            | addBuddyResponse(buddyID, isagree, applicationID) | 被添加好友响应操作                      |
+| array([TinyUserBean](../model/TinyUserBean.md))             | getBuddyList()                                    | 获取好友列表(缓存)                      |
+| array([TinyUserBean](../model/TinyUserBean.md))             | getSubscriptionList()                             | 获取订阅号列表(缓存)                    |
+| [SmallUserBean](../model/SmallUserBean.md)                  | getBuddy(userID)                                  | 获取好友信息(优先缓存，其次服务器请求)    |
+| [GetBuddyOnlineResult](../model/GetBuddyOnlineResult.md)    | getBuddyOnline()                                  | 获取在线的好友状态                           |
+
+### 方法详细信息
+__ __
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) addBuddy(userID, message)
+```markdown
+描述
+    添加好友操作
+参数
+    userID - 被添加好友用户ID
+    message - (../mode/Message)
+```    
+    
+        
+
+####[CommonDataResult](../model/CommonDataResult.md) removeBuddy(userID)
+```markdown
+描述
+    删除好友操作
+参数
+    userID - 好友ID
+```    
+    
+
+####[CommonDataResult](../model/CommonDataResult.md) addInBlackList(userID)
+```markdown
+描述
+   将好友加入黑名单
+参数
+   userID - 好友ID
+```       
+
+
+####[CommonDataResult](../model/CommonDataResult.md) editBuddyRemark(userID, remark)
+```markdown
+描述
+    修改好友备注
+参数
+    userID - 好友ID
+    remark - 备注名称
+```
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) addBuddyResponse(buddyID, isagree, applicationID)
+```markdown
+描述
+    被添加好友响应操作(同意/拒绝)
+参数
+    buddyID - 申请人UserID 
+    isagree - 是否同意 0.拒绝 1.同意
+    applicationID - 申请单号
+```
+
+####[TinyUserBean](../model/TinyUserBean.md) getBuddyList()
+```markdown
+描述
+    获取好友列表(缓存数据)
+```
+
+####[TinyUserBean](../model/TinyUserBean.md) getSubscriptionList()
+```markdown
+描述
+    获取订阅号列表
+    PS:不要问为什么订阅号在好友操作里，我也不造为啥在获取好友中包含了订阅号数据
+```
+
+
+####[GetUserResult](../model/GetUserResult.md) getBuddy(userID)
+```markdown
+描述
+    获取好友信息，优先使用缓存数据(好友列表)，缓存中没有则从服务器请求
+参数
+    userID - 好友ID
+```
+
+
+####[GetBuddyOnlineResult](../model/GetBuddyOnlineResult.md) getBuddyOnline
+```markdown
+描述
+    获取在线的好友状态
+```

package/docs/md/action/chat.md

@@ -0,0 +1,84 @@
+## 会话服务接口
+
+| 返回                                    | 接口                                | 描述                     |
+| --------------------------------------- | ----------------------------------- | ----------------------- |
+| array([ChatRes](../model/ChatRes.md))   | getChatList()                       | 获取本地缓存会话列表      |
+| [ChatRes](../model/ChatRes.md)          | addChat(chatID, chatType)           | 新建会话缓存             |
+| number                                  | getChatCacheListUnreadCount()       | 获取会话菜单未读消息总数   |
+| void                                    | setActiveChatID(chatID = 0)         | 设置当前激活会话ID        |
+| number                                  | deleteChatCache(chatID)             | 删除当前会话             |
+| number                                  | clearChatCacheList()                | 清空会话列表             |
+| number                                  | clearChatCacheContent(chatID)       | 清空会话内容             |
+| number                                  | setChatTop(chatID, isTop)           | 设置会话是否置顶          | 
+| number                                  | setChatReadOrNoRead(chatID, isRead) | 设置会话已读/未读       |
+### 方法详细信息
+__ __
+
+####[TODO](../model/test.md) getChatList()
+```markdown
+描述
+    获取本地缓存会话列表
+```
+
+####[TODO](../model/test.md) addChat(chatID, chatType)
+```markdown
+描述
+    新建会话缓存
+参数
+    chatID - 作用ID(好用/非好友/群)
+    chatType - 类型 user group enterprise
+```
+
+####number getChatCacheListUnreadCount()
+```markdown
+描述
+    获取会话菜单未读消息总数
+```
+
+####void setActiveChatID(chatID)
+```markdown
+描述
+    设置当前激活会话ID
+参数
+    chatID - 作用ID(好用/非好友/群)    
+```
+
+####number deleteChatCache(chatID)
+```markdown
+描述
+    删除当前会话
+参数
+    chatID - 作用ID(好用/非好友/群)    
+```
+
+####number clearChatCacheList()
+```markdown
+描述
+    清空会话列表
+```
+
+####number clearChatCacheContent()
+```markdown
+描述
+    清空会话内容
+参数
+    chatID - 作用ID(好用/非好友/群)         
+```
+
+####number setChatTop(chatID, isTop)
+```markdown
+描述
+    设置会话是否置顶
+参数
+   chatID - 作用ID(好用/非好友/群)      
+   isTop - 是否置顶  true/false
+```
+
+####number setChatReadOrNoRead(chatID, isRead)
+```markdown
+描述
+    设置会话已读/未读
+参数
+   chatID - 作用ID(好用/非好友/群)      
+   isRead - 已读true/未读false
+```

package/docs/md/action/config.md

@@ -0,0 +1,16 @@
+## 预登录接口
+
+| 返回                                              | 接口                                | 描述     |
+| ------------------------------------------------- | ----------------------------------- | -------- |
+| [TODO](../model/test.md)                          | getConfig(prelogin)                 | 登录     |
+
+### 方法详细信息
+__ __
+
+####[TODO](../model/test.md)  getConfig(prelogin)
+```markdown
+描述
+    预登陆
+参数
+   prelogin - 登录地址
+```

package/docs/md/action/enterprise.md

@@ -0,0 +1,5 @@
+## 企业号服务接口
+
+| 返回                                    | 接口                                | 描述                     |
+| --------------------------------------- | ----------------------------------- | ----------------------- |
+| [PltFRet](../model/PltFRet.md)          | getEnterprise                       | 获取本地缓存企业号信息     |

package/docs/md/action/file.md

@@ -0,0 +1,20 @@
+## 文件服务
+
+| 返回                                              | 接口                                          | 描述           |
+| ------------------------------------------------- | -------------------------------------------- | ------------- |
+| [TODO](../model/test.md)                          | uploadFile(file, type = 5, isGroup = false, isEncryption = false)      | 文件上传       |
+
+### 方法详细信息
+__ __
+
+
+####[TODO](../model/test.md)  uploadFile(file, isGroup, isEncryption)
+```markdown
+描述
+    上传文件
+参数
+    file - 文件源(document.querySelector("input[type=file]").files[0])
+    type - 消息类型: 5|28 图片， 6 文件
+    isGroup - 是否是群
+    isEncryption - 是否加群
+```

package/docs/md/action/group.md

@@ -0,0 +1,235 @@
+## 群服务
+
+| 返回                                                                   | 接口                                                        | 描述                                                 |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------- |
+| TODO                                                                   | createGroup(groupName, members[], groupIcon = '')          | 创建群                                               |
+| [CommonDataResult](../model/CommonDataResult.md)                       | activeGroup(groupID)                                       | 激活群-如果存在群成员则添加群成员                    |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | addGroupRequest(groupID, message)                          | 加群申请请求                                         |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | addGroupResponse(userID, groupID, applicationID, isagree)  | 添加群响应                                           |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | groupInviteResponse(groupID, applicationID, isagree)       | 群邀请 被邀请人响应                                  |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | groupDissolveRequest(groupID, groupName)                   | 解散群                                               |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | groupMemberExitRequest(groupID)                            | 群成员退出                                           |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | groupMemberKickoutRequest(groupID, kickoutUserIDs[])       | 管理员踢群成员                                       |
+| [TransferGroupResult](../model/TransferGroupResult.md)                 | transferGroup(groupID, targetUserID)                       | 群转让                                               |
+| [GroupInfoResult](../model/GroupInfoResult.md)                         | getGroupInfo(groupID)                                      | 获取群信息(优先缓存，其次服务器请求)                    |
+| [GroupSetResult](../model/GroupSetResult.md)                           | getGroupSet(groupID)                                       | 获取群设置信息                                       |
+| array([TinyGroupInfo](../model/TinyGroupInfo.md))                      | getGroupList()                                             | 获取缓存群列表信息                                   |
+| array([SmallUserBean](../model/SmallUserBean.md))                      | getGroupMemberList(groupID)                                | 获取群成员列表(取最近，如果时间没变，优先取缓存数据)     |
+| [CommonDataResult](../model/CommonDataResult.md)                       | updateGroupInfo(groupInfo)                                 | 更新群信息                                           |
+| [CommonDataResult](../model/CommonDataResult.md)                       | deleteGroup(groupID)                                       | 删除群                                               |
+| [AddGroupMemberResult](../model/AddGroupMemberResult.md)  [VerifyMessageRet](../model/VerifyMessageRet.md) | invitationGroupMembers(groupID, members[])                 | 邀请群成员                                           |
+| [AddGroupMemberResult](../model/AddGroupMemberResult.md)               | addOldGroupMember(groupID, members[])                      | 邀请群成员---老接口                                  |
+| [VerifyMessageRet](../model/VerifyMessageRet.md)                       | addNewGroupMember(groupID, invitees[])                     | 邀请群成员---新接口                                  |
+| [RemoveGroupMemberResult](../model/RemoveGroupMemberResult.md)         | removeMembers(groupID, members)                            | 移除群成员                                           |
+| [GroupMemberInfoResult](../model/GroupMemberInfoResult.md)             | getMemberInfo(groupID, targetUserID)                       | 获取群成员信息                                       |
+| [GetBuddyOnlineResult](../model/GetBuddyOnlineResult.md)               | getMembersOnline(members[])                                | 获取群成员信息                                       |
+| TODO                                                                   | getGroupMessagesHistory(groupID, messageID = 0, size = 10) | 获取群聊天历史信息(缓存)                             |
+
+### 方法详细信息
+__ __
+
+####[TODO](../model/test.md) createGroup(groupName, members, groupIcon = '')
+```markdown
+描述
+    创建群
+参数
+    groupName - 群名称
+    members -   群成员用户id集  
+    groupIcon - 群头像
+```
+
+####[CommonDataResult](../model/CommonDataResult.md) activeGroup(groupID)
+```markdown
+描述
+    激活群-如果存在群成员则添加群成员
+参数
+    groupID - 群ID    
+```
+
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) addGroupRequest(groupID, message)
+```markdown
+描述
+    加群申请请求
+参数
+    groupID - 群ID
+    message - (./mode/Message) 
+```
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) addGroupResponse(userID, groupID, applicationID, isagree)
+```markdown
+描述
+    添加群响应
+参数
+    userID - 申请人ID
+    groupID - 群ID
+    applicationID - 申请单号
+    isagree - 是否同意 0.拒绝 1.同意
+```
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) groupInviteResponse(groupID, applicationID, isagree)
+```markdown
+表述
+    群邀请 被邀请人响应
+参数
+    groupID - 群ID
+    applicationID - 申请单号
+    isagree - 是否同意 0.拒绝 1.同意
+```
+
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) groupDissolveRequest(groupID, groupName) 
+```markdown
+表述
+    解散群
+参数
+    groupID - 群ID
+    groupName - 群名称        
+```
+
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) groupMemberExitRequest(groupID)
+```markdown
+表述
+    群成员退出
+参数
+    groupID - 群ID    
+```
+
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) groupMemberKickoutRequest(groupID, kickoutUserIDs[])
+```markdown
+表述
+    管理员踢群成员
+参数
+    groupID - 群ID
+    kickoutUserIDs - 被踢出群成员ID集合
+```
+
+####[TransferGroupResult](../model/TransferGroupResult.md) transferGroup(groupID, targetUserID)
+```markdown
+表述
+    群转让
+参数
+    groupID - 群ID      
+    targetUserID - 转让人用户ID
+```
+
+
+####[GroupInfoResult](../model/GroupInfoResult.md) getGroupInfo(groupID)
+```markdown
+表述
+    获取群信息  优先从本地获取，本地没有则从服务器获取
+参数
+    groupID - 群ID
+```
+
+#####[GroupSetResult](../model/GroupSetResult.md) getGroupSet(groupID)
+```markdown
+表述 
+    获取群设置信息
+参数
+    groupID - 群ID        
+```
+
+
+####array([TinyGroupInfo](../model/TinyGroupInfo.md)) getGroupList()
+```markdown
+表述
+    获取缓存群成员列表信息
+```
+
+
+####array([SmallUserBean](../model/SmallUserBean.md)) getGroupMemberList(groupID)
+```markdown
+描述
+    获取群成员列表(取最近，如果时间没变，优先取缓存数据)
+参数
+    groupID - 群ID           
+```
+
+
+####[CommonDataResult](../model/CommonDataResult.md) updateGroupInfo(groupInfo)
+```markdown
+描述
+    更新群信息
+参数
+    [groupInfo](../model/test.md) - 群实体
+```
+
+####[CommonDataResult](../model/CommonDataResult.md) deleteGroup(groupID)
+```markdown
+描述
+    删除群
+参数
+    groupID - 群ID        
+```
+
+
+####[AddGroupMemberResult](../model/AddGroupMemberResult.md)|[VerifyMessageRet](../model/VerifyMessageRet.md) invitationGroupMembers(groupID, members[])
+```markdown
+描述
+    邀请群成员
+参数
+    groupID - 群ID
+    members - 用户ID
+```
+
+    
+####[AddGroupMemberResult](../model/AddGroupMemberResult.md) addOldGroupMember(groupID, members[])
+```markdown
+描述
+    邀请群成员---老接口
+参数
+   groupID - 群ID
+   members - 用户ID  
+```
+
+
+####[VerifyMessageRet](../model/VerifyMessageRet.md) addNewGroupMember(groupID, invitees[])
+```markdown
+描述
+    邀请群成员---新接口
+参数
+    groupID - 群ID
+    invitees - 被邀请人集合
+```
+
+
+####[RemoveGroupMemberResult](../model/RemoveGroupMemberResult.md) removeMembers(groupID, members[])
+```markdown
+描述
+    移除群成员
+参数
+    groupID - 群ID
+    members - 移除人ID集合
+```
+
+
+####[GroupMemberInfoResult](../model/GroupMemberInfoResult.md) getMemberInfo(groupID, targetUserID)
+```markdown
+描述
+   获取群成员信息
+参数
+   groupID - 群ID
+   targetUserID - 目标人ID    
+```
+
+####[GetBuddyOnlineResult](../model/GetBuddyOnlineResult.md) getMembersOnline(members[])
+```markdown
+描述
+    获取群成员信息
+参数
+    members - 成员ID集   
+```
+
+####[TODO](../model/test.md) getGroupMessagesHistory(groupID, messageID = 0, size = 10)
+```markdown
+描述
+    获取群聊天历史信息(缓存)
+    以小于messageID为条件查询，取对对应记录数
+参数
+     groupID - 群ID
+     messageID - 消息ID
+     size - 记录数   
+```

package/docs/md/action/message.md

@@ -0,0 +1,93 @@
+## 群服务
+
+| 返回                                                     | 接口                                                            | 描述                                                  |
+| -------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------- |
+| [SendMessageResult](../model/SendMessageResult.md)       | sendMessage([messageBean](../model/test.md))                   | 发送消息                                               |
+| [SendMessageResult](../model/SendMessageResult.md)       | sendPictureMessage(formData, [messageBean](../model/test.md))  | 发送图片消息                                            |
+| [SendMessageResult](../model/SendMessageResult.md)       | sendFileMessage(formData, [messageBean](../model/test.md))     | 发送文件消息                                            |
+| [SendMessageResult](../model/SendMessageResult.md)       | sendTipMessage([messageBean](../model/test.md))                | 发送弱提示消息                                          |
+| [SendMessageResult](../model/SendMessageResult.md)       | sendCardMessage([messageBean](../model/test.md))               | 发送名片消息                                            |
+| [MessageStorageResult](../model/MessageStorageResult.md) | getMessages(chatID, messageID, size)                           | 获取服务器历史消息(访问服务器)                            |
+| [MessageStorageBean](../model/MessageStorageBean.md)     | getMessagesHistory(chatID, messageID, size)                    | 分页获取本地历史消息缓存                                  |
+
+### 方法详细信息
+__ __
+
+
+####[SendMessageResult](../model/SendMessageResult.md) sendMessage([messageBean](../model/test.md))
+```markdown
+描述
+    发送消息-文本消息
+参数
+    messageBean - 入参消息
+```
+
+
+####[SendMessageResult](../model/SendMessageResult.md) sendPictureMessage(formData, [messageBean](../model/test.md))
+```markdown
+描述
+    发送图片消息
+参数
+    fromData -  图片封到fromData中
+    messageBean - 入参消息
+```
+
+
+####[SendMessageResult](../model/SendMessageResult.md) sendFileMessage(formData, [messageBean](../model/test.md))
+```markdown
+描述
+    发送文件消息
+参数
+    fromData -  文件封到fromData中
+    messageBean - 入参消息
+```
+
+
+####[SendMessageResult](../model/SendMessageResult.md) sendTipMessage([messageBean](../model/test.md))
+```markdown
+描述
+    发送弱提示消息
+参数
+    messageBean - 入参消息
+```
+
+
+####[SendMessageResult](../model/SendMessageResult.md) sendCardMessage([messageBean](../model/test.md))
+```markdown
+描述
+    发送名片消息
+参数
+    messageBean - 入参消息
+```
+
+
+####[CommonDataResult](../model/CommonDataResult.md) setMessageForRead(chatID, maxMessageID)
+```markdown
+描述
+    更新消息为已读状态
+参数
+    chatID - 传入会话对应的ID，群或者人
+    maxMessageID - 最大消息ID
+```
+
+
+####[MessageStorageResult](../model/MessageStorageResult.md) getMessages(chatID, messageID, size)
+```markdown
+描述
+    获取服务器历史消息(访问服务器)
+参数
+    chatID - 传入会话对应的ID，群或者人
+    messageID - 消息Id，查询基准消息ID
+    size - 偏移标志 正数向前，负数向后
+```
+
+
+####[MessageStorageBean](../model/MessageStorageBean.md) getMessagesHistory(chatID, messageID, size)
+```markdown
+描述
+    分页获取本地历史消息缓存
+参数
+    chatID - 传入会话对应的ID，群或者人
+    messageID - 消息Id，查询基准消息ID
+    size - 偏移标志 正数向前，负数向后
+```

package/docs/md/action/org.md

@@ -0,0 +1,37 @@
+## 组织机构
+
+| 返回                                                     | 接口                                                            | 描述                                                  |
+| -------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------- |
+| [GetOrgUserResult](../model/GetOrgUserResult.md)         | getOrgUser(orgID, entID)                                       | 获取组织下成员列表                                      |
+| [EnORet](../model/EnORet.md)                             | getVisibleOrgUsers(options)                                    | 获取某个用户所在组织下可见的子组织和用户                   |
+| [GetEnterpriseResult](../model/GetOrgUserResult.md)      | getOrgList()                                                   | 获取一个用户拥有的企业列表                               |
+
+
+### 方法详细信息
+__ __
+
+####[GetOrgUserResult](../model/GetOrgUserResult.md) getOrgUser(orgID, entID)
+```markdown
+描述
+    获取组织下成员列表
+参数
+    orgID - 组织机构ID
+    entID - 企业ID
+```
+
+####[EnORet](../model/EnORet.md)  getVisibleOrgUsers(options)
+```markdown
+描述
+    获取某个用户所在组织下可见的子组织和用户
+参数
+    options - {
+        enterpriseID 企业ID 
+        orgID 用户所在组织ID
+   }
+```
+
+####[GetEnterpriseResult](../model/GetOrgUserResult.md) getOrgList()
+```markdown
+描述
+    获取一个用户拥有的企业列表
+```

package/docs/md/action/search.md

@@ -0,0 +1,27 @@
+## 搜索
+
+| 返回                                                                 | 接口                             | 描述                         |
+| -------------------------------------------------------------------- | ------------------------------- | ---------------------------- |
+| [SearchResult](../model/SearchResult.md)                             | simpleSearchBuddy(keyword)      | 通用查询接口                  |
+| [CommonSettingServerResult](../model/CommonSettingServerResult.md)   | getPersonDataSwitch(userID)     | 查看好友隐私接口               |
+
+
+### 方法详细信息
+__ __
+
+####[SearchResult](../model/SearchResult.md)  simpleSearchBuddy(keyword)
+```markdown
+描述
+    通用查询接口
+参数
+    keyword - 搜索内从
+```                
+
+
+####[CommonSettingServerResult](../model/CommonSettingServerResult.md)  getPersonDataSwitch(userID)
+```markdown
+描述
+    查看好友隐私接口
+参数
+    userID - 好友ID
+```