node-nim 10.5.2 → 10.6.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 (67) hide show
  1. package/dist/nim/msglog.js +8 -0
  2. package/dist/nim/msglog.js.map +1 -1
  3. package/dist/v2/v2_nim_ai_service.js.map +1 -1
  4. package/dist/v2/v2_nim_chatroom_client.js +153 -40
  5. package/dist/v2/v2_nim_chatroom_client.js.map +1 -1
  6. package/dist/v2/v2_nim_chatroom_queue_service.js +148 -0
  7. package/dist/v2/v2_nim_chatroom_queue_service.js.map +1 -0
  8. package/dist/v2/v2_nim_chatroom_service.js +201 -65
  9. package/dist/v2/v2_nim_chatroom_service.js.map +1 -1
  10. package/dist/v2/v2_nim_client.js +116 -25
  11. package/dist/v2/v2_nim_client.js.map +1 -1
  12. package/dist/v2/v2_nim_conversation_group_service.js +57 -9
  13. package/dist/v2/v2_nim_conversation_group_service.js.map +1 -1
  14. package/dist/v2/v2_nim_conversation_service.js +149 -27
  15. package/dist/v2/v2_nim_conversation_service.js.map +1 -1
  16. package/dist/v2/v2_nim_friend_service.js +152 -36
  17. package/dist/v2/v2_nim_friend_service.js.map +1 -1
  18. package/dist/v2/v2_nim_login_service.js +66 -14
  19. package/dist/v2/v2_nim_login_service.js.map +1 -1
  20. package/dist/v2/v2_nim_message_service.js +335 -93
  21. package/dist/v2/v2_nim_message_service.js.map +1 -1
  22. package/dist/v2/v2_nim_notification_service.js +11 -4
  23. package/dist/v2/v2_nim_notification_service.js.map +1 -1
  24. package/dist/v2/v2_nim_passthrough_service.js +39 -0
  25. package/dist/v2/v2_nim_passthrough_service.js.map +1 -0
  26. package/dist/v2/v2_nim_setting_service.js +81 -29
  27. package/dist/v2/v2_nim_setting_service.js.map +1 -1
  28. package/dist/v2/v2_nim_signalling_service.js +172 -44
  29. package/dist/v2/v2_nim_signalling_service.js.map +1 -1
  30. package/dist/v2/v2_nim_storage_service.js +116 -37
  31. package/dist/v2/v2_nim_storage_service.js.map +1 -1
  32. package/dist/v2/v2_nim_subscription_service.js +42 -12
  33. package/dist/v2/v2_nim_subscription_service.js.map +1 -1
  34. package/dist/v2/v2_nim_team_service.js +349 -140
  35. package/dist/v2/v2_nim_team_service.js.map +1 -1
  36. package/dist/v2/v2_nim_user_service.js +62 -19
  37. package/dist/v2/v2_nim_user_service.js.map +1 -1
  38. package/dist/v2/v2_nim_utilities.js +306 -129
  39. package/dist/v2/v2_nim_utilities.js.map +1 -1
  40. package/dist/v2_def/v2_nim_enum_def.js +14 -3
  41. package/dist/v2_def/v2_nim_enum_def.js.map +1 -1
  42. package/dist/v2_def/v2_nim_struct_def.js +0 -2
  43. package/dist/v2_def/v2_nim_struct_def.js.map +1 -1
  44. package/package.json +1 -1
  45. package/types/nim/msglog.d.ts +7 -1
  46. package/types/nim_def/msglog_def.d.ts +2 -0
  47. package/types/v2/v2_nim_ai_service.d.ts +3 -3
  48. package/types/v2/v2_nim_chatroom_client.d.ts +153 -42
  49. package/types/v2/v2_nim_chatroom_queue_service.d.ts +96 -0
  50. package/types/v2/v2_nim_chatroom_service.d.ts +203 -67
  51. package/types/v2/v2_nim_client.d.ts +117 -30
  52. package/types/v2/v2_nim_conversation_group_service.d.ts +59 -11
  53. package/types/v2/v2_nim_conversation_service.d.ts +151 -29
  54. package/types/v2/v2_nim_friend_service.d.ts +139 -39
  55. package/types/v2/v2_nim_login_service.d.ts +70 -15
  56. package/types/v2/v2_nim_message_service.d.ts +337 -95
  57. package/types/v2/v2_nim_notification_service.d.ts +13 -6
  58. package/types/v2/v2_nim_passthrough_service.d.ts +25 -0
  59. package/types/v2/v2_nim_setting_service.d.ts +83 -31
  60. package/types/v2/v2_nim_signalling_service.d.ts +174 -46
  61. package/types/v2/v2_nim_storage_service.d.ts +119 -40
  62. package/types/v2/v2_nim_subscription_service.d.ts +44 -14
  63. package/types/v2/v2_nim_team_service.d.ts +335 -142
  64. package/types/v2/v2_nim_user_service.d.ts +64 -21
  65. package/types/v2/v2_nim_utilities.d.ts +306 -129
  66. package/types/v2_def/v2_nim_enum_def.d.ts +10 -0
  67. package/types/v2_def/v2_nim_struct_def.d.ts +48 -8
