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
@@ -18,7 +18,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
18
18
  /** 注册全局回调 */
19
19
  initEventHandlers(): void;
20
20
  /** 查询置顶会话列表
21
- * @param cb 置顶会话列表查询结果的回调函数
21
+ * @param cb 置顶会话列表查询结果的回调函数
22
22
  * @return void 无返回值
23
23
  * @note
24
24
  * <pre>
@@ -27,10 +27,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
27
27
  */
28
28
  queryStickTopSessionList(cb: QueryStickTopSessionListCallback | null): Promise<[NIMResCode, string]>;
29
29
  /** 设置置顶会话
30
- * @param session_id 会话id
31
- * @param to_type 会话类型
32
- * @param ext 扩展字段
33
- * @param cb 置顶会话设置结果的回调函数
30
+ * @param session_id 会话id
31
+ * @param to_type 会话类型
32
+ * @param ext 扩展字段
33
+ * @param cb 置顶会话设置结果的回调函数
34
34
  * @return void 无返回值
35
35
  * @note
36
36
  * <pre>
@@ -39,10 +39,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
39
39
  */
40
40
  setToStickTopSession(session_id: string, to_type: number, ext: string, cb: SetToStickTopSessionCallback | null): Promise<[NIMResCode, string]>;
41
41
  /** 更新置顶会话列表
42
- * @param session_id 会话id
43
- * @param to_type 会话类型
44
- * @param ext 扩展字段
45
- * @param cb 更新置顶会话设置结果的回调函数
42
+ * @param session_id 会话id
43
+ * @param to_type 会话类型
44
+ * @param ext 扩展字段
45
+ * @param cb 更新置顶会话设置结果的回调函数
46
46
  * @return void 无返回值
47
47
  * @note
48
48
  * <pre>
@@ -51,9 +51,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
51
51
  */
52
52
  updateToStickTopSession(session_id: string, to_type: number, ext: string, cb: UpdateStickTopSessionCallback | null): Promise<[NIMResCode, string]>;
53
53
  /** 取消置顶会话列表
54
- * @param session_id 会话id
55
- * @param to_type 会话类型
56
- * @param cb 取消置顶会话设置结果的回调函数
54
+ * @param session_id 会话id
55
+ * @param to_type 会话类型
56
+ * @param cb 取消置顶会话设置结果的回调函数
57
57
  * @return void 无返回值
58
58
  * @note
59
59
  * <pre>
@@ -62,24 +62,24 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
62
62
  */
63
63
  cancelToStickTopSession(session_id: string, to_type: number, cb: CancelToStickTopSessionCallback | null): Promise<[NIMResCode, string, NIMSessionType]>;
64
64
  /** 查询指定数量的最后会话数据
65
- * @param limit 要返回的最大数量
66
- * @param cb 查询会话列表的回调函数
65
+ * @param limit 要返回的最大数量
66
+ * @param cb 查询会话列表的回调函数
67
67
  * @param jsonExtension json扩展参数(备用,目前不需要)
68
68
  * @return void 无返回值
69
69
  */
70
70
  queryLastFewSessionAsync(limit: number, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionDataList]>;
71
71
  /** 查询会话列表,可指定最后一条会话消息要排除掉的类型(列表)
72
72
  * @param msg_excluded_type_list 最后一条会话消息要排除掉的类型(列表),如果不排除任何消息,传入空列表
73
- * @param cb 查询会话列表的回调函数
73
+ * @param cb 查询会话列表的回调函数
74
74
  * @param jsonExtension json扩展参数(备用,目前不需要)
75
75
  * @return void 无返回值
76
76
  */
