node-nim 7.8.3 → 9.1.0-rc.3

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 (131) hide show
  1. package/README.md +70 -23
  2. package/download-sdk.mjs +59 -0
  3. package/js/api/client.js +103 -36
  4. package/js/api/client.js.map +1 -0
  5. package/js/api/data_sync.js +8 -8
  6. package/js/api/data_sync.js.map +1 -0
  7. package/js/api/friend.js +75 -12
  8. package/js/api/friend.js.map +1 -0
  9. package/js/api/global.js +66 -14
  10. package/js/api/global.js.map +1 -0
  11. package/js/api/msglog.js +398 -47
  12. package/js/api/msglog.js.map +1 -0
  13. package/js/api/nos.js +114 -24
  14. package/js/api/nos.js.map +1 -0
  15. package/js/api/online_session.js +39 -13
  16. package/js/api/online_session.js.map +1 -0
  17. package/js/api/pass_through_proxy.js +18 -5
  18. package/js/api/pass_through_proxy.js.map +1 -0
  19. package/js/api/plugin.js +40 -4
  20. package/js/api/plugin.js.map +1 -0
  21. package/js/api/session.js +192 -25
  22. package/js/api/session.js.map +1 -0
  23. package/js/api/subscribe_event.js +75 -11
  24. package/js/api/subscribe_event.js.map +1 -0
  25. package/js/api/super_team.js +332 -68
  26. package/js/api/super_team.js.map +1 -0
  27. package/js/api/sysmsg.js +94 -17
  28. package/js/api/sysmsg.js.map +1 -0
  29. package/js/api/talk.js +50 -29
  30. package/js/api/talk.js.map +1 -0
  31. package/js/api/talkex.js +72 -28
  32. package/js/api/talkex.js.map +1 -0
  33. package/js/api/team.js +423 -25
  34. package/js/api/team.js.map +1 -0
  35. package/js/api/tool.js +72 -9
  36. package/js/api/tool.js.map +1 -0
  37. package/js/api/user.js +97 -13
  38. package/js/api/user.js.map +1 -0
  39. package/js/{api/rescode_def.js → def/client_def.js} +74 -10
  40. package/js/def/client_def.js.map +1 -0
  41. package/js/{api → def}/data_sync_def.js +1 -2
  42. package/js/def/data_sync_def.js.map +1 -0
  43. package/js/{api → def}/doc_trans_def.js +1 -2
  44. package/js/def/doc_trans_def.js.map +1 -0
  45. package/js/{api → def}/friend_def.js +2 -2
  46. package/js/def/friend_def.js.map +1 -0
  47. package/js/{api → def}/global_def.js +1 -1
  48. package/js/def/global_def.js.map +1 -0
  49. package/js/{api → def}/msglog_def.js +14 -8
  50. package/js/def/msglog_def.js.map +1 -0
  51. package/js/{api → def}/nos_def.js +1 -0
  52. package/js/def/nos_def.js.map +1 -0
  53. package/js/{api → def}/online_session_def.js +1 -0
  54. package/js/def/online_session_def.js.map +1 -0
  55. package/js/{api → def}/pass_through_proxy_def.js +1 -1
  56. package/js/def/pass_through_proxy_def.js.map +1 -0
  57. package/js/{api → def}/plugin_def.js +1 -0
  58. package/js/def/plugin_def.js.map +1 -0
  59. package/js/{api/session.def.js → def/session_def.js} +1 -0
  60. package/js/def/session_def.js.map +1 -0
  61. package/js/{api → def}/subscribe_event_def.js +2 -1
  62. package/js/def/subscribe_event_def.js.map +1 -0
  63. package/js/{api → def}/super_team_def.js +9 -6
  64. package/js/def/super_team_def.js.map +1 -0
  65. package/js/{api → def}/sysmsg_def.js +11 -1
  66. package/js/def/sysmsg_def.js.map +1 -0
  67. package/js/{api → def}/talk_def.js +1 -0
  68. package/js/def/talk_def.js.map +1 -0
  69. package/js/{api → def}/talkex_def.js +1 -0
  70. package/js/def/talkex_def.js.map +1 -0
  71. package/js/{api → def}/team_def.js +3 -2
  72. package/js/def/team_def.js.map +1 -0
  73. package/js/{api → def}/tool_def.js +1 -1
  74. package/js/def/tool_def.js.map +1 -0
  75. package/js/{api → def}/user_def.js +2 -1
  76. package/js/def/user_def.js.map +1 -0
  77. package/js/loader.js +30 -0
  78. package/js/loader.js.map +1 -0
  79. package/js/nim.js +38 -44
  80. package/js/nim.js.map +1 -0
  81. package/package.json +37 -24
  82. package/types/api/client.d.ts +124 -0
  83. package/types/api/data_sync.d.ts +13 -0
  84. package/types/api/friend.d.ts +82 -0
  85. package/types/api/global.d.ts +69 -0
  86. package/types/api/msglog.d.ts +388 -0
  87. package/types/api/nos.d.ts +118 -0
  88. package/types/api/online_session.d.ts +44 -0
  89. package/types/api/pass_through_proxy.d.ts +24 -0
  90. package/types/api/plugin.d.ts +37 -0
  91. package/types/api/session.d.ts +212 -0
  92. package/types/api/subscribe_event.d.ts +87 -0
  93. package/types/api/super_team.d.ts +332 -0
  94. package/types/api/sysmsg.d.ts +104 -0
  95. package/types/api/talk.d.ts +69 -0
  96. package/types/api/talkex.d.ts +93 -0
  97. package/types/api/team.d.ts +442 -0
  98. package/types/api/tool.d.ts +75 -0
  99. package/types/api/user.d.ts +111 -0
  100. package/types/def/client_def.d.ts +276 -0
  101. package/types/def/data_sync_def.d.ts +19 -0
  102. package/types/def/doc_trans_def.d.ts +11 -0
  103. package/types/def/friend_def.d.ts +65 -0
  104. package/types/def/global_def.d.ts +69 -0
  105. package/types/def/msglog_def.d.ts +328 -0
  106. package/types/def/nos_def.d.ts +71 -0
  107. package/types/def/online_session_def.d.ts +34 -0
  108. package/types/def/pass_through_proxy_def.d.ts +12 -0
  109. package/types/def/plugin_def.d.ts +7 -0
  110. package/types/def/session_def.d.ts +113 -0
  111. package/types/def/subscribe_event_def.d.ts +82 -0
  112. package/types/def/super_team_def.d.ts +133 -0
  113. package/types/def/sysmsg_def.d.ts +84 -0
  114. package/types/def/talk_def.d.ts +48 -0
  115. package/types/def/talkex_def.d.ts +111 -0
  116. package/types/def/team_def.d.ts +153 -0
  117. package/types/def/tool_def.d.ts +27 -0
  118. package/types/def/user_def.d.ts +58 -0
  119. package/types/loader.d.ts +2 -0
  120. package/types/nim.d.ts +18 -0
  121. package/js/api/client_def.js +0 -58
  122. package/js/api/nim.js +0 -13
  123. package/js/api/rts.js +0 -68
  124. package/js/api/rts_def.js +0 -15
  125. package/js/api/signaling.js +0 -62
  126. package/js/api/signaling_def.js +0 -20
  127. package/just-task.js +0 -154
  128. package/scripts/build_addon.js +0 -56
  129. package/scripts/build_wrapper.js +0 -45
  130. package/scripts/fetch_wrapper.js +0 -45
  131. package/scripts/pack_addon.js +0 -41