@@ -12,12 +12,21 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
12
12
  super();
13
13
  this.instance = new loader_1.default.V2NIMTeamService({ emit: this.emit.bind(this) });
14
14
  }
15
- /** @brief 创建群组 */
16
- /** @param createTeamParams 创建群组参数 */
17
- /** @param inviteeAccountIds 群组创建时, 同时被邀请加入群的成员列表 */
18
- /** @param postscript 群组创建时, 邀请入群的附言 */
19
- /** @param antispamConfig 反垃圾配置 */
20
- /** @return void */
15
+ /**
16
+ * @brief 创建群组
17
+ * @param createTeamParams 创建群组参数
18
+ * @param inviteeAccountIds 群组创建时, 同时被邀请加入群的成员列表
19
+ * @param postscript 群组创建时, 邀请入群的附言
20
+ * @param antispamConfig 反垃圾配置
21
+ * @returns Promise<V2NIMCreateTeamResult>
22
+ * @example
23
+ * ```javascript
24
+ * const result = await v2.teamService.createTeam({
25
+ * name: 'team1',
26
+ * teamType: 0,
27
+ * }, inviteeAccountIds, postscript, antispamConfig)
28
+ * ```
29
+ */
21
30
  createTeam(createTeamParams, inviteeAccountIds, postscript, antispamConfig) {
22
31
  return new Promise((resolve, reject) => {
23
32
  this.instance.createTeam(createTeamParams, inviteeAccountIds, postscript, antispamConfig, (result) => {
@@ -27,12 +36,20 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
27
36
  });
28
37
  });
29
38
  }
30
- /** @brief 修改群组信息 */
31
- /** @param teamId 群组 id */
32
- /** @param teamType 群组类型 */
33
- /** @param updateTeamInfoParams 修改群组信息参数 */
34
- /** @param antispamConfig 反垃圾配置 */
35
- /** @return void */
39
+ /**
40
+ * @brief 修改群组信息
41
+ * @param teamId 群组 id
42
+ * @param teamType 群组类型
43
+ * @param updateTeamInfoParams 修改群组信息参数
44
+ * @param antispamConfig 反垃圾配置
45
+ * @returns void
46
+ * @example
47
+ * ```javascript
48
+ * await v2.teamService.updateTeamInfo(teamId, teamType, {
49
+ * name: 'team1',
50
+ * }, antispamConfig)
51
+ * ```
52
+ */
36
53
  updateTeamInfo(teamId, teamType, updateTeamInfoParams, antispamConfig) {
37
54
  return new Promise((resolve, reject) => {
38
55
  this.instance.updateTeamInfo(teamId, teamType, updateTeamInfoParams, antispamConfig, () => {
@@ -42,10 +59,16 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
42
59
  });
43
60
  });
44
61
  }
45
- /** @brief 退出群组 */
46
- /** @param teamId 群组 id */
47
- /** @param teamType 群组类型 */
48
- /** @return void */
62
+ /**
63
+ * @brief 退出群组
64
+ * @param teamId 群组 id
65
+ * @param teamType 群组类型
66
+ * @returns void
67
+ * @example
68
+ * ```javascript
69
+ * await v2.teamService.leaveTeam(teamId, teamType)
70
+ * ```
71
+ */
49
72
  leaveTeam(teamId, teamType) {
50
73
  return new Promise((resolve, reject) => {
51
74
  this.instance.leaveTeam(teamId, teamType, () => {
@@ -55,10 +78,16 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
55
78
  });
56
79
  });
57
80
  }