77
- queryAllRecentSessionAsync(msg_excluded_type_list: Array<NIMMessageType>, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[number, SessionDataList]>;
77
+ queryAllRecentSessionAsync(msg_excluded_type_list: Array<NIMMessageType>, cb: QuerySessionListCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionDataList]>;
78
78
  /** 删除最近联系人
79
- * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
80
- * @param id 对方的account id或者群组tid。
79
+ * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
80
+ * @param id 对方的account id或者群组tid。
81
81
  * @param delete_roaming 是否同时删除漫游消息
82
- * @param cb 最近会话列表项变更的回调函数
82
+ * @param cb 最近会话列表项变更的回调函数
83
83
  * @return boolean 检查参数如果不符合要求则返回失败
84
84
  * @note
85
85
  * <pre>
@@ -89,7 +89,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
89
89
  deleteRecentSession(type: NIMSessionType, id: string, cb: SessionChangeCallback | null, delete_roaming: boolean): Promise<[NIMResCode, SessionData, number]>;
90
90
  /** 删除全部最近联系人
91
91
  * @param jsonExtension json扩展参数(备用,目前不需要)
92
- * @param cb 最近会话列表项变更的回调函数
92
+ * @param cb 最近会话列表项变更的回调函数
93
93
  * @return void 无返回值
94
94
  * @note
95
95
  * <pre>
@@ -98,10 +98,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
98
98
  */
99
99
  deleteAllRecentSession(cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number]>;
100
100
  /** 删除某会话的漫游消息
101
- * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
102
- * @param id 对方的account id或者群组tid。
101
+ * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
102
+ * @param id 对方的account id或者群组tid。
103
103
  * @param jsonExtension json扩展参数(备用,目前不需要)
104
- * @param cb 删除结果 回调回调函数
104
+ * @param cb 删除结果 回调回调函数
105
105
  * @return boolean 检查参数如果不符合要求则返回失败
106
106
  * @note
107
107
  * <pre>
@@ -110,10 +110,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
110
110
  */
111
111
  deleteSessionRoamingMessage(to_type: number, session_id: string, cb: DeleteSessionRoamingMessageCallback | null, ext: string): Promise<[NIMResCode, number, string]>;
112
112
  /** 最近联系人项未读数清零
113
- * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
114
- * @param id 对方的account id或者群组tid。
113
+ * @param to_type 会话类型,双人0,群组1 (nim_msglog_def.h)
114
+ * @param id 对方的account id或者群组tid。
115
115
  * @param jsonExtension json扩展参数(备用,目前不需要)
116
- * @param cb 最近会话列表项变更的回调函数
116
+ * @param cb 最近会话列表项变更的回调函数
117
117
  * @return boolean 检查参数如果不符合要求则返回失败
118
118
  * @note
119
119
  * <pre>
@@ -122,9 +122,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
122
122
  */
123
123
  setUnreadCountZeroAsync(type: NIMSessionType, id: string, cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
124
124
  /** 最近联系人项未读数清零
125
- * @param is_super_team 会话列表中的会话是否是超大群会话
126
- * @param zero_list 清零的会话信息列表。
127
- * @param cb 最近会话列表项变更的回调函数
125
+ * @param is_super_team 会话列表中的会话是否是超大群会话
126
+ * @param zero_list 清零的会话信息列表。
127
+ * @param cb 最近会话列表项变更的回调函数
128
128
  * @return boolean 检查参数如果不符合要求则返回失败
129
129
  * @note
130
130
  * <pre>
@@ -133,10 +133,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
133
133
  */
134
134
  setMultiUnreadCountZeroAsync(is_super_team: boolean, zero_list: Array<MultiUnreadCountZeroInfo>, cb: SetMultiUnreadCountZeroAsyncCallback | null): Promise<[NIMResCode, Array<SessionData>, number] | null>;
135
135
  /** 设置会话项是否置顶(置顶属性只保存在本地)
136
- * @param to_type 会话类型
137
- * @param id 对方的account id或者群组tid。
138
- * @param top true - 置顶 false - 取消置顶
139
- * @param cb 回调函数
136
+ * @param to_type 会话类型
137
+ * @param id 对方的account id或者群组tid。
138
+ * @param top true - 置顶 false - 取消置顶
139
+ * @param cb 回调函数
140
140
  * @param jsonExtension json扩展参数(备用,目前不需要)
141
141
  * @return boolean 检查参数如果不符合要求则返回失败
142
142
  * @note
@@ -146,10 +146,10 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
146
146
  */
147
147
  setSessionTop(type: NIMSessionType, id: string, top: boolean, cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
148
148
  /** 设置会话项扩展数据(扩展数据只保存在本地)
149
- * @param to_type 会话类型
150
- * @param id 对方的account id或者群组tid。
151
- * @param data 扩展数据,建议使用灵活可扩展的数据结构,例如Json
152
- * @param cb 回调函数
149
+ * @param to_type 会话类型
150
+ * @param id 对方的account id或者群组tid。
151
+ * @param data 扩展数据,建议使用灵活可扩展的数据结构,例如Json
152
+ * @param cb 回调函数
153
153
  * @param jsonExtension json扩展参数(备用,目前不需要)
154
154
  * @return boolean 检查参数如果不符合要求则返回失败
155
155
  * @note
@@ -160,7 +160,7 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
160
160
  setSessionExtendData(type: NIMSessionType, id: string, data: string, cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
161
161
  /** 最近联系人项全部未读数清零
162
162
  * @param jsonExtension json扩展参数(备用,目前不需要)
163
- * @param cb 最近会话列表项变更的回调函数
163
+ * @param cb 最近会话列表项变更的回调函数
164
164
  * @return boolean 检查参数如果不符合要求则返回失败
165
165
  * @note
166
166
  * <pre>
@@ -169,9 +169,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
169
169
  */
170
170
  setAllUnreadCountZeroAsync(cb: SessionChangeCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData, number] | null>;
171
171
  /** 根据给定的id查询相应会话的信息
172
- * @param to_type 会话类型
173
- * @param id 对方的account id或者群组tid。
174
- * @param cb 会话信息查询结果的回调函数
172
+ * @param to_type 会话类型
173
+ * @param id 对方的account id或者群组tid。
174
+ * @param cb 会话信息查询结果的回调函数
175
175
  * @param jsonExtension json扩展参数(备用,目前不需要)
176
176
  * @return void 无返回值
177
177
  * @note
@@ -181,9 +181,9 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
181
181
  */
182
182
  querySessionDataById(type: NIMSessionType, id: string, cb: QuerySessionDataCallback | null, jsonExtension: string): Promise<[NIMResCode, SessionData]>;
183
183
  /** 查询会话是漫游消息未拉取信息
184
- * @param session_id 会话id
185
- * @param to_type 会话类型
186
- * @param cb 查询会话是漫游消息未拉取信息回调函数
184
+ * @param session_id 会话id
185
+ * @param to_type 会话类型
186
+ * @param cb 查询会话是漫游消息未拉取信息回调函数
187
187
  * @return void 无返回值
188
188
  * @note
189
189
  * <pre>
@@ -192,20 +192,20 @@ export declare class NIMSession extends EventEmitter<NIMSessionEvents> {
192
192
  */
193
193
  queryHasmoreRoammsg(session_id: string, to_type: number, cb: QueryHasmoreRoammsgCallback | null): Promise<[NIMResCode, SessionRoamMsgHasMoreTagInfo]>;
194
194
  /** 查询所有漫游消息未拉取完全的会话
195
- * @param cb 结果回调
195
+ * @param cb 结果回调
196
196
  * @return void 无返回值
197
197
  */
198
198
  queryAllHasmoreRoammsg(cb: QueryAllHasmoreRoammsgCallback | null): Promise<[NIMResCode, Array<SessionRoamMsgHasMoreTagInfo>]>;
199
199
  /** 更新会话是漫游消息未拉取信息
200
- * @param msg 对应的消息内容
201
- * @param cb 结果回调
200
+ * @param msg 对应的消息内容
201
+ * @param cb 结果回调
202
202
  * @return void 无返回值
203
203
  */
204
204
  updateHasmoreRoammsg(msg: IMMessage, cb: UpdateHasmoreRoammsgCallback | null): Promise<[NIMResCode]>;
205
205
  /** 删除会话是漫游消息未拉取信息
206
- * @param session_id 会话id
207
- * @param to_type 会话类型
208
- * @param cb 结果回调
206
+ * @param session_id 会话id
207
+ * @param to_type 会话类型
208
+ * @param cb 结果回调
209
209
  * @return void 无返回值
210
210
  */
211
211
  deleteHasmoreRoammsg(session_id: string, to_type: NIMSessionType, cb: DeleteHasmoreRoammsgCallback | null): Promise<[NIMResCode]>;
@@ -13,8 +13,8 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
13
13
  /** 注册全局回调 */
14
14
  initEventHandlers(): void;
15
15
  /** 发布事件
16
- * @param event_data 事件
17
- * @param cb 发布事件回调函数
16
+ * @param event_data 事件
17
+ * @param cb 发布事件回调函数
18
18
  * @param jsonExtension json扩展参数(备用,目前不需要)
19
19
  * @return boolean 检查参数如果不符合要求则返回失败
20
20
  * @note
@@ -28,11 +28,11 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
28
28
  */
29
29
  publish(data: EventData, cb: PublishEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number, EventData] | null>;
30
30
  /** 订阅事件
31
- * @param event_type 事件类型
32
- * @param ttl 订阅有效期,单位:秒,范围:60s到30天
33
- * @param sync_type 订阅后是否立即同步最新事件
34
- * @param accid_list 要订阅的用户列表
35
- * @param cb 订阅事件回调函数
31
+ * @param event_type 事件类型
32
+ * @param ttl 订阅有效期,单位:秒,范围:60s到30天
33
+ * @param sync_type 订阅后是否立即同步最新事件
34
+ * @param accid_list 要订阅的用户列表
35
+ * @param cb 订阅事件回调函数
36
36
  * @param jsonExtension json扩展参数(备用,目前不需要)
37
37
  * @return boolean 检查参数如果不符合要求则返回失败
38
38
  * @note
@@ -44,9 +44,9 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
44
44
  */
45
45
  subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number, Array<string>] | null>;
46
46
  /** 按账号取消指定事件的订阅关系
47
- * @param event_type 事件类型
48
- * @param accid_list 要取消订阅的用户列表
49
- * @param cb 取消订阅事件回调函数
47
+ * @param event_type 事件类型
48
+ * @param accid_list 要取消订阅的用户列表
49
+ * @param cb 取消订阅事件回调函数
50
50
  * @param jsonExtension json扩展参数(备用,目前不需要)
51
51
  * @return boolean 检查参数如果不符合要求则返回失败
52
52
  * @note
@@ -58,8 +58,8 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
58
58
  */
59
59
  unSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number, Array<string>] | null>;
60
60
  /** 取消指定事件的全部订阅关系
61
- * @param event_type 事件类型
62
- * @param cb 取消订阅事件回调函数
61
+ * @param event_type 事件类型
62
+ * @param cb 取消订阅事件回调函数
63
63
  * @param jsonExtension json扩展参数(备用,目前不需要)
64
64
  * @return boolean 检查参数如果不符合要求则返回失败
65
65
  * @note
@@ -71,9 +71,9 @@ export declare class NIMSubscribeEvent extends EventEmitter<NIMSubscribeEventEve
71
71
  */
72
72
  batchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback | null, jsonExtension: string): Promise<[NIMResCode, number] | null>;
