node-nim 9.2.8-rc.1 → 9.3.0-rc.2

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 (215) hide show
  1. package/README.md +74 -39
  2. package/dist/chatroom/chatroom.js +253 -0
  3. package/dist/chatroom/chatroom.js.map +1 -0
  4. package/dist/chatroom_def/chatroom_def.js +120 -0
  5. package/dist/chatroom_def/chatroom_def.js.map +1 -0
  6. package/{js → dist}/loader.js +0 -0
  7. package/{js → dist}/loader.js.map +0 -0
  8. package/{js/api → dist/nim}/client.js +46 -8
  9. package/dist/nim/client.js.map +1 -0
  10. package/{js/api → dist/nim}/data_sync.js +2 -2
  11. package/dist/nim/data_sync.js.map +1 -0
  12. package/{js/api → dist/nim}/friend.js +62 -12
  13. package/dist/nim/friend.js.map +1 -0
  14. package/{js/api → dist/nim}/global.js +50 -8
  15. package/dist/nim/global.js.map +1 -0
  16. package/{js/api → dist/nim}/msglog.js +271 -52
  17. package/dist/nim/msglog.js.map +1 -0
  18. package/{js/api → dist/nim}/nos.js +54 -13
  19. package/dist/nim/nos.js.map +1 -0
  20. package/{js/api → dist/nim}/online_session.js +34 -6
  21. package/dist/nim/online_session.js.map +1 -0
  22. package/{js/api → dist/nim}/pass_through_proxy.js +10 -3
  23. package/dist/nim/pass_through_proxy.js.map +1 -0
  24. package/{js/api → dist/nim}/plugin.js +18 -4
  25. package/dist/nim/plugin.js.map +1 -0
  26. package/{js/api → dist/nim}/session.js +171 -28
  27. package/dist/nim/session.js.map +1 -0
  28. package/{js/api → dist/nim}/subscribe_event.js +53 -12
  29. package/dist/nim/subscribe_event.js.map +1 -0
  30. package/{js/api → dist/nim}/super_team.js +253 -47
  31. package/dist/nim/super_team.js.map +1 -0
  32. package/{js/api → dist/nim}/sysmsg.js +80 -12
  33. package/dist/nim/sysmsg.js.map +1 -0
  34. package/{js/api → dist/nim}/talk.js +10 -3
  35. package/dist/nim/talk.js.map +1 -0
  36. package/dist/nim/talkex.js +192 -0
  37. package/dist/nim/talkex.js.map +1 -0
  38. package/{js/api → dist/nim}/team.js +363 -87
  39. package/dist/nim/team.js.map +1 -0
  40. package/{js/api → dist/nim}/tool.js +21 -5
  41. package/dist/nim/tool.js.map +1 -0
  42. package/{js/api → dist/nim}/user.js +84 -16
  43. package/dist/nim/user.js.map +1 -0
  44. package/{js/def → dist/nim_def}/client_def.js +0 -0
  45. package/dist/nim_def/client_def.js.map +1 -0
  46. package/{js/def → dist/nim_def}/data_sync_def.js +0 -0
  47. package/dist/nim_def/data_sync_def.js.map +1 -0
  48. package/{js/def → dist/nim_def}/doc_trans_def.js +0 -0
  49. package/dist/nim_def/doc_trans_def.js.map +1 -0
  50. package/{js/def → dist/nim_def}/friend_def.js +0 -0
  51. package/dist/nim_def/friend_def.js.map +1 -0
  52. package/{js/def → dist/nim_def}/global_def.js +0 -0
  53. package/dist/nim_def/global_def.js.map +1 -0
  54. package/{js/def → dist/nim_def}/msglog_def.js +1 -1
  55. package/dist/nim_def/msglog_def.js.map +1 -0
  56. package/{js/def → dist/nim_def}/nos_def.js +0 -0
  57. package/dist/nim_def/nos_def.js.map +1 -0
  58. package/{js/def → dist/nim_def}/online_session_def.js +0 -0
  59. package/dist/nim_def/online_session_def.js.map +1 -0
  60. package/{js/def → dist/nim_def}/pass_through_proxy_def.js +0 -0
  61. package/dist/nim_def/pass_through_proxy_def.js.map +1 -0
  62. package/{js/def → dist/nim_def}/plugin_def.js +0 -0
  63. package/{js/def → dist/nim_def}/plugin_def.js.map +1 -1
  64. package/{js/def → dist/nim_def}/session_def.js +0 -0
  65. package/dist/nim_def/session_def.js.map +1 -0
  66. package/{js/def → dist/nim_def}/subscribe_event_def.js +0 -0
  67. package/dist/nim_def/subscribe_event_def.js.map +1 -0
  68. package/{js/def → dist/nim_def}/super_team_def.js +0 -0
  69. package/dist/nim_def/super_team_def.js.map +1 -0
  70. package/{js/def → dist/nim_def}/sysmsg_def.js +0 -0
  71. package/dist/nim_def/sysmsg_def.js.map +1 -0
  72. package/{js/def → dist/nim_def}/talk_def.js +0 -0
  73. package/{js/def → dist/nim_def}/talk_def.js.map +1 -1
  74. package/{js/def → dist/nim_def}/talkex_def.js +0 -0
  75. package/{js/def → dist/nim_def}/talkex_def.js.map +1 -1
  76. package/{js/def → dist/nim_def}/team_def.js +0 -0
  77. package/dist/nim_def/team_def.js.map +1 -0
  78. package/{js/def → dist/nim_def}/tool_def.js +0 -0
  79. package/dist/nim_def/tool_def.js.map +1 -0
  80. package/{js/def → dist/nim_def}/user_def.js +0 -0
  81. package/dist/nim_def/user_def.js.map +1 -0
  82. package/dist/node-nim.js +98 -0
  83. package/dist/node-nim.js.map +1 -0
  84. package/dist/qchat/attachment.js +75 -0
  85. package/dist/qchat/attachment.js.map +1 -0
  86. package/dist/qchat/channel.js +402 -0
  87. package/dist/qchat/channel.js.map +1 -0
  88. package/dist/qchat/channel_category.js +249 -0
  89. package/dist/qchat/channel_category.js.map +1 -0
  90. package/dist/qchat/instance.js +94 -0
  91. package/dist/qchat/instance.js.map +1 -0
  92. package/dist/qchat/message.js +325 -0
  93. package/dist/qchat/message.js.map +1 -0
  94. package/dist/qchat/role.js +562 -0
  95. package/dist/qchat/role.js.map +1 -0
  96. package/dist/qchat/server.js +515 -0
  97. package/dist/qchat/server.js.map +1 -0
  98. package/dist/qchat/system_notification.js +96 -0
  99. package/dist/qchat/system_notification.js.map +1 -0
  100. package/dist/qchat_def/attachment_def.js +3 -0
  101. package/dist/qchat_def/attachment_def.js.map +1 -0
  102. package/dist/qchat_def/channel_def.js +3 -0
  103. package/dist/qchat_def/channel_def.js.map +1 -0
  104. package/dist/qchat_def/instance_def.js +3 -0
  105. package/dist/qchat_def/instance_def.js.map +1 -0
  106. package/dist/qchat_def/message_def.js +3 -0
  107. package/dist/qchat_def/message_def.js.map +1 -0
  108. package/dist/qchat_def/public_def.js +584 -0
  109. package/dist/qchat_def/public_def.js.map +1 -0
  110. package/dist/qchat_def/role_def.js +3 -0
  111. package/dist/qchat_def/role_def.js.map +1 -0
  112. package/dist/qchat_def/server_def.js +3 -0
  113. package/dist/qchat_def/server_def.js.map +1 -0
  114. package/dist/qchat_def/system_notification_def.js +3 -0
  115. package/dist/qchat_def/system_notification_def.js.map +1 -0
  116. package/package.json +7 -6
  117. package/script/download-sdk.mjs +17 -16
  118. package/types/chatroom/chatroom.d.ts +54 -0
  119. package/types/chatroom_def/chatroom_def.d.ts +419 -0
  120. package/types/{api → nim}/client.d.ts +22 -23
  121. package/types/nim/data_sync.d.ts +12 -0
  122. package/types/{api → nim}/friend.d.ts +17 -17
  123. package/types/{api → nim}/global.d.ts +13 -13
  124. package/types/{api → nim}/msglog.d.ts +62 -62
  125. package/types/{api → nim}/nos.d.ts +21 -21
  126. package/types/{api → nim}/online_session.d.ts +12 -12
  127. package/types/{api → nim}/pass_through_proxy.d.ts +8 -8
  128. package/types/{api → nim}/plugin.d.ts +8 -6
  129. package/types/{api → nim}/session.d.ts +40 -40
  130. package/types/{api → nim}/subscribe_event.d.ts +19 -19
  131. package/types/{api → nim}/super_team.d.ts +51 -52
  132. package/types/{api → nim}/sysmsg.d.ts +20 -20
  133. package/types/{api → nim}/talk.d.ts +19 -19
  134. package/types/{api → nim}/talkex.d.ts +29 -27
  135. package/types/{api → nim}/team.d.ts +89 -88
  136. package/types/{api → nim}/tool.d.ts +9 -7
  137. package/types/{api → nim}/user.d.ts +23 -23
  138. package/types/{def → nim_def}/client_def.d.ts +86 -86
  139. package/types/{def → nim_def}/data_sync_def.d.ts +0 -0
  140. package/types/{def → nim_def}/doc_trans_def.d.ts +0 -0
  141. package/types/{def → nim_def}/friend_def.d.ts +17 -16
  142. package/types/{def → nim_def}/global_def.d.ts +14 -13
  143. package/types/{def → nim_def}/msglog_def.d.ts +152 -141
  144. package/types/nim_def/nos_def.d.ts +72 -0
  145. package/types/{def → nim_def}/online_session_def.d.ts +15 -15
  146. package/types/{def → nim_def}/pass_through_proxy_def.d.ts +2 -1
  147. package/types/{def → nim_def}/plugin_def.d.ts +3 -2
  148. package/types/{def → nim_def}/session_def.d.ts +49 -48
  149. package/types/nim_def/subscribe_event_def.d.ts +83 -0
  150. package/types/{def → nim_def}/super_team_def.d.ts +34 -34
  151. package/types/{def → nim_def}/sysmsg_def.d.ts +25 -25
  152. package/types/{def → nim_def}/talk_def.d.ts +24 -24
  153. package/types/nim_def/talkex_def.d.ts +112 -0
  154. package/types/{def → nim_def}/team_def.d.ts +37 -37
  155. package/types/{def → nim_def}/tool_def.d.ts +7 -6
  156. package/types/{def → nim_def}/user_def.d.ts +22 -21
  157. package/types/node-nim.d.ts +53 -0
  158. package/types/qchat/attachment.d.ts +40 -0
  159. package/types/qchat/channel.d.ts +133 -0
  160. package/types/qchat/channel_category.d.ts +82 -0
  161. package/types/qchat/instance.d.ts +46 -0
  162. package/types/qchat/message.d.ts +110 -0
  163. package/types/qchat/role.d.ts +161 -0
  164. package/types/qchat/server.d.ts +168 -0
  165. package/types/qchat/system_notification.d.ts +39 -0
  166. package/types/qchat_def/attachment_def.d.ts +71 -0
  167. package/types/qchat_def/channel_def.d.ts +624 -0
  168. package/types/qchat_def/instance_def.d.ts +212 -0
  169. package/types/qchat_def/message_def.d.ts +477 -0
  170. package/types/qchat_def/public_def.d.ts +774 -0
  171. package/types/qchat_def/role_def.d.ts +430 -0
  172. package/types/qchat_def/server_def.d.ts +451 -0
  173. package/types/qchat_def/system_notification_def.d.ts +170 -0
  174. package/js/api/client.js.map +0 -1
  175. package/js/api/data_sync.js.map +0 -1
  176. package/js/api/friend.js.map +0 -1
  177. package/js/api/global.js.map +0 -1
  178. package/js/api/msglog.js.map +0 -1
  179. package/js/api/nos.js.map +0 -1
  180. package/js/api/online_session.js.map +0 -1
  181. package/js/api/pass_through_proxy.js.map +0 -1
  182. package/js/api/plugin.js.map +0 -1
  183. package/js/api/session.js.map +0 -1
  184. package/js/api/subscribe_event.js.map +0 -1
  185. package/js/api/super_team.js.map +0 -1
  186. package/js/api/sysmsg.js.map +0 -1
  187. package/js/api/talk.js.map +0 -1
  188. package/js/api/talkex.js +0 -115
  189. package/js/api/talkex.js.map +0 -1
  190. package/js/api/team.js.map +0 -1
  191. package/js/api/tool.js.map +0 -1
  192. package/js/api/user.js.map +0 -1
  193. package/js/def/client_def.js.map +0 -1
  194. package/js/def/data_sync_def.js.map +0 -1
  195. package/js/def/doc_trans_def.js.map +0 -1
  196. package/js/def/friend_def.js.map +0 -1
  197. package/js/def/global_def.js.map +0 -1
  198. package/js/def/msglog_def.js.map +0 -1
  199. package/js/def/nos_def.js.map +0 -1
  200. package/js/def/online_session_def.js.map +0 -1
  201. package/js/def/pass_through_proxy_def.js.map +0 -1
  202. package/js/def/session_def.js.map +0 -1
  203. package/js/def/subscribe_event_def.js.map +0 -1
  204. package/js/def/super_team_def.js.map +0 -1
  205. package/js/def/sysmsg_def.js.map +0 -1
  206. package/js/def/team_def.js.map +0 -1
  207. package/js/def/tool_def.js.map +0 -1
  208. package/js/def/user_def.js.map +0 -1
  209. package/js/nim.js +0 -72
  210. package/js/nim.js.map +0 -1
  211. package/types/api/data_sync.d.ts +0 -13
  212. package/types/def/nos_def.d.ts +0 -71
  213. package/types/def/subscribe_event_def.d.ts +0 -82
  214. package/types/def/talkex_def.d.ts +0 -111
  215. package/types/nim.d.ts +0 -36