58
- /** @brief 获取群组信息 */
59
- /** @param teamId 群组 id */
60
- /** @param teamType 群组类型 */
61
- /** @return void */
81
+ /**
82
+ * @brief 获取群组信息
83
+ * @param teamId 群组 id
84
+ * @param teamType 群组类型
85
+ * @returns Promise<V2NIMTeam>
86
+ * @example
87
+ * ```javascript
88
+ * const team = await v2.teamService.getTeamInfo(teamId, teamType)
89
+ * ```
90
+ */
62
91
  getTeamInfo(teamId, teamType) {
63
92
  return new Promise((resolve, reject) => {
64
93
  this.instance.getTeamInfo(teamId, teamType, (team) => {
@@ -68,10 +97,16 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
68
97
  });
69
98
  });
70
99
  }
71
- /** @brief 根据群组 ID 获取群组信息 */
72
- /** @param teamIds 群组 id 列表 */
73
- /** @param teamType 群组类型 */
74
- /** @return void */
100
+ /**
101
+ * @brief 根据群组 ID 获取群组信息
102
+ * @param teamIds 群组 id 列表
103
+ * @param teamType 群组类型
104
+ * @returns Promise<Array<V2NIMTeam>>
105
+ * @example
106
+ * ```javascript
107
+ * const teams = await v2.teamService.getTeamInfoByIds(teamIds, teamType)
108
+ * ```
109
+ */
75
110
  getTeamInfoByIds(teamIds, teamType) {
76
111
  return new Promise((resolve, reject) => {
77
112
  this.instance.getTeamInfoByIds(teamIds, teamType, (teams) => {
@@ -81,10 +116,16 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
81
116
  });
82
117
  });
83
118
  }
84
- /** @brief 解散群组 */
85
- /** @param teamId 群组 id */
86
- /** @param teamType 群组类型 */
87
- /** @return void */
119
+ /**
120
+ * @brief 解散群组
121
+ * @param teamId 群组 id
122
+ * @param teamType 群组类型
123
+ * @returns void
124
+ * @example
125
+ * ```javascript
126
+ * await v2.teamService.dismissTeam(teamId, teamType)
127
+ * ```
128
+ */
88
129
  dismissTeam(teamId, teamType) {
89
130
  return new Promise((resolve, reject) => {
90
131
  this.instance.dismissTeam(teamId, teamType, () => {
@@ -94,12 +135,18 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
94
135
  });
95
136
  });
96
137
  }
97
- /** @brief 邀请成员加入群组 */
98
- /** @param teamId 群组 id */
99
- /** @param teamType 群组类型 */
100
- /** @param inviteeAccountIds 被邀请人 id 列表 */
101
- /** @param postscript 邀请附言 */
102
- /** @return void */
138
+ /**
139
+ * @brief 邀请成员加入群组
140
+ * @param teamId 群组 id
141
+ * @param teamType 群组类型
142
+ * @param inviteeAccountIds 被邀请人 id 列表
143
+ * @param postscript 邀请附言
144
+ * @returns Promise<Array<string>>
145
+ * @example
146
+ * ```javascript
147
+ * const accountIds = await v2.teamService.inviteMember(teamId, teamType, inviteeAccountIds, postscript)
148
+ * ```
149
+ */
103
150
  inviteMember(teamId, teamType, inviteeAccountIds, postscript) {
104
151
  return new Promise((resolve, reject) => {
105
152
  this.instance.inviteMember(teamId, teamType, inviteeAccountIds, postscript, (accountIds) => {
@@ -109,11 +156,15 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
109
156
  });
110
157
  });
111
158
  }
112
- /** @brief 同意邀请入群 */
113
- /** @param teamId 群组 id */
114
- /** @param teamType 群组类型 */
115
- /** @param invitorAccountId 邀请人 id */
116
- /** @return void */
159
+ /**
160
+ * @brief 同意邀请入群
161
+ * @param invitationInfo 邀请信息
162
+ * @returns Promise<V2NIMTeam>
163
+ * @example
164
+ * ```javascript
165
+ * const team = await v2.teamService.acceptInvitation(invitationInfo)
166
+ * ```
167
+ */
117
168
  acceptInvitation(invitationInfo) {
118
169
  return new Promise((resolve, reject) => {
119
170
  this.instance.acceptInvitation(invitationInfo, (team) => {
@@ -123,12 +174,16 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
123
174
  });
124
175
  });
125
176
  }