73
73
  /** 按账号查询指定事件订阅关系
74
- * @param event_type 事件类型
75
- * @param accid_list 要查询订阅关系的用户列表
76
- * @param cb 查询订阅关系回调函数
74
+ * @param event_type 事件类型
75
+ * @param accid_list 要查询订阅关系的用户列表
76
+ * @param cb 查询订阅关系回调函数
77
77
  * @param jsonExtension json扩展参数(备用,目前不需要)
78
78
  * @return boolean 检查参数如果不符合要求则返回失败
79
79
  * @note
@@ -10,12 +10,12 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
10
10
  /** 注册全局回调 */
11
11
  initEventHandlers(): void;
12
12
  /** 邀请
13
- * @param tid 群组id
14
- * @param ids 邀请对象id
13
+ * @param tid 群组id
14
+ * @param ids 邀请对象id
15
15
  * @param invitation_postscript 邀请附言
16
16
  * @param invitation_attachment 用户可自定义的补充邀请信息
17
17
  * @param jsonExtension json扩展参数(备用,目前不需要)
18
- * @param cb 邀请的回调函数
18
+ * @param cb 邀请的回调函数
19
19
  * @return boolean 检查参数如果不符合要求则返回失败
20
20
  * @note
21
21
  * <pre>
@@ -29,10 +29,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
29
29
  */