@@ -0,0 +1,212 @@
1
+ import { NIMQChatClientType, NIMQChatLoginStatus, NIMQChatExchangeKeyEncryptionAlgorithm, NIMQChatCommEncryptionAlgorithm, NIMQChatHandShakeType, NIMQChatFCSAuthenticationType, NIMQChatLoginAuthType, NIMResCode } from './public_def';
2
+ /** @struct QChatCustomTokenResp 获取自定义token */
3
+ export interface QChatCustomTokenResp {
4
+ /** appkey */
5
+ appkey?: string;
6
+ /** accid */
7
+ accid?: string;
8
+ /** 自定义token */
9
+ token?: string;
10
+ }
11
+ /** @struct QChatLoginClientInfo 多端登录信息 */
12
+ export interface QChatLoginClientInfo {
13
+ /** 终端类型 */
14
+ client_type?: NIMQChatClientType;
15
+ /** 设备 ID */
16
+ device_id?: string;
17
+ /** 客户端 IP */
18
+ client_ip?: string;
19
+ /** 客户端端口 */
20
+ client_port?: number;
21
+ /** 会话 ID */
22
+ consid?: string;
23
+ /** 时间戳 */
24
+ timestamp?: number;
25
+ /** 自定义终端类型 */
26
+ custom_client_type?: number;
27
+ /** 自定义标签 */
28
+ custom_tag?: string;
29
+ /** 操作系统名称 */
30
+ os_name?: string;
31
+ }
32
+ /** @interface QChatKickedResp */
33
+ export interface QChatKickedResp {
34
+ /** 客户端类型 */
35
+ client_type?: number;
36
+ /** 被踢原因 */
37
+ kick_reason?: number;
38
+ /** 扩展字段 */
39
+ ext?: string;
40
+ /** 自定义客户端类型 */
41
+ custom_client_type?: number;
42
+ }
43
+ /** @interface QChatLoginStatusResp */
44
+ export interface QChatLoginStatusResp {
45
+ /** 登录状态 */
46
+ login_status?: NIMQChatLoginStatus;
47
+ }
48
+ /** @interface QChatMultispotLoginResp */
49
+ export interface QChatMultispotLoginResp {
50
+ /** 操作结果, 参考NIMResCode */
51
+ res_code?: NIMResCode;
52
+ /** 通知类型 1:登录 2:登出 */
53
+ notify_type?: number;
54
+ /** 客户端信息 */
55
+ client_info?: QChatLoginClientInfo;
56
+ }
57
+ /** @interface QChatLoginResp */
58
+ export interface QChatLoginResp {
59
+ /** 操作结果, 参考NIMResCode */
60
+ res_code?: NIMResCode;
61
+ /** 客户端信息 */
62
+ client_info?: QChatLoginClientInfo;
63
+ /** 其他客户端信息 */
64
+ other_clients?: Array<QChatLoginClientInfo>;
65
+ }
66
+ /** @interface QChatLogoutResp */
67
+ export interface QChatLogoutResp {
68
+ /** 操作结果, 参考NIMResCode */
69
+ res_code?: NIMResCode;
70
+ }
71
+ /** @interface QChatKickResp */
72
+ export interface QChatKickResp {
73
+ /** 操作结果, 参考NIMResCode */
74
+ res_code?: NIMResCode;
75
+ /** 被踢的设备id列表 */
76
+ kicked_device_ids?: Array<string>;
77
+ }
78
+ /** @interface QChatSDKLogResp */
79
+ export interface QChatSDKLogResp {
80
+ /** 日志内容 */
81
+ log_content?: string;
82
+ }
83
+ /** @interface QChatGetRTCTokenResp */
84
+ export interface QChatGetRTCTokenResp {
85
+ /** 操作结果, 参考NIMResCode */
86
+ res_code?: NIMResCode;
87
+ /** token */
88
+ token?: string;
89
+ /** ttl, 单位秒 */
90
+ ttl?: number;
91
+ }
92
+ /** 获取自定义token回调 */
93
+ export declare type CustomTokenCallback = (resp: QChatCustomTokenResp) => QChatCustomTokenResp;
94
+ /** 被踢回调 */
95
+ export declare type KickedCallback = (resp: QChatKickedResp) => void;
96
+ /** 登录状态回调 */
97
+ export declare type LoginStatusCallback = (resp: QChatLoginStatusResp) => void;
98
+ /** 多点登录回调 */
99
+ export declare type MultispotLoginCallback = (resp: QChatMultispotLoginResp) => void;
100
+ /** SDK系统日志回调模板 */
101
+ export declare type SDKLogCallback = (resp: QChatSDKLogResp) => void;
102
+ /** 登录回调 */
103
+ export declare type QChatLoginCallback = (resp: QChatLoginResp) => void;
104
+ /** 登出回调 */
105
+ export declare type QChatLogoutCallback = (resp: QChatLogoutResp) => void;
106
+ /** 踢掉自己其他端回调 */
107
+ export declare type KickCallback = (resp: QChatKickResp) => void;
108
+ /** 获取RTC频道token回调 */
109
+ export declare type GetRTCTokenCallback = (resp: QChatGetRTCTokenResp) => void;
110
+ /** @struct NIMQChatEncryptionConfiguration
111
+ * @brief 圈组协议加密配置
112
+ */
113
+ export interface QChatEncryptionConfiguration {
114
+ /** "交换密钥"协议加密算法 1(RSA),2(SM2) 非对称加密 */
115
+ nego_key_neca?: NIMQChatExchangeKeyEncryptionAlgorithm;
116
+ /** 通信加密算法 1(RC4),2(AES128),4(SM4) 对称加密 */
117
+ comm_neca?: NIMQChatCommEncryptionAlgorithm;
118
+ /** 握手协议类型 0:支持配置多种对称与非对称加密算法,1:只支持RAS + RC4 */
119
+ hand_shake_type?: NIMQChatHandShakeType;
120
+ /** "交换密钥"协议加密算法密钥, 为空使用默认值 */
121
+ nego_key_neca_key_parta?: string;
122
+ /** 非对称加密算法 key */
123
+ nego_key_neca_key_partb?: string;
124
+ /** 非对称加密算法的 key version */
125
+ nego_key_neca_key_version?: number;
126
+ }
127
+ /** @struct NIMQChatFCSConfiguration
128
+ * @brief 圈组云端数据存储配置信息
129
+ */
130
+ export interface QChatFCSConfiguration {
131
+ /** 缩略图宽度 */
132
+ thumbnail_width?: number;
133
+ /** 缩略图高度 */
134
+ thumbnail_height?: number;
135
+ /** 是否自动下载历史消息附件 */
136
+ auto_download_history_msg_attach_?: boolean;
137
+ /** 是否自动下载图片缩略图 */
138
+ auto_download_image_thumb?: boolean;
139
+ /** 是否自动下载视频缩略图 */
140
+ auto_download_video_thumb?: boolean;
141
+ /** 是否自动下载图片 */
142
+ auto_download_image?: boolean;
143
+ /** 是否自动下载音频 */
144
+ auto_download_audio?: boolean;
145
+ /** 是否自动下载视频 */
146
+ auto_download_video?: boolean;
147
+ /** 是否自动下载文件 */
148
+ auto_download_file?: boolean;
149
+ /** 下载附件类数据的鉴权方式 */
150
+ fcs_auth_type?: NIMQChatFCSAuthenticationType;
151
+ /** mock user-agent */
152
+ mock_ua?: string;
153
+ /** mock refer */
154
+ mock_refer?: string;
155
+ }
156
+ /** @interface QChatMessageCacheConfiguration */
157
+ export interface QChatMessageCacheConfiguration {
158
+ /** 是否开启缓存消息,默认不开启 */
159
+ enable_message_cache?: boolean;
160
+ }
161
+ /** @interface QChatInitParam */
162
+ export interface QChatInitParam {
163
+ /** APP数据存储路径,如果为空,则使用系统默认路径 */
164
+ app_data_path?: string;
165
+ /** APP安装路径,用于加载依赖库,如果为空,则使用当前路径 */
166
+ app_install_path?: string;
167
+ /** 自定义通信超时时间,单位秒, 为0使用默认值 */
168
+ custom_timeout?: number;
169
+ /** 自定义鉴权超时时间,单位秒, 为0使用默认值 */
170
+ auth_timeout?: number;
171
+ /** 数据库加密密钥,如果为空,则使用默认值 */
172
+ database_encrypt_key?: string;
173
+ /** 加密配置 */
174
+ encryption_configuration?: QChatEncryptionConfiguration;
175
+ /** FCS配置 */
176
+ fcs_configuration?: QChatFCSConfiguration;
177
+ /** 消息缓存配置 */
178
+ message_cache_configuration?: QChatMessageCacheConfiguration;
179
+ }
180
+ /** @interface QChatCleanupParam */
181
+ export interface QChatCleanupParam {
182
+ }
183
+ /** @interface QChatLoginParam */
184
+ export interface QChatLoginParam {
185
+ /** app唯一标识符 */
186
+ appkey?: string;
187
+ /** 用户帐号 */
188
+ accid?: string;
189
+ /** 鉴权方式 */
190
+ auth_type?: NIMQChatLoginAuthType;
191
+ /** 登陆的token */
192
+ login_token?: string;
193
+ /** 登录自定义字段 */
194
+ login_ext?: string;
195
+ /** 链接地址列表 */
196
+ link_address?: Array<string>;
197
+ }
198
+ /** @interface QChatLogoutParam */
199
+ export interface QChatLogoutParam {
200
+ }
201
+ /** @interface QChatKickParam */
202
+ export interface QChatKickParam {
203
+ /** 要踢下线的设备id列表 */
204
+ device_ids?: Array<string>;
205
+ }
206
+ /** @interface QChatGetRTCTokenParam */
207
+ export interface QChatGetRTCTokenParam {
208
+ /** 获取RTC频道token回调 */
209
+ cb?: GetRTCTokenCallback;
210
+ /** device_id */
211
+ device_id?: string;
212
+ }
@@ -0,0 +1,477 @@
1
+ import { NIMQChatMsgType, NIMQChatMessageStatus, NIMQChatMessageNotifyReason, NIMQChatUnreadInfo, QChatBaseResp, NIMQChatChannelIDInfo, NIMQChatGetReferMessageType, QChatBaseCallback, NIMResCode } from './public_def';
2
+ /** @struct QChatMessageUpdateInfo 更新消息时需要指定的参数 */
3
+ export interface QChatMessageUpdateInfo {
4
+ /** 操作附言 */
5
+ postscript?: string;
6
+ /** 操作扩展字段 */
7
+ extension?: string;
8
+ /** 推送文案 */
9
+ push_content?: string;
10
+ /** 推送payload */
11
+ push_payload?: string;
12
+ /** 环境变量,用于指向不同的抄送、第三方回调等配置 */
13
+ env?: string;
14
+ /** 是否需要抄送 */
15
+ route_enable?: boolean;
16
+ operator_id?: string;
17
+ operator_client_type?: number;
18
+ }
19
+ /** @interface QChatMessageAntiSpamInfo */
20
+ export interface QChatMessageAntiSpamInfo {
21
+ /** 是否需要使用自定义反垃圾字段(即antiSpamContent), false:不需要, true:需要, 一般使用的情况是通用反垃圾转易盾 */
22
+ use_custom_content?: boolean;
23
+ /** 单条消息是否使用易盾反垃圾, false:(在开通易盾的情况下)不过易盾反垃圾, 其他都是按照原来的规则 */
24
+ anti_spam_using_yidun?: boolean;
25
+ /** 反垃圾内容, 开发者自定义的反垃圾字段, 如果提供了这个字段, 在过反垃圾时不会再使用body或者attach */
26
+ anti_spam_content?: string;
27
+ /** 反垃圾业务ID, 对某些单条消息另外的反垃圾的业务ID */
28
+ anti_spam_bussiness_id?: string;
29
+ /** 易盾check的回调URL */
30
+ yidun_callback_url?: string;
31
+ /** 易盾反垃圾增强反作弊专属字段, 限制json, 长度限制1024 */
32
+ yidun_anti_cheating?: string;
33
+ /** 易盾反垃圾扩展字段, 限制json, 长度限制1024 */
34
+ yidun_anti_spam_ext?: string;
35
+ }
36
+ /** @struct QChatMessageThreadInfo thread 消息结构信息 */
37
+ export interface QChatMessageThreadInfo {
38
+ /** 被回复的消息所有者 ID */
39
+ reply_from_accid?: string;
40
+ /** 被回复消息得创建时间 */
41
+ reply_msg_timestamp?: number;
42
+ /** 被回复消息得服务器消息 ID */
43
+ reply_msg_server_id?: number;
44
+ /** 被回复消息得客户端消息 ID */
45
+ reply_msg_client_id?: string;
46
+ /** thread 根消息的所有者 ID */
47
+ thread_root_accid?: string;
48
+ /** thread 根消息的创建时间 */
49
+ thread_root_msg_timestamp?: number;
50
+ /** thread 根消息的服务器消息 ID */
51
+ thread_root_msg_server_id?: number;
52
+ /** thread 根消息的客户端消息 ID */
53
+ thread_root_msg_client_id?: string;
54
+ }
55
+ /** @struct QChatMessageSend 发送消息时指定的参数 */
56
+ export interface QChatMessageSend {
57
+ /** 必填,消息所属的server id */
58
+ server_id?: number;
59
+ /** 必填,消息所属的channel id */
60
+ channel_id?: number;
61
+ /** 必填,消息类型 */
62
+ msg_type?: NIMQChatMsgType;
63
+ /** 可选,消息内容 */
64
+ msg_body?: string;
65
+ /** 可选,消息附件 */
66
+ msg_attach?: object;
67
+ /** 可选,消息扩展字段 */
68
+ msg_ext?: string;
69
+ /** 可选,消息重发时需要指定此参数 */
70
+ msg_id?: string;
71
+ /** 必填,重发标记,false:不是重发,true:是重发 */
72
+ resend_flag?: boolean;
73
+ /** 可选,是否艾特所有人,false:否,true:是 */
74
+ mention_all?: boolean;
75
+ /** 可选,被艾特的人的accid列表 */
76
+ mention_accids?: Array<string>;
77
+ /** 必填,该消息是否存储云端历史,0:不支持,1:支持 */
78
+ history_enable?: boolean;
79
+ /** 可选,自定义的推送属性,限制json */
80
+ push_payload?: string;
81
+ /** 可选,自定义的推送内容 */
82
+ push_content?: string;
83
+ /** 可选,是否需要推送, false: 不需要, true: 需要, 默认 false */
84
+ push_enable?: boolean;
85
+ /** 可选,是否需要消息计数, false: 不需要, true: 需要, 默认 true */
86
+ need_badge?: boolean;
87
+ /** 可选,是否需要推送昵称, false: 不需要, true: 需要, 默认 true */
88
+ need_push_nick?: boolean;
89
+ /** 可选,是否需要抄送, false: 不需要, true: 需要, 默认 true */
90
+ route_enable?: boolean;
91
+ /** 可选,thread 消息相关信息 */
92
+ thread_info?: QChatMessageThreadInfo;
93
+ /** 可选,反垃圾信息 */
94
+ anti_spam_info?: QChatMessageAntiSpamInfo;
95
+ /** 可选,环境变量 */
96
+ env?: string;
97
+ }
98
+ /** @interface QChatMessageUpdateContent */
99
+ export interface QChatMessageUpdateContent {
100
+ /** 消息状态 */
101
+ status?: NIMQChatMessageStatus;
102
+ /** 消息内容 */
103
+ msg_body?: string;
104
+ /** 消息扩展字段 */
105
+ msg_ext?: string;
106
+ }
107
+ /** @interface QChatMessageUpdateOpeInfo */
108
+ export interface QChatMessageUpdateOpeInfo {
109
+ /** 操作者账号 */
110
+ operator_id?: string;
111
+ /** 操作者客户端类型 */
112
+ operator_client_type?: number;
113
+ /** 操作附言 */
114
+ postscript?: string;
115
+ /** 操作扩展字段 */
116
+ extension?: string;
117
+ /** 推送文案 */
118
+ push_content?: string;
119
+ /** 推送payload */
120
+ push_payload?: string;
121
+ }
122
+ /** @interface QChatMessage 接收到的完整消息体 */
123
+ export interface QChatMessage {
124
+ /** 必填,消息所属的server id */
125
+ server_id?: number;
126
+ /** 必填,消息所属的channel id */
127
+ channel_id?: number;
128
+ /** 必填,消息类型 */
129
+ msg_type?: NIMQChatMsgType;
130
+ /** 可选,消息内容 */
131
+ msg_body?: string;
132
+ /** 可选,消息附件 */
133
+ msg_attach?: object;
134
+ /** 可选,消息扩展字段 */
135
+ msg_ext?: string;
136
+ /** 可选,消息重发时需要指定此参数 */
137
+ msg_id?: string;
138
+ /** 必填,重发标记,false:不是重发,true:是重发 */
139
+ resend_flag?: boolean;
140
+ /** 可选,是否艾特所有人,false:否,true:是 */
141
+ mention_all?: boolean;
142
+ /** 可选,被艾特的人的accid列表 */
143
+ mention_accids?: Array<string>;
144
+ /** 必填,该消息是否存储云端历史,0:不支持,1:支持 */
145
+ history_enable?: boolean;
146
+ /** 可选,自定义的推送属性,限制json */
147
+ push_payload?: string;
148
+ /** 可选,自定义的推送内容 */
149
+ push_content?: string;
150
+ /** 可选,是否需要推送, false: 不需要, true: 需要, 默认 false */
151
+ push_enable?: boolean;
152
+ /** 可选,是否需要消息计数, false: 不需要, true: 需要, 默认 true */
153
+ need_badge?: boolean;
154
+ /** 可选,是否需要推送昵称, false: 不需要, true: 需要, 默认 true */
155
+ need_push_nick?: boolean;
156
+ /** 可选,是否需要抄送, false: 不需要, true: 需要, 默认 true */
157
+ route_enable?: boolean;
158
+ /** 可选,thread 消息相关信息 */
159
+ thread_info?: QChatMessageThreadInfo;
160
+ /** 可选,反垃圾信息 */
161
+ anti_spam_info?: QChatMessageAntiSpamInfo;
162
+ /** 可选,环境变量 */
163
+ env?: string;
164
+ /** 消息状态 */
165
+ status?: NIMQChatMessageStatus;
166
+ /** 更新消息时必填,消息服务器端id */
167
+ msg_server_id?: number;
168
+ /** 消息发送者的accid */
169
+ from_accid?: string;
170
+ /** 消息发送者的客户端类型 */
171
+ from_client_type?: number;
172
+ /** 消息发送者的设备id */
173
+ from_device_id?: string;
174
+ /** 消息发送者的昵称 */
175
+ from_nick?: string;
176
+ /** 更新消息时必填,消息创建的时间戳,以服务器返回信息为准 */
177
+ timestamp?: number;
178
+ /** 消息更新时间戳 */
179
+ update_timestamp?: number;
180
+ /** 消息下发原因 */
181
+ notify_reason?: NIMQChatMessageNotifyReason;
182
+ /** 是否被反垃圾 */
183
+ is_anti_spamed?: boolean;
184
+ /** 反垃圾结果 */
185
+ anti_spam_result?: string;
186
+ /** 可选,第三方回调扩展字段 */
187
+ callback_ext?: string;
188
+ /** 上次消息变更内容 */
189
+ update_content?: QChatMessageUpdateContent;
190
+ /** 上次消息变更操作信息 */
191
+ update_ope_info?: QChatMessageUpdateOpeInfo;
192
+ }
193
+ /** @interface QChatRecvMsgResp */
194
+ export interface QChatRecvMsgResp {
195
+ /** 消息体 */
196
+ message?: QChatMessage;
197
+ }
198
+ /** @interface QChatMsgUpdatedResp */
199
+ export interface QChatMsgUpdatedResp {
200
+ /** 操作结果, 参考NIMResCode */
201
+ res_code?: NIMResCode;
202
+ /** 消息更新信息 */
203
+ update_info?: QChatMessageUpdateInfo;
204
+ /** 消息体 */
205
+ message?: QChatMessage;
206
+ }
207
+ /** @interface QChatSendMessageResp */
208
+ export interface QChatSendMessageResp {
209
+ /** 操作结果, 参考NIMResCode */
210
+ res_code?: NIMResCode;
211
+ /** 消息体 */
212
+ message?: QChatMessage;
213
+ }
214
+ /** @interface QChatReplyMessageResp */
215
+ export declare type QChatReplyMessageResp = QChatSendMessageResp;
216
+ /** @interface QChatUpdateMessageResp */
217
+ export interface QChatUpdateMessageResp {
218
+ /** 操作结果, 参考NIMResCode */
219
+ res_code?: NIMResCode;
220
+ /** 消息体 */
221
+ message?: QChatMessage;
222
+ }
223
+ /** @interface QChatGetMessagesResp */
224
+ export interface QChatGetMessagesResp {
225
+ /** 操作结果, 参考NIMResCode */
226
+ res_code?: NIMResCode;
227
+ /** 消息列表 */
228
+ messages?: Array<QChatMessage>;
229
+ }
230
+ /** @interface QChatGetLastMessagesResp */
231
+ export interface QChatGetLastMessagesResp {
232
+ /** 操作结果, 参考NIMResCode */
233
+ res_code?: NIMResCode;
234
+ /** 消息列表, key为channel_id */
235
+ messages?: Map<number, QChatMessage>;
236
+ }
237
+ /** @interface QChatGetMessagesCacheResp */
238
+ export declare type QChatGetMessagesCacheResp = QChatGetMessagesResp;
239
+ /** @interface QChatGetMessageHistoryByIdsResp */
240
+ export declare type QChatGetMessageHistoryByIdsResp = QChatGetMessagesResp;
241
+ /** @interface QChatGetReferMessagesResp */
242
+ export declare type QChatGetReferMessagesResp = QChatGetMessagesResp;
243
+ /** @interface QChatMarkMessageReadResp */
244
+ export interface QChatMarkMessageReadResp {
245
+ /** 操作结果, 参考NIMResCode */
246
+ res_code?: NIMResCode;
247
+ /** 未读数信息 */
248
+ unread_info?: NIMQChatUnreadInfo;
249
+ }
250
+ /** @interface NIMQChatThreadMessageMetaInfo */
251
+ export interface NIMQChatThreadMessageMetaInfo {
252
+ /** 总数 */
253
+ total?: number;
254
+ /** 最后一条消息时间戳 */
255
+ timestamp?: number;
256
+ /** thread 消息服务器 ID */
257
+ thread_msg_server_id?: number;
258
+ /** thread 消息时间戳 */
259
+ thread_msg_timestamp?: number;
260
+ }
261
+ /** @interface QChatGetThreadMessagesResp */
262
+ export interface QChatGetThreadMessagesResp {
263
+ /** 操作结果, 参考NIMResCode */
264
+ res_code?: NIMResCode;
265
+ /** thread 消息元信息 */
266
+ meta_info?: NIMQChatThreadMessageMetaInfo;
267
+ /** 消息体 */
268
+ root_message?: QChatMessage;
269
+ /** 消息列表 */
270
+ messages?: Array<QChatMessage>;
271
+ }
272
+ /** @interface QChatGetThreadRootMessagesMetaResp */
273
+ export interface QChatGetThreadRootMessagesMetaResp {
274
+ /** 操作结果, 参考NIMResCode */
275
+ res_code?: NIMResCode;
276
+ /** thread 消息元信息 */
277
+ meta_infos?: Array<NIMQChatThreadMessageMetaInfo>;
278
+ }
279
+ /** @interface QChatAddQuickCommentResp */
280
+ export declare type QChatAddQuickCommentResp = QChatBaseResp;
281
+ /** @interface QChatRemoveQuickCommentResp */
282
+ export declare type QChatRemoveQuickCommentResp = QChatBaseResp;
283
+ /** @interface QChatQuickCommentDetail */
284
+ export interface QChatQuickCommentDetail {
285
+ /** 表示评论类型 */
286
+ type?: number;
287
+ /** 表示这个评论的数量 */
288
+ count?: number;
289
+ /** 表示自己是否添加过这个标签 */
290
+ include_yourself?: boolean;
291
+ /** 若干个添加过表情的 account ID */
292
+ accids?: Array<string>;
293
+ }
294
+ /** @interface QChatQuickCommentInfo */
295
+ export interface QChatQuickCommentInfo {
296
+ /** 评论所在服务器 */
297
+ server_id?: number;
298
+ /** 评论所在频道 */
299
+ channel_id?: number;
300
+ /** 评论所属的消息服务器 ID */
301
+ msg_server_id?: number;
302
+ /** 总的评论数量 */
303
+ count?: number;
304
+ /** 最后一次操作的时间 */
305
+ timestamp?: number;
306
+ /** 评论详情 */
307
+ details?: Array<QChatQuickCommentDetail>;
308
+ }
309
+ /** @interface QChatGetQuickCommentsResp */
310
+ export interface QChatGetQuickCommentsResp {
311
+ /** 操作结果, 参考NIMResCode */
312
+ res_code?: NIMResCode;
313
+ /** 快捷评论列表 */
314
+ comments?: Array<QChatQuickCommentInfo>;
315
+ }
316
+ /** 接收消息回调 */
317
+ export declare type RecvMsgCallback = (resp: QChatRecvMsgResp) => void;
318
+ /** 发送消息回调 */
319
+ export declare type SendMsgCallback = (resp: QChatSendMessageResp) => void;
320
+ /** 更新消息回调 */
321
+ export declare type UpdateMsgCallback = (resp: QChatUpdateMessageResp) => void;
322
+ /** 消息更新回调 */
323
+ export declare type MsgUpdatedCallback = (resp: QChatMsgUpdatedResp) => void;
324
+ /** 查询历史消息回调 */
325
+ export declare type GetMessagesCallback = (resp: QChatGetMessagesResp) => void;
326
+ /** 查询频道最后一条消息回调 */
327
+ export declare type GetLastMessagesCallback = (resp: QChatGetLastMessagesResp) => void;
328
+ /** 本地获取消息回调 */
329
+ export declare type GetMessagesCacheCallback = GetMessagesCallback;
330
+ /** 消息已读标记回调 */
331
+ export declare type MarkMessageReadCallback = (resp: QChatMarkMessageReadResp) => void;
332
+ /** 回复消息回调 */
333
+ export declare type ReplyMessageCallback = (resp: QChatReplyMessageResp) => void;
334
+ export declare type GetMessageHistoryByIdsCallback = GetMessagesCallback;
335
+ export declare type GetReferMessagesCallback = GetMessagesCallback;
336
+ /** 获取 thread 消息回调 */
337
+ export declare type GetThreadMessagesCallback = (resp: QChatGetThreadMessagesResp) => void;
338
+ export declare type GetThreadRootMessagesMetaCallback = (resp: QChatGetThreadRootMessagesMetaResp) => void;
339
+ export declare type QuickCommentCallback = QChatBaseCallback;
340
+ export declare type GetQuickCommentsCallback = (resp: QChatGetQuickCommentsResp) => void;
341
+ /** @interface QChatSendMessageParam */
342
+ export interface QChatSendMessageParam {
343
+ /** 圈组消息体 */
344
+ message?: QChatMessageSend;
345
+ }
346
+ /** @interface QChatUpdateMessageParam */
347
+ export interface QChatUpdateMessageParam {
348
+ id_info?: NIMQChatChannelIDInfo;
349
+ msg_server_id?: number;
350
+ timestamp?: number;
351
+ update_info?: QChatMessageUpdateInfo;
352
+ anti_spam_info?: QChatMessageAntiSpamInfo;
353
+ status?: NIMQChatMessageStatus;
354
+ msg_body?: string;
355
+ msg_ext?: string;
356
+ }
357
+ /** @interface QChatRevokeMessageParam */
358
+ export interface QChatRevokeMessageParam {
359
+ id_info?: NIMQChatChannelIDInfo;
360
+ msg_server_id?: number;
361
+ timestamp?: number;
362
+ update_info?: QChatMessageUpdateInfo;
363
+ }
364
+ /** @interface QChatDeleteMessageParam */
365
+ export interface QChatDeleteMessageParam {
366
+ id_info?: NIMQChatChannelIDInfo;
367
+ msg_server_id?: number;
368
+ timestamp?: number;
369
+ update_info?: QChatMessageUpdateInfo;
370
+ }
371
+ /** @interface QChatGetMessagesParam */
372
+ export interface QChatGetMessagesParam {
373
+ /** 服务器ID */
374
+ server_id?: number;
375
+ /** 频道ID */
376
+ channel_id?: number;
377
+ /** 查询开始时间 */
378
+ from_time?: number;
379
+ /** 查询结束时间 */
380
+ to_time?: number;
381
+ /** 排除某条消息 */
382
+ exclude_msg_server_id?: number;
383
+ /** 查询条数 */
384
+ limit?: number;
385
+ /** 是否倒序, false: 否, true: 是 */
386
+ reverse?: boolean;
387
+ }
388
+ /** @interface QChatGetLastMessagesParam */
389
+ export interface QChatGetLastMessagesParam {
390
+ /** 服务器ID */
391
+ server_id?: number;
392
+ /** 频道ID列表 */
393
+ channel_ids?: Array<number>;
394
+ }
395
+ /** @interface QChatGetMessagesCacheParam */
396
+ export interface QChatGetMessagesCacheParam {
397
+ /** 服务器 ID */
398
+ server_id?: number;
399
+ /** 频道 ID */
400
+ channel_id?: number;
401
+ }
402
+ /** @interface QChatMarkMessageReadParam */
403
+ export interface QChatMarkMessageReadParam {
404
+ /** 标记已读channel ID */
405
+ id_info?: NIMQChatChannelIDInfo;
406
+ /** 标记消息已读时间戳 */
407
+ timestamp?: number;
408
+ }
409
+ /** @interface QChatReplyMessageParam */
410
+ export interface QChatReplyMessageParam {
411
+ /** 被引用的消息体 */
412
+ quote_message?: QChatMessage;
413
+ /** 回复消息内容 */
414
+ message?: QChatMessageSend;
415
+ }
416
+ /** @interface NIMQChatGetMessageColumns */
417
+ export interface NIMQChatGetMessageColumns {
418
+ /** 消息服务器 ID */
419
+ msg_server_id?: number;
420
+ /** 消息发送时间戳 */
421
+ timestamp?: number;
422
+ }
423
+ /** @interface QChatGetMessageHistoryByIdsParam */
424
+ export interface QChatGetMessageHistoryByIdsParam {
425
+ cb?: GetMessageHistoryByIdsCallback;
426
+ server_id?: number;
427
+ channel_id?: number;
428
+ columns?: Array<NIMQChatGetMessageColumns>;
429
+ }
430
+ /** @interface QChatGetReferMessagesParam */
431
+ export interface QChatGetReferMessagesParam {
432
+ cb?: GetReferMessagesCallback;
433
+ type?: NIMQChatGetReferMessageType;
434
+ message?: QChatMessage;
435
+ }
436
+ /** @interface QChatGetThreadMessagesParam */
437
+ export interface QChatGetThreadMessagesParam {
438
+ /** 要查询的 thread 依据完整消息体 */
439
+ message?: QChatMessage;
440
+ /** 查询开始时间 */
441
+ from_time?: number;
442
+ /** 查询结束时间 */
443
+ to_time?: number;
444
+ /** 排除的消息 ID */
445
+ exclude_msg_server_id?: number;
446
+ /** 查询条数 */
447
+ limit?: number;
448
+ /** 是否倒序, false: 否, true: 是 */
449
+ reverse?: boolean;
450
+ }
451
+ export interface QChatAddQuickCommentParam {
452
+ /** 快速评论内容 */
453
+ message?: QChatMessage;
454
+ /** 快速评论类型,是一个数组,大于 0 */
455
+ type?: number;
456
+ }
457
+ export interface QChatRemoveQuickCommentParam {
458
+ /** 快速评论内容 */
459
+ message?: QChatMessage;
460
+ /** 快速评论类型,是一个数组,大于 0 */
461
+ type?: number;
462
+ }
463
+ /** @interface QChatGetThreadRootMessagesMetaParam */
464
+ export interface QChatGetThreadRootMessagesMetaParam {
465
+ server_id?: number;
466
+ channel_id?: number;
467
+ thread_root_messages?: Array<QChatMessage>;
468
+ }
469
+ /** @interface QChatGetQuickCommentsParam */
470
+ export interface QChatGetQuickCommentsParam {
471
+ /** 服务器 ID */
472
+ server_id?: number;
473
+ /** 频道 ID */
474
+ channel_id?: number;
475
+ /** 要查询的服务器消息 ID 列表 */
476
+ msg_server_id_list?: Array<number>;
477
+ }