126
- /** @brief 拒绝邀请入群 */
127
- /** @param teamId 群组 id */
128
- /** @param teamType 群组类型 */
129
- /** @param invitorAccountId 邀请人 id */
130
- /** @param postscript 拒绝邀请的理由附言 */
131
- /** @return void */
177
+ /**
178
+ * @brief 拒绝邀请入群
179
+ * @param invitationInfo 邀请信息
180
+ * @param postscript 拒绝邀请的理由附言
181
+ * @returns void
182
+ * @example
183
+ * ```javascript
184
+ * await v2.teamService.rejectInvitation(invitationInfo, postscript)
185
+ * ```
186
+ */
132
187
  rejectInvitation(invitationInfo, postscript) {
133
188
  return new Promise((resolve, reject) => {
134
189
  this.instance.rejectInvitation(invitationInfo, postscript, () => {
@@ -138,11 +193,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
138
193
  });
139
194
  });
140
195
  }
141
- /** @brief 踢出群组成员 */
142
- /** @param teamId 群组 id */
143
- /** @param teamType 群组类型 */
144
- /** @param memberAccountIds 踢出群组的成员账号列表 */
145
- /** @return void */
196
+ /**
197
+ * @brief 踢出群组成员
198
+ * @param teamId 群组 id
199
+ * @param teamType 群组类型
200
+ * @param memberAccountIds 踢出群组的成员账号列表
201
+ * @returns void
202
+ * @example
203
+ * ```javascript
204
+ * await v2.teamService.kickMember(teamId, teamType, memberAccountIds)
205
+ * ```
206
+ */
146
207
  kickMember(teamId, teamType, memberAccountIds) {
147
208
  return new Promise((resolve, reject) => {
148
209
  this.instance.kickMember(teamId, teamType, memberAccountIds, () => {
@@ -152,11 +213,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
152
213
  });
153
214
  });
154
215
  }
155
- /** @brief 申请加入群组 */
156
- /** @param teamId 群组 id */
157
- /** @param teamType 群组类型 */
158
- /** @param postscript 申请入群的附言 */
159
- /** @return void */
216
+ /**
217
+ * @brief 申请加入群组
218
+ * @param teamId 群组 id
219
+ * @param teamType 群组类型
220
+ * @param postscript 申请入群的附言
221
+ * @returns Promise<V2NIMTeam>
222
+ * @example
223
+ * ```javascript
224
+ * const team = await v2.teamService.applyJoinTeam(teamId, teamType, postscript)
225
+ * ```
226
+ */
160
227
  applyJoinTeam(teamId, teamType, postscript) {
161
228
  return new Promise((resolve, reject) => {
162
229
  this.instance.applyJoinTeam(teamId, teamType, postscript, (team) => {
@@ -166,11 +233,15 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
166
233
  });
167
234
  });
168
235
  }
169
- /** @brief 接受入群申请 */
170
- /** @param teamId 群组 id */
171
- /** @param teamType 群组类型 */
172
- /** @param applyAccountId 申请人 id */
173
- /** @return void */
236
+ /**
237
+ * @brief 接受入群申请
238
+ * @param applicationInfo 申请信息
239
+ * @returns void
240
+ * @example
241
+ * ```javascript
242
+ * await v2.teamService.acceptJoinApplication(applicationInfo)
243
+ * ```
244
+ */
174
245
  acceptJoinApplication(applicationInfo) {
175
246
  return new Promise((resolve, reject) => {
176
247
  this.instance.acceptJoinApplication(applicationInfo, () => {
@@ -180,12 +251,16 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
180
251
  });
181
252
  });
182
253
  }
