node-nim 10.4.0-beta.1 → 10.6.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. package/README.md +58 -44
  2. package/dist/chatroom/chatroom.js +482 -0
  3. package/dist/chatroom/chatroom.js.map +1 -0
  4. package/dist/chatroom_def/chatroom_def.js +146 -73
  5. package/dist/chatroom_def/chatroom_def.js.map +1 -1
  6. package/dist/loader.js +2 -2
  7. package/dist/loader.js.map +1 -1
  8. package/dist/nim/ai.js +44 -0
  9. package/dist/nim/ai.js.map +1 -0
  10. package/dist/nim/client.js +4 -4
  11. package/dist/nim/client.js.map +1 -1
  12. package/dist/nim/data_sync.js.map +1 -1
  13. package/dist/nim/friend.js +9 -9
  14. package/dist/nim/friend.js.map +1 -1
  15. package/dist/nim/global.js.map +1 -1
  16. package/dist/nim/msglog.js +9 -1
  17. package/dist/nim/msglog.js.map +1 -1
  18. package/dist/nim/nos.js.map +1 -1
  19. package/dist/nim/online_session.js.map +1 -1
  20. package/dist/nim/pass_through_proxy.js +7 -7
  21. package/dist/nim/pass_through_proxy.js.map +1 -1
  22. package/dist/nim/plugin.js +3 -3
  23. package/dist/nim/plugin.js.map +1 -1
  24. package/dist/nim/session.js +52 -52
  25. package/dist/nim/session.js.map +1 -1
  26. package/dist/nim/subscribe_event.js +15 -15
  27. package/dist/nim/subscribe_event.js.map +1 -1
  28. package/dist/nim/super_team.js +63 -63
  29. package/dist/nim/super_team.js.map +1 -1
  30. package/dist/nim/sysmsg.js +14 -14
  31. package/dist/nim/sysmsg.js.map +1 -1
  32. package/dist/nim/talk.js +31 -10
  33. package/dist/nim/talk.js.map +1 -1
  34. package/dist/nim/talkex.js +27 -27
  35. package/dist/nim/talkex.js.map +1 -1
  36. package/dist/nim/team.js +86 -86
  37. package/dist/nim/team.js.map +1 -1
  38. package/dist/nim/tool.js +1 -1
  39. package/dist/nim/tool.js.map +1 -1
  40. package/dist/nim/user.js +2 -2
  41. package/dist/nim/user.js.map +1 -1
  42. package/dist/nim_def/ai_def.js +25 -0
  43. package/dist/nim_def/ai_def.js.map +1 -0
  44. package/dist/nim_def/client_def.js +145 -118
  45. package/dist/nim_def/client_def.js.map +1 -1
  46. package/dist/nim_def/data_sync_def.js +18 -9
  47. package/dist/nim_def/data_sync_def.js.map +1 -1
  48. package/dist/nim_def/doc_trans_def.js +10 -5
  49. package/dist/nim_def/doc_trans_def.js.map +1 -1
  50. package/dist/nim_def/friend_def.js +28 -14
  51. package/dist/nim_def/friend_def.js.map +1 -1
  52. package/dist/nim_def/global_def.js +32 -16
  53. package/dist/nim_def/global_def.js.map +1 -1
  54. package/dist/nim_def/msglog_def.js +203 -117
  55. package/dist/nim_def/msglog_def.js.map +1 -1
  56. package/dist/nim_def/nos_def.js +12 -6
  57. package/dist/nim_def/nos_def.js.map +1 -1
  58. package/dist/nim_def/pass_through_proxy_def.js +5 -0
  59. package/dist/nim_def/pass_through_proxy_def.js.map +1 -1
  60. package/dist/nim_def/session_def.js +30 -15
  61. package/dist/nim_def/session_def.js.map +1 -1
  62. package/dist/nim_def/subscribe_event_def.js +32 -15
  63. package/dist/nim_def/subscribe_event_def.js.map +1 -1
  64. package/dist/nim_def/super_team_def.js +52 -27
  65. package/dist/nim_def/super_team_def.js.map +1 -1
  66. package/dist/nim_def/sysmsg_def.js +32 -17
  67. package/dist/nim_def/sysmsg_def.js.map +1 -1
  68. package/dist/nim_def/team_def.js +56 -29
  69. package/dist/nim_def/team_def.js.map +1 -1
  70. package/dist/nim_def/tool_def.js +8 -4
  71. package/dist/nim_def/tool_def.js.map +1 -1
  72. package/dist/nim_def/user_def.js +16 -8
  73. package/dist/nim_def/user_def.js.map +1 -1
  74. package/dist/node-nim.js +32 -1
  75. package/dist/node-nim.js.map +1 -1
  76. package/dist/qchat/attachment.js.map +1 -1
  77. package/dist/qchat/channel.js.map +1 -1
  78. package/dist/qchat/channel_category.js.map +1 -1
  79. package/dist/qchat/instance.js.map +1 -1
  80. package/dist/qchat/message.js.map +1 -1
  81. package/dist/qchat/role.js.map +1 -1
  82. package/dist/qchat/server.js.map +1 -1
  83. package/dist/qchat/system_notification.js.map +1 -1
  84. package/dist/qchat_def/public_def.js +9 -2
  85. package/dist/qchat_def/public_def.js.map +1 -1
  86. package/dist/v2/v2_nim_ai_service.js.map +1 -1
  87. package/dist/v2/v2_nim_chatroom_client.js +160 -39
  88. package/dist/v2/v2_nim_chatroom_client.js.map +1 -1
  89. package/dist/v2/v2_nim_chatroom_queue_service.js +148 -0
  90. package/dist/v2/v2_nim_chatroom_queue_service.js.map +1 -0
  91. package/dist/v2/v2_nim_chatroom_service.js +201 -65
  92. package/dist/v2/v2_nim_chatroom_service.js.map +1 -1
  93. package/dist/v2/v2_nim_client.js +126 -24
  94. package/dist/v2/v2_nim_client.js.map +1 -1
  95. package/dist/v2/v2_nim_conversation_group_service.js +57 -9
  96. package/dist/v2/v2_nim_conversation_group_service.js.map +1 -1
  97. package/dist/v2/v2_nim_conversation_service.js +149 -27
  98. package/dist/v2/v2_nim_conversation_service.js.map +1 -1
  99. package/dist/v2/v2_nim_friend_service.js +152 -36
  100. package/dist/v2/v2_nim_friend_service.js.map +1 -1
  101. package/dist/v2/v2_nim_login_service.js +72 -13
  102. package/dist/v2/v2_nim_login_service.js.map +1 -1
  103. package/dist/v2/v2_nim_message_service.js +335 -93
  104. package/dist/v2/v2_nim_message_service.js.map +1 -1
  105. package/dist/v2/v2_nim_notification_service.js +11 -4
  106. package/dist/v2/v2_nim_notification_service.js.map +1 -1
  107. package/dist/v2/v2_nim_passthrough_service.js +39 -0
  108. package/dist/v2/v2_nim_passthrough_service.js.map +1 -0
  109. package/dist/v2/v2_nim_setting_service.js +81 -29
  110. package/dist/v2/v2_nim_setting_service.js.map +1 -1
  111. package/dist/v2/v2_nim_signalling_service.js +172 -44
  112. package/dist/v2/v2_nim_signalling_service.js.map +1 -1
  113. package/dist/v2/v2_nim_storage_service.js +116 -37
  114. package/dist/v2/v2_nim_storage_service.js.map +1 -1
  115. package/dist/v2/v2_nim_subscription_service.js +42 -12
  116. package/dist/v2/v2_nim_subscription_service.js.map +1 -1
  117. package/dist/v2/v2_nim_team_service.js +367 -130
  118. package/dist/v2/v2_nim_team_service.js.map +1 -1
  119. package/dist/v2/v2_nim_user_service.js +62 -19
  120. package/dist/v2/v2_nim_user_service.js.map +1 -1
  121. package/dist/v2/v2_nim_utilities.js +313 -125
  122. package/dist/v2/v2_nim_utilities.js.map +1 -1
  123. package/dist/v2_def/v2_nim_enum_def.js +76 -62
  124. package/dist/v2_def/v2_nim_enum_def.js.map +1 -1
  125. package/dist/v2_def/v2_nim_struct_def.js +0 -2
  126. package/dist/v2_def/v2_nim_struct_def.js.map +1 -1
  127. package/package.json +9 -6
  128. package/script/download-sdk.js +1 -1
  129. package/types/chatroom/chatroom.d.ts +274 -0
  130. package/types/chatroom_def/chatroom_def.d.ts +150 -74
  131. package/types/nim/ai.d.ts +25 -0
  132. package/types/nim/client.d.ts +8 -8
  133. package/types/nim/friend.d.ts +9 -9
  134. package/types/nim/msglog.d.ts +8 -2
  135. package/types/nim/pass_through_proxy.d.ts +7 -7
  136. package/types/nim/plugin.d.ts +3 -3
  137. package/types/nim/session.d.ts +50 -50
  138. package/types/nim/subscribe_event.d.ts +15 -15
  139. package/types/nim/super_team.d.ts +63 -63
  140. package/types/nim/sysmsg.d.ts +14 -14
  141. package/types/nim/talk.d.ts +28 -11
  142. package/types/nim/talkex.d.ts +27 -27
  143. package/types/nim/team.d.ts +86 -86
  144. package/types/nim/tool.d.ts +1 -1
  145. package/types/nim/user.d.ts +2 -2
  146. package/types/nim_def/ai_def.d.ts +79 -0
  147. package/types/nim_def/client_def.d.ts +322 -127
  148. package/types/nim_def/data_sync_def.d.ts +18 -9
  149. package/types/nim_def/doc_trans_def.d.ts +10 -5
  150. package/types/nim_def/friend_def.d.ts +52 -26
  151. package/types/nim_def/global_def.d.ts +32 -16
  152. package/types/nim_def/msglog_def.d.ts +466 -217
  153. package/types/nim_def/nos_def.d.ts +62 -31
  154. package/types/nim_def/online_session_def.d.ts +21 -9
  155. package/types/nim_def/pass_through_proxy_def.d.ts +5 -0
  156. package/types/nim_def/session_def.d.ts +92 -46
  157. package/types/nim_def/subscribe_event_def.d.ts +75 -35
  158. package/types/nim_def/super_team_def.d.ts +75 -37
  159. package/types/nim_def/sysmsg_def.d.ts +78 -40
  160. package/types/nim_def/talk_def.d.ts +85 -20
  161. package/types/nim_def/talkex_def.d.ts +92 -46
  162. package/types/nim_def/team_def.d.ts +93 -39
  163. package/types/nim_def/tool_def.d.ts +16 -8
  164. package/types/nim_def/user_def.d.ts +52 -26
  165. package/types/node-nim.d.ts +29 -2
  166. package/types/qchat_def/message_def.d.ts +1 -1
  167. package/types/qchat_def/public_def.d.ts +6 -0
  168. package/types/qchat_def/role_def.d.ts +3 -1
  169. package/types/v2/v2_nim_ai_service.d.ts +3 -3
  170. package/types/v2/v2_nim_chatroom_client.d.ts +158 -41
  171. package/types/v2/v2_nim_chatroom_queue_service.d.ts +96 -0
  172. package/types/v2/v2_nim_chatroom_service.d.ts +204 -67
  173. package/types/v2/v2_nim_client.d.ts +124 -30
  174. package/types/v2/v2_nim_conversation_group_service.d.ts +59 -11
  175. package/types/v2/v2_nim_conversation_service.d.ts +152 -29
  176. package/types/v2/v2_nim_friend_service.d.ts +140 -39
  177. package/types/v2/v2_nim_login_service.d.ts +75 -14
  178. package/types/v2/v2_nim_message_service.d.ts +337 -95
  179. package/types/v2/v2_nim_notification_service.d.ts +13 -6
  180. package/types/v2/v2_nim_passthrough_service.d.ts +25 -0
  181. package/types/v2/v2_nim_setting_service.d.ts +84 -31
  182. package/types/v2/v2_nim_signalling_service.d.ts +174 -46
  183. package/types/v2/v2_nim_storage_service.d.ts +119 -40
  184. package/types/v2/v2_nim_subscription_service.d.ts +44 -14
  185. package/types/v2/v2_nim_team_service.d.ts +338 -132
  186. package/types/v2/v2_nim_user_service.d.ts +64 -21
  187. package/types/v2/v2_nim_utilities.d.ts +311 -125
  188. package/types/v2_def/v2_nim_enum_def.d.ts +72 -62
  189. package/types/v2_def/v2_nim_struct_def.d.ts +56 -7
