node-nim 7.8.3 → 9.1.0-rc.1

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 +83 -36
  2. package/download-sdk.mjs +59 -0
  3. package/js/api/client.js +147 -80
  4. package/js/api/client.js.map +1 -0
  5. package/js/api/data_sync.js +20 -20
  6. package/js/api/data_sync.js.map +1 -0
  7. package/js/api/friend.js +101 -38
  8. package/js/api/friend.js.map +1 -0
  9. package/js/api/global.js +90 -38
  10. package/js/api/global.js.map +1 -0
  11. package/js/api/msglog.js +455 -104
  12. package/js/api/msglog.js.map +1 -0
  13. package/js/api/nos.js +140 -50
  14. package/js/api/nos.js.map +1 -0
  15. package/js/api/online_session.js +58 -32
  16. package/js/api/online_session.js.map +1 -0
  17. package/js/api/pass_through_proxy.js +33 -20
  18. package/js/api/pass_through_proxy.js.map +1 -0
  19. package/js/api/plugin.js +52 -16
  20. package/js/api/plugin.js.map +1 -0
  21. package/js/api/session.js +250 -83
  22. package/js/api/session.js.map +1 -0
  23. package/js/api/subscribe_event.js +102 -38
  24. package/js/api/subscribe_event.js.map +1 -0
  25. package/js/api/super_team.js +387 -123
  26. package/js/api/super_team.js.map +1 -0
  27. package/js/api/sysmsg.js +127 -50
  28. package/js/api/sysmsg.js.map +1 -0
  29. package/js/api/talk.js +71 -50
  30. package/js/api/talk.js.map +1 -0
  31. package/js/api/talkex.js +115 -71
  32. package/js/api/talkex.js.map +1 -0
  33. package/js/api/team.js +514 -116
  34. package/js/api/team.js.map +1 -0
  35. package/js/api/tool.js +104 -41
  36. package/js/api/tool.js.map +1 -0
  37. package/js/api/user.js +134 -50
  38. package/js/api/user.js.map +1 -0
  39. package/js/{api/rescode_def.js → def/client_def.js} +157 -93
  40. package/js/def/client_def.js.map +1 -0
  41. package/js/{api → def}/data_sync_def.js +21 -22
  42. package/js/def/data_sync_def.js.map +1 -0
  43. package/js/{api → def}/doc_trans_def.js +17 -18
  44. package/js/def/doc_trans_def.js.map +1 -0
  45. package/js/{api → def}/friend_def.js +38 -38
  46. package/js/def/friend_def.js.map +1 -0
  47. package/js/{api → def}/global_def.js +49 -49
  48. package/js/def/global_def.js.map +1 -0
  49. package/js/{api → def}/msglog_def.js +131 -125
  50. package/js/def/msglog_def.js.map +1 -0
  51. package/js/{api → def}/nos_def.js +17 -16
  52. package/js/def/nos_def.js.map +1 -0
  53. package/js/{api → def}/online_session_def.js +3 -2
  54. package/js/def/online_session_def.js.map +1 -0
  55. package/js/{api → def}/pass_through_proxy_def.js +11 -11
  56. package/js/def/pass_through_proxy_def.js.map +1 -0
  57. package/js/{api → def}/plugin_def.js +3 -2
  58. package/js/def/plugin_def.js.map +1 -0
  59. package/js/{api/session.def.js → def/session_def.js} +27 -26
  60. package/js/def/session_def.js.map +1 -0
  61. package/js/{api → def}/subscribe_event_def.js +53 -52
  62. package/js/def/subscribe_event_def.js.map +1 -0
  63. package/js/{api → def}/super_team_def.js +65 -62
  64. package/js/def/super_team_def.js.map +1 -0
  65. package/js/{api → def}/sysmsg_def.js +37 -27
  66. package/js/def/sysmsg_def.js.map +1 -0
  67. package/js/{api → def}/talk_def.js +3 -2
  68. package/js/def/talk_def.js.map +1 -0
  69. package/js/{api → def}/talkex_def.js +3 -2
  70. package/js/def/talkex_def.js.map +1 -0
  71. package/js/{api → def}/team_def.js +70 -69
  72. package/js/def/team_def.js.map +1 -0
  73. package/js/{api → def}/tool_def.js +12 -12
  74. package/js/def/tool_def.js.map +1 -0
  75. package/js/{api → def}/user_def.js +23 -22
  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 +40 -46
  80. package/js/nim.js.map +1 -0
  81. package/package.json +61 -48
  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,332 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { QueryMyAllMemberInfosCallback, NIMSuperTeamAPI, SuperTeamEventCallback, SuperTeamInfo, SuperTeamMemberProperty, QueryAllMySuperTeamsCallback, QueryAllMySuperTeamsInfoCallback, QuerySuperTeamMembersCallback, QuerySuperTeamMemberCallback, QuerySuperTeamInfoCallback } from 'ts/def/super_team_def';