183
- /** @brief 拒绝入群申请 */
184
- /** @param teamId 群组 id */
185
- /** @param teamType 群组类型 */
186
- /** @param applyAccountId 申请人 id */
187
- /** @param postscript 拒绝入群申请的附言 */
188
- /** @return void */
254
+ /**
255
+ * @brief 拒绝入群申请
256
+ * @param applicationInfo 申请信息
257
+ * @param postscript 拒绝入群申请的附言
258
+ * @returns void
259
+ * @example
260
+ * ```javascript
261
+ * await v2.teamService.rejectJoinApplication(applicationInfo, postscript)
262
+ * ```
263
+ */
189
264
  rejectJoinApplication(applicationInfo, postscript) {
190
265
  return new Promise((resolve, reject) => {
191
266
  this.instance.rejectJoinApplication(applicationInfo, postscript, () => {
@@ -195,12 +270,18 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
195
270
  });
196
271
  });
197
272
  }
198
- /** @brief 设置成员角色 */
199
- /** @param teamId 群组 id */
200
- /** @param teamType 群组类型 */
201
- /** @param memberAccountId 成员 id */
202
- /** @param memberRole 设置新的角色类型 */
203
- /** @return void */
273
+ /**
274
+ * @brief 设置成员角色
275
+ * @param teamId 群组 id
276
+ * @param teamType 群组类型
277
+ * @param memberAccountIds 成员 id 列表
278
+ * @param memberRole 设置新的角色类型
279
+ * @returns void
280
+ * @example
281
+ * ```javascript
282
+ * await v2.teamService.updateTeamMemberRole(teamId, teamType, memberAccountIds, memberRole)
283
+ * ```
284
+ */
204
285
  updateTeamMemberRole(teamId, teamType, memberAccountIds, memberRole) {
205
286
  return new Promise((resolve, reject) => {
206
287
  this.instance.updateTeamMemberRole(teamId, teamType, memberAccountIds, memberRole, () => {
@@ -210,12 +291,18 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
210
291
  });
211
292
  });
212
293
  }
213
- /** @brief 移交群主 */
214
- /** @param teamId 群组 id */
215
- /** @param teamType 群组类型 */
216
- /** @param accountId 新群主 id */
217
- /** @param leave 是否同时退出群组 */
218
- /** @return void */
294
+ /**
295
+ * @brief 移交群主
296
+ * @param teamId 群组 id
297
+ * @param teamType 群组类型
298
+ * @param accountId 新群主 id
299
+ * @param leave 是否同时退出群组
300
+ * @returns void
301
+ * @example
302
+ * ```javascript
303
+ * await v2.teamService.transferTeamOwner(teamId, teamType, accountId, leave)
304
+ * ```
305
+ */
219
306
  transferTeamOwner(teamId, teamType, accountId, leave) {
220
307
  return new Promise((resolve, reject) => {
221
308
  this.instance.transferTeamOwner(teamId, teamType, accountId, leave, () => {
@@ -225,11 +312,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
225
312
  });
226
313
  });
227
314
  }
228
- /** @brief 修改自己的群成员信息 */
229
- /** @param teamId 群组 id */
230
- /** @param teamType 群组类型 */
231
- /** @param memberInfoParams 修改群成员信息参数 */
232
- /** @return void */
315
+ /**
316
+ * @brief 修改自己的群成员信息
317
+ * @param teamId 群组 id
318
+ * @param teamType 群组类型
319
+ * @param memberInfoParams 修改群成员信息参数
320
+ * @returns void
321
+ * @example
322
+ * ```javascript
323
+ * await v2.teamService.updateSelfTeamMemberInfo(teamId, teamType, memberInfoParams)
324
+ * ```
325
+ */
233
326
  updateSelfTeamMemberInfo(teamId, teamType, memberInfoParams) {
234
327
  return new Promise((resolve, reject) => {
235
328
  this.instance.updateSelfTeamMemberInfo(teamId, teamType, memberInfoParams, () => {
@@ -239,12 +332,18 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
239
332
  });
240
333
  });
241
334
  }
242
- /** @brief 修改群成员昵称 */
243
- /** @param teamId 群组 id */
244
- /** @param teamType 群组类型 */
245
- /** @param accountId 群成员 id */
246
- /** @param nick 群成员昵称 */
247
- /** @return void */
335
+ /**
336
+ * @brief 修改群成员昵称
337
+ * @param teamId 群组 id
338
+ * @param teamType 群组类型
339
+ * @param accountId 群成员 id
340
+ * @param nick 群成员昵称
341
+ * @returns void
342
+ * @example
343
+ * ```javascript
344
+ * await v2.teamService.updateTeamMemberNick(teamId, teamType, accountId, teamNick)
345
+ * ```
346
+ */
248
347
  updateTeamMemberNick(teamId, teamType, accountId, teamNick) {
249
348
  return new Promise((resolve, reject) => {
250
349
  this.instance.updateTeamMemberNick(teamId, teamType, accountId, teamNick, () => {
@@ -254,11 +353,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
254
353
  });
255
354
  });
256
355
  }