@@ -12,10 +12,17 @@ class V2NIMChatroomService extends eventemitter3_1.default {
12
12
  super();
13
13
  this.instance = new loader_1.default.V2NIMChatroomService({ emit: this.emit.bind(this) }, instanceId);
14
14
  }
15
- /** @brief 发送消息 */
16
- /** @param message 需要发送的消息体 */
17
- /** @param params 发送消息相关配置参数 */
18
- /** @return void */
15
+ /**
16
+ * @brief 发送消息
17
+ * @param message 需要发送的消息体
18
+ * @param params 发送消息相关配置参数
19
+ * @returns void
20
+ * @example
21
+ * ```javascript
22
+ * const message = V2NIMChatroomMessageCreator.createTextMessage('Hello NTES IM')
23
+ * await chatroomService.sendMessage(message, {})
24
+ * ```
25
+ */
19
26
  sendMessage(message, params) {
20
27
  return new Promise((resolve, reject) => {
21
28
  this.instance.sendMessage(message, params, (result) => {
@@ -25,8 +32,15 @@ class V2NIMChatroomService extends eventemitter3_1.default {
25
32
  });
26
33
  });
27
34
  }
28
- /** @brief 取消文件消息附件上传 */
29
- /** @param message 要取消上传的文件消息 */
35
+ /**
36
+ * @brief 取消上传消息附件
37
+ * @param message 要取消上传的文件消息
38
+ * @returns void
39
+ * @example
40
+ * ```javascript
41
+ * await chatroomService.cancelMessageAttachmentUpload(message)
42
+ * ```
43
+ */
30
44
  cancelMessageAttachmentUpload(message) {
31
45
  return new Promise((resolve, reject) => {
32
46
  this.instance.cancelMessageAttachmentUpload(message, () => {
@@ -36,9 +50,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
36
50
  });
37
51
  });
38
52
  }
39
- /** @brief 分页获取聊天室成员列表 */
40
- /** @param queryOption 查询选项 */
41
- /** @return void */
53
+ /**
54
+ * @brief 查询聊天室成员列表
55
+ * @param queryOption 查询选项
56
+ * @returns V2NIMChatroomMemberListResult
57
+ * @example
58
+ * ```javascript
59
+ * const result = await chatroomService.getMemberListByOption({
60
+ * limit: 10
61
+ * })
62
+ * console.log(result)
63
+ * ```
64
+ */
42
65
  getMemberListByOption(queryOption) {
43
66
  return new Promise((resolve, reject) => {
44
67
  this.instance.getMemberListByOption(queryOption, (result) => {
@@ -48,9 +71,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
48
71
  });
49
72
  });
50
73
  }
51
- /** @brief 查询历史消息 */
52
- /** @param option 查询选项 */
53
- /** @return void */
74
+ /**
75
+ * @brief 查询聊天室消息列表
76
+ * @param option 查询选项
77
+ * @returns Array<V2NIMChatroomMessage>
78
+ * @example
79
+ * ```javascript
80
+ * const result = await chatroomService.getMessageList({
81
+ * limit: 10
82
+ * })
83
+ * console.log(result)
84
+ * ```
85
+ */
54
86
  getMessageList(option) {
55
87
  return new Promise((resolve, reject) => {
56
88
  this.instance.getMessageList(option, (result) => {
@@ -60,10 +92,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
60
92
  });
61
93
  });
62
94
  }
63
- /** @brief 更新聊天室成员角色 */
64
- /** @param accountId 聊天室成员 id */
65
- /** @param upadateParams 更新参数 */
66
- /** @return void */
95
+ /**
96
+ * @brief 更新聊天室成员角色
97
+ * @param accountId 聊天室成员 id
98
+ * @param upadateParams 更新参数
99
+ * @returns void
100
+ * @example
101
+ * ```javascript
102
+ * await chatroomService.updateMemberRole('accountId', {
103
+ * memberRole: 2
104
+ * })
105
+ * ```
106
+ */
67
107
  updateMemberRole(accountId, upadateParams) {
68
108
  return new Promise((resolve, reject) => {
69
109
  this.instance.updateMemberRole(accountId, upadateParams, () => {
@@ -73,11 +113,17 @@ class V2NIMChatroomService extends eventemitter3_1.default {
73
113
  });
74
114
  });
75
115
  }
76
- /** @brief 设置聊天室成员黑名单状态 */
77
- /** @param accountId 聊天室成员 id */
78
- /** @param blocked 黑名单状态 */
79
- /** @param notificationExtension 通知扩展字段 */
80
- /** @return void */
116
+ /**
117
+ * @brief 设置聊天室成员黑名单状态
118
+ * @param accountId 聊天室成员 id
119
+ * @param blocked 黑名单状态
120
+ * @param notificationExtension 通知扩展字段
121
+ * @returns void
122
+ * @example
123
+ * ```javascript
124
+ * await chatroomService.setMemberBlockedStatus('accountId', true, 'your notification extension')
125
+ * ```
126
+ */
81
127
  setMemberBlockedStatus(accountId, blocked, notificationExtension) {
82
128
  return new Promise((resolve, reject) => {
83
129
  this.instance.setMemberBlockedStatus(accountId, blocked, notificationExtension, () => {
@@ -87,11 +133,17 @@ class V2NIMChatroomService extends eventemitter3_1.default {
87
133
  });
88
134
  });
89
135
  }
90
- /** @brief 设置聊天室成员禁言状态 */
91
- /** @param accountId 聊天室成员 id */
92
- /** @param chatBanned 禁言状态 */
93
- /** @param notificationExtension 通知扩展字段 */
94
- /** @return void */
136
+ /**
137
+ * @brief 设置聊天室成员禁言状态
138
+ * @param accountId 聊天室成员 id
139
+ * @param chatBanned 禁言状态
140
+ * @param notificationExtension 通知扩展字段
141
+ * @returns void
142
+ * @example
143
+ * ```javascript
144
+ * await chatroomService.setMemberChatBannedStatus('accountId', true, 'your notification extension')
145
+ * ```
146
+ */
95
147
  setMemberChatBannedStatus(accountId, chatBanned, notificationExtension) {
96
148
  return new Promise((resolve, reject) => {
97
149
  this.instance.setMemberChatBannedStatus(accountId, chatBanned, notificationExtension, () => {
@@ -101,12 +153,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
101
153
  });
102
154
  });
103
155
  }
104
- /** @brief 设置聊天室成员临时禁言状态 */
105
- /** @param accountId 聊天室成员 id */
106
- /** @param tempChatBannedDuration 临时禁言时长, 单位秒, 0 表示取消临时禁言 */
107
- /** @param notificationEnabled 是否发送通知 */
108
- /** @param notificationExtension 通知扩展字段 */
109
- /** @return void */
156
+ /**
157
+ * @brief 设置聊天室成员临时禁言状态
158
+ * @param accountId 聊天室成员 id
159
+ * @param tempChatBannedDuration 临时禁言时长, 单位秒, 0 表示取消临时禁言
160
+ * @param notificationEnabled 是否发送通知
161
+ * @param notificationExtension 通知扩展字段
162
+ * @returns void
163
+ * @example
164
+ * ```javascript
165
+ * await chatroomService.setMemberTempChatBanned('accountId', 10, true, 'your notification extension')
166
+ * ```
167
+ */
110
168
  setMemberTempChatBanned(accountId, tempChatBannedDuration, notificationEnabled, notificationExtension) {
111
169
  return new Promise((resolve, reject) => {
112
170
  this.instance.setMemberTempChatBanned(accountId, tempChatBannedDuration, notificationEnabled, notificationExtension, () => {
@@ -116,10 +174,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
116
174
  });
117
175
  });
118
176
  }
119
- /** @brief 更新聊天室信息 */
120
- /** @param updateParams 更新参数 */
121
- /** @param antispamConfig 反垃圾配置 */
122
- /** @return void */
177
+ /**
178
+ * @brief 更新聊天室信息
179
+ * @param updateParams 更新参数
180
+ * @param antispamConfig 反垃圾配置
181
+ * @returns void
182
+ * @example
183
+ * ```javascript
184
+ * await chatroomService.updateChatroomInfo({
185
+ * roomName: 'new room name'
186
+ * }, {})
187
+ * ```
188
+ */
123
189
  updateChatroomInfo(updateParams, antispamConfig) {
124
190
  return new Promise((resolve, reject) => {
125
191
  this.instance.updateChatroomInfo(updateParams, antispamConfig, () => {
@@ -129,10 +195,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
129
195
  });
130
196
  });
131
197
  }
132
- /** @brief 更新自己在聊天室的成员信息 */
133
- /** @param updateParams 更新参数 */
134
- /** @param antispamConfig 反垃圾配置 */
135
- /** @return void */
198
+ /**
199
+ * @brief 更新自己在聊天室的成员信息
200
+ * @param updateParams 更新参数
201
+ * @param antispamConfig 反垃圾配置
202
+ * @returns void
203
+ * @example
204
+ * ```javascript
205
+ * await chatroomService.updateSelfMemberInfo({
206
+ * roomNick: 'new room nickname'
207
+ * }, {})
208
+ * ```
209
+ */
136
210
  updateSelfMemberInfo(updateParams, antispamConfig) {
137
211
  return new Promise((resolve, reject) => {
138
212
  this.instance.updateSelfMemberInfo(updateParams, antispamConfig, () => {
@@ -142,9 +216,15 @@ class V2NIMChatroomService extends eventemitter3_1.default {
142
216
  });
143
217
  });
144
218
  }
145
- /** @brief 根据账号列表查询成员信息 */
146
- /** @param accountIds 账号列表 */
147
- /** @return void */
219
+ /**
220
+ * @param accountIds 账号列表
221
+ * @returns Array<V2NIMChatroomMember>
222
+ * @example
223
+ * ```javascript
224
+ * const result = await chatroomService.getMemberByIds(['accountId1', 'accountId2'])
225
+ * console.log(result)
226
+ * ```
227
+ */
148
228
  getMemberByIds(accountIds) {
149
229
  return new Promise((resolve, reject) => {
150
230
  this.instance.getMemberByIds(accountIds, (result) => {
@@ -154,10 +234,16 @@ class V2NIMChatroomService extends eventemitter3_1.default {
154
234
  });
155
235
  });
156
236
  }
157
- /** @brief 踢出聊天室成员 */
158
- /** @param accountId 聊天室成员 id */
159
- /** @param notificationExtension 通知扩展字段 */
160
- /** @return void */
237
+ /**
238
+ * @brief 踢出聊天室成员
239
+ * @param accountId 聊天室成员 id
240
+ * @param notificationExtension 通知扩展字段
241
+ * @returns void
242
+ * @example
243
+ * ```javascript
244
+ * await chatroomService.kickMember('accountId', 'your notification extension')
245
+ * ```
246
+ */
161
247
  kickMember(accountId, notificationExtension) {
162
248
  return new Promise((resolve, reject) => {
163
249
  this.instance.kickMember(accountId, notificationExtension, () => {
@@ -167,9 +253,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
167
253
  });
168
254
  });
169
255
  }
170
- /** @brief 按聊天室标签临时禁言 */
171
- /** @param params 设置标签禁言的参数 */
172
- /** @return void */
256
+ /**
257
+ * @brief 按聊天室标签临时禁言
258
+ * @param params 设置标签禁言的参数
259
+ * @returns void
260
+ * @example
261
+ * ```javascript
262
+ * await chatroomService.setTempChatBannedByTag({
263
+ * targetTag: 'tag',
264
+ * duration: 10
265
+ * })
266
+ * ```
267
+ */
173
268
  setTempChatBannedByTag(params) {
174
269
  return new Promise((resolve, reject) => {
175
270
  this.instance.setTempChatBannedByTag(params, () => {
@@ -179,9 +274,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
179
274
  });
180
275
  });
181
276
  }
182
- /** @brief 根据标签查询成员列表 */
183
- /** @param option 查询成员列表的参数 */
184
- /** @return void */
277
+ /**
278
+ * @brief 根据标签查询成员列表
279
+ * @param option 查询成员列表的参数
280
+ * @returns V2NIMChatroomMemberListResult
281
+ * @example
282
+ * ```javascript
283
+ * const result = await chatroomService.getMemberListByTag({
284
+ * tag: 'tag',
285
+ * limit: 10
286
+ * })
287
+ * ```
288
+ */
185
289
  getMemberListByTag(option) {
186
290
  return new Promise((resolve, reject) => {
187
291
  this.instance.getMemberListByTag(option, (result) => {
@@ -191,9 +295,15 @@ class V2NIMChatroomService extends eventemitter3_1.default {
191
295
  });
192
296
  });
193
297
  }
194
- /** @brief 查询某个标签下的成员人数 */
195
- /** @param tag 标签 */
196
- /** @return void */
298
+ /**
299
+ * @brief 查询某个标签下的成员人数
300
+ * @param tag 标签
301
+ * @returns number
302
+ * @example
303
+ * ```javascript
304
+ * const count = await chatroomService.getMemberCountByTag('tag')
305
+ * ```
306
+ */
197
307
  getMemberCountByTag(tag) {
198
308
  return new Promise((resolve, reject) => {
199
309
  this.instance.getMemberCountByTag(tag, (result) => {
@@ -203,9 +313,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
203
313
  });
204
314
  });
205
315
  }
206
- /** @brief 更新坐标信息 */
207
- /** @param locationConfig 坐标信息 */
208
- /** @return void */
316
+ /**
317
+ * @brief 更新坐标信息
318
+ * @param locationConfig 坐标信息
319
+ * @returns void
320
+ * @example
321
+ * ```javascript
322
+ * await chatroomService.updateChatroomLocationInfo({
323
+ * latitude: 30.5,
324
+ * longitude: 120.5
325
+ * })
326
+ * ```
327
+ */
209
328
  updateChatroomLocationInfo(locationConfig) {
210
329
  return new Promise((resolve, reject) => {
211
330
  this.instance.updateChatroomLocationInfo(locationConfig, () => {
@@ -215,9 +334,17 @@ class V2NIMChatroomService extends eventemitter3_1.default {
215
334
  });
216
335
  });
217
336
  }
218
- /** @brief 更新聊天室 tag 信息 */
219
- /** @param updateParams tag 更新的参数 */
220
- /** @return void */
337
+ /**
338
+ * @brief 更新聊天室 tag 信息
339
+ * @param updateParams tag 更新的参数
340
+ * @returns void
341
+ * @example
342
+ * ```javascript
343
+ * await chatroomService.updateChatroomTags({
344
+ * tags: ['tag1', 'tag2']
345
+ * })
346
+ * ```
347
+ */
221
348
  updateChatroomTags(updateParams) {
222
349
  return new Promise((resolve, reject) => {
223
350
  this.instance.updateChatroomTags(updateParams, () => {
@@ -227,9 +354,18 @@ class V2NIMChatroomService extends eventemitter3_1.default {
227
354
  });
228
355
  });
229
356
  }
230
- /** @brief 根据标签查询消息列表 */
231
- /** @param messageOption 查询参数 */
232
- /** @return void */
357
+ /**
358
+ * @brief 根据标签查询消息列表
359
+ * @param messageOption 查询参数
360
+ * @returns Array<V2NIMChatroomMessage>
361
+ * @example
362
+ * ```javascript
363
+ * const result = await chatroomService.getMessageListByTag({
364
+ * tags: ['tag1', 'tag2'],
365
+ * limit: 10
366
+ * })
367
+ * ```
368
+ */
233
369
  getMessageListByTag(messageOption) {
234
370
  return new Promise((resolve, reject) => {
235
371
  this.instance.getMessageListByTag(messageOption, (result) => {
@@ -1 +1 @@
1
- {"version":3,"file":"v2_nim_chatroom_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_chatroom_service.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAsBxC,uDAA2B;AA6B3B,mBAAmB;AACnB,MAAa,oBAAqB,SAAQ,uBAAwC;IAE9E,YAAY,UAAkB;QAC1B,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;IAC5F,CAAC;IACD,kBAAkB;IAClB,8BAA8B;IAC9B,+BAA+B;IAC/B,mBAAmB;IACnB,WAAW,CAAC,OAA6B,EAAE,MAAsC;QAC7E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,WAAW,CACrB,OAAO,EACP,MAAM,EACN,CAAC,MAAsC,EAAE,EAAE;gBACvC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,wBAAwB;IACxB,gCAAgC;IAChC,6BAA6B,CAAC,OAA6B;QACvD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,6BAA6B,CACvC,OAAO,EACP,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,yBAAyB;IACzB,8BAA8B;IAC9B,mBAAmB;IACnB,qBAAqB,CAAC,WAA2C;QAC7D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAC/B,WAAW,EACX,CAAC,MAAqC,EAAE,EAAE;gBACtC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,yBAAyB;IACzB,mBAAmB;IACnB,cAAc,CAAC,MAAsC;QACjD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,cAAc,CACxB,MAAM,EACN,CAAC,MAAmC,EAAE,EAAE;gBACpC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,uBAAuB;IACvB,gCAAgC;IAChC,gCAAgC;IAChC,mBAAmB;IACnB,gBAAgB,CAAC,SAAiB,EAAE,aAAkD;QAClF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC1B,SAAS,EACT,aAAa,EACb,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,gCAAgC;IAChC,2BAA2B;IAC3B,0CAA0C;IAC1C,mBAAmB;IACnB,sBAAsB,CAAC,SAAiB,EAAE,OAAgB,EAAE,qBAA6B;QACrF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAChC,SAAS,EACT,OAAO,EACP,qBAAqB,EACrB,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,yBAAyB;IACzB,gCAAgC;IAChC,6BAA6B;IAC7B,0CAA0C;IAC1C,mBAAmB;IACnB,yBAAyB,CAAC,SAAiB,EAAE,UAAmB,EAAE,qBAA6B;QAC3F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CACnC,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,2BAA2B;IAC3B,gCAAgC;IAChC,4DAA4D;IAC5D,wCAAwC;IACxC,0CAA0C;IAC1C,mBAAmB;IACnB,uBAAuB,CAAC,SAAiB,EAAE,sBAA8B,EAAE,mBAA4B,EAAE,qBAA6B;QAClI,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACjC,SAAS,EACT,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,qBAAqB;IACrB,+BAA+B;IAC/B,kCAAkC;IAClC,mBAAmB;IACnB,kBAAkB,CAAC,YAAuC,EAAE,cAAmC;QAC3F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC5B,YAAY,EACZ,cAAc,EACd,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,2BAA2B;IAC3B,+BAA+B;IAC/B,kCAAkC;IAClC,mBAAmB;IACnB,oBAAoB,CAAC,YAAiD,EAAE,cAAmC;QACvG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAC9B,YAAY,EACZ,cAAc,EACd,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,6BAA6B;IAC7B,mBAAmB;IACnB,cAAc,CAAC,UAAyB;QACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,cAAc,CACxB,UAAU,EACV,CAAC,MAAkC,EAAE,EAAE;gBACnC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,qBAAqB;IACrB,gCAAgC;IAChC,0CAA0C;IAC1C,mBAAmB;IACnB,UAAU,CAAC,SAAiB,EAAE,qBAA6B;QACvD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,UAAU,CACpB,SAAS,EACT,qBAAqB,EACrB,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,wBAAwB;IACxB,8BAA8B;IAC9B,mBAAmB;IACnB,sBAAsB,CAAC,MAA4C;QAC/D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAChC,MAAM,EACN,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,wBAAwB;IACxB,8BAA8B;IAC9B,mBAAmB;IACnB,kBAAkB,CAAC,MAAoC;QACnD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC5B,MAAM,EACN,CAAC,MAAqC,EAAE,EAAE;gBACtC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,oBAAoB;IACpB,mBAAmB;IACnB,mBAAmB,CAAC,GAAW;QAC3B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAC7B,GAAG,EACH,CAAC,MAAc,EAAE,EAAE;gBACf,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB;IACpB,iCAAiC;IACjC,mBAAmB;IACnB,0BAA0B,CAAC,cAA2C;QAClE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,CACpC,cAAc,EACd,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,0BAA0B;IAC1B,oCAAoC;IACpC,mBAAmB;IACnB,kBAAkB,CAAC,YAA2C;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC5B,YAAY,EACZ,GAAG,EAAE;gBACD,OAAO,EAAE,CAAA;YACb,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,wBAAwB;IACxB,gCAAgC;IAChC,mBAAmB;IACnB,mBAAmB,CAAC,aAA4C;QAC5D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAC7B,aAAa,EACb,CAAC,MAAmC,EAAE,EAAE;gBACpC,OAAO,CAAC,MAAM,CAAC,CAAA;YACnB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ;AA9UD,oDA8UC"}
1
+ {"version":3,"file":"v2_nim_chatroom_service.js","sourceRoot":"","sources":["../../ts/v2/v2_nim_chatroom_service.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwC;AAsBxC,uDAA2B;AA8B3B,mBAAmB;AACnB,MAAa,oBAAqB,SAAQ,uBAAmC;IAG3E,YAAa,UAAkB;QAC7B,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAG,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;IAC1F,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAE,OAA6B,EAAE,MAAsC;QAChF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,WAAW,CACvB,OAAO,EACP,MAAM,EACN,CAAC,MAAsC,EAAE,EAAE;gBACzC,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,6BAA6B,CAAE,OAA6B;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,6BAA6B,CACzC,OAAO,EACP,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAE,WAA2C;QAChE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CACjC,WAAW,EACX,CAAC,MAAqC,EAAE,EAAE;gBACxC,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAE,MAAsC;QACpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC1B,MAAM,EACN,CAAC,MAAmC,EAAE,EAAE;gBACtC,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAE,SAAiB,EAAE,aAAkD;QACrF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC5B,SAAS,EACT,aAAa,EACb,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,sBAAsB,CAAE,SAAiB,EAAE,OAAgB,EAAE,qBAA6B;QACxF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAClC,SAAS,EACT,OAAO,EACP,qBAAqB,EACrB,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,yBAAyB,CAAE,SAAiB,EAAE,UAAmB,EAAE,qBAA6B;QAC9F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CACrC,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAE,SAAiB,EAAE,sBAA8B,EAAE,mBAA4B,EAAE,qBAA6B;QACrI,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACnC,SAAS,EACT,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAE,YAAuC,EAAE,cAAmC;QAC9F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC9B,YAAY,EACZ,cAAc,EACd,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAE,YAAiD,EAAE,cAAmC;QAC1G,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAChC,YAAY,EACZ,cAAc,EACd,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CAAE,UAAyB;QACvC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAC1B,UAAU,EACV,CAAC,MAAkC,EAAE,EAAE;gBACrC,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAE,SAAiB,EAAE,qBAA6B;QAC1D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,UAAU,CACtB,SAAS,EACT,qBAAqB,EACrB,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,sBAAsB,CAAE,MAA4C;QAClE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAClC,MAAM,EACN,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAE,MAAoC;QACtD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC9B,MAAM,EACN,CAAC,MAAqC,EAAE,EAAE;gBACxC,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,mBAAmB,CAAE,GAAW;QAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAC/B,GAAG,EACH,CAAC,MAAc,EAAE,EAAE;gBACjB,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,0BAA0B,CAAE,cAA2C;QACrE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,0BAA0B,CACtC,cAAc,EACd,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAAE,YAA2C;QAC7D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAC9B,YAAY,EACZ,GAAG,EAAE;gBACH,OAAO,EAAE,CAAA;YACX,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAE,aAA4C;QAC/D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAC/B,aAAa,EACb,CAAC,MAAmC,EAAE,EAAE;gBACtC,OAAO,CAAC,MAAM,CAAC,CAAA;YACjB,CAAC,EACD,CAAC,KAAiB,EAAE,EAAE;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAA;YACf,CAAC,CACF,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAxdD,oDAwdC"}
@@ -19,6 +19,7 @@ const v2_nim_user_service_1 = require("./v2_nim_user_service");
19
19
  const v2_nim_ai_service_1 = require("./v2_nim_ai_service");
20
20
  const v2_nim_signalling_service_1 = require("./v2_nim_signalling_service");
21
21
  const v2_nim_subscription_service_1 = require("./v2_nim_subscription_service");
22
+ const v2_nim_passthrough_service_1 = require("./v2_nim_passthrough_service");
22
23
  const v2_nim_utilities_1 = require("./v2_nim_utilities");
23
24
  class V2NIMClient extends eventemitter3_1.EventEmitter {
24
25
  constructor() {
@@ -32,6 +33,7 @@ class V2NIMClient extends eventemitter3_1.EventEmitter {
32
33
  this.conversationIdUtil = null;
33
34
  this.messageCreator = null;
34
35
  this.messageConverter = null;
36
+ this.messageAttachmentCreator = null;
35
37
  this.clientAntispamUtil = null;
36
38
  this.storageUtil = null;
37
39
  this.loginService = null;
@@ -47,12 +49,21 @@ class V2NIMClient extends eventemitter3_1.EventEmitter {
47
49
  this.aiService = null;
48
50
  this.signallingService = null;
49
51
  this.subscriptionService = null;
52
+ this.passthroughService = null;
50
53
  }
51
54
  /**
52
- * 初始化
55
+ * @brief 初始化
53
56
  * @param option - 初始化选项
54
57
  * @returns V2NIMError | null
55
58
  * @example
59
+ * ```javascript
60
+ * await client.init({
61
+ * appkey: 'your app key'
62
+ * })
63
+ * if (error) {
64
+ * console.error(error)
65
+ * }
66
+ * ```
56
67
  */
57
68
  init(option) {
58
69
  let error = this.instance.init(option);
@@ -62,6 +73,7 @@ class V2NIMClient extends eventemitter3_1.EventEmitter {
62
73
  this.conversationIdUtil = new v2_nim_utilities_1.V2NIMConversationIdUtil();
63
74
  this.messageCreator = new v2_nim_utilities_1.V2NIMMessageCreator();
64
75
  this.messageConverter = new v2_nim_utilities_1.V2NIMMessageConverter();
76
+ this.messageAttachmentCreator = new v2_nim_utilities_1.V2NIMMessageAttachmentCreator();
65
77
  this.clientAntispamUtil = new v2_nim_utilities_1.V2NIMClientAntispamUtil();
66
78
  this.storageUtil = new v2_nim_utilities_1.V2NIMStorageUtil();
67
79
  this.loginService = new v2_nim_login_service_1.V2NIMLoginService();
@@ -77,14 +89,24 @@ class V2NIMClient extends eventemitter3_1.EventEmitter {
77
89
  this.aiService = new v2_nim_ai_service_1.V2NIMAIService();
78
90
  this.signallingService = new v2_nim_signalling_service_1.V2NIMSignallingService();
79
91
  this.subscriptionService = new v2_nim_subscription_service_1.V2NIMSubscriptionService();
92
+ this.passthroughService = new v2_nim_passthrough_service_1.V2NIMPassthroughService();
80
93
  return null;
81
94
  }
82
- /** @brief 反初始化
83
- * @return V2NIMError | null
95
+ /**
96
+ * @brief 反初始化
97
+ * @returns V2NIMError | null
98
+ * @example
99
+ * ```javascript
100
+ * await client.uninit()
101
+ * if (error) {
102
+ * console.error(error)
103
+ * }
104
+ * ```
84
105
  */
85
106
  uninit() {
86
107
  this.conversationIdUtil = null;
87
108
  this.messageCreator = null;
109
+ this.messageAttachmentCreator = null;
88
110
  this.clientAntispamUtil = null;
89
111
  this.loginService = null;
90
112
  this.conversationService = null;
@@ -99,76 +121,156 @@ class V2NIMClient extends eventemitter3_1.EventEmitter {
99
121
  this.aiService = null;
100
122
  this.signallingService = null;
101
123
  this.subscriptionService = null;
124
+ this.passthroughService = null;
102
125
  return this.instance.uninit();
103
126
  }
104
- /** @brief 获取登录服务
105
- * @return V2NIMLoginService
127
+ /**
128
+ * @brief 更新 appKey
129
+ * @param appKey - 新的 App key
130
+ * @returns V2NIMError | null
131
+ * @example
132
+ * ```javascript
133
+ * await client.updateAppKey('your new app key')
134
+ * if (error) {
135
+ * console.error(error)
136
+ * }
137
+ * ```
138
+ */
139
+ updateAppKey(appKey) {
140
+ return this.instance.updateAppKey(appKey);
141
+ }
142
+ /**
143
+ * @brief 获取登录服务
144
+ * @returns V2NIMLoginService
145
+ * @example
146
+ * ```javascript
147
+ * const loginService = client.getLoginService()
148
+ * ```
106
149
  */
107
150
  getLoginService() {
108
151
  return this.loginService;
109
152
  }
110
- /** @brief 获取会话服务
111
- /* @return V2NIMConversationService
112
- */
153
+ /**
154
+ * @brief 获取会话服务
155
+ * @returns V2NIMConversationService
156
+ * @example
157
+ * ```javascript
158
+ * const conversationService = client.getConversationService()
159
+ * ```
160
+ */
113
161
  getConversationService() {
114
162
  return this.conversationService;
115
163
  }
116
- /** @brief 获取会话分组服务
117
- * @return V2NIMConversationGroupService
164
+ /**
165
+ * @brief 获取会话分组服务
166
+ * @returns V2NIMConversationGroupService
167
+ * @example
168
+ * ```javascript
169
+ * const conversationGroupService = client.getConversationGroupService()
170
+ * ```
118
171
  */
119
172
  getConversationGroupService() {
120
173
  return this.conversationGroupService;
121
174
  }
122
- /** @brief 获取消息服务
123
- * @return V2NIMMessageService
175
+ /**
176
+ * @brief 获取消息服务
177
+ * @returns V2NIMMessageService
178
+ * @example
179
+ * ```javascript
180
+ * const messageService = client.getMessageService()
181
+ * ```
124
182
  */
125
183
  getMessageService() {
126
184
  return this.messageService;
127
185
  }
128
- /** @brief 获取ai服务
129
- * @return V2NIMAIService
186
+ /**
187
+ * @brief 获取ai服务
188
+ * @returns V2NIMAIService
189
+ * @example
190
+ * ```javascript
191
+ * const aiService = client.getAIService()
192
+ * ```
130
193
  */
131
194
  getAIService() {
132
195
  return this.aiService;
133
196
  }
134
- /** @brief 获取通知服务
135
- * @return V2NIMNotificationService
197
+ /**
198
+ * @brief 获取通知服务
199
+ * @returns V2NIMNotificationService
200
+ * @example
201
+ * ```javascript
202
+ * const notificationService = client.getNotificationService()
203
+ * ```
136
204
  */
137
205
  getNotificationService() {
138
206
  return this.notificationService;
139
207
  }
140
- /** @brief 获取存储服务
141
- * @return V2NIMStorageService
208
+ /**
209
+ * @brief 获取存储服务
210
+ * @returns V2NIMStorageService
211
+ * @example
212
+ * ```javascript
213
+ * const storageService = client.getStorageService()
214
+ * ```
142
215
  */
143
216
  getStorageService() {
144
217
  return this.storageService;
145
218
  }
146
- /** @brief 获取群组服务
147
- * @return V2NIMTeamService
219
+ /**
220
+ * @brief 获取群组服务
221
+ * @returns V2NIMTeamService
222
+ * @example
223
+ * ```javascript
224
+ * const teamService = client.getTeamService()
225
+ * ```
148
226
  */
149
227
  getTeamService() {
150
228
  return this.teamService;
151
229
  }
152
- /** @brief 获取设置服务
153
- * @return V2NIMSettingService
230
+ /**
231
+ * @brief 获取设置服务
232
+ * @returns V2NIMSettingService
233
+ * @example
234
+ * ```javascript
235
+ * const settingService = client.getSettingService()
236
+ * ```
154
237
  */
155
238
  getSettingService() {
156
239
  return this.settingService;
157
240
  }
158
241
  /**
159
242
  * @brief 获取独立信令服务
160
- * @return V2NIMSignallingService
243
+ * @returns V2NIMSignallingService
244
+ * @example
245
+ * ```javascript
246
+ * const signallingService = client.getSignallingService()
247
+ * ```
161
248
  */
162
249
  getSignallingService() {
163
250
  return this.signallingService;
164
251
  }
165
252
  /**
166
253
  * @brief 获取订阅服务
167
- * @return V2NIMSubscriptionService
254
+ * @returns V2NIMSubscriptionService
255
+ * @example
256
+ * ```javascript
257
+ * const subscriptionService = client.getSubscriptionService()
258
+ * ```
168
259
  */
169
260
  getSubscriptionService() {
170
261
  return this.subscriptionService;
171
262
  }
263
+ /**
264
+ * @brief 获取透传服务
265
+ * @returns V2NIMPassthroughService
266
+ * @example
267
+ * ```javascript
268
+ * const passthroughService = client.getPasseThroughService()
269
+ * ```
270
+ */
271
+ getPasseThroughService() {
272
+ return this.passthroughService;
273
+ }
172
274
  }
173
275
  exports.V2NIMClient = V2NIMClient;
174
276
  //# sourceMappingURL=v2_nim_client.js.map