@@ -0,0 +1,442 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { IMMessage } from '../def/msglog_def';
4
+ import { NIMTeamAPI, TeamInfo, TeamEventCallback, QueryAllMyTeamsCallback, QueryAllMyTeamsInfoCallback, QueryMyAllMemberInfosCallback, QueryTeamMembersCallback, QueryTeamMemberCallback, QueryTeamInfoCallback, QueryTeamMembersOnlineCallback, TeamMsgAckReadCallback, QueryTeamMembersInvitorCallback, QueryTeamsInfoCallback, UpdateTInfoLocalCallback, GetTeamInfoBatchSFTransCallback, GetTeamInfoListCallback, TeamMemberProperty } from '../def/team_def';
5
+ export declare interface NIMTeam {
6
+ on(event: 'teamEvent', listener: () => void): this;
7
+ once(event: 'teamEvent', listener: () => void): this;
8
+ }
9
+ export declare class NIMTeam extends ev.EventEmitter {
10
+ team: NIMTeamAPI;
11
+ constructor();
12
+ /** 注册全局回调 */
13
+ initEventHandlers(): void;
14
+ /** 创建群组
15
+ * @param team_info 群组信息
16
+ * @param ids 邀请对象id
17
+ * @param invitation_postscript 邀请附言
18
+ * @param jsonExtension json扩展参数(备用,目前不需要)
19
+ * @param cb 群通知的回调函数
20
+ * @return bool 检查参数如果不符合要求则返回失败
21
+ * @note
22
+ * <pre>
23
+ * 200:成功
24
+ * 810:如果创建的是高级群,返回810表示邀请成功并带上tinfo
25
+ * 414:成员不足
26
+ * 801:成员数超限制
27
+ * 404:成员中有非法用户
28
+ * </pre>
29
+ */
30
+ createTeamAsync(info: TeamInfo, ids: Array<string>, invitationPostscript: string, cb: TeamEventCallback, jsonExtension: string): boolean;
31
+ /** 邀请
32
+ * @param tid 群组id
33
+ * @param ids 邀请对象id
34
+ * @param invitation_postscript 邀请附言
35
+ * @param invitation_attachment 用户可自定义的补充邀请信息
36
+ * @param jsonExtension json扩展参数(备用,目前不需要)
37
+ * @param cb 邀请的回调函数
38
+ * @return bool 检查参数如果不符合要求则返回失败
39
+ * @note
40
+ * <pre>
41
+ * 200:成功
42
+ * 810:如果是高级群,返回810表示邀请成功并带上timetag
43
+ * 404:非法用户
44
+ * 801:群人数超限
45
+ * 802:没有权限
46
+ * 803:群不存在
47
+ * </pre>
48
+ */
49
+ inviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: TeamEventCallback, jsonExtension: string): boolean;
50
+ /** 踢人
51
+ * @param tid 群组id
52
+ * @param ids 被踢对象id
53
+ * @param jsonExtension json扩展参数(备用,目前不需要)
54
+ * @param cb 踢人的回调函数
55
+ * @return bool 检查参数如果不符合要求则返回失败
56
+ * @note
57
+ * <pre>
58
+ * 200:成功
59
+ * 403:无超大群功能
60
+ * 414:踢人数量超限
61
+ * 802:群人数超限、不能踢自己
62
+ * 803:群不存在
63
+ * 804:用户不在群里面
64
+ * </pre>
65
+ */
66
+ kickAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): boolean;
67
+ /** 离开群
68
+ * @param tid 群组id
69
+ * @param jsonExtension json扩展参数(备用,目前不需要)
70
+ * @param cb 离开群的回调函数
71
+ * @return bool 检查参数如果不符合要求则返回失败
72
+ * @note
73
+ * <pre>
74
+ * 200:成功
75
+ * 403:无超大群功能
76
+ * 802:没有群权限、群主不能退群
77
+ * 803:群不存在
78
+ * 804:用户不在群里
79
+ * </pre>
80
+ */
81
+ leaveAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
82
+ /** 解散群
83
+ * @param tid 群组id
84
+ * @param jsonExtension json扩展参数(备用,目前不需要)
85
+ * @param cb 解散群的回调函数
86
+ * @return bool 检查参数如果不符合要求则返回失败
87
+ * @note
88
+ * <pre>
89
+ * 200:成功
90
+ * 802:没有权限
91
+ * 803:群不存在
92
+ * </pre>
93
+ */
94
+ dismissAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
95
+ /** 更新群信息
96
+ * @param tid 群组id
97
+ * @param team_info 群组信息
98
+ * @param jsonExtension json扩展参数(备用,目前不需要)
99
+ * @param cb 更新群信息的回调函数
100
+ * @return bool 检查参数如果不符合要求则返回失败
101
+ * @note
102
+ * <pre>
103
+ * 200:成功
104
+ * 802:没有权限
105
+ * 803:群不存在
106
+ * </pre>
107
+ */
108
+ updateTeamInfoAsync(tid: string, info: TeamInfo, cb: TeamEventCallback, jsonExtension: string): boolean;
109
+ /** 申请入群
110
+ * @param tid 群组id
111
+ * @param reason 附言
112
+ * @param jsonExtension json扩展参数(备用,目前不需要)
113
+ * @param cb 申请入群的回调函数
114
+ * @return bool 检查参数如果不符合要求则返回失败
115
+ * @note
116
+ * <pre>
117
+ * 200:成功
118
+ * 802:群验证方式为拒绝所有人申请
119
+ * 808:申请成功,等待验证
120
+ * 809:已经在群里
121
+ * 801:人数限制
122
+ * 803:群不存在
123
+ * 805:群类型不对
124
+ * </pre>
125
+ */
126
+ applyJoinAsync(tid: string, reason: string, cb: TeamEventCallback, jsonExtension: string): boolean;
127
+ /** 同意入群申请
128
+ * @param tid 群组id
129
+ * @param applicant_id 申请者id
130
+ * @param jsonExtension json扩展参数(备用,目前不需要)
131
+ * @param cb 同意入群申请的回调函数
132
+ * @return bool 检查参数如果不符合要求则返回失败
133
+ * @note
134
+ * <pre>
135
+ * 200:成功
136
+ * 509:操作已失效
137
+ * 809:已经在群里
138
+ * 801:人数限制
139
+ * 802:没有权限
140
+ * 803:群不存在
141
+ * 805:群类型不对
142
+ * </pre>
143
+ */
144
+ passJoinApplyAsync(tid: string, applicantId: string, cb: TeamEventCallback, jsonExtension: string): boolean;
145
+ /** 拒绝入群申请
146
+ * @param tid 群组id
147
+ * @param applicant_id 申请者id
148
+ * @param reason 附言
149
+ * @param jsonExtension json扩展参数(备用,目前不需要)
150
+ * @param cb 拒绝入群申请的回调函数
151
+ * @return bool 检查参数如果不符合要求则返回失败
152
+ * @note
153
+ * <pre>
154
+ * 200:成功,如果用户处于申请状态则会通知申请用户被拒绝
155
+ * 509:操作已失效
156
+ * 802:没有权限
157
+ * 803:群不存在
158
+ * 805:群类型不对
159
+ * </pre>
160
+ */
161
+ rejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: TeamEventCallback, jsonExtension: string): boolean;
162
+ /** 添加管理员
163
+ * @param tid 群组id
164
+ * @param ids 管理员id
165
+ * @param jsonExtension json扩展参数(备用,目前不需要)
166
+ * @param cb 添加管理员的回调函数
167
+ * @return bool 检查参数如果不符合要求则返回失败
168
+ * @note
169
+ * <pre>
170
+ * 200:成功
171
+ * 802:没有权限
172
+ * 803:群不存在
173
+ * 805:群类型不对
174
+ * </pre>
175
+ */
176
+ addManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): boolean;
177
+ /** 删除管理员
178
+ * @param tid 群组id
179
+ * @param ids 管理员id
180
+ * @param jsonExtension json扩展参数(备用,目前不需要)
181
+ * @param cb 删除管理员的回调函数
182
+ * @return bool 检查参数如果不符合要求则返回失败
183
+ * @note
184
+ * <pre>
185
+ * 200:成功
186
+ * 802:没有权限
187
+ * 803:群不存在
188
+ * 805:群类型不对
189
+ * </pre>
190
+ */
191
+ removeManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): boolean;
192
+ /** 移交群主
193
+ * @param tid 群组id
194
+ * @param new_owner_id 移交对象id
195
+ * @param is_leave 是否同时退出群
196
+ * @param jsonExtension json扩展参数(备用,目前不需要)
197
+ * @param cb 移交群主的回调函数
198
+ * @return bool 检查参数如果不符合要求则返回失败
199
+ * @note
200
+ * <pre>
201
+ * 200:成功
202
+ * 802:没有权限
203
+ * 803:群不存在
204
+ * 805:群类型不对
205
+ * 806:群数量上限
206
+ * </pre>
207
+ */
208
+ transferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: TeamEventCallback, jsonExtension: string): boolean;
209
+ /** 更新自己的群属性
210
+ * @param prop 群成员属性
211
+ * @param jsonExtension json扩展参数(备用,目前不需要)
212
+ * @param cb 更新自己的群属性的回调函数
213
+ * @return bool 检查参数如果不符合要求则返回失败
214
+ * @note
215
+ * <pre>
216
+ * 200:成功
217
+ * 803:群不存在
218
+ * 804:不在群里
219
+ * 805:群类型不对
220
+ * </pre>
221
+ */
222
+ updateMyPropertyAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string): boolean;
223
+ /** 修改别人的群昵称
224
+ * @param prop 群成员属性
225
+ * @param jsonExtension json扩展参数(备用,目前不需要)
226
+ * @param cb 修改别人的群昵称的回调函数
227
+ * @return bool 检查参数如果不符合要求则返回失败
228
+ * @note
229
+ * <pre>
230
+ * 200:成功
231
+ * 803:群不存在
232
+ * 804:不在群里
233
+ * 805:群类型不对
234
+ * </pre>
235
+ */
236
+ updateOtherNickAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string): boolean;
237
+ /** 接受邀请
238
+ * @param tid 群组id
239
+ * @param invitor_id 邀请者id
240
+ * @param jsonExtension json扩展参数(备用,目前不需要)
241
+ * @param cb 接受邀请的回调函数
242
+ * @return bool 检查参数如果不符合要求则返回失败
243
+ * @note
244
+ * <pre>
245
+ * 200:成功
246
+ * 802:没有权限
247
+ * 803:群不存在
248
+ * 805:群类型不对
249
+ * </pre>
250
+ */
251
+ acceptInvitationAsync(tid: string, inviterId: string, cb: TeamEventCallback, jsonExtension: string): boolean;
252
+ /** 拒绝邀请
253
+ * @param tid 群组id
254
+ * @param invitor_id 邀请者id
255
+ * @param reason 附言
256
+ * @param jsonExtension json扩展参数(备用,目前不需要)
257
+ * @param cb 拒绝邀请的回调函数
258
+ * @return bool 检查参数如果不符合要求则返回失败
259
+ * @note
260
+ * <pre>
261
+ * 200:成功
262
+ * 802:没有权限
263
+ * 803:群不存在
264
+ * 805:群类型不对
265
+ * </pre>
266
+ */
267
+ rejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: TeamEventCallback, jsonExtension: string): boolean;
268
+ /** 查询所有群
269
+ * @param jsonExtension json扩展参数(备用,目前不需要)
270
+ * @param cb 查询所有群的回调函数
271
+ * @return void 无返回值
272
+ */
273
+ queryAllMyTeamsAsync(cb: QueryAllMyTeamsCallback, jsonExtension: string): void;
274
+ /** 查询所有群信息
275
+ * @param jsonExtension json扩展参数(备用,目前不需要)
276
+ * @param cb 查询所有群信息的回调函数
277
+ * @return void 无返回值
278
+ */
279
+ queryAllMyTeamsInfoAsync(cb: QueryAllMyTeamsInfoCallback, jsonExtension: string): void;
280
+ /** 查询所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)
281
+ * @param jsonExtension json扩展参数(备用,目前不需要)
282
+ * @param cb 查询所有群里我的成员信息的回调函数
283
+ * @return void 无返回值
284
+ */
285
+ queryMyAllMemberInfosAsync(cb: QueryMyAllMemberInfosCallback, jsonExtension: string): void;
286
+ /** 查询群成员
287
+ * @param tid 群组id
288
+ * @param jsonExtension json扩展参数(备用,目前不需要)
289
+ * @param cb 查询群成员的回调函数
290
+ * @return bool 检查参数如果不符合要求则返回失败
291
+ * @note
292
+ * <pre>
293
+ * 200:成功
294
+ * 406:没有变化
295
+ * 802:没有权限
296
+ * </pre>
297
+ */
298
+ queryTeamMembersAsync(tid: string, cb: QueryTeamMembersCallback, jsonExtension: string): boolean;
299
+ /** 查询(单个)群成员信息
300
+ * @param tid 群组id
301
+ * @param id 群成员id
302
+ * @param jsonExtension json扩展参数(备用,目前不需要)
303
+ * @param cb 查询群成员的回调函数
304
+ * @return bool 检查参数如果不符合要求则返回失败
305
+ */
306
+ queryTeamMemberAsync(tid: string, id: string, cb: QueryTeamMemberCallback, jsonExtension: string): void;
307
+ /** 查询群信息
308
+ * @param tid 群组id
309
+ * @param jsonExtension json扩展参数(备用,目前不需要)
310
+ * @param cb 查询群信息的回调函数
311
+ * @return bool 检查参数如果不符合要求则返回失败
312
+ */
313
+ queryTeamInfoAsync(tid: string, cb: QueryTeamInfoCallback, jsonExtension: string): boolean;
314
+ /** 获取群信息(从服务器获取)
315
+ * @param tid 群组id
316
+ * @param jsonExtension json扩展参数(备用,目前不需要)
317
+ * @param cb 获取群信息的回调函数
318
+ * @return bool 检查参数如果不符合要求则返回失败
319
+ * @note
320
+ * <pre>
321
+ * 200:成功
322
+ * 803:群不存在
323
+ * </pre>
324
+ */
325
+ queryTeamInfoOnlineAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
326
+ /** 禁言/解除禁言
327
+ * @param tid 群组id
328
+ * @param member_id 操作对象id
329
+ * @param set_mute 禁言/解除禁言
330
+ * @param jsonExtension json扩展参数(备用,目前不需要)
331
+ * @param cb 踢人的回调函数
332
+ * @return bool 检查参数如果不符合要求则返回失败
333
+ * @note
334
+ * <pre>
335
+ * 200:成功
336
+ * 404:禁言对象不存在
337
+ * 414:参数错误
338
+ * 803:群不存在
339
+ * 802:没有权限
340
+ * </pre>
341
+ */
342
+ muteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string): boolean;
343
+ /** 获取群禁言成员列表
344
+ * @param tid 群组id
345
+ * @param cb 回调函数
346
+ * @param jsonExtension json扩展参数(备用,目前不需要)
347
+ * @return bool 检查参数如果不符合要求则返回失败
348
+ * @note
349
+ * <pre>
350
+ * 200:成功
351
+ * 802:没有权限
352
+ * 803:群不存在
353
+ * </pre>
354
+ */
355
+ queryMuteListOnlineAsync(tid: string, cb: QueryTeamMembersOnlineCallback, jsonExtension: string): boolean;
356
+ /** 群禁言/解除群禁言
357
+ * @param tid 群组id
358
+ * @param set_mute 禁言/解除禁言
359
+ * @param jsonExtension json扩展参数(备用,目前不需要)
360
+ * @param cb 踢人的回调函数
361
+ * @return bool 检查参数如果不符合要求则返回失败.
362
+ * @note
363
+ * <pre>
364
+ * 200:成功
365
+ * 414:参数错误
366
+ * </pre>
367
+ */
368
+ muteAsync(tid: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string): boolean;
369
+ /** 群消息回执
370
+ * @param tid 群组id
371
+ * @param msgs 需要发送消息回执的群消息
372
+ * @param jsonExtension json扩展参数(备用,目前不需要)
373
+ * @param cb 回调函数
374
+ * @return void 无返回值
375
+ * @note
376
+ * <pre>
377
+ * 200:成功
378
+ * 414:参数错误
379
+ * </pre>
380
+ */
381
+ teamMsgAckRead(tid: string, msgs: Array<IMMessage>, cb: TeamMsgAckReadCallback, jsonExtension: string): void;
382
+ /** 根据指定 ID 获取群组消息已读未读情况
383
+ * @param[in] tid 群组id
384
+ * @param[in] msg 群消息
385
+ * @param[in] accids 要查询的 ID 列表
386
+ * @param[in] jsonExtension json扩展参数(备用,目前不需要)
387
+ * @param[in] cb 回调函数
388
+ * @return void 无返回值
389
+ * @note
390
+ * <pre>
391
+ * 200:成功
392
+ * 414:参数错误
393
+ * </pre>
394
+ */
395
+ teamMsgQueryUnreadList(tid: string, msg: IMMessage, accids: Array<string>, cb: TeamEventCallback, jsonExtension: string): void;
396
+ /** 查询群成员的邀请人 accid 由接口 原 TeamQueryTeamMembersInvitor方法
397
+ * @param tid 群组id
398
+ * @param members 要查询 的群成员accid列表
399
+ * @param cb 回调函数
400
+ * @return void 无返回值
401
+ * @note
402
+ * <pre>
403
+ * 200:成功
404
+ * </pre>
405
+ */
406
+ queryTeamMembersInvitor(tid: string, members: Array<string>, cb: QueryTeamMembersInvitorCallback): void;
407
+ /** 查询群信息
408
+ * @param keyword 要查询的关键字
409
+ * @param cb 查询群信息的回调函数
410
+ * @param jsonExtension json扩展参数(备用,目前不需要)
411
+ * @return bool 检查参数如果不符合要求则返回失败
412
+ */
413
+ queryTeamInfoByKeywordAsync(keyword: string, cb: QueryTeamsInfoCallback, jsonExtension: string): boolean;
414
+ /** 更新群信息
415
+ * @param tid 群组id
416
+ * @param team_infos 群组信息
417
+ * @param notify_event 更新后是否触发事件以通知应用层
418
+ * @param cb 更新群信息的回调函数,回调中会指明更新成功与失败的群ID
419
+ * @param jsonExtension json扩展参数(备用,目前不需要)
420
+ * @return void
421
+ */
422
+ updateTInfoLocal(infos: Array<TeamInfo>, cb: UpdateTInfoLocalCallback, jsonExtension: string): void;
423
+ /** 查询所有群
424
+ * @param cb 查询所有群的回调函数
425
+ * @param time_tag 时间戳,没有特殊需求此参数赋0
426
+ * @param jsonExtension json扩展参数(备用,目前不需要)
427
+ * @return void 无返回值
428
+ */
429
+ getTeamInfoBatchTrans(cb: GetTeamInfoBatchSFTransCallback, time_tag: number, jsonExtension: string): void;
430
+ /** 查询给定的一组群ID详细信息
431
+ * @param tid_list 群组id列表,最多10个
432
+ * @param cb 查询给定的一组群ID详细信息的回调模板
433
+ * @return void 无返回值
434
+ * @note
435
+ * <pre>
436
+ * 200:成功
437
+ * 414:参数错误
438
+ * 816:部分成功
439
+ * </pre>
440
+ */
441
+ getTeaminfoList(tids: Array<string>, cb: GetTeamInfoListCallback): void;
442
+ }
@@ -0,0 +1,75 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { NIMToolAPI, NIMAppDataType, AudioInfo, GetAudioTextCallback, FilterClientAntispamCallback } from '../def/tool_def';
4
+ export declare class NIMTool extends ev.EventEmitter {
5
+ tool: NIMToolAPI;
6
+ constructor();
7
+ /** 注册全局回调 */
8
+ initEventHandlers(): void;
9
+ /** 获取SDK里app account对应的app data目录(各个帐号拥有独立的目录,其父目录相同)
10
+ * @param app_account APP account。如果传入空字符串,则将获取到各个帐号目录的父目录(谨慎删除!)
11
+ * @return std::string 返回的目录路径(UTF8)
12
+ */
13
+ getUserAppdataDir(appAccount: string): string;
14
+ /** 获取SDK里app account对应的具体类型的app data目录(如图片消息文件存放目录,语音消息文件存放目录等),需要调用nim_free_buf(void *data)释放内存
15
+ * @param app_account APP account。如果传入空字符串,则返回结果为空
16
+ * @param appdata_type 具体类型的app data。见NIMAppDataType定义
17
+ * @return std::string返回的目录路径(目录可能未生成,需要app自行判断是否已生成)
18
+ */
19
+ getSpecificAppdataDir(appAccount: string, appdataType: NIMAppDataType): string;
20
+ /** 获取本地存储路径
21
+ * @return std::string 返回的目录路径(UTF8)
22
+ */
23
+ getLocalAppdataDir(): string;
24
+ /** 获取安装目录(SDK DLL所在的当前目录)
25
+ * @return std::string 返回的目录路径(UTF8)
26
+ */
27
+ getCurModuleDir(): string;
28
+ /** 计算md5
29
+ * @param input 需要计算md5的内容
30
+ * @return std::string 返回的md5
31
+ */
32
+ getMd5(input: string): string;
33
+ /** 计算文件的md5
34
+ * @param file_path 文件完整路径,UTF-8
35
+ * @return std::string 返回的md5
36
+ */
37
+ getFileMd5(filePath: string): string;
38
+ /** 生成UUID
39
+ * @return std::string 返回的UUID
40
+ */
41
+ getUuid(): string;
42
+ /** 语音转文字
43
+ * @param audio_info 语音信息
44
+ * @param cb 语音转文字回调
45
+ * @param jsonExtension json扩展参数(备用,目前不需要)
46
+ * @return bool 检查参数如果不符合要求则返回失败
47
+ * @note
48
+ * <pre>
49
+ * 200:成功
50
+ * 403:没有权限
51
+ * 414:参数错误
52
+ * 500:未知错误
53
+ * 6101:语音转码解析失败
54
+ * 6102:语音时长过长(超过60s
55
+ * 6103:服务不可用
56
+ * 6104:audioUrl不合法
57
+ * </pre>
58
+ */
59
+ getAudioTextAsync(audioInfo: AudioInfo, cb: GetAudioTextCallback, jsonExtension: string): boolean;
60
+ /** 客户端本地反垃圾
61
+ * @param text 文本内容,UTF-8
62
+ * @param replace_str 进行替换的字符串,UTF-8
63
+ * @param lib_name 词库名称,UTF-8
64
+ * @param callback 回调函数
65
+ * @return
66
+ * @note
67
+ * <pre>
68
+ * 回调函数ret
69
+ * 1:敏感词已被替换;
70
+ * 2:含有敏感词不允许发送;
71
+ * 3:需要将内容设置在消息结构的反垃圾字段里,由服务器过滤
72
+ * </pre>
73
+ */
74
+ filterClientAntispam(text: string, replaceString: string, libName: string, cb: FilterClientAntispamCallback): void;
75
+ }
@@ -0,0 +1,111 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { NIMUserAPI, SetRelationCallback, GetSpecialListCallback, GetUserNameCardCallback, UpdateMyUserNameCardCallback, NINPushType, UserNameCard } from '../def/user_def';
4
+ export declare interface NIMUser {
5
+ on(event: 'specialRelationChange', listener: () => void): this;
6
+ on(event: 'userNameCardChange', listener: () => void): this;
7
+ once(event: 'specialRelationChange', listener: () => void): this;
8
+ once(event: 'userNameCardChange', listener: () => void): this;
9
+ }
10
+ export declare class NIMUser extends ev.EventEmitter {
11
+ user: NIMUserAPI;
12
+ constructor();
13
+ /** 注册全局回调 */
14
+ initEventHandlers(): void;
15
+ /** 设置、取消设置黑名单
16
+ * @param accid 好友id
17
+ * @param set_black 取消或设置
18
+ * @param jsonExtension json扩展参数(备用,目前不需要)
19
+ * @param cb
20
+ * @return bool 检查参数如果不符合要求则返回失败
21
+ * @note
22
+ * <pre>
23
+ * 200:成功
24
+ * 419:黑名单数量超过上限
25
+ * </pre>
26
+ */
27
+ setBlack(accid: string, setBlack: boolean, cb: SetRelationCallback, jsonExtension: string): boolean;
28
+ /** 设置、取消设置静音名单
29
+ * @param accid 好友id
30
+ * @param set_mute 取消或设置
31
+ * @param jsonExtension json扩展参数(备用,目前不需要)
32
+ * @param cb
33
+ * @return bool 检查参数如果不符合要求则返回失败
34
+ * @note
35
+ * <pre>
36
+ * 200:成功
37
+ * 419:静音列表数量超过上限
38
+ * </pre>
39
+ */
40
+ setMute(accid: string, set_mute: boolean, cb: SetRelationCallback, jsonExtension: string): boolean;
41
+ /** 获得静音名单列表
42
+ * @param jsonExtension json扩展参数(备用,目前不需要)
43
+ * @param cb
44
+ * @return bool 检查参数如果不符合要求则返回失败
45
+ * @note
46
+ * <pre>
47
+ * 200:成功
48
+ * </pre>
49
+ */
50
+ getMutelist(cb: GetSpecialListCallback, jsonExtension: string): void;
51
+ /** 获得黑名单名单
52
+ * @param jsonExtension json扩展参数(备用,目前不需要)
53
+ * @param cb
54
+ * @return void 无返回值
55
+ */
56
+ getBlacklist(cb: GetSpecialListCallback, jsonExtension: string): void;
57
+ /** 获取本地的指定帐号的用户名片
58
+ * @param accids
59
+ * @param cb 操作结果回调
60
+ * @param jsonExtension json扩展参数(备用,目前不需要)
61
+ * @return void 无返回值
62
+ * @note
63
+ * <pre>
64
+ * 200:成功
65
+ * 414:参数错误
66
+ * 20000:还未初始化或初始化未正常完成
67
+ * 20001:还未登陆或登录未完成
68
+ * </pre>
69
+ */
70
+ getUserNameCard(accids: Array<string>, cb: GetUserNameCardCallback, jsonExtension: string): boolean;
71
+ /** 在线查询指定帐号的用户名片
72
+ * @param accids
73
+ * @param cb 操作结果回调
74
+ * @param jsonExtension json扩展参数(备用,目前不需要)
75
+ * @return bool 检查参数如果不符合要求则返回失败
76
+ * @note
77
+ * <pre>
78
+ * 200:成功
79
+ * 414:参数错误
80
+ * 20000:还未初始化或初始化未正常完成
81
+ * 20001:还未登陆或登录未完成
82
+ * </pre>
83
+ */
84
+ getUserNameCardOnline(accids: Array<string>, cb: GetUserNameCardCallback, jsonExtension: string): boolean;
85
+ /** 更新自己的用户名片
86
+ * @param namecard 用户名片内容
87
+ * @param cb 操作结果回调
88
+ * @param jsonExtension json扩展参数(备用,目前不需要)
89
+ * @return bool 检查参数如果不符合要求则返回失败
90
+ * @note
91
+ * <pre>
92
+ * 200:成功
93
+ * 400:非法参数
94
+ * </pre>
95
+ */
96
+ updateMyUserNameCard(nameCard: UserNameCard, cb: UpdateMyUserNameCardCallback, jsonExtension: string): boolean;
97
+ /** 获取本地的指定帐号的用户名片
98
+ * @param keyword 要查询的关键字
99
+ * @param cb 操作结果回调
100
+ * @param jsonExtension json扩展参数(备用,目前不需要)
101
+ * @return bool 检查参数如果不符合要求则返回失败
102
+ */
103
+ queryUserListByKeyword(keyword: string, cb: GetUserNameCardCallback, jsonExtension: string): boolean;
104
+ /** 更新推送证书
105
+ * @param cer_name 云信后台配置的s推送证明名称
106
+ * @param token 设备token
107
+ * @param type 1: pushkit (仅iOS) 其他 apns 默认填0
108
+ * @return void 无返回值
109
+ */
110
+ updatePushToken(cerName: string, token: string, type: NINPushType): void;
111
+ }