257
- /** @brief 设置群组禁言模式 */
258
- /** @param teamId 群组 id */
259
- /** @param teamType 群组类型 */
260
- /** @param chatBannedMode 群组禁言模式 */
261
- /** @return void */
356
+ /**
357
+ * @brief 设置群组禁言模式
358
+ * @param teamId 群组 id
359
+ * @param teamType 群组类型
360
+ * @param chatBannedMode 群组禁言模式
361
+ * @returns void
362
+ * @example
363
+ * ```javascript
364
+ * await v2.teamService.setTeamChatBannedMode(teamId, teamType, chatBannedMode)
365
+ * ```
366
+ */
262
367
  setTeamChatBannedMode(teamId, teamType, chatBannedMode) {
263
368
  return new Promise((resolve, reject) => {
264
369
  this.instance.setTeamChatBannedMode(teamId, teamType, chatBannedMode, () => {
@@ -268,12 +373,18 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
268
373
  });
269
374
  });
270
375
  }
271
- /** @brief 设置群组成员聊天禁言状态 */
272
- /** @param teamId 群组 id */
273
- /** @param teamType 群组类型 */
274
- /** @param accountId 群成员 id */
275
- /** @param chatBanned 是否禁言 */
276
- /** @return void */
376
+ /**
377
+ * @brief 设置群组成员聊天禁言状态
378
+ * @param teamId 群组 id
379
+ * @param teamType 群组类型
380
+ * @param accountId 群成员 id
381
+ * @param chatBanned 是否禁言
382
+ * @returns void
383
+ * @example
384
+ * ```javascript
385
+ * await v2.teamService.setTeamMemberChatBannedStatus(teamId, teamType, accountId, chatBanned)
386
+ * ```
387
+ */
277
388
  setTeamMemberChatBannedStatus(teamId, teamType, accountId, chatBanned) {
278
389
  return new Promise((resolve, reject) => {
279
390
  this.instance.setTeamMemberChatBannedStatus(teamId, teamType, accountId, chatBanned, () => {
@@ -283,9 +394,15 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
283
394
  });
284
395
  });
285
396
  }
286
- /** @brief 获取当前已经加入的群组列表 */
287
- /** @param teamType 群组类型 */
288
- /** @return void */
397
+ /**
398
+ * @brief 获取当前已经加入的群组列表
399
+ * @param teamType 群组类型
400
+ * @returns Promise<Array<V2NIMTeam>>
401
+ * @example
402
+ * ```javascript
403
+ * const teams = await v2.teamService.getJoinedTeamList(teamTypes)
404
+ * ```
405
+ */
289
406
  getJoinedTeamList(teamTypes) {
290
407
  return new Promise((resolve, reject) => {
291
408
  this.instance.getJoinedTeamList(teamTypes, (teams) => {
@@ -295,17 +412,32 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
295
412
  });
296
413
  });
297
414
  }
298
- /** @brief 获取当前已经加入的群组数量 */
299
- /** @param teamTypes 群组类型列表, 为空表示查询所有群类型 */
300
- /** @return number */
415
+ /**
416
+ * @brief 获取当前已经加入的群组数量
417
+ * @param teamTypes 群组类型列表, 为空表示查询所有群类型
418
+ * @returns number
419
+ * @example
420
+ * ```javascript
421
+ * const count = v2.teamService.getJoinedTeamCount(teamTypes)
422
+ * ```
423
+ */
301
424
  getJoinedTeamCount(teamTypes) {
302
425
  return this.instance.getJoinedTeamCount(teamTypes);
303
426
  }