30
30
  inviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
31
31
  /** 踢人
32
- * @param tid 群组id
33
- * @param ids 被踢对象id
32
+ * @param tid 群组id
33
+ * @param ids 被踢对象id
34
34
  * @param jsonExtension json扩展参数(备用,目前不需要)
35
- * @param cb 踢人的回调函数
35
+ * @param cb 踢人的回调函数
36
36
  * @return boolean 检查参数如果不符合要求则返回失败
37
37
  * @note
38
38
  * <pre>
@@ -46,9 +46,9 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
46
46
  */
47
47
  kickAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
48
48
  /** 离开群
49
- * @param tid 群组id
49
+ * @param tid 群组id
50
50
  * @param jsonExtension json扩展参数(备用,目前不需要)
51
- * @param cb 离开群的回调函数
51
+ * @param cb 离开群的回调函数
52
52
  * @return boolean 检查参数如果不符合要求则返回失败
53
53
  * @note
54
54
  * <pre>
@@ -61,10 +61,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
61
61
  */
62
62
  leaveAsync(tid: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
63
63
  /** 更新群信息
64
- * @param tid 群组id
65
- * @param team_info 群组信息
64
+ * @param tid 群组id
65
+ * @param team_info 群组信息
66
66
  * @param jsonExtension json扩展参数(备用,目前不需要)
67
- * @param cb 更新群信息的回调函数
67
+ * @param cb 更新群信息的回调函数
68
68
  * @return boolean 检查参数如果不符合要求则返回失败
69
69
  * @note
70
70
  * <pre>
@@ -75,10 +75,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
75
75
  */
76
76
  updateSuperTeamInfoAsync(tid: string, info: SuperTeamInfo, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
77
77
  /** 申请入群
78
- * @param tid 群组id
79
- * @param reason 附言
78
+ * @param tid 群组id
79
+ * @param reason 附言
80
80
  * @param jsonExtension json扩展参数(备用,目前不需要)
81
- * @param cb 申请入群的回调函数
81
+ * @param cb 申请入群的回调函数
82
82
  * @return boolean 检查参数如果不符合要求则返回失败
83
83
  * @note
84
84
  * <pre>
@@ -93,10 +93,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
93
93
  */
94
94
  applyJoinAsync(tid: string, reason: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
95
95
  /** 同意入群申请
96
- * @param tid 群组id
97
- * @param applicant_id 申请者id
96
+ * @param tid 群组id
97
+ * @param applicant_id 申请者id
98
98
  * @param jsonExtension json扩展参数(备用,目前不需要)
99
- * @param cb 同意入群申请的回调函数
99
+ * @param cb 同意入群申请的回调函数
100
100
  * @return boolean 检查参数如果不符合要求则返回失败
101
101
  * @note
102
102
  * <pre>
@@ -111,11 +111,11 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
111
111
  */
112
112
  passJoinApplyAsync(tid: string, applicantId: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
113
113
  /** 拒绝入群申请
114
- * @param tid 群组id
115
- * @param applicant_id 申请者id
116
- * @param reason 附言
114
+ * @param tid 群组id
115
+ * @param applicant_id 申请者id
116
+ * @param reason 附言
117
117
  * @param jsonExtension json扩展参数(备用,目前不需要)
118
- * @param cb 拒绝入群申请的回调函数
118
+ * @param cb 拒绝入群申请的回调函数
119
119
  * @return boolean 检查参数如果不符合要求则返回失败
120
120
  * @note
121
121
  * <pre>
@@ -128,10 +128,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
128
128
  */
129
129
  rejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
130
130
  /** 添加管理员
131
- * @param tid 群组id
132
- * @param ids 管理员id
131
+ * @param tid 群组id
132
+ * @param ids 管理员id
133
133
  * @param jsonExtension json扩展参数(备用,目前不需要)
134
- * @param cb 添加管理员的回调函数
134
+ * @param cb 添加管理员的回调函数
135
135
  * @return boolean 检查参数如果不符合要求则返回失败
136
136
  * @note
137
137
  * <pre>
@@ -143,10 +143,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
143
143
  */
144
144
  addManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
145
145
  /** 删除管理员
146
- * @param tid 群组id
147
- * @param ids 管理员id
146
+ * @param tid 群组id
147
+ * @param ids 管理员id
148
148
  * @param jsonExtension json扩展参数(备用,目前不需要)
149
- * @param cb 删除管理员的回调函数
149
+ * @param cb 删除管理员的回调函数
150
150
  * @return boolean 检查参数如果不符合要求则返回失败
151
151
  * @note
152
152
  * <pre>
@@ -158,11 +158,11 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
158
158
  */
159
159
  removeManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
160
160
  /** 移交群主
161
- * @param tid 群组id
162
- * @param new_owner_id 移交对象id
163
- * @param is_leave 是否同时退出群
161
+ * @param tid 群组id
162
+ * @param new_owner_id 移交对象id
163
+ * @param is_leave 是否同时退出群
164
164
  * @param jsonExtension json扩展参数(备用,目前不需要)
165
- * @param cb 移交群主的回调函数
165
+ * @param cb 移交群主的回调函数
166
166
  * @return boolean 检查参数如果不符合要求则返回失败
167
167
  * @note
168
168
  * <pre>
@@ -175,9 +175,9 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
175
175
  */
176
176
  transferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
177
177
  /** 更新自己的群属性
178
- * @param prop 群成员属性
178
+ * @param prop 群成员属性
179
179
  * @param jsonExtension json扩展参数(备用,目前不需要)
180
- * @param cb 更新自己的群属性的回调函数
180
+ * @param cb 更新自己的群属性的回调函数
181
181
  * @return boolean 检查参数如果不符合要求则返回失败
182
182
  * @note
183
183
  * <pre>
@@ -202,9 +202,9 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
202
202
  */
203
203
  removeTeamMembersFollow(tid: string, account_ids: Array<string>, cb: SuperTeamEventCallback): Promise<[SuperTeamEvent] | null>;
204
204
  /** 修改别人的群昵称
205
- * @param prop 群成员属性
205
+ * @param prop 群成员属性
206
206
  * @param jsonExtension json扩展参数(备用,目前不需要)
207
- * @param cb 修改别人的群昵称的回调函数
207
+ * @param cb 修改别人的群昵称的回调函数
208
208
  * @return boolean 检查参数如果不符合要求则返回失败
209
209
  * @note
210
210
  * <pre>
@@ -217,10 +217,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
217
217
  */
218
218
  updateOtherNickAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
219
219
  /** 接受邀请
220
- * @param tid 群组id
221
- * @param invitor_id 邀请者id
220
+ * @param tid 群组id
221
+ * @param invitor_id 邀请者id
222
222
  * @param jsonExtension json扩展参数(备用,目前不需要)
223
- * @param cb 接受邀请的回调函数
223
+ * @param cb 接受邀请的回调函数
224
224
  * @return boolean 检查参数如果不符合要求则返回失败
225
225
  * @note
226
226
  * <pre>
@@ -232,11 +232,11 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
232
232
  */
233
233
  acceptInvitationAsync(tid: string, inviterId: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
234
234
  /** 拒绝邀请
235
- * @param tid 群组id
236
- * @param invitor_id 邀请者id
237
- * @param reason 附言
235
+ * @param tid 群组id
236
+ * @param invitor_id 邀请者id
237
+ * @param reason 附言
238
238
  * @param jsonExtension json扩展参数(备用,目前不需要)
239
- * @param cb 拒绝邀请的回调函数
239
+ * @param cb 拒绝邀请的回调函数
240
240
  * @return boolean 检查参数如果不符合要求则返回失败
241
241
  * @note
242
242
  * <pre>
@@ -249,26 +249,26 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
249
249
  rejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
250
250
  /** 查询所有群
251
251
  * @param jsonExtension json扩展参数(备用,目前不需要)
252
- * @param cb 查询所有群的回调函数
252
+ * @param cb 查询所有群的回调函数
253
253
  * @return void 无返回值
254
254
  */
255
255
  queryAllMySuperTeamsAsync(cb: QueryAllMySuperTeamsCallback | null, jsonExtension: string): Promise<[number, Array<string>]>;
256
256
  /** 查询所有群信息
257
257
  * @param jsonExtension json扩展参数(备用,目前不需要)
258
- * @param cb 查询所有群信息的回调函数
258
+ * @param cb 查询所有群信息的回调函数
259
259
  * @return void 无返回值
260
260
  */
261
261
  queryAllMySuperTeamsInfoAsync(cb: QueryAllMySuperTeamsInfoCallback | null, jsonExtension: string): Promise<[number, Array<SuperTeamInfo>]>;
262
262
  /** 查询所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)
263
263
  * @param jsonExtension json扩展参数(备用,目前不需要)
264
- * @param cb 查询所有群里我的成员信息的回调函数
264
+ * @param cb 查询所有群里我的成员信息的回调函数
265
265
  * @return void 无返回值
266
266
  */
267
267
  queryMyAllMemberInfosAsync(cb: QuerySuperTeamMyAllMemberInfosCallback | null, jsonExtension: string): Promise<[number, Array<SuperTeamMemberProperty>]>;
268
268
  /** 查询群成员
269
- * @param tid 群组id
269
+ * @param tid 群组id
270
270
  * @param jsonExtension json扩展参数(备用,目前不需要)
271
- * @param cb 查询群成员的回调函数
271
+ * @param cb 查询群成员的回调函数
272
272
  * @return boolean 检查参数如果不符合要求则返回失败
273
273
  * @note
274
274
  * <pre>
@@ -279,24 +279,24 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
279
279
  */
280
280
  querySuperTeamMembersAsync(tid: string, cb: QuerySuperTeamMembersCallback | null, jsonExtension: string): Promise<[number, string, number, Array<SuperTeamMemberProperty>] | null>;
281
281
  /** 查询(单个)群成员信息
282
- * @param tid 群组id
283
- * @param id 群成员id
282
+ * @param tid 群组id
283
+ * @param id 群成员id
284
284
  * @param jsonExtension json扩展参数(备用,目前不需要)
285
- * @param cb 查询群成员的回调函数
285
+ * @param cb 查询群成员的回调函数
286
286
  * @return boolean 检查参数如果不符合要求则返回失败
287
287
  */
288
288
  querySuperTeamMemberAsync(tid: string, id: string, cb: QuerySuperTeamMemberCallback | null, jsonExtension: string): Promise<[SuperTeamMemberProperty]>;
289
289
  /** 查询群信息
290
- * @param tid 群组id
290
+ * @param tid 群组id
291
291
  * @param jsonExtension json扩展参数(备用,目前不需要)
292
- * @param cb 查询群信息的回调函数
292
+ * @param cb 查询群信息的回调函数
293
293
  * @return boolean 检查参数如果不符合要求则返回失败
294
294
  */
295
295
  querySuperTeamInfoAsync(tid: string, cb: QuerySuperTeamInfoCallback | null, jsonExtension: string): Promise<[string, SuperTeamInfo] | null>;
296
296
  /** 获取群信息(从服务器获取)
297
- * @param tid 群组id
297
+ * @param tid 群组id
298
298
  * @param jsonExtension json扩展参数(备用,目前不需要)
299
- * @param cb 获取群信息的回调函数
299
+ * @param cb 获取群信息的回调函数
300
300
  * @return boolean 检查参数如果不符合要求则返回失败
301
301
  * @note
302
302
  * <pre>
@@ -306,11 +306,11 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
306
306
  */
307
307
  querySuperTeamInfoOnlineAsync(tid: string, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
308
308
  /** 禁言/解除禁言
309
- * @param tid 群组id
310
- * @param member_id 操作对象id
311
- * @param set_mute 禁言/解除禁言
309
+ * @param tid 群组id
310
+ * @param member_id 操作对象id
311
+ * @param set_mute 禁言/解除禁言
312
312
  * @param jsonExtension json扩展参数(备用,目前不需要)
313
- * @param cb 踢人的回调函数
313
+ * @param cb 踢人的回调函数
314
314
  * @return boolean 检查参数如果不符合要求则返回失败
315
315
  * @note
316
316
  * <pre>
@@ -323,10 +323,10 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
323
323
  */
324
324
  muteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: SuperTeamEventCallback | null, jsonExtension: string): Promise<[SuperTeamEvent] | null>;
325
325
  /** 群禁言/解除群禁言
326
- * @param tid 群组id
327
- * @param set_mute 禁言/解除禁言
326
+ * @param tid 群组id
327
+ * @param set_mute 禁言/解除禁言
328
328
  * @param jsonExtension json扩展参数(备用,目前不需要)
329
- * @param cb 踢人的回调函数
329
+ * @param cb 踢人的回调函数
330
330
  * @return boolean 检查参数如果不符合要求则返回失败
331
331
  * @note
332
332
  * <pre>
@@ -338,7 +338,7 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
338
338
  /** 查询所有群信息
339
339
  * @param keyword 要查询的关键字
340
340
  * @param jsonExtension json扩展参数(备用,目前不需要)
341
- * @param cb 查询所有群信息的回调函数
341
+ * @param cb 查询所有群信息的回调函数
342
342
  * @return boolean 检查参数如果不符合要求则返回失败
343
343
  */
344
344
  querySuperTeamsInfoByKeywordAsync(keyword: string, cb: QueryAllMySuperTeamsInfoCallback | null, jsonExtension: string): Promise<[number, Array<SuperTeamInfo>]>;
@@ -348,7 +348,7 @@ export declare class NIMSuperTeam extends EventEmitter<NIMSuperTeamEvents> {
348
348
  */
349
349
  searchTeamMembers(option: SuperTeamMemberKeywordSearchOption): Promise<[SuperTeamMemberSerachResult]>;
350
350
  /** 根据成员类型获取群成员
351
- * @param tid 群组id
351
+ * @param tid 群组id
352
352
  * @param option 获取群成员选项
353
353
  * @return boolean 检查参数如果不符合要求则返回失败
354
354
  */