4
+ export declare interface NIMSuperTeam {
5
+ on(event: 'superTeamEvent', listener: () => void): this;
6
+ once(event: 'superTeamEvent', listener: () => void): this;
7
+ }
8
+ export declare class NIMSuperTeam extends ev.EventEmitter {
9
+ team: NIMSuperTeamAPI;
10
+ constructor();
11
+ /** 注册全局回调 */
12
+ initEventHandlers(): void;
13
+ /** 邀请
14
+ * @param tid 群组id
15
+ * @param ids 邀请对象id
16
+ * @param invitation_postscript 邀请附言
17
+ * @param invitation_attachment 用户可自定义的补充邀请信息
18
+ * @param jsonExtension json扩展参数(备用,目前不需要)
19
+ * @param cb 邀请的回调函数
20
+ * @return bool 检查参数如果不符合要求则返回失败
21
+ * @note
22
+ * <pre>
23
+ * 200:成功
24
+ * 810:如果是高级群,返回810表示邀请成功并带上timetag
25
+ * 404:非法用户
26
+ * 801:群人数超限
27
+ * 802:没有权限
28
+ * 803:群不存在
29
+ * </pre>
30
+ */
31
+ inviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
32
+ /** 踢人
33
+ * @param tid 群组id
34
+ * @param ids 被踢对象id
35
+ * @param jsonExtension json扩展参数(备用,目前不需要)
36
+ * @param cb 踢人的回调函数
37
+ * @return bool 检查参数如果不符合要求则返回失败
38
+ * @note
39
+ * <pre>
40
+ * 200:成功
41
+ * 403:无超大群功能
42
+ * 414:踢人数量超限
43
+ * 802:群人数超限、不能踢自己
44
+ * 803:群不存在
45
+ * 804:用户不在群里面
46
+ * </pre>
47
+ */
48
+ kickAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
49
+ /** 离开群
50
+ * @param tid 群组id
51
+ * @param jsonExtension json扩展参数(备用,目前不需要)
52
+ * @param cb 离开群的回调函数
53
+ * @return bool 检查参数如果不符合要求则返回失败
54
+ * @note
55
+ * <pre>
56
+ * 200:成功
57
+ * 403:无超大群功能
58
+ * 802:没有群权限、群主不能退群
59
+ * 803:群不存在
60
+ * 804:用户不在群里
61
+ * </pre>
62
+ */
63
+ leaveAsync(tid: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
64
+ /** 更新群信息
65
+ * @param tid 群组id
66
+ * @param team_info 群组信息
67
+ * @param jsonExtension json扩展参数(备用,目前不需要)
68
+ * @param cb 更新群信息的回调函数
69
+ * @return bool 检查参数如果不符合要求则返回失败
70
+ * @note
71
+ * <pre>
72
+ * 200:成功
73
+ * 802:没有群权限、群主不能退群
74
+ * 803:群不存在
75
+ * </pre>
76
+ */
77
+ updateSuperTeamInfoAsync(tid: string, info: SuperTeamInfo, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
78
+ /** 申请入群
79
+ * @param tid 群组id
80
+ * @param reason 附言
81
+ * @param jsonExtension json扩展参数(备用,目前不需要)
82
+ * @param cb 申请入群的回调函数
83
+ * @return bool 检查参数如果不符合要求则返回失败
84
+ * @note
85
+ * <pre>
86
+ * 200:成功
87
+ * 802:群验证方式为拒绝所有人申请
88
+ * 808:申请成功,等待验证
89
+ * 809:已经在群里
90
+ * 801:人数限制
91
+ * 803:群不存在
92
+ * 805:群类型不对
93
+ * </pre>
94
+ */
95
+ applyJoinAsync(tid: string, reason: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
96
+ /** 同意入群申请
97
+ * @param tid 群组id
98
+ * @param applicant_id 申请者id
99
+ * @param jsonExtension json扩展参数(备用,目前不需要)
100
+ * @param cb 同意入群申请的回调函数
101
+ * @return bool 检查参数如果不符合要求则返回失败
102
+ * @note
103
+ * <pre>
104
+ * 200:成功
105
+ * 509:操作已失效
106
+ * 809:已经在群里
107
+ * 801:人数限制
108
+ * 802:没有权限
109
+ * 803:群不存在
110
+ * 805:群类型不对
111
+ * </pre>
112
+ */
113
+ passJoinApplyAsync(tid: string, applicantId: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
114
+ /** 拒绝入群申请
115
+ * @param tid 群组id
116
+ * @param applicant_id 申请者id
117
+ * @param reason 附言
118
+ * @param jsonExtension json扩展参数(备用,目前不需要)
119
+ * @param cb 拒绝入群申请的回调函数
120
+ * @return bool 检查参数如果不符合要求则返回失败
121
+ * @note
122
+ * <pre>
123
+ * 200:成功,如果用户处于申请状态则会通知申请用户被拒绝
124
+ * 509:操作已失效
125
+ * 802:没有权限
126
+ * 803:群不存在
127
+ * 805:群类型不对
128
+ * </pre>
129
+ */
130
+ rejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
131
+ /** 添加管理员
132
+ * @param tid 群组id
133
+ * @param ids 管理员id
134
+ * @param jsonExtension json扩展参数(备用,目前不需要)
135
+ * @param cb 添加管理员的回调函数
136
+ * @return bool 检查参数如果不符合要求则返回失败
137
+ * @note
138
+ * <pre>
139
+ * 200:成功
140
+ * 802:没有权限
141
+ * 803:群不存在
142
+ * 805:群类型不对
143
+ * </pre>
144
+ */
145
+ addManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
146
+ /** 删除管理员
147
+ * @param tid 群组id
148
+ * @param ids 管理员id
149
+ * @param jsonExtension json扩展参数(备用,目前不需要)
150
+ * @param cb 删除管理员的回调函数
151
+ * @return bool 检查参数如果不符合要求则返回失败
152
+ * @note
153
+ * <pre>
154
+ * 200:成功
155
+ * 802:没有权限
156
+ * 803:群不存在
157
+ * 805:群类型不对
158
+ * </pre>
159
+ */
160
+ removeManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
161
+ /** 移交群主
162
+ * @param tid 群组id
163
+ * @param new_owner_id 移交对象id
164
+ * @param is_leave 是否同时退出群
165
+ * @param jsonExtension json扩展参数(备用,目前不需要)
166
+ * @param cb 移交群主的回调函数
167
+ * @return bool 检查参数如果不符合要求则返回失败
168
+ * @note
169
+ * <pre>
170
+ * 200:成功
171
+ * 802:没有权限
172
+ * 803:群不存在
173
+ * 805:群类型不对
174
+ * 806:群数量上限
175
+ * </pre>
176
+ */
177
+ transferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
178
+ /** 更新自己的群属性
179
+ * @param prop 群成员属性
180
+ * @param jsonExtension json扩展参数(备用,目前不需要)
181
+ * @param cb 更新自己的群属性的回调函数
182
+ * @return bool 检查参数如果不符合要求则返回失败
183
+ * @note
184
+ * <pre>
185
+ * 200:成功
186
+ * 803:群不存在
187
+ * 805:群类型不对s
188
+ * </pre>
189
+ */
190
+ updateMyPropertyAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
191
+ /** 修改别人的群昵称
192
+ * @param prop 群成员属性
193
+ * @param jsonExtension json扩展参数(备用,目前不需要)
194
+ * @param cb 修改别人的群昵称的回调函数
195
+ * @return bool 检查参数如果不符合要求则返回失败
196
+ * @note
197
+ * <pre>
198
+ * 200:成功
199
+ * 802:没有权限
200
+ * 803:群不存在
201
+ * 804:不在群里
202
+ * 805:群类型不对
203
+ * </pre>
204
+ */
205
+ updateOtherNickAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
206
+ /** 接受邀请
207
+ * @param tid 群组id
208
+ * @param invitor_id 邀请者id
209
+ * @param jsonExtension json扩展参数(备用,目前不需要)
210
+ * @param cb 接受邀请的回调函数
211
+ * @return bool 检查参数如果不符合要求则返回失败
212
+ * @note
213
+ * <pre>
214
+ * 200:成功
215
+ * 802:没有权限
216
+ * 803:群不存在
217
+ * 805:群类型不对
218
+ * </pre>
219
+ */
220
+ acceptInvitationAsync(tid: string, inviterId: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
221
+ /** 拒绝邀请
222
+ * @param tid 群组id
223
+ * @param invitor_id 邀请者id
224
+ * @param reason 附言
225
+ * @param jsonExtension json扩展参数(备用,目前不需要)
226
+ * @param cb 拒绝邀请的回调函数
227
+ * @return bool 检查参数如果不符合要求则返回失败
228
+ * @note
229
+ * <pre>
230
+ * 200:成功
231
+ * 802:没有权限
232
+ * 803:群不存在
233
+ * 805:群类型不对
234
+ * </pre>
235
+ */
236
+ rejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
237
+ /** 查询所有群
238
+ * @param jsonExtension json扩展参数(备用,目前不需要)
239
+ * @param cb 查询所有群的回调函数
240
+ * @return void 无返回值
241
+ */
242
+ queryAllMySuperTeamsAsync(cb: QueryAllMySuperTeamsCallback, jsonExtension: string): void;
243
+ /** 查询所有群信息
244
+ * @param jsonExtension json扩展参数(备用,目前不需要)
245
+ * @param cb 查询所有群信息的回调函数
246
+ * @return void 无返回值
247
+ */
248
+ queryAllMySuperTeamsInfoAsync(cb: QueryAllMySuperTeamsInfoCallback, jsonExtension: string): void;
249
+ /** 查询所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)
250
+ * @param jsonExtension json扩展参数(备用,目前不需要)
251
+ * @param cb 查询所有群里我的成员信息的回调函数
252
+ * @return void 无返回值
253
+ */
254
+ queryMyAllMemberInfosAsync(cb: QueryMyAllMemberInfosCallback, jsonExtension: string): void;
255
+ /** 查询群成员
256
+ * @param tid 群组id
257
+ * @param jsonExtension json扩展参数(备用,目前不需要)
258
+ * @param cb 查询群成员的回调函数
259
+ * @return bool 检查参数如果不符合要求则返回失败
260
+ * @note
261
+ * <pre>
262
+ * 200:成功
263
+ * 406:没有变化
264
+ * 802:没有权限
265
+ * </pre>
266
+ */
267
+ querySuperTeamMembersAsync(tid: string, cb: QuerySuperTeamMembersCallback, jsonExtension: string): boolean;
268
+ /** 查询(单个)群成员信息
269
+ * @param tid 群组id
270
+ * @param id 群成员id
271
+ * @param jsonExtension json扩展参数(备用,目前不需要)
272
+ * @param cb 查询群成员的回调函数
273
+ * @return bool 检查参数如果不符合要求则返回失败
274
+ */
275
+ querySuperTeamMemberAsync(tid: string, id: string, cb: QuerySuperTeamMemberCallback, jsonExtension: string): void;
276
+ /** 查询群信息
277
+ * @param tid 群组id
278
+ * @param jsonExtension json扩展参数(备用,目前不需要)
279
+ * @param cb 查询群信息的回调函数
280
+ * @return bool 检查参数如果不符合要求则返回失败
281
+ */
282
+ querySuperTeamInfoAsync(tid: string, cb: QuerySuperTeamInfoCallback, jsonExtension: string): boolean;
283
+ /** 获取群信息(从服务器获取)
284
+ * @param tid 群组id
285
+ * @param jsonExtension json扩展参数(备用,目前不需要)
286
+ * @param cb 获取群信息的回调函数
287
+ * @return bool 检查参数如果不符合要求则返回失败
288
+ * @note
289
+ * <pre>
290
+ * 200:成功
291
+ * 803:群不存在
292
+ * </pre>
293
+ */
294
+ querySuperTeamInfoOnlineAsync(tid: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
295
+ /** 禁言/解除禁言
296
+ * @param tid 群组id
297
+ * @param member_id 操作对象id
298
+ * @param set_mute 禁言/解除禁言
299
+ * @param jsonExtension json扩展参数(备用,目前不需要)
300
+ * @param cb 踢人的回调函数
301
+ * @return bool 检查参数如果不符合要求则返回失败
302
+ * @note
303
+ * <pre>
304
+ * 200:成功
305
+ * 404:禁言对象不存在
306
+ * 414:参数错误
307
+ * 803:群不存在
308
+ * 802:没有权限
309
+ * </pre>
310
+ */
311
+ muteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
312
+ /** 群禁言/解除群禁言
313
+ * @param tid 群组id
314
+ * @param set_mute 禁言/解除禁言
315
+ * @param jsonExtension json扩展参数(备用,目前不需要)
316
+ * @param cb 踢人的回调函数
317
+ * @return bool 检查参数如果不符合要求则返回失败
318
+ * @note
319
+ * <pre>
320
+ * 200:成功
321
+ * 414:参数错误
322
+ * </pre>
323
+ */
324
+ muteAsync(tid: string, set_mute: boolean, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
325
+ /** 查询所有群信息
326
+ * @param keyword 要查询的关键字
327
+ * @param jsonExtension json扩展参数(备用,目前不需要)
328
+ * @param cb 查询所有群信息的回调函数
329
+ * @return bool 检查参数如果不符合要求则返回失败
330
+ */
331
+ querySuperTeamsInfoByKeywordAsync(keyword: string, cb: QueryAllMySuperTeamsInfoCallback, jsonExtension: string): void;
332
+ }
@@ -0,0 +1,104 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { NIMSysMsgAPI, SysMessage, NIMSysMsgStatus, NIMSysMsgType, NotifySingleSysmsgCallback, NotifySysmsgResCallback, QuerySysmsgCallback } from '../def/sysmsg_def';
4
+ export declare interface NIMSysMsg {
5
+ on(event: 'receiveSystemMsg', listener: () => void): this;
6
+ on(event: 'sendCustomSystemMsg', listener: () => void): this;
7
+ once(event: 'receiveSystemMsg', listener: () => void): this;
8
+ once(event: 'sendCustomSystemMsg', listener: () => void): this;
9
+ }
10
+ export declare class NIMSysMsg extends ev.EventEmitter {
11
+ sysmsg: NIMSysMsgAPI;
12
+ constructor();
13
+ /** 注册全局回调 */
14
+ initEventHandlers(): void;
15
+ /** 发送自定义通知消息
16
+ * @param json_msg 消息体Json, 可以通过CreateCustomNotificationMsg方法自动创建
17
+ * @return void 无返回值
18
+ */
19
+ sendCustomNotificationMsg(msg: SysMessage): void;
20
+ /** 查询本地系统消息
21
+ * @param limit_count 一次查询数量,建议20
22
+ * @param last_time 上次查询最后一条消息的时间戳
23
+ * @param jsonExtension json扩展参数(备用,目前不需要)
24
+ * @param cb 查询本地系统消息的回调函数
25
+ * @return bool 检查参数如果不符合要求则返回失败
26
+ */
27
+ queryMsgAsync(limit_count: number, last_time: number, cb: QuerySysmsgCallback, jsonExtension: string): boolean;
28
+ /** 查询未读消息数
29
+ * @param jsonExtension json扩展参数(备用,目前不需要)
30
+ * @param cb 查询未读消息数的回调函数
31
+ * @return void 无返回值
32
+ * @note
33
+ * <pre>
34
+ * 200:成功
35
+ * </pre>
36
+ */
37
+ queryUnreadCount(cb: NotifySysmsgResCallback, jsonExtension: string): void;
38
+ /** 设置消息状态
39
+ * @param msg_id 消息id
40
+ * @param status 消息状态
41
+ * @param jsonExtension json扩展参数(备用,目前不需要)
42
+ * @param cb 设置消息状态的回调函数
43
+ * @return void 无返回值
44
+ * @note
45
+ * <pre>
46
+ * 200:成功
47
+ * </pre>
48
+ */
49
+ setStatusAsync(msg_id: number, status: NIMSysMsgStatus, cb: NotifySingleSysmsgCallback, jsonExtension: string): boolean;
50
+ /** 设置全部消息为已读
51
+ * @param jsonExtension json扩展参数(备用,目前不需要)
52
+ * @param cb 设置全部消息为已读的回调函数
53
+ * @return void 无返回值
54
+ * @note
55
+ * <pre>
56
+ * 200:成功
57
+ * </pre>
58
+ */
59
+ readAllAsync(cb: NotifySysmsgResCallback, jsonExtension: string): void;
60
+ /** 删除消息
61
+ * @param msg_id 消息id
62
+ * @param jsonExtension json扩展参数(备用,目前不需要)
63
+ * @param cb 删除消息的回调函数
64
+ * @return bool 检查参数如果不符合要求则返回失败
65
+ * @note
66
+ * <pre>
67
+ * 200:成功
68
+ * </pre>
69
+ */
70
+ deleteAsync(msg_id: number, cb: NotifySingleSysmsgCallback, jsonExtension: string): boolean;
71
+ /** 全部删除
72
+ * @param jsonExtension json扩展参数(备用,目前不需要)
73
+ * @param cb 删除消息的回调函数
74
+ * @return void 无返回值
75
+ * @note
76
+ * <pre>
77
+ * 200:成功
78
+ * </pre>
79
+ */
80
+ deleteAllAsync(cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
81
+ /** 按类型设置系统通知状态
82
+ * @param type 类型
83
+ * @param status 状态
84
+ * @param jsonExtension json扩展参数(备用,目前不需要)
85
+ * @param cb 回调函数
86
+ * @return void 无返回值
87
+ * @note
88
+ * <pre>
89
+ * 200:成功
90
+ * </pre>
91
+ */
92
+ setStatusByTypeAsync(type: NIMSysMsgType, status: NIMSysMsgStatus, cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
93
+ /** 按类型删除系统通知
94
+ * @param type 类型
95
+ * @param jsonExtension json扩展参数(备用,目前不需要)
96
+ * @param cb 回调函数
97
+ * @return void 无返回值
98
+ * @note
99
+ * <pre>
100
+ * 200:成功
101
+ * </pre>
102
+ */
103
+ deleteByTypeAsync(type: NIMSysMsgType, cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
104
+ }
@@ -0,0 +1,69 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { IMMessage, NIMMessageType } from '../def/msglog_def';
4
+ import { NIMTalkAPI, RecallMsgsCallback } from '../def/talk_def';
5
+ export declare interface NIMTalk {
6
+ on(event: 'sendMsg', listener: () => void): this;
7
+ on(event: 'receiveMsg', listener: () => void): this;
8
+ on(event: 'receiveMsgs', listener: () => void): this;
9
+ on(event: 'filterNotification', listener: () => void): this;
10
+ on(event: 'filterMsg', listener: () => void): this;
11
+ on(event: 'recallMsgs', listener: () => void): this;
12
+ on(event: 'receiveBroadcastMsg', listener: () => void): this;
13
+ on(event: 'receiveBroadcastMsgs', listener: () => void): this;
14
+ once(event: 'sendMsg', listener: () => void): this;
15
+ once(event: 'receiveMsg', listener: () => void): this;
16
+ once(event: 'receiveMsgs', listener: () => void): this;
17
+ once(event: 'filterNotification', listener: () => void): this;
18
+ once(event: 'filterMsg', listener: () => void): this;
19
+ once(event: 'recallMsgs', listener: () => void): this;
20
+ once(event: 'receiveBroadcastMsg', listener: () => void): this;
21
+ once(event: 'receiveBroadcastMsgs', listener: () => void): this;
22
+ }
23
+ export declare class NIMTalk extends ev.EventEmitter {
24
+ talk: NIMTalkAPI;
25
+ constructor();
26
+ /** 注册全局回调 */
27
+ initEventHandlers(): void;
28
+ /** 发送消息
29
+ * @param json_msg 消息体Json字符串,可以通过CreateXXXMessage方法自动创建
30
+ * @param jsonExtension json扩展参数(备用,目前不需要)
31
+ * @param pcb 上传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
32
+ * @return void 无返回值
33
+ */
34
+ sendMsg(msg: IMMessage, jsonExtension: string): void;
35
+ /** 停止正在发送中的消息(目前只支持发送文件消息时的终止)
36
+ * @param client_msg_id 停止发送的消息客户端id
37
+ * @param type 停止发送的消息类型
38
+ * @param jsonExtension json扩展参数(备用,目前不需要)
39
+ * @return void 无返回值
40
+ */
41
+ stopSendMsg(clientMsgId: string, type: NIMMessageType, jsonExtension: string): void;
42
+ /** 撤回消息
43
+ * @param msg 消息
44
+ * @param notify_msg 自定义通知消息
45
+ * @param cb 回调
46
+ * @param param 额外的参数,包含apnstext、pushpayload、jsonExtension、env_config、user_data
47
+ * @note
48
+ * <pre>
49
+ * 200:成功
50
+ * 414:参数错误
51
+ * 508:撤回时间超过配制有效期,默认是2分钟
52
+ * 10414:本地错误码,参数错误
53
+ * 10508:本地错误码,超过配置有效期或者所需参数不存在
54
+ * </pre>
55
+ */
56
+ recallMsg(msg: IMMessage, notify_msg: string, cb: RecallMsgsCallback, apnstext: string, pushpayloadconst: string, jsonExtension: string): void;
57
+ /** 从消息体中获取附件(图片、语音、视频等)的本地路径
58
+ * @param msg 消息
59
+ * @return string 消息如果有附件,不管是否已下载,返回附件的本地路径;消息如果没有附件,返回空字符串。
60
+ */
61
+ getAttachmentPathFromMsg(msg: IMMessage): string;
62
+ /** 回复消息thread 聊天场景
63
+ * @param msg 被回复消息的消息体
64
+ * @param json_reply_msg 回复消息的消息体,可通过各种createxxxmessage接口创建
65
+ * @param prg_cb 传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
66
+ * @return void 无返回值
67
+ */
68
+ replyMessage(msg: IMMessage, json_reply_msg: string): void;
69
+ }
@@ -0,0 +1,93 @@
1
+ /// <reference types="node" />
2
+ import ev from 'events';
3
+ import { NIMTalkExAPI, CollectInfo, AddCollectCallback, RemoveCollectsParm, RemoveCollectsCallback, MatchCollectParm, UpdateCollectCallback, QueryCollectsParm, QueryCollectsCallback, QuickCommentInfo, AddQuickCommentCallback, RemoveQuickCommentParam, RemoveQuickCommentCallback, QueryQuickCommentsParam, QueryQuickCommentCallback, PinMessageInfo, PinMessageCallback, ModifyPinMessageParam, UnPinMessageCallback, UpdatePinMessageCallback, QueryPinMessageCallback } from '../def/talkex_def';
4
+ import { IMMessage } from '../def/msglog_def';
5
+ export declare interface NIMTalkEx {
6
+ on(event: 'addQuickComment', listener: () => void): this;
7
+ on(event: 'removeQuickComment', listener: () => void): this;
8
+ on(event: 'pin', listener: () => void): this;
9
+ on(event: 'unpin', listener: () => void): this;
10
+ on(event: 'updatePin', listener: () => void): this;
11
+ once(event: 'addQuickComment', listener: () => void): this;
12
+ once(event: 'removeQuickComment', listener: () => void): this;
13
+ once(event: 'pin', listener: () => void): this;
14
+ once(event: 'unpin', listener: () => void): this;
15
+ once(event: 'updatePin', listener: () => void): this;
16
+ }
17
+ export declare class NIMTalkEx extends ev.EventEmitter {
18
+ talkex: NIMTalkExAPI;
19
+ constructor();
20
+ /** 注册全局回调 */
21
+ initEventHandlers(): void;
22
+ /** 添加收藏
23
+ * @param collect_info 收藏内容
24
+ * @param cb 执行结果回调函数
25
+ * @return void 无返回值
26
+ */
27
+ addCollect(collect_info: CollectInfo, cb: AddCollectCallback): void;
28
+ /** 批量删除收藏
29
+ * @param collect_list 要删除的收藏列表
30
+ * @param cb 执行结果回调函数
31
+ * @return void 无返回值
32
+ */
33
+ removeCollects(collect_list: RemoveCollectsParm, cb: RemoveCollectsCallback): void;
34
+ /** 更新收藏扩展字段
35
+ * @param collect_match_param 根据收藏的id 与 create time去匹配收藏内容
36
+ * @param ext 收藏的扩展字段内容
37
+ * @param cb 执行结果回调函数
38
+ * @return void 无返回值
39
+ */
40
+ updateCollectExt(collect_match_param: MatchCollectParm, ext: string, cb: UpdateCollectCallback): void;
41
+ /** 分页查询收藏列表
42
+ * @param query_collect_list_param 查询参数
43
+ * @param cb 执行结果回调函数
44
+ * @return void 无返回值
45
+ */
46
+ queryCollectList(query_collect_list_param: QueryCollectsParm, cb: QueryCollectsCallback): void;
47
+ /** 添加快捷回复
48
+ * @param msg 被回复的消息
49
+ * @param info 回复的内容及设置
50
+ * @param cb 执行结果回调函数
51
+ * @return void 无返回值
52
+ */
53
+ addQuickComment(msg: IMMessage, info: QuickCommentInfo, cb: AddQuickCommentCallback): void;
54
+ /** 删除快捷回复
55
+ * @param msg 被删除的消息
56
+ * @param param 删除设置
57
+ * @param cb 执行结果回调函数
58
+ * @return void 无返回值
59
+ */
60
+ removeQuickComment(msg: IMMessage, param: RemoveQuickCommentParam, cb: RemoveQuickCommentCallback): void;
61
+ /** 查询快捷回复
62
+ * @param query_param 查询参数,一次最多只能查询20条消息的快捷回复
63
+ * @param cb 执行结果回调函数
64
+ * @return void 无返回值
65
+ */
66
+ queryQuickCommentList(query_param: QueryQuickCommentsParam, cb: QueryQuickCommentCallback): void;
67
+ /** Pin某条消息
68
+ * @param msg 要Pin的消息
69
+ * @param pin_info Pin的内容 只需赋值 ext参数,其它参数SDK来补充
70
+ * @param cb 执行结果回调函数
71
+ * @return void 无返回值
72
+ */
73
+ addPinMessage(msg: IMMessage, info: PinMessageInfo, cb: PinMessageCallback): void;
74
+ /** 取消Pin某条消息
75
+ * @param modify_param UnPin Message 参数
76
+ * @param cb 执行结果回调函数
77
+ * @return void 无返回值
78
+ */
79
+ unPinMessage(modify_param: ModifyPinMessageParam, cb: UnPinMessageCallback): void;
80
+ /** 更新 Pin Message ext字段
81
+ * @param modify_param 更新 Pin Message 参数
82
+ * @param cb 执行结果回调函数
83
+ * @return void 无返回值
84
+ */
85
+ updatePinMessage(modify_param: ModifyPinMessageParam, cb: UpdatePinMessageCallback): void;
86
+ /** 查询会话的所有 Pin Message
87
+ * @param session 会话ID
88
+ * @param to_type 会话类型
89
+ * @param cb 执行结果回调函数
90
+ * @return void 无返回值
91
+ */
92
+ queryAllPinMessage(session: string, to_type: number, cb: QueryPinMessageCallback): void;
93
+ }