304
- /** @brief 获取群组成员列表 */
305
- /** @param teamId 群组 id */
306
- /** @param teamType 群组类型 */
307
- /** @param queryOption 群组成员查询选项 */
308
- /** @return void */
427
+ /**
428
+ * @brief 获取群组成员列表
429
+ * @param teamId 群组 id
430
+ * @param teamType 群组类型
431
+ * @param queryOption 群组成员查询选项
432
+ * @returns Promise<V2NIMTeamMemberListResult>
433
+ * @example
434
+ * ```javascript
435
+ * const result = await v2.teamService.getTeamMemberList(teamId, teamType, {
436
+ * limit: 10,
437
+ * nextToken: ''
438
+ * })
439
+ * ```
440
+ */
309
441
  getTeamMemberList(teamId, teamType, queryOption) {
310
442
  return new Promise((resolve, reject) => {
311
443
  this.instance.getTeamMemberList(teamId, teamType, queryOption, (result) => {
@@ -315,11 +447,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
315
447
  });
316
448
  });
317
449
  }
318
- /** @brief 根据账号 ID 列表获取群组成员列表 */
319
- /** @param teamId 群组 id */
320
- /** @param teamType 群组类型 */
321
- /** @param accountIds 账号 ID 列表 */
322
- /** @return void */
450
+ /**
451
+ * @brief 根据账号 ID 列表获取群组成员列表
452
+ * @param teamId 群组 id
453
+ * @param teamType 群组类型
454
+ * @param accountIds 账号 ID 列表
455
+ * @returns Promise<Array<V2NIMTeamMember>>
456
+ * @example
457
+ * ```javascript
458
+ * const members = await v2.teamService.getTeamMemberListByIds(teamId, teamType, accountIds)
459
+ * ```
460
+ */
323
461
  getTeamMemberListByIds(teamId, teamType, accountIds) {
324
462
  return new Promise((resolve, reject) => {
325
463
  this.instance.getTeamMemberListByIds(teamId, teamType, accountIds, (members) => {
@@ -329,11 +467,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
329
467
  });
330
468
  });
331
469
  }
332
- /** @brief 根据账号 ID 列表获取群组成员邀请人 */
333
- /** @param teamId 群组 id */
334
- /** @param teamType 群组类型 */
335
- /** @param accountIds 账号 ID 列表 */
336
- /** @return void */
470
+ /**
471
+ * @brief 根据账号 ID 列表获取群组成员邀请人
472
+ * @param teamId 群组 id
473
+ * @param teamType 群组类型
474
+ * @param accountIds 账号 ID 列表
475
+ * @returns Promise<Map<string, string>>
476
+ * @example
477
+ * ```javascript
478
+ * const invitorMap = await v2.teamService.getTeamMemberInvitor(teamId, teamType, accountIds)
479
+ * ```
480
+ */
337
481
  getTeamMemberInvitor(teamId, teamType, accountIds) {
338
482
  return new Promise((resolve, reject) => {
339
483
  this.instance.getTeamMemberInvitor(teamId, teamType, accountIds, (invitorMap) => {
@@ -343,9 +487,15 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
343
487
  });
344
488
  });
345
489
  }
346
- /** @brief 获取群加入相关信息 */
347
- /** @param option 查询参数 */
348
- /** @return void */
490
+ /**
491
+ * @brief 获取群加入相关信息
492
+ * @param option 查询参数
493
+ * @returns Promise<V2NIMTeamJoinActionInfoResult>
494
+ * @example
495
+ * ```javascript
496
+ * const result = await v2.teamService.getTeamJoinActionInfoList(option)
497
+ * ```
498
+ */
349
499
  getTeamJoinActionInfoList(option) {
350
500
  return new Promise((resolve, reject) => {
351
501
  this.instance.getTeamJoinActionInfoList(option, (result) => {
@@ -355,9 +505,15 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
355
505
  });
356
506
  });
357
507
  }
358
- /** @brief 根据关键字搜索群组,混合搜索高级群和超大群,使用 LIKE 方式匹配,只搜索群名称 */
359
- /** @param keyword 关键字 */
360
- /** @return Promise<Array<V2NIMTeam>> */
508
+ /**
509
+ * @brief 根据关键字搜索群组,混合搜索高级群和超大群,使用 LIKE 方式匹配,只搜索群名称
510
+ * @param keyword 关键字
511
+ * @returns Promise<Array<V2NIMTeam>>
512
+ * @example
513
+ * ```javascript
514
+ * const teams = await v2.teamService.searchTeamByKeyword(keyword)
515
+ * ```
516
+ */
361
517
  searchTeamByKeyword(keyword) {
362
518
  return new Promise((resolve, reject) => {
363
519
  this.instance.searchTeamByKeyword(keyword, (teams) => {
@@ -367,9 +523,15 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
367
523
  });
368
524
  });
369
525
  }
370
- /** @brief 根据关键字搜索群组成员 */
371
- /** @param option 搜索选项 */
372
- /** @return Promise<V2NIMTeamMemberListResult> */
526
+ /**
527
+ * @brief 根据关键字搜索群组成员
528
+ * @param option 搜索选项
529
+ * @returns Promise<V2NIMTeamMemberListResult>
530
+ * @example
531
+ * ```javascript
532
+ * const result = await v2.teamService.searchTeamMembers(option)
533
+ * ```
534
+ */
373
535
  searchTeamMembers(option) {
374
536
  return new Promise((resolve, reject) => {
375
537
  this.instance.searchTeamMembers(option, (result) => {
@@ -379,11 +541,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
379
541
  });
380
542
  });
381
543
  }
382
- /** @brief 添加特别关注群成员列表 */
383
- /** @param teamId 群组 id */
384
- /** @param teamType 群组类型 */
385
- /** @param accountIds 账号 id 列表 */
386
- /** @return void */
544
+ /**
545
+ * @brief 添加特别关注群成员列表
546
+ * @param teamId 群组 id
547
+ * @param teamType 群组类型
548
+ * @param accountIds 账号 id 列表
549
+ * @returns void
550
+ * @example
551
+ * ```javascript
552
+ * await v2.teamService.addTeamMembersFollow(teamId, teamType, accountIds)
553
+ * ```
554
+ */
387
555
  addTeamMembersFollow(teamId, teamType, accountIds) {
388
556
  return new Promise((resolve, reject) => {
389
557
  this.instance.addTeamMembersFollow(teamId, teamType, accountIds, () => {
@@ -393,11 +561,17 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
393
561
  });
394
562
  });
395
563
  }
396
- /** @brief 移除特别关注群成员列表 */
397
- /** @param teamId 群组 id */
398
- /** @param teamType 群组类型 */
399
- /** @param accountIds 账号 id 列表 */
400
- /** @return void */
564
+ /**
565
+ * @brief 移除特别关注群成员列表
566
+ * @param teamId 群组 id
567
+ * @param teamType 群组类型
568
+ * @param accountIds 账号 id 列表
569
+ * @returns void
570
+ * @example
571
+ * ```javascript
572
+ * await v2.teamService.removeTeamMembersFollow(teamId, teamType, accountIds)
573
+ * ```
574
+ */
401
575
  removeTeamMembersFollow(teamId, teamType, accountIds) {
402
576
  return new Promise((resolve, reject) => {
403
577
  this.instance.removeTeamMembersFollow(teamId, teamType, accountIds, () => {
@@ -407,6 +581,41 @@ class V2NIMTeamService extends eventemitter3_1.EventEmitter {
407
581
  });
408
582
  });
409
583
  }
584
+ /**
585
+ * @brief 清空所有群申请
586
+ * @returns void
587
+ * @example
588
+ * ```javascript
589
+ * await v2.teamService.clearAllTeamJoinActionInfo()
590
+ * ```
591
+ */
592
+ clearAllTeamJoinActionInfo() {
593
+ return new Promise((resolve, reject) => {
594
+ this.instance.clearAllTeamJoinActionInfo(() => {
595
+ resolve();
596
+ }, (error) => {
597
+ reject(error);
598
+ });
599
+ });
600
+ }
601
+ /**
602
+ * @brief 删除群申请
603
+ * @param applicationInfo 群申请信息
604
+ * @returns void
605
+ * @example
606
+ * ```javascript
607
+ * await v2.teamService.deleteTeamJoinActionInfo(applicationInfo)
608
+ * ```
609
+ */
610
+ deleteTeamJoinActionInfo(applicationInfo) {
611
+ return new Promise((resolve, reject) => {
612
+ this.instance.deleteTeamJoinActionInfo(applicationInfo, () => {
613
+ resolve();
614
+ }, (error) => {
615
+ reject(error);
616
+ });
617
+ });
618
+ }
410
619
  }
411
620
  exports.V2NIMTeamService = V2NIMTeamService;
412
621
  //# sourceMappingURL=v2_nim_team_service.js.map