@rongcloud/engine 5.8.1 → 5.8.3-alpha.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.
- package/index.d.ts +987 -1306
- package/index.esm.js +1 -1
- package/index.js +1 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -103,954 +103,695 @@ declare enum TagChangeType {
|
|
|
103
103
|
}
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
STATISTICS = -2,
|
|
113
|
-
/**
|
|
114
|
-
* 未明确使用场景,暂未使用,控制台不打印
|
|
115
|
-
* TODO:
|
|
116
|
-
* 暂未明确使用场景,实时日志系统上报?
|
|
117
|
-
* 需要明确下为什么会有 -1,以及与 -2 的区别,并在注释中补充
|
|
118
|
-
*/
|
|
119
|
-
RECORD = -1,
|
|
120
|
-
/**
|
|
121
|
-
* 未明确使用场景,暂未使用,控制台不打印
|
|
122
|
-
*/
|
|
123
|
-
FATAL = 0,
|
|
124
|
-
/**
|
|
125
|
-
* ERROR 级
|
|
126
|
-
*/
|
|
127
|
-
ERROR = 1,
|
|
128
|
-
/**
|
|
129
|
-
* WARN 级
|
|
130
|
-
*/
|
|
131
|
-
WARN = 2,
|
|
132
|
-
/**
|
|
133
|
-
* INFO 级
|
|
134
|
-
*/
|
|
135
|
-
INFO = 3,
|
|
136
|
-
/**
|
|
137
|
-
* DEBUG 级
|
|
138
|
-
*/
|
|
139
|
-
DEBUG = 4
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* 有效的日志等级声明
|
|
143
|
-
*/
|
|
144
|
-
declare type EnableLogL = LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR;
|
|
145
|
-
|
|
146
|
-
declare type LogContent = string | number | boolean | null;
|
|
147
|
-
declare type LogType = 'IM' | 'RTC';
|
|
148
|
-
/**
|
|
149
|
-
* 对外暴露的 Logger 工具接口定义,以隐藏 BasicLogger 其他实现
|
|
150
|
-
*/
|
|
151
|
-
interface ILogger {
|
|
152
|
-
debug(tag: string, content?: LogContent, traceId?: string): void;
|
|
153
|
-
info(tag: string, content?: LogContent, traceId?: string): void;
|
|
154
|
-
warn(tag: string, content?: LogContent, traceId?: string): void;
|
|
155
|
-
error(tag: string, content?: LogContent, traceId?: string): void;
|
|
156
|
-
/**
|
|
157
|
-
* 设置日志打印等级,默认为 `LogL.WARN`
|
|
158
|
-
* @param level
|
|
159
|
-
*/
|
|
160
|
-
setOutputLevel(level?: EnableLogL): void;
|
|
161
|
-
/**
|
|
162
|
-
* 创建事务追踪 ID,全局唯一,便于跨进程、异步事务追踪,需要考虑多进程
|
|
163
|
-
*/
|
|
164
|
-
createTraceId(): string;
|
|
165
|
-
}
|
|
166
|
-
|
|
167
|
-
interface ILogData {
|
|
168
|
-
/**
|
|
169
|
-
* 日志原始内容
|
|
170
|
-
*/
|
|
171
|
-
content?: LogContent;
|
|
172
|
-
/**
|
|
173
|
-
* 日志标签,如 `L-INIT-O`
|
|
174
|
-
*/
|
|
175
|
-
tag: string;
|
|
176
|
-
/**
|
|
177
|
-
* logger 实例 Id,用于确定日志由谁埋点,如 `RCEngien` 为 engine 包埋点日志
|
|
178
|
-
*/
|
|
179
|
-
loggerId: string;
|
|
180
|
-
/**
|
|
181
|
-
* 日志生成时间
|
|
182
|
-
*/
|
|
183
|
-
time: number;
|
|
184
|
-
/**
|
|
185
|
-
* 应用的声明周期 sessionId
|
|
186
|
-
* @description
|
|
187
|
-
* Electron 环境下,以主进程 sessionId 入库,渲染进程 sessionId 存储于 content 内。
|
|
188
|
-
* 日志上报时,通过 `${mainSessionId}:${renderSessionId}` 形式作为 sessionId 上报
|
|
189
|
-
* @TODO 需确认服务是否允许 `${mainSessionId}:${renderSessionId}` 的方式,以及 sessionId 是否超出长度。
|
|
190
|
-
*/
|
|
191
|
-
sessionId: string;
|
|
192
|
-
/**
|
|
193
|
-
* 日志类型,仅用于大数据后台查阅统计
|
|
194
|
-
*/
|
|
195
|
-
type: 'IM' | 'RTC';
|
|
196
|
-
/**
|
|
197
|
-
* 日志等级,该等级与服务器统计等级保持一致,为入库等级
|
|
198
|
-
*/
|
|
199
|
-
level: LogL;
|
|
200
|
-
/**
|
|
201
|
-
* 事务跟踪 ID
|
|
202
|
-
*/
|
|
203
|
-
traceId?: string;
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* Logger 抽象基类,定义日志采集接口与进程内打印,
|
|
208
|
-
* 由子类继承实现入库逻辑
|
|
209
|
-
*/
|
|
210
|
-
declare abstract class BasicLogger implements ILogger {
|
|
211
|
-
protected readonly _appkey: string;
|
|
212
|
-
protected readonly _id: string;
|
|
213
|
-
protected readonly _type: LogType;
|
|
214
|
-
constructor(_appkey: string, _id: string, _type: LogType);
|
|
215
|
-
private _stdout;
|
|
216
|
-
/**
|
|
217
|
-
* 用户的打印日志等级配置
|
|
218
|
-
*/
|
|
219
|
-
private outputLevel;
|
|
220
|
-
setOutputLevel(level?: EnableLogL): void;
|
|
221
|
-
/**
|
|
222
|
-
* 由子类继承实现日志入库
|
|
223
|
-
* @override
|
|
224
|
-
*/
|
|
225
|
-
protected abstract flush(data: ILogData): void;
|
|
226
|
-
private _log;
|
|
227
|
-
debug: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
228
|
-
info: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
229
|
-
warn: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
230
|
-
error: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
231
|
-
/**
|
|
232
|
-
* 内部质量数据统计接口,仅限 IMLib 与 RTCLib 内部使用
|
|
233
|
-
*/
|
|
234
|
-
__statistics: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
235
|
-
/**
|
|
236
|
-
* 创建事务追踪 ID,全局唯一,便于跨进程、异步事务追踪,需要考虑多进程
|
|
237
|
-
*/
|
|
238
|
-
createTraceId(): string;
|
|
239
|
-
/**
|
|
240
|
-
* 获取当前进程的 sessionId,全局唯一
|
|
241
|
-
* @returns
|
|
242
|
-
*/
|
|
243
|
-
getSessionId(): string;
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
/**
|
|
247
|
-
* 实现基于 IndexDB 存储的日志类
|
|
248
|
-
*/
|
|
249
|
-
declare class IndexDBLogger extends BasicLogger {
|
|
250
|
-
protected flush(data: ILogData): void;
|
|
251
|
-
}
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* 日志数据库接口
|
|
255
|
-
*/
|
|
256
|
-
interface ILogDB {
|
|
257
|
-
/**
|
|
258
|
-
* 获取实时日志上报的时间戳记录。
|
|
259
|
-
* 时间戳不以人为维度记录,避免换账户登录时,一次拉取巨量的历史日志。
|
|
260
|
-
*/
|
|
261
|
-
getTimestamp4RealtimeLog(): number;
|
|
262
|
-
/**
|
|
263
|
-
* 设置实时日志上报的时间戳记录
|
|
264
|
-
* @param timestamp
|
|
265
|
-
*/
|
|
266
|
-
setTimestamp4RealtimeLog(timestamp: number): void;
|
|
267
|
-
/**
|
|
268
|
-
* 根据时间戳和日志等级获取全量日志
|
|
269
|
-
* @param startTime
|
|
270
|
-
* @param endTime
|
|
271
|
-
* @param level
|
|
272
|
-
* @param realtimeReport 是否实时上报。实时上报时,需要取质量数据日志
|
|
273
|
-
*/
|
|
274
|
-
getLogs(startTime: number, endTime: number, level: LogL, realtimeReport: boolean): Promise<{
|
|
275
|
-
logs: ILogData[];
|
|
276
|
-
dbReady: boolean;
|
|
277
|
-
}>;
|
|
106
|
+
* 聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
|
|
107
|
+
* @category Enum
|
|
108
|
+
*/
|
|
109
|
+
declare enum ChatroomEntryType {
|
|
110
|
+
UPDATE = 1,
|
|
111
|
+
DELETE = 2
|
|
278
112
|
}
|
|
279
113
|
|
|
280
114
|
/**
|
|
281
|
-
*
|
|
115
|
+
* 聊天室成员进入和退出状态
|
|
282
116
|
* @category Enum
|
|
283
117
|
*/
|
|
284
|
-
declare enum
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
*/
|
|
288
|
-
GLOBAL = 1,
|
|
289
|
-
/**
|
|
290
|
-
自定义敏感词拦截:命中了客户在融云自定义的敏感词
|
|
291
|
-
*/
|
|
292
|
-
CUSTOM = 2,
|
|
293
|
-
/**
|
|
294
|
-
第三方审核拦截:命中了第三方(数美)或模板路由决定不下发的状态
|
|
295
|
-
*/
|
|
296
|
-
THIRD_PARTY = 3
|
|
297
|
-
}
|
|
298
|
-
/**
|
|
299
|
-
* 消息被拦截源触发类型
|
|
300
|
-
*/
|
|
301
|
-
declare enum MessageBlockSourceType {
|
|
302
|
-
/** 原始消息 */
|
|
303
|
-
MSG_ORIGINAL = 0,
|
|
304
|
-
/** 消息扩展 */
|
|
305
|
-
MSG_EXPANSION = 1,
|
|
306
|
-
/** 消息修改 */
|
|
307
|
-
MSG_MODIFY = 2
|
|
118
|
+
declare enum ChatroomUserChangeType {
|
|
119
|
+
QUIT = 0,
|
|
120
|
+
JOIN = 1
|
|
308
121
|
}
|
|
309
122
|
|
|
310
123
|
/**
|
|
311
|
-
*
|
|
124
|
+
* 聊天室多端同步时,消息中的状态:加入/离开
|
|
312
125
|
* @category Enum
|
|
126
|
+
* @since 5.7.9
|
|
313
127
|
*/
|
|
314
|
-
declare enum
|
|
128
|
+
declare enum ChrmSyncStatus {
|
|
315
129
|
/**
|
|
316
|
-
*
|
|
130
|
+
* 离开
|
|
317
131
|
*/
|
|
318
|
-
|
|
132
|
+
QUIT = 0,
|
|
319
133
|
/**
|
|
320
|
-
*
|
|
134
|
+
* 加入
|
|
321
135
|
*/
|
|
322
|
-
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
/**
|
|
326
|
-
* 输入状态类型
|
|
327
|
-
*/
|
|
328
|
-
declare enum OperateStatus {
|
|
329
|
-
typing = 0
|
|
136
|
+
JOIN = 1
|
|
330
137
|
}
|
|
331
138
|
|
|
332
139
|
/**
|
|
333
|
-
*
|
|
140
|
+
* 聊天室解封/封禁用户消息,操作类型枚举
|
|
334
141
|
* @category Enum
|
|
142
|
+
* @since 5.7.9
|
|
335
143
|
*/
|
|
336
|
-
declare enum
|
|
337
|
-
/**
|
|
338
|
-
* 图片文件
|
|
339
|
-
*/
|
|
340
|
-
IMAGE = 1,
|
|
341
|
-
/**
|
|
342
|
-
* 声音文件
|
|
343
|
-
*/
|
|
344
|
-
AUDIO = 2,
|
|
144
|
+
declare enum ChrmMemOperateType {
|
|
345
145
|
/**
|
|
346
|
-
*
|
|
146
|
+
* 解封
|
|
347
147
|
*/
|
|
348
|
-
|
|
148
|
+
Deblock = 0,
|
|
349
149
|
/**
|
|
350
|
-
*
|
|
150
|
+
* 封禁
|
|
351
151
|
*/
|
|
352
|
-
|
|
353
|
-
/**
|
|
354
|
-
* 小视频类型
|
|
355
|
-
*/
|
|
356
|
-
SIGHT = 5,
|
|
357
|
-
/**
|
|
358
|
-
* 合并转发
|
|
359
|
-
*/
|
|
360
|
-
COMBINE_HTML = 6
|
|
152
|
+
Blocked = 1
|
|
361
153
|
}
|
|
362
154
|
|
|
363
155
|
/**
|
|
364
|
-
*
|
|
365
|
-
* 2 开头为 IM Server 返回错误码
|
|
366
|
-
* 3 开头: 30000 到 33xxx 为协议栈错误码,34001 ~ 34999 为移动端自定错误码
|
|
367
|
-
* 备注:iOS 与 Android 错误码一致。Web 与移动端一致的错误码,也用此片段,比如 34008 (消息不支持扩展)
|
|
368
|
-
* 35001 ~ 39999 为 Web 端错误码 备注:由于 Web IM 历史版本 35xxx 36xxx 37xxx 38xxx 39xxxx 都占用过,所以错误码段范围较大
|
|
369
|
-
*/
|
|
370
|
-
/**
|
|
371
|
-
* 错误码
|
|
156
|
+
* 聊天室禁言/解除禁言操作类型枚举
|
|
372
157
|
* @category Enum
|
|
158
|
+
* @since 5.7.9
|
|
373
159
|
*/
|
|
374
|
-
declare enum
|
|
375
|
-
/** 超时 */
|
|
376
|
-
TIMEOUT = -1,
|
|
377
|
-
/**
|
|
378
|
-
* 未知原因失败。
|
|
379
|
-
*/
|
|
380
|
-
UNKNOWN = -2,
|
|
381
|
-
/** 参数错误 */
|
|
382
|
-
PARAMETER_ERROR = -3,
|
|
383
|
-
/** 未实现的方法定义,在应用层调用 callExtra 传入无法识别的方法名时抛出 */
|
|
384
|
-
EXTRA_METHOD_UNDEFINED = -4,
|
|
385
|
-
/** 主进程内方法错误 */
|
|
386
|
-
MAIN_PROCESS_ERROR = -5,
|
|
387
|
-
/**
|
|
388
|
-
* 参数变更
|
|
389
|
-
*/
|
|
390
|
-
PARAMETER_CHANGED = -6,
|
|
391
|
-
/**
|
|
392
|
-
* 成功
|
|
393
|
-
*/
|
|
394
|
-
SUCCESS = 0,
|
|
395
|
-
/**
|
|
396
|
-
* 群组 Id 无效
|
|
397
|
-
* @deprecated 讨论组已废弃
|
|
398
|
-
*/
|
|
399
|
-
RC_DISCUSSION_GROUP_ID_INVALID = 20407,
|
|
400
|
-
/**
|
|
401
|
-
* 发送频率过快
|
|
402
|
-
*/
|
|
403
|
-
SEND_FREQUENCY_TOO_FAST = 20604,
|
|
404
|
-
/**
|
|
405
|
-
* 不在讨论组。
|
|
406
|
-
* @deprecated 讨论组已废弃
|
|
407
|
-
*/
|
|
408
|
-
NOT_IN_DISCUSSION = 21406,
|
|
409
|
-
/**
|
|
410
|
-
* 群组被禁言
|
|
411
|
-
*/
|
|
412
|
-
FORBIDDEN_IN_GROUP = 22408,
|
|
413
|
-
/**
|
|
414
|
-
* 撤回消息参数无效,请确认撤回消息参数是否正确的填写
|
|
415
|
-
*/
|
|
416
|
-
RECALL_MESSAGE = 25101,
|
|
417
|
-
/**
|
|
418
|
-
* 不在群组。
|
|
419
|
-
*/
|
|
420
|
-
NOT_IN_GROUP = 22406,
|
|
421
|
-
/**
|
|
422
|
-
* 不在聊天室。
|
|
423
|
-
*/
|
|
424
|
-
NOT_IN_CHATROOM = 23406,
|
|
425
|
-
/**
|
|
426
|
-
*聊天室被禁言
|
|
427
|
-
*/
|
|
428
|
-
FORBIDDEN_IN_CHATROOM = 23408,
|
|
429
|
-
/**
|
|
430
|
-
* 当前用户被目标聊天室封禁
|
|
431
|
-
*/
|
|
432
|
-
RC_CHATROOM_USER_KICKED = 23409,
|
|
433
|
-
/**
|
|
434
|
-
* 聊天室不存在
|
|
435
|
-
*/
|
|
436
|
-
RC_CHATROOM_NOT_EXIST = 23410,
|
|
437
|
-
/**
|
|
438
|
-
* 聊天室成员已满
|
|
439
|
-
*/
|
|
440
|
-
RC_CHATROOM_IS_FULL = 23411,
|
|
441
|
-
/**
|
|
442
|
-
* 获取聊天室信息参数无效
|
|
443
|
-
*/
|
|
444
|
-
RC_CHATROOM_PATAMETER_INVALID = 23412,
|
|
445
|
-
/**
|
|
446
|
-
* 聊天室异常
|
|
447
|
-
*/
|
|
448
|
-
CHATROOM_GET_HISTORYMSG_ERROR = 23413,
|
|
449
|
-
/**
|
|
450
|
-
* 没有打开聊天室消息存储
|
|
451
|
-
*/
|
|
452
|
-
CHATROOM_NOT_OPEN_HISTORYMSG_STORE = 23414,
|
|
453
|
-
/**
|
|
454
|
-
* 聊天室 KV 设置超出最大值(已满, 默认最多设置 100 个)
|
|
455
|
-
*/
|
|
456
|
-
CHATROOM_KV_EXCEED = 23423,
|
|
457
|
-
/**
|
|
458
|
-
* 聊天室 KV 设置失败(kv 已存在, 需覆盖设置)
|
|
459
|
-
*/
|
|
460
|
-
CHATROOM_KV_OVERWRITE_INVALID = 23424,
|
|
461
|
-
/**
|
|
462
|
-
* 未开通聊天室属性自定义设置。请在开发者后台"免费基础功能"页面开通"聊天室属性自定义设置
|
|
463
|
-
*/
|
|
464
|
-
CHATROOM_KV_STORE_NOT_OPEN = 23426,
|
|
465
|
-
/**
|
|
466
|
-
* 聊天室Key不存在
|
|
467
|
-
*/
|
|
468
|
-
CHATROOM_KEY_NOT_EXIST = 23427,
|
|
469
|
-
CHATROOM_KV_SET_ERROR = 23431,
|
|
470
|
-
/**
|
|
471
|
-
* 敏感词屏蔽
|
|
472
|
-
*/
|
|
473
|
-
SENSITIVE_SHIELD = 21501,
|
|
474
|
-
/**
|
|
475
|
-
* 消息中含敏感词且敏感词已被替换
|
|
476
|
-
*/
|
|
477
|
-
SENSITIVE_REPLACE = 21502,
|
|
478
|
-
/**
|
|
479
|
-
* 加入讨论失败
|
|
480
|
-
* @deprecated
|
|
481
|
-
*/
|
|
482
|
-
JOIN_IN_DISCUSSION = 21407,
|
|
483
|
-
/**
|
|
484
|
-
* 创建讨论组失败
|
|
485
|
-
* @deprecated
|
|
486
|
-
*/
|
|
487
|
-
CREATE_DISCUSSION = 21408,
|
|
488
|
-
/**
|
|
489
|
-
* 设置讨论组邀请状态失败
|
|
490
|
-
* @deprecated
|
|
491
|
-
*/
|
|
492
|
-
INVITE_DICUSSION = 21409,
|
|
493
|
-
/**
|
|
494
|
-
*获取用户失败
|
|
495
|
-
*/
|
|
496
|
-
GET_USERINFO_ERROR = 23407,
|
|
497
|
-
/**
|
|
498
|
-
* 在黑名单中。
|
|
499
|
-
*/
|
|
500
|
-
REJECTED_BY_BLACKLIST = 405,
|
|
501
|
-
/**
|
|
502
|
-
* 通信过程中,当前 Socket 不存在。
|
|
503
|
-
*/
|
|
504
|
-
RC_NET_CHANNEL_INVALID = 30001,
|
|
505
|
-
/**
|
|
506
|
-
* Socket 连接不可用。
|
|
507
|
-
*/
|
|
508
|
-
RC_NET_UNAVAILABLE = 30002,
|
|
509
|
-
/**
|
|
510
|
-
* 通信超时。
|
|
511
|
-
*/
|
|
512
|
-
RC_MSG_RESP_TIMEOUT = 30003,
|
|
513
|
-
/**
|
|
514
|
-
* 导航操作时,Http 请求失败。
|
|
515
|
-
*/
|
|
516
|
-
RC_HTTP_SEND_FAIL = 30004,
|
|
517
|
-
/**
|
|
518
|
-
* HTTP 请求失败。
|
|
519
|
-
*/
|
|
520
|
-
RC_HTTP_REQ_FAIL = 30005,
|
|
521
|
-
/**
|
|
522
|
-
* HTTP 接收失败。
|
|
523
|
-
*/
|
|
524
|
-
RC_HTTP_RECV_FAIL = 30006,
|
|
525
|
-
/**
|
|
526
|
-
* 导航请求失败
|
|
527
|
-
*/
|
|
528
|
-
RC_NAVI_REQ_FAILED = 30007,
|
|
529
|
-
/**
|
|
530
|
-
* 导航数据解析后,其中不存在有效数据。
|
|
531
|
-
*/
|
|
532
|
-
RC_NODE_NOT_FOUND = 30008,
|
|
533
|
-
/**
|
|
534
|
-
* 导航数据解析后,其中不存在有效 IP 地址。
|
|
535
|
-
*/
|
|
536
|
-
RC_DOMAIN_NOT_RESOLVE = 30009,
|
|
537
|
-
/**
|
|
538
|
-
* Socket 连接失败
|
|
539
|
-
*/
|
|
540
|
-
RC_SOCKET_NOT_CREATED = 30010,
|
|
541
|
-
/**
|
|
542
|
-
* Socket 连接断开
|
|
543
|
-
*/
|
|
544
|
-
RC_SOCKET_DISCONNECTED = 30011,
|
|
545
|
-
/**
|
|
546
|
-
* PING 连续失败次数超限制
|
|
547
|
-
*/
|
|
548
|
-
RC_PING_EXCEED_LIMIT = 30012,
|
|
549
|
-
/**
|
|
550
|
-
* 消息发送失败。
|
|
551
|
-
*/
|
|
552
|
-
RC_MSG_SEND_FAIL = 30014,
|
|
553
|
-
/**
|
|
554
|
-
* JSON 后的消息体超限, 目前最大 128kb
|
|
555
|
-
*/
|
|
556
|
-
RC_MSG_CONTENT_EXCEED_LIMIT = 30016,
|
|
557
|
-
/**
|
|
558
|
-
* 网络不可用,未连接。
|
|
559
|
-
*/
|
|
560
|
-
RC_NETWORK_DOWN = 30019,
|
|
561
|
-
/**
|
|
562
|
-
* TCP 连上后,rmtp 还未连上时, TCP 连接断开。
|
|
563
|
-
*/
|
|
564
|
-
RC_TCP_DISCONNECTED_NO_RMTP = 30021,
|
|
565
|
-
/**
|
|
566
|
-
* TCP 连接中,CMP 应答超时。
|
|
567
|
-
*/
|
|
568
|
-
RC_CONN_ACK_TIMEOUT = 31000,
|
|
569
|
-
/**
|
|
570
|
-
* 连接协议版本错误
|
|
571
|
-
*/
|
|
572
|
-
RC_CONN_PROTO_VERSION_ERROR = 31001,
|
|
573
|
-
/**
|
|
574
|
-
* 客户端连接用设备 info 信息错误
|
|
575
|
-
*/
|
|
576
|
-
RC_CONN_IDENTIFIER_REJECTED = 31002,
|
|
577
|
-
/**
|
|
578
|
-
* 连接服务未开通,需要排查后台小程序(或桌面端)服务是否已开通
|
|
579
|
-
*/
|
|
580
|
-
RC_CONN_SERVER_UNAVAILABLE = 31003,
|
|
581
|
-
/**
|
|
582
|
-
* Token 无法解析,或 Token 已过期
|
|
583
|
-
*/
|
|
584
|
-
RC_CONN_TOKEN_INCORRECT = 31004,
|
|
585
|
-
/**
|
|
586
|
-
* 防黑产校验失败
|
|
587
|
-
*/
|
|
588
|
-
RC_CONN_NOT_AUTHRORIZED = 31005,
|
|
589
|
-
/**
|
|
590
|
-
* 重定向,地址错误。
|
|
591
|
-
*/
|
|
592
|
-
RC_CONN_REDIRECTED = 31006,
|
|
593
|
-
/**
|
|
594
|
-
* 包名不合法(目前仅限移动端使用)
|
|
595
|
-
*/
|
|
596
|
-
RC_CONN_PACKAGE_NAME_INVALID = 31007,
|
|
597
|
-
/**
|
|
598
|
-
* Appkey 已被封禁或删除
|
|
599
|
-
*/
|
|
600
|
-
RC_CONN_APP_BLOCKED_OR_DELETED = 31008,
|
|
160
|
+
declare enum ChrmMemBanType {
|
|
601
161
|
/**
|
|
602
|
-
*
|
|
162
|
+
* 解除指定聊天室中用户禁言
|
|
603
163
|
*/
|
|
604
|
-
|
|
164
|
+
UnmuteUsers = 0,
|
|
605
165
|
/**
|
|
606
|
-
*
|
|
166
|
+
* 禁言指定聊天室中用户
|
|
607
167
|
*/
|
|
608
|
-
|
|
168
|
+
MuteUsers = 1,
|
|
609
169
|
/**
|
|
610
|
-
*
|
|
170
|
+
* 解除聊天室全体禁言
|
|
611
171
|
*/
|
|
612
|
-
|
|
172
|
+
UnmuteAll = 2,
|
|
613
173
|
/**
|
|
614
|
-
*
|
|
174
|
+
* 聊天室全体禁言
|
|
615
175
|
*/
|
|
616
|
-
|
|
176
|
+
MuteAll = 3,
|
|
617
177
|
/**
|
|
618
|
-
*
|
|
178
|
+
* 移出禁言用户白名单
|
|
619
179
|
*/
|
|
620
|
-
|
|
180
|
+
RemoveWhitelist = 4,
|
|
621
181
|
/**
|
|
622
|
-
*
|
|
182
|
+
* 添加禁言用户白名单
|
|
623
183
|
*/
|
|
624
|
-
|
|
184
|
+
AddWhitelist = 5,
|
|
625
185
|
/**
|
|
626
|
-
*
|
|
186
|
+
* 解除用户聊天室全局禁言
|
|
627
187
|
*/
|
|
628
|
-
|
|
188
|
+
UnmuteGloble = 6,
|
|
629
189
|
/**
|
|
630
|
-
*
|
|
190
|
+
* 用户聊天室全局禁言
|
|
631
191
|
*/
|
|
632
|
-
|
|
192
|
+
MuteGloble = 7
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* 聊天室多端同步时,离开聊天室的原因
|
|
197
|
+
* @category Enum
|
|
198
|
+
* @since 5.7.9
|
|
199
|
+
*/
|
|
200
|
+
declare enum ChatroomSyncStatusReason {
|
|
633
201
|
/**
|
|
634
|
-
*
|
|
202
|
+
* 自己主动离开
|
|
635
203
|
*/
|
|
636
|
-
|
|
204
|
+
LeaveOnMyOwn = 0,
|
|
637
205
|
/**
|
|
638
|
-
*
|
|
206
|
+
* 多端加入互踢导致离开
|
|
639
207
|
*/
|
|
640
|
-
|
|
208
|
+
OtherDeviceLogin = 1
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* @category Interface
|
|
213
|
+
*/
|
|
214
|
+
interface IChatroomEntryListenerData {
|
|
641
215
|
/**
|
|
642
|
-
*
|
|
643
|
-
|
|
644
|
-
|
|
216
|
+
* 更新的键
|
|
217
|
+
*/
|
|
218
|
+
key: string;
|
|
645
219
|
/**
|
|
646
|
-
*
|
|
647
|
-
|
|
648
|
-
|
|
220
|
+
* 更新的值
|
|
221
|
+
*/
|
|
222
|
+
value: string;
|
|
649
223
|
/**
|
|
650
|
-
*
|
|
651
|
-
|
|
652
|
-
|
|
224
|
+
* 更新的时间
|
|
225
|
+
*/
|
|
226
|
+
timestamp: number;
|
|
653
227
|
/**
|
|
654
|
-
*
|
|
655
|
-
|
|
656
|
-
|
|
228
|
+
* 更新的聊天室 ID
|
|
229
|
+
*/
|
|
230
|
+
chatroomId: string;
|
|
657
231
|
/**
|
|
658
|
-
*
|
|
659
|
-
|
|
660
|
-
|
|
232
|
+
* 更新类型
|
|
233
|
+
*/
|
|
234
|
+
type: ChatroomEntryType;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* @category Interface
|
|
238
|
+
*/
|
|
239
|
+
interface IChatroomRejoinedFailed {
|
|
661
240
|
/**
|
|
662
|
-
*
|
|
663
|
-
|
|
664
|
-
|
|
241
|
+
* 自动重新加入的聊天室 ID
|
|
242
|
+
*/
|
|
243
|
+
chatroomId: string;
|
|
665
244
|
/**
|
|
666
|
-
*
|
|
667
|
-
|
|
668
|
-
|
|
245
|
+
* 自动重新加入失败的 code
|
|
246
|
+
*/
|
|
247
|
+
errorCode: number;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* @category Interface
|
|
251
|
+
*/
|
|
252
|
+
interface IChatroomRejoinedSuccessed extends IChatroomJoinResponse {
|
|
669
253
|
/**
|
|
670
|
-
*
|
|
671
|
-
|
|
672
|
-
|
|
254
|
+
* 自动重新加入的聊天室 ID
|
|
255
|
+
*/
|
|
256
|
+
chatroomId: string;
|
|
673
257
|
/**
|
|
674
|
-
*
|
|
675
|
-
|
|
676
|
-
|
|
258
|
+
* 自动重新加入的聊天室拉取消息的数量
|
|
259
|
+
*/
|
|
260
|
+
count: number;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* @category Interface
|
|
264
|
+
*/
|
|
265
|
+
interface IChatroomUserChangeInfo {
|
|
266
|
+
users: {
|
|
267
|
+
[userId: string]: ChatroomUserChangeType;
|
|
268
|
+
};
|
|
269
|
+
chatroomId: string;
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* @category Interface
|
|
273
|
+
* @since 5.7.9
|
|
274
|
+
*/
|
|
275
|
+
interface IChatroomNotifyMultiLoginSync {
|
|
677
276
|
/**
|
|
678
|
-
*
|
|
277
|
+
* 聊天室ID
|
|
679
278
|
*/
|
|
680
|
-
|
|
279
|
+
chatroomId: string;
|
|
681
280
|
/**
|
|
682
|
-
*
|
|
281
|
+
* 变更的状态,0:离开, 1:加入
|
|
683
282
|
*/
|
|
684
|
-
|
|
283
|
+
status: ChrmSyncStatus;
|
|
685
284
|
/**
|
|
686
|
-
*
|
|
687
|
-
* @deprecated
|
|
285
|
+
* 如果status是0的情况,区分离开类型,0:主动离开, 1:多端加入被踢
|
|
688
286
|
*/
|
|
689
|
-
|
|
287
|
+
reason: ChatroomSyncStatusReason;
|
|
690
288
|
/**
|
|
691
|
-
*
|
|
692
|
-
* @deprecated
|
|
289
|
+
* 用户加入/退出/被踢的时间(毫秒时间戳)
|
|
693
290
|
*/
|
|
694
|
-
|
|
291
|
+
time: number;
|
|
695
292
|
/**
|
|
696
|
-
*
|
|
697
|
-
* @deprecated
|
|
293
|
+
* 附加信息
|
|
698
294
|
*/
|
|
699
|
-
|
|
295
|
+
extra: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* @category Interface
|
|
299
|
+
* @since 5.7.9
|
|
300
|
+
*/
|
|
301
|
+
interface IChatroomNotifyBlock {
|
|
700
302
|
/**
|
|
701
|
-
*
|
|
303
|
+
* 聊天室ID
|
|
702
304
|
*/
|
|
703
|
-
|
|
305
|
+
chatroomId: string;
|
|
704
306
|
/**
|
|
705
|
-
*
|
|
307
|
+
* 封禁类型,0是解封,1是封禁
|
|
706
308
|
*/
|
|
707
|
-
|
|
309
|
+
operateType: ChrmMemOperateType;
|
|
708
310
|
/**
|
|
709
|
-
*
|
|
311
|
+
* 封禁时长(毫秒),封禁时有此字段,封禁时长最大值为43200分钟(1个月), 最小值1分钟
|
|
710
312
|
*/
|
|
711
|
-
|
|
313
|
+
durationTime: number;
|
|
712
314
|
/**
|
|
713
|
-
*
|
|
315
|
+
* 操作时间(毫秒时间戳)
|
|
714
316
|
*/
|
|
715
|
-
|
|
317
|
+
operateTime: number;
|
|
716
318
|
/**
|
|
717
|
-
*
|
|
319
|
+
* 被封禁/解封的用户 ID 列表
|
|
718
320
|
*/
|
|
719
|
-
|
|
321
|
+
userIdList: string[];
|
|
720
322
|
/**
|
|
721
|
-
*
|
|
323
|
+
* 附加信息
|
|
722
324
|
*/
|
|
723
|
-
|
|
325
|
+
extra: string;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* @category Interface
|
|
329
|
+
* @since 5.7.9
|
|
330
|
+
*/
|
|
331
|
+
interface IChatroomNotifyBan {
|
|
724
332
|
/**
|
|
725
|
-
*
|
|
333
|
+
* 聊天室ID
|
|
726
334
|
*/
|
|
727
|
-
|
|
335
|
+
chatroomId: string;
|
|
728
336
|
/**
|
|
729
|
-
*
|
|
730
|
-
* @deprecated
|
|
337
|
+
* 禁言类型
|
|
731
338
|
*/
|
|
732
|
-
|
|
339
|
+
banType: ChrmMemBanType;
|
|
733
340
|
/**
|
|
734
|
-
*
|
|
735
|
-
* @deprecated
|
|
341
|
+
* 禁言时长(毫秒),禁言时有此字段,禁言时长最大值为43200分钟(1个月), 最小值1分钟
|
|
736
342
|
*/
|
|
737
|
-
|
|
343
|
+
durationTime: number;
|
|
738
344
|
/**
|
|
739
|
-
*
|
|
740
|
-
* @deprecated
|
|
345
|
+
* 操作时间(毫秒时间戳)
|
|
741
346
|
*/
|
|
742
|
-
|
|
347
|
+
operateTime: number;
|
|
743
348
|
/**
|
|
744
|
-
*
|
|
745
|
-
* @deprecated
|
|
349
|
+
* 禁言/解禁言用户 ID 列表
|
|
746
350
|
*/
|
|
747
|
-
|
|
351
|
+
userIdList: string[];
|
|
748
352
|
/**
|
|
749
|
-
*
|
|
750
|
-
* @deprecated
|
|
353
|
+
* 附加信息
|
|
751
354
|
*/
|
|
752
|
-
|
|
355
|
+
extra: string;
|
|
356
|
+
}
|
|
357
|
+
declare type IChatroomRejoinedInfo = IChatroomRejoinedFailed | IChatroomRejoinedSuccessed;
|
|
358
|
+
/**
|
|
359
|
+
* 聊天室信息
|
|
360
|
+
* @category Interface
|
|
361
|
+
*/
|
|
362
|
+
interface IChatroomListenerData {
|
|
753
363
|
/**
|
|
754
|
-
*
|
|
755
|
-
|
|
756
|
-
|
|
364
|
+
* SDK 内部重连聊天室信息
|
|
365
|
+
*/
|
|
366
|
+
rejoinedRoom?: IChatroomRejoinedInfo;
|
|
367
|
+
/**
|
|
368
|
+
* 监听到的聊天室 KV 更新
|
|
369
|
+
*/
|
|
370
|
+
updatedEntries?: IChatroomEntryListenerData[];
|
|
757
371
|
/**
|
|
758
|
-
*
|
|
372
|
+
* 登录退出的用户通知
|
|
759
373
|
*/
|
|
760
|
-
|
|
374
|
+
userChange?: IChatroomUserChangeInfo;
|
|
761
375
|
/**
|
|
762
|
-
*
|
|
376
|
+
* 聊天室销毁
|
|
763
377
|
*/
|
|
764
|
-
|
|
378
|
+
chatroomDestroyed?: string;
|
|
765
379
|
/**
|
|
766
|
-
*
|
|
380
|
+
* 加入退出多端同步通知
|
|
767
381
|
*/
|
|
768
|
-
|
|
382
|
+
chatroomNotifyMultiLoginSync?: IChatroomNotifyMultiLoginSync;
|
|
769
383
|
/**
|
|
770
|
-
*
|
|
384
|
+
* 聊天室用户封禁通知
|
|
771
385
|
*/
|
|
772
|
-
|
|
386
|
+
chatroomNotifyBlock?: IChatroomNotifyBlock;
|
|
773
387
|
/**
|
|
774
|
-
*
|
|
775
|
-
* @deprecated 没有使用
|
|
388
|
+
* 聊天室用户禁言通知
|
|
776
389
|
*/
|
|
777
|
-
|
|
390
|
+
chatroomNotifyBan?: IChatroomNotifyBan;
|
|
391
|
+
}
|
|
392
|
+
/**
|
|
393
|
+
* @category Interface
|
|
394
|
+
*/
|
|
395
|
+
interface IChatroomEntry {
|
|
778
396
|
/**
|
|
779
|
-
*
|
|
780
|
-
* @deprecated 没有使用
|
|
397
|
+
* 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
|
|
781
398
|
*/
|
|
782
|
-
|
|
399
|
+
key: string;
|
|
783
400
|
/**
|
|
784
|
-
*
|
|
401
|
+
* 属性对应的值, 最大长度 4096 字符
|
|
785
402
|
*/
|
|
786
|
-
|
|
403
|
+
value: string;
|
|
787
404
|
/**
|
|
788
|
-
*
|
|
405
|
+
* 设置成功后是否发送通知消息
|
|
789
406
|
*/
|
|
790
|
-
|
|
407
|
+
isSendNotification?: boolean;
|
|
791
408
|
/**
|
|
792
|
-
*
|
|
793
|
-
* @deprecated 没有使用
|
|
409
|
+
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
794
410
|
*/
|
|
795
|
-
|
|
411
|
+
notificationExtra?: string;
|
|
796
412
|
/**
|
|
797
|
-
*
|
|
413
|
+
* 用户退出聊天室时是否清除此属性
|
|
798
414
|
*/
|
|
799
|
-
|
|
415
|
+
isAutoDelete?: boolean;
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* @category Interface
|
|
419
|
+
*/
|
|
420
|
+
interface IChatroomUser {
|
|
800
421
|
/**
|
|
801
|
-
*
|
|
422
|
+
* 用户 id
|
|
802
423
|
*/
|
|
803
|
-
|
|
424
|
+
id: string;
|
|
804
425
|
/**
|
|
805
|
-
*
|
|
806
|
-
* @deprecated 没有使用
|
|
426
|
+
* 加入聊天室的时间
|
|
807
427
|
*/
|
|
808
|
-
|
|
428
|
+
time: number;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* @category Interface
|
|
432
|
+
*/
|
|
433
|
+
interface IChatroomInfo {
|
|
809
434
|
/**
|
|
810
|
-
*
|
|
435
|
+
* 成员列表
|
|
436
|
+
* @todo 需确认数组元素的数据结构
|
|
811
437
|
*/
|
|
812
|
-
|
|
438
|
+
userInfos: IChatroomUser[];
|
|
813
439
|
/**
|
|
814
|
-
*
|
|
440
|
+
* 房间内总人数
|
|
815
441
|
*/
|
|
816
|
-
|
|
442
|
+
userCount: number;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* @category Interface
|
|
446
|
+
*/
|
|
447
|
+
interface IRemoveChatroomEntry {
|
|
817
448
|
/**
|
|
818
|
-
*
|
|
449
|
+
* 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
|
|
819
450
|
*/
|
|
820
|
-
|
|
451
|
+
key: string;
|
|
821
452
|
/**
|
|
822
|
-
*
|
|
453
|
+
* 删除成功后是否发送通知消息
|
|
823
454
|
*/
|
|
824
|
-
|
|
455
|
+
isSendNotification?: boolean;
|
|
825
456
|
/**
|
|
826
|
-
*
|
|
827
|
-
* @deprecated
|
|
457
|
+
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
828
458
|
*/
|
|
829
|
-
|
|
459
|
+
notificationExtra?: string;
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* @category Interface
|
|
463
|
+
*/
|
|
464
|
+
interface IRemoveChatroomEntries {
|
|
830
465
|
/**
|
|
831
|
-
*
|
|
832
|
-
* @deprecated
|
|
466
|
+
* key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
|
|
833
467
|
*/
|
|
834
|
-
|
|
468
|
+
entries: {
|
|
469
|
+
key: string;
|
|
470
|
+
}[];
|
|
835
471
|
/**
|
|
836
|
-
*
|
|
837
|
-
* @deprecated
|
|
472
|
+
* 删除成功后是否发送通知消息
|
|
838
473
|
*/
|
|
839
|
-
CHATROOM_HISMESSAGE_ERROR = 36003,
|
|
840
474
|
/**
|
|
841
|
-
*
|
|
842
|
-
* @deprecated
|
|
475
|
+
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
843
476
|
*/
|
|
844
|
-
|
|
477
|
+
notificationExtra?: string;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* @category Interface
|
|
481
|
+
*/
|
|
482
|
+
interface IChatroomEntries {
|
|
845
483
|
/**
|
|
846
|
-
*
|
|
847
|
-
*
|
|
484
|
+
* entries ,要设置的属性列表
|
|
485
|
+
* key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
|
|
486
|
+
* value 属性对应的值, 最大长度 4096 字符
|
|
848
487
|
*/
|
|
849
|
-
|
|
488
|
+
entries: {
|
|
489
|
+
key: string;
|
|
490
|
+
value: string;
|
|
491
|
+
}[];
|
|
850
492
|
/**
|
|
851
|
-
*
|
|
852
|
-
* @deprecated
|
|
493
|
+
* 设置成功后是否发送通知消息
|
|
853
494
|
*/
|
|
854
|
-
BLACK_GETSTATUS_ERROR = 37002,
|
|
855
495
|
/**
|
|
856
|
-
*
|
|
857
|
-
* @deprecated
|
|
496
|
+
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
858
497
|
*/
|
|
859
|
-
|
|
498
|
+
notificationExtra?: string;
|
|
860
499
|
/**
|
|
861
|
-
*
|
|
862
|
-
* @deprecated
|
|
500
|
+
* 用户退出聊天室时是否清除此属性
|
|
863
501
|
*/
|
|
864
|
-
|
|
502
|
+
isAutoDelete?: boolean;
|
|
865
503
|
/**
|
|
866
|
-
*
|
|
504
|
+
* 是否强制覆盖
|
|
867
505
|
*/
|
|
868
|
-
|
|
506
|
+
isForce?: boolean;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* 聊天室加入成功返回值
|
|
510
|
+
* @5.8.3
|
|
511
|
+
*/
|
|
512
|
+
interface IChatroomJoinResponse {
|
|
869
513
|
/**
|
|
870
|
-
*
|
|
514
|
+
* 聊天室创建时间
|
|
871
515
|
*/
|
|
872
|
-
|
|
516
|
+
createTime: number;
|
|
873
517
|
/**
|
|
874
|
-
*
|
|
875
|
-
* @deprecated
|
|
518
|
+
* 当前聊天室人员数量
|
|
876
519
|
*/
|
|
877
|
-
|
|
520
|
+
memberCount: number;
|
|
878
521
|
/**
|
|
879
|
-
*
|
|
522
|
+
* 聊天室全局禁言
|
|
880
523
|
*/
|
|
881
|
-
|
|
524
|
+
isAllChatroomBanned: boolean;
|
|
882
525
|
/**
|
|
883
|
-
*
|
|
884
|
-
* @deprecated
|
|
526
|
+
* 当前用户被全局禁言
|
|
885
527
|
*/
|
|
886
|
-
|
|
528
|
+
isCurrentUserBanned: boolean;
|
|
887
529
|
/**
|
|
888
|
-
*
|
|
889
|
-
* @deprecated
|
|
530
|
+
* 当前聊天室被禁言
|
|
890
531
|
*/
|
|
891
|
-
|
|
532
|
+
isCurrentChatroomBanned: boolean;
|
|
892
533
|
/**
|
|
893
|
-
*
|
|
894
|
-
* @deprecated
|
|
534
|
+
* 聊天室全局禁言白名单
|
|
895
535
|
*/
|
|
896
|
-
|
|
536
|
+
isCurrentChatroomInWhitelist: boolean;
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
/**
|
|
540
|
+
* LogLevel 等级定义,与大数据服务器日志等级保持一致
|
|
541
|
+
*/
|
|
542
|
+
declare enum LogL {
|
|
897
543
|
/**
|
|
898
|
-
*
|
|
899
|
-
*
|
|
544
|
+
* IM 质量数据日志,控制台不打印
|
|
900
545
|
*/
|
|
901
|
-
|
|
546
|
+
STATISTICS = -2,
|
|
902
547
|
/**
|
|
903
|
-
*
|
|
904
|
-
*
|
|
548
|
+
* 未明确使用场景,暂未使用,控制台不打印
|
|
549
|
+
* TODO:
|
|
550
|
+
* 暂未明确使用场景,实时日志系统上报?
|
|
551
|
+
* 需要明确下为什么会有 -1,以及与 -2 的区别,并在注释中补充
|
|
905
552
|
*/
|
|
906
|
-
|
|
553
|
+
RECORD = -1,
|
|
907
554
|
/**
|
|
908
|
-
*
|
|
909
|
-
*
|
|
555
|
+
* 未明确使用场景,暂未使用,控制台不打印
|
|
910
556
|
*/
|
|
911
|
-
|
|
557
|
+
FATAL = 0,
|
|
912
558
|
/**
|
|
913
|
-
*
|
|
914
|
-
*
|
|
559
|
+
* ERROR 级
|
|
915
560
|
*/
|
|
916
|
-
|
|
561
|
+
ERROR = 1,
|
|
917
562
|
/**
|
|
918
|
-
*
|
|
563
|
+
* WARN 级
|
|
919
564
|
*/
|
|
920
|
-
|
|
565
|
+
WARN = 2,
|
|
921
566
|
/**
|
|
922
|
-
*
|
|
567
|
+
* INFO 级
|
|
923
568
|
*/
|
|
924
|
-
|
|
569
|
+
INFO = 3,
|
|
925
570
|
/**
|
|
926
|
-
*
|
|
571
|
+
* DEBUG 级
|
|
927
572
|
*/
|
|
928
|
-
|
|
573
|
+
DEBUG = 4
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* 有效的日志等级声明
|
|
577
|
+
*/
|
|
578
|
+
declare type EnableLogL = LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR;
|
|
579
|
+
|
|
580
|
+
declare type LogContent = string | number | boolean | null;
|
|
581
|
+
declare type LogType = 'IM' | 'RTC';
|
|
582
|
+
/**
|
|
583
|
+
* 对外暴露的 Logger 工具接口定义,以隐藏 BasicLogger 其他实现
|
|
584
|
+
*/
|
|
585
|
+
interface ILogger {
|
|
586
|
+
debug(tag: string, content?: LogContent, traceId?: string): void;
|
|
587
|
+
info(tag: string, content?: LogContent, traceId?: string): void;
|
|
588
|
+
warn(tag: string, content?: LogContent, traceId?: string): void;
|
|
589
|
+
error(tag: string, content?: LogContent, traceId?: string): void;
|
|
929
590
|
/**
|
|
930
|
-
*
|
|
591
|
+
* 设置日志打印等级,默认为 `LogL.WARN`
|
|
592
|
+
* @param level
|
|
931
593
|
*/
|
|
932
|
-
|
|
594
|
+
setOutputLevel(level?: EnableLogL): void;
|
|
933
595
|
/**
|
|
934
|
-
*
|
|
596
|
+
* 创建事务追踪 ID,全局唯一,便于跨进程、异步事务追踪,需要考虑多进程
|
|
935
597
|
*/
|
|
936
|
-
|
|
598
|
+
createTraceId(): string;
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
interface ILogData {
|
|
937
602
|
/**
|
|
938
|
-
*
|
|
603
|
+
* 日志原始内容
|
|
939
604
|
*/
|
|
940
|
-
|
|
605
|
+
content?: LogContent;
|
|
941
606
|
/**
|
|
942
|
-
*
|
|
607
|
+
* 日志标签,如 `L-INIT-O`
|
|
943
608
|
*/
|
|
944
|
-
|
|
609
|
+
tag: string;
|
|
945
610
|
/**
|
|
946
|
-
*
|
|
947
|
-
* @deprecated
|
|
611
|
+
* logger 实例 Id,用于确定日志由谁埋点,如 `RCEngien` 为 engine 包埋点日志
|
|
948
612
|
*/
|
|
949
|
-
|
|
613
|
+
loggerId: string;
|
|
950
614
|
/**
|
|
951
|
-
*
|
|
952
|
-
* @deprecated
|
|
615
|
+
* 日志生成时间
|
|
953
616
|
*/
|
|
954
|
-
|
|
617
|
+
time: number;
|
|
955
618
|
/**
|
|
956
|
-
*
|
|
957
|
-
* @
|
|
619
|
+
* 应用的声明周期 sessionId
|
|
620
|
+
* @description
|
|
621
|
+
* Electron 环境下,以主进程 sessionId 入库,渲染进程 sessionId 存储于 content 内。
|
|
622
|
+
* 日志上报时,通过 `${mainSessionId}:${renderSessionId}` 形式作为 sessionId 上报
|
|
623
|
+
* @TODO 需确认服务是否允许 `${mainSessionId}:${renderSessionId}` 的方式,以及 sessionId 是否超出长度。
|
|
958
624
|
*/
|
|
959
|
-
|
|
625
|
+
sessionId: string;
|
|
960
626
|
/**
|
|
961
|
-
*
|
|
962
|
-
* @deprecated
|
|
627
|
+
* 日志类型,仅用于大数据后台查阅统计
|
|
963
628
|
*/
|
|
964
|
-
|
|
629
|
+
type: 'IM' | 'RTC';
|
|
965
630
|
/**
|
|
966
|
-
*
|
|
967
|
-
* @deprecated
|
|
631
|
+
* 日志等级,该等级与服务器统计等级保持一致,为入库等级
|
|
968
632
|
*/
|
|
969
|
-
|
|
633
|
+
level: LogL;
|
|
970
634
|
/**
|
|
971
|
-
*
|
|
972
|
-
* @deprecated
|
|
635
|
+
* 事务跟踪 ID
|
|
973
636
|
*/
|
|
974
|
-
|
|
637
|
+
traceId?: string;
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* Logger 抽象基类,定义日志采集接口与进程内打印,
|
|
642
|
+
* 由子类继承实现入库逻辑
|
|
643
|
+
*/
|
|
644
|
+
declare abstract class BasicLogger implements ILogger {
|
|
645
|
+
protected readonly _appkey: string;
|
|
646
|
+
protected readonly _id: string;
|
|
647
|
+
protected readonly _type: LogType;
|
|
648
|
+
constructor(_appkey: string, _id: string, _type: LogType);
|
|
649
|
+
private _stdout;
|
|
975
650
|
/**
|
|
976
|
-
*
|
|
977
|
-
* @deprecated
|
|
651
|
+
* 用户的打印日志等级配置
|
|
978
652
|
*/
|
|
979
|
-
|
|
653
|
+
private outputLevel;
|
|
654
|
+
setOutputLevel(level?: EnableLogL): void;
|
|
980
655
|
/**
|
|
981
|
-
*
|
|
982
|
-
* @
|
|
656
|
+
* 由子类继承实现日志入库
|
|
657
|
+
* @override
|
|
983
658
|
*/
|
|
984
|
-
|
|
659
|
+
protected abstract flush(data: ILogData): void;
|
|
660
|
+
private _log;
|
|
661
|
+
debug: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
662
|
+
info: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
663
|
+
warn: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
664
|
+
error: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
985
665
|
/**
|
|
986
|
-
*
|
|
987
|
-
* @deprecated
|
|
666
|
+
* 内部质量数据统计接口,仅限 IMLib 与 RTCLib 内部使用
|
|
988
667
|
*/
|
|
989
|
-
|
|
668
|
+
__statistics: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
|
|
990
669
|
/**
|
|
991
|
-
*
|
|
992
|
-
* @deprecated
|
|
670
|
+
* 创建事务追踪 ID,全局唯一,便于跨进程、异步事务追踪,需要考虑多进程
|
|
993
671
|
*/
|
|
994
|
-
|
|
672
|
+
createTraceId(): string;
|
|
995
673
|
/**
|
|
996
|
-
*
|
|
997
|
-
* @
|
|
674
|
+
* 获取当前进程的 sessionId,全局唯一
|
|
675
|
+
* @returns
|
|
998
676
|
*/
|
|
999
|
-
|
|
677
|
+
getSessionId(): string;
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
* 实现基于 IndexDB 存储的日志类
|
|
682
|
+
*/
|
|
683
|
+
declare class IndexDBLogger extends BasicLogger {
|
|
684
|
+
protected flush(data: ILogData): void;
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* 日志数据库接口
|
|
689
|
+
*/
|
|
690
|
+
interface ILogDB {
|
|
1000
691
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
692
|
+
* 获取实时日志上报的时间戳记录。
|
|
693
|
+
* 时间戳不以人为维度记录,避免换账户登录时,一次拉取巨量的历史日志。
|
|
1003
694
|
*/
|
|
1004
|
-
|
|
695
|
+
getTimestamp4RealtimeLog(): number;
|
|
1005
696
|
/**
|
|
1006
|
-
*
|
|
1007
|
-
* @
|
|
697
|
+
* 设置实时日志上报的时间戳记录
|
|
698
|
+
* @param timestamp
|
|
1008
699
|
*/
|
|
1009
|
-
|
|
700
|
+
setTimestamp4RealtimeLog(timestamp: number): void;
|
|
1010
701
|
/**
|
|
1011
|
-
*
|
|
1012
|
-
* @
|
|
702
|
+
* 根据时间戳和日志等级获取全量日志
|
|
703
|
+
* @param startTime
|
|
704
|
+
* @param endTime
|
|
705
|
+
* @param level
|
|
706
|
+
* @param realtimeReport 是否实时上报。实时上报时,需要取质量数据日志
|
|
1013
707
|
*/
|
|
1014
|
-
|
|
708
|
+
getLogs(startTime: number, endTime: number, level: LogL, realtimeReport: boolean): Promise<{
|
|
709
|
+
logs: ILogData[];
|
|
710
|
+
dbReady: boolean;
|
|
711
|
+
}>;
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
/**
|
|
715
|
+
* 消息被拦截类型
|
|
716
|
+
* @category Enum
|
|
717
|
+
*/
|
|
718
|
+
declare enum MessageBlockType {
|
|
1015
719
|
/**
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
VOIP_NOT_AVALIABLE = 18,
|
|
720
|
+
全局敏感词:命中了融云内置的全局敏感词
|
|
721
|
+
*/
|
|
722
|
+
GLOBAL = 1,
|
|
1020
723
|
/**
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
724
|
+
自定义敏感词拦截:命中了客户在融云自定义的敏感词
|
|
725
|
+
*/
|
|
726
|
+
CUSTOM = 2,
|
|
1024
727
|
/**
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
728
|
+
第三方审核拦截:命中了第三方(数美)或模板路由决定不下发的状态
|
|
729
|
+
*/
|
|
730
|
+
THIRD_PARTY = 3
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* 消息被拦截源触发类型
|
|
734
|
+
*/
|
|
735
|
+
declare enum MessageBlockSourceType {
|
|
736
|
+
/** 原始消息 */
|
|
737
|
+
MSG_ORIGINAL = 0,
|
|
738
|
+
/** 消息扩展 */
|
|
739
|
+
MSG_EXPANSION = 1,
|
|
740
|
+
/** 消息修改 */
|
|
741
|
+
MSG_MODIFY = 2
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* 消息方向
|
|
746
|
+
* @category Enum
|
|
747
|
+
*/
|
|
748
|
+
declare enum MessageDirection {
|
|
1028
749
|
/**
|
|
1029
|
-
*
|
|
750
|
+
* 己方发送消息
|
|
1030
751
|
*/
|
|
1031
|
-
|
|
752
|
+
SEND = 1,
|
|
1032
753
|
/**
|
|
1033
|
-
*
|
|
754
|
+
* 己方接收消息
|
|
1034
755
|
*/
|
|
1035
|
-
|
|
756
|
+
RECEIVE = 2
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
/**
|
|
760
|
+
* 输入状态类型
|
|
761
|
+
*/
|
|
762
|
+
declare enum OperateStatus {
|
|
763
|
+
typing = 0
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
/**
|
|
767
|
+
* 文件类型
|
|
768
|
+
* @category Enum
|
|
769
|
+
*/
|
|
770
|
+
declare enum FileType {
|
|
1036
771
|
/**
|
|
1037
|
-
*
|
|
772
|
+
* 图片文件
|
|
1038
773
|
*/
|
|
1039
|
-
|
|
774
|
+
IMAGE = 1,
|
|
1040
775
|
/**
|
|
1041
|
-
*
|
|
776
|
+
* 声音文件
|
|
1042
777
|
*/
|
|
1043
|
-
|
|
778
|
+
AUDIO = 2,
|
|
1044
779
|
/**
|
|
1045
|
-
*
|
|
1046
|
-
* 移动端使用的为 31028,但web 端此状态码已经被占用,所以改为 web 端使用号码段 35XXX
|
|
1047
|
-
* @discussion 设置 setProxy 接口不可在连接或正在连接中的状态调用。
|
|
780
|
+
* 视频文件
|
|
1048
781
|
*/
|
|
1049
|
-
|
|
782
|
+
VIDEO = 3,
|
|
1050
783
|
/**
|
|
1051
|
-
*
|
|
784
|
+
* 非媒体文件
|
|
1052
785
|
*/
|
|
1053
|
-
|
|
786
|
+
FILE = 4,
|
|
787
|
+
/**
|
|
788
|
+
* 小视频类型
|
|
789
|
+
*/
|
|
790
|
+
SIGHT = 5,
|
|
791
|
+
/**
|
|
792
|
+
* 合并转发
|
|
793
|
+
*/
|
|
794
|
+
COMBINE_HTML = 6
|
|
1054
795
|
}
|
|
1055
796
|
|
|
1056
797
|
/**
|
|
@@ -1061,15 +802,32 @@ declare enum ErrorCode {
|
|
|
1061
802
|
*
|
|
1062
803
|
* @category Enum
|
|
1063
804
|
*/
|
|
1064
|
-
declare enum
|
|
805
|
+
declare enum ErrorCode {
|
|
806
|
+
/**
|
|
807
|
+
* 未知错误
|
|
808
|
+
*/
|
|
809
|
+
TIMEOUT = -1,
|
|
810
|
+
/**
|
|
811
|
+
* 成功
|
|
812
|
+
*/
|
|
813
|
+
SUCCESS = 0,
|
|
814
|
+
/**
|
|
815
|
+
* 主动断开连接
|
|
816
|
+
*/
|
|
817
|
+
ACTIVE_DISCONNECT = 2,
|
|
1065
818
|
/**
|
|
1066
819
|
* 已被对方加入黑名单,消息发送失败
|
|
1067
820
|
*/
|
|
1068
821
|
REJECTED_BY_BLACKLIST = 405,
|
|
822
|
+
/**
|
|
823
|
+
* 系统会话不支持发送该消息
|
|
824
|
+
* @since 5.8.2
|
|
825
|
+
*/
|
|
826
|
+
SYS_CONVERSATION_NOT_SUPPORT_MESSAGE = 20109,
|
|
1069
827
|
/**
|
|
1070
828
|
* 发送消息频率过高,1 秒钟最多只允许发送 5 条消息
|
|
1071
829
|
*/
|
|
1072
|
-
|
|
830
|
+
SEND_FREQUENCY_TOO_FAST = 20604,
|
|
1073
831
|
/**
|
|
1074
832
|
* 操作被禁止,此错误码已被弃用
|
|
1075
833
|
*/
|
|
@@ -1082,14 +840,18 @@ declare enum ErrorCodes {
|
|
|
1082
840
|
* 请求超出了调用频率限制,请稍后再试
|
|
1083
841
|
*/
|
|
1084
842
|
REQUEST_OVER_FREQUENCY = 20607,
|
|
843
|
+
/**
|
|
844
|
+
* 不在讨论组
|
|
845
|
+
*/
|
|
846
|
+
NOT_IN_DISCUSSION = 21406,
|
|
1085
847
|
/**
|
|
1086
848
|
* 发送的消息中包含敏感词 (发送方发送失败,接收方不会收到消息)
|
|
1087
849
|
*/
|
|
1088
|
-
|
|
850
|
+
SENSITIVE_SHIELD = 21501,
|
|
1089
851
|
/**
|
|
1090
852
|
* 消息中敏感词已经被替换 (接收方可以收到被替换之后的消息)
|
|
1091
853
|
*/
|
|
1092
|
-
|
|
854
|
+
SENSITIVE_REPLACE = 21502,
|
|
1093
855
|
/**
|
|
1094
856
|
* 超级群扩展消息,但是原始消息不存在。
|
|
1095
857
|
*/
|
|
@@ -1121,7 +883,7 @@ declare enum ErrorCodes {
|
|
|
1121
883
|
/**
|
|
1122
884
|
* 获取用户失败
|
|
1123
885
|
*/
|
|
1124
|
-
|
|
886
|
+
GET_USERINFO_ERROR = 23407,
|
|
1125
887
|
/**
|
|
1126
888
|
* 在该聊天室中已被禁言
|
|
1127
889
|
*/
|
|
@@ -1129,35 +891,35 @@ declare enum ErrorCodes {
|
|
|
1129
891
|
/**
|
|
1130
892
|
* 已被踢出并禁止加入聊天室。被禁止的时间取决于服务端调用踢出接口时传入的时间。
|
|
1131
893
|
*/
|
|
1132
|
-
|
|
894
|
+
RC_CHATROOM_USER_KICKED = 23409,
|
|
1133
895
|
/**
|
|
1134
896
|
* 聊天室不存在
|
|
1135
897
|
*/
|
|
1136
|
-
|
|
898
|
+
RC_CHATROOM_NOT_EXIST = 23410,
|
|
1137
899
|
/**
|
|
1138
900
|
* 聊天室成员超限,开发者可以提交工单申请聊天室人数限制变更。
|
|
1139
901
|
*/
|
|
1140
|
-
|
|
902
|
+
RC_CHATROOM_IS_FULL = 23411,
|
|
1141
903
|
/**
|
|
1142
904
|
* 聊天室接口参数无效。请确认参数是否为空或者有效。
|
|
1143
905
|
*/
|
|
1144
|
-
|
|
906
|
+
RC_CHATROOM_PATAMETER_INVALID = 23412,
|
|
1145
907
|
/**
|
|
1146
908
|
* 查询聊天室历史消息异常
|
|
1147
909
|
*/
|
|
1148
|
-
|
|
910
|
+
CHATROOM_GET_HISTORYMSG_ERROR = 23413,
|
|
1149
911
|
/**
|
|
1150
912
|
* 聊天室云存储业务未开通
|
|
1151
913
|
*/
|
|
1152
|
-
|
|
914
|
+
CHATROOM_NOT_OPEN_HISTORYMSG_STORE = 23414,
|
|
1153
915
|
/**
|
|
1154
916
|
* 聊天室的 KV 属性个数超限,单个聊天室默认上限为 100 个
|
|
1155
917
|
*/
|
|
1156
|
-
|
|
918
|
+
CHATROOM_KV_EXCEED = 23423,
|
|
1157
919
|
/**
|
|
1158
920
|
* 没有权限修改聊天室中已存在的属性值
|
|
1159
921
|
*/
|
|
1160
|
-
|
|
922
|
+
CHATROOM_KV_OVERWRITE_INVALID = 23424,
|
|
1161
923
|
/**
|
|
1162
924
|
* 超过聊天室中状态设置频率,1 个聊天室 1 秒钟最多设置和删除状态 100 次
|
|
1163
925
|
*/
|
|
@@ -1165,23 +927,24 @@ declare enum ErrorCodes {
|
|
|
1165
927
|
/**
|
|
1166
928
|
* 聊天室属性自定义设置,您可以在开发者后台免费基础功能页面中开启该功能。
|
|
1167
929
|
*/
|
|
1168
|
-
|
|
930
|
+
CHATROOM_KV_STORE_NOT_OPEN = 23426,
|
|
1169
931
|
/**
|
|
1170
932
|
* 聊天室属性不存在
|
|
1171
933
|
*/
|
|
1172
|
-
|
|
934
|
+
CHATROOM_KEY_NOT_EXIST = 23427,
|
|
1173
935
|
/**
|
|
1174
936
|
* 聊天室批量设置或删除KV部分不成功
|
|
1175
937
|
*/
|
|
1176
|
-
|
|
938
|
+
CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
|
|
1177
939
|
/**
|
|
1178
940
|
* 聊天室批量设置或删除KV数量超限(最多一次10条)
|
|
1179
941
|
*/
|
|
1180
|
-
|
|
942
|
+
CHATROOM_KV_STORE_OUT_LIMIT = 23429,
|
|
1181
943
|
/**
|
|
1182
944
|
* 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
|
|
945
|
+
* @since 5.3.0
|
|
1183
946
|
*/
|
|
1184
|
-
|
|
947
|
+
CHATROOM_KV_SET_ERROR = 23431,
|
|
1185
948
|
/**
|
|
1186
949
|
* 超级群功能未开通
|
|
1187
950
|
*/
|
|
@@ -1232,12 +995,13 @@ declare enum ErrorCodes {
|
|
|
1232
995
|
ULTRA_GROUP_MESSAGE_SENT_OVER_FREQUENCY = 24415,
|
|
1233
996
|
/**
|
|
1234
997
|
* 用户不在超级群私有频道中
|
|
998
|
+
* @since 5.4.2
|
|
1235
999
|
*/
|
|
1236
|
-
|
|
1000
|
+
ULTRA_GROUP_USER_NOT_IN_PRIVATE_CHANNEL = 24416,
|
|
1237
1001
|
/**
|
|
1238
1002
|
* 撤回消息参数无效,请确认撤回消息参数是否正确的填写
|
|
1239
1003
|
*/
|
|
1240
|
-
|
|
1004
|
+
RECALL_MESSAGE = 25101,
|
|
1241
1005
|
/**
|
|
1242
1006
|
* 未开通单群聊云存储服务
|
|
1243
1007
|
*/
|
|
@@ -1260,300 +1024,450 @@ declare enum ErrorCodes {
|
|
|
1260
1024
|
CONVERSATION_TAG_OVERSIZE = 26004,
|
|
1261
1025
|
/**
|
|
1262
1026
|
* 当前连接已经被释放
|
|
1027
|
+
* @solution 表明当前 socket 已经释放,需要重新建立连接
|
|
1028
|
+
* @since 5.2.0
|
|
1263
1029
|
*/
|
|
1264
|
-
|
|
1030
|
+
RC_NET_CHANNEL_INVALID = 30001,
|
|
1265
1031
|
/**
|
|
1266
1032
|
* 当前连接不可用
|
|
1033
|
+
* @solution 建议链接成功后再调用其他 api
|
|
1034
|
+
* @since 5.2.0
|
|
1267
1035
|
*/
|
|
1268
|
-
|
|
1036
|
+
RC_NET_UNAVAILABLE = 30002,
|
|
1269
1037
|
/**
|
|
1270
1038
|
* 客户端发送消息请求,融云服务端响应超时
|
|
1039
|
+
* @since 5.2.0
|
|
1271
1040
|
*/
|
|
1272
|
-
|
|
1041
|
+
RC_MSG_RESP_TIMEOUT = 30003,
|
|
1273
1042
|
/**
|
|
1274
1043
|
* 导航操作时,Http 请求失败
|
|
1044
|
+
* @since 5.2.0
|
|
1275
1045
|
*/
|
|
1276
|
-
|
|
1046
|
+
RC_HTTP_SEND_FAIL = 30004,
|
|
1277
1047
|
/**
|
|
1278
1048
|
* 请求连接导航地址失败
|
|
1049
|
+
* @solution http 请求失败,建议本地使用 ping 或者 telnet 检查一下地址是否能正常访问
|
|
1050
|
+
* @since 5.2.0
|
|
1279
1051
|
*/
|
|
1280
|
-
|
|
1052
|
+
RC_HTTP_REQ_FAIL = 30005,
|
|
1281
1053
|
/**
|
|
1282
1054
|
* 导航操作时,HTTP 接收失败
|
|
1055
|
+
* @since 5.2.0
|
|
1283
1056
|
*/
|
|
1284
|
-
|
|
1057
|
+
RC_HTTP_RECV_FAIL = 30006,
|
|
1285
1058
|
/**
|
|
1286
1059
|
* 导航返回结果异常
|
|
1060
|
+
* @since 5.2.0
|
|
1287
1061
|
*/
|
|
1288
|
-
|
|
1062
|
+
RC_NAVI_REQ_FAILED = 30007,
|
|
1289
1063
|
/**
|
|
1290
1064
|
* 导航 HTTP 返回数据格式错误
|
|
1065
|
+
* @since 5.2.0
|
|
1291
1066
|
*/
|
|
1292
|
-
|
|
1067
|
+
RC_NODE_NOT_FOUND = 30008,
|
|
1293
1068
|
/**
|
|
1294
1069
|
* 导航数据解析后,其中不存在有效 IP 地址
|
|
1070
|
+
* @since 5.2.0
|
|
1295
1071
|
*/
|
|
1296
|
-
|
|
1072
|
+
RC_DOMAIN_NOT_RESOLVE = 30009,
|
|
1297
1073
|
/**
|
|
1298
1074
|
* 创建连接失败
|
|
1075
|
+
* @solution 一般是本地网络导致连接不成功,建议更换网络重新尝试连接
|
|
1076
|
+
* @since 5.2.0
|
|
1299
1077
|
*/
|
|
1300
|
-
|
|
1078
|
+
RC_SOCKET_NOT_CREATED = 30010,
|
|
1301
1079
|
/**
|
|
1302
1080
|
* 链接断开
|
|
1081
|
+
* @solution 连接断开,SDK 会进行重连
|
|
1082
|
+
* @since 5.2.0
|
|
1303
1083
|
*/
|
|
1304
|
-
|
|
1084
|
+
RC_SOCKET_DISCONNECTED = 30011,
|
|
1305
1085
|
/**
|
|
1306
1086
|
* PING 失败
|
|
1087
|
+
* @solution 本地网络问题导致ping失败,SDK 会进入重连逻辑
|
|
1088
|
+
* @since 5.2.0
|
|
1307
1089
|
*/
|
|
1308
|
-
|
|
1090
|
+
RC_PING_EXCEED_LIMIT = 30012,
|
|
1309
1091
|
/**
|
|
1310
1092
|
* PING 超时
|
|
1093
|
+
* @since 5.7.0
|
|
1311
1094
|
*/
|
|
1312
1095
|
PONG_RECEIVED_ERROR = 30013,
|
|
1313
1096
|
/**
|
|
1314
1097
|
* 信令发送失败
|
|
1098
|
+
* @since 5.2.0
|
|
1315
1099
|
*/
|
|
1316
|
-
|
|
1100
|
+
RC_MSG_SEND_FAIL = 30014,
|
|
1317
1101
|
/**
|
|
1318
1102
|
* 连接过于频繁
|
|
1319
1103
|
*/
|
|
1320
1104
|
CONNECT_OVER_FREQUENCY = 30015,
|
|
1321
1105
|
/**
|
|
1322
1106
|
* 消息大小超限,消息体(序列化成 json 格式之后的内容)最大 128k bytes
|
|
1107
|
+
* @solution 建议检查发送的消息内容,防止超过消息体大小限制
|
|
1108
|
+
* @since 5.2.0
|
|
1323
1109
|
*/
|
|
1324
|
-
|
|
1110
|
+
RC_MSG_CONTENT_EXCEED_LIMIT = 30016,
|
|
1325
1111
|
/**
|
|
1326
1112
|
* 网络连接不可用
|
|
1113
|
+
* @solution 网络问题,SDK 会进行重连
|
|
1114
|
+
* @since 5.7.9
|
|
1327
1115
|
*/
|
|
1328
|
-
|
|
1116
|
+
RC_NETWORK_DOWN = 30019,
|
|
1329
1117
|
/**
|
|
1330
1118
|
* tcp 连接成功,rmtp 连接失败
|
|
1119
|
+
* @since 5.7.9
|
|
1331
1120
|
*/
|
|
1332
|
-
|
|
1121
|
+
RC_TCP_DISCONNECTED_NO_RMTP = 30021,
|
|
1333
1122
|
/**
|
|
1334
1123
|
* 连接ACK超时
|
|
1124
|
+
* @solution 网络问题,SDK 会进行重连
|
|
1125
|
+
* @since 5.2.0
|
|
1335
1126
|
*/
|
|
1336
|
-
|
|
1127
|
+
RC_CONN_ACK_TIMEOUT = 31000,
|
|
1337
1128
|
/**
|
|
1338
1129
|
* 信令版本错误
|
|
1130
|
+
* @since 5.2.0
|
|
1339
1131
|
*/
|
|
1340
|
-
|
|
1132
|
+
RC_CONN_PROTO_VERSION_ERROR = 31001,
|
|
1341
1133
|
/**
|
|
1342
1134
|
* 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk版本}。 其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识, 移动/电信/联通}
|
|
1135
|
+
* @solution 一般是 appkey 错误导致,建议在融云的开发者后台中确认一下当前应用的 appkey 标识是否正确
|
|
1136
|
+
* @since 5.2.0
|
|
1343
1137
|
*/
|
|
1344
|
-
|
|
1138
|
+
RC_CONN_IDENTIFIER_REJECTED = 31002,
|
|
1345
1139
|
/**
|
|
1346
1140
|
* 连接服务未开通,需要排查后台小程序(或桌面端)服务是否已开通
|
|
1141
|
+
* @solution 建议到开发者后台 - 服务管理开通对应业务服务
|
|
1142
|
+
* @since 5.2.0
|
|
1347
1143
|
*/
|
|
1348
|
-
|
|
1144
|
+
RC_CONN_SERVER_UNAVAILABLE = 31003,
|
|
1349
1145
|
/**
|
|
1350
1146
|
* Token 无效;AppKey 和 Token 不匹配;Token 过期
|
|
1147
|
+
* @solution 建议确认从服务获取 token 时传入的 appkey 与客户端初始化使用的 appkey 是否为同一个
|
|
1148
|
+
* @since 5.2.0
|
|
1351
1149
|
*/
|
|
1352
|
-
|
|
1150
|
+
RC_CONN_TOKEN_INCORRECT = 31004,
|
|
1353
1151
|
/**
|
|
1354
1152
|
* App 校验未通过(开通了 App 校验功能,但是校验未通过)
|
|
1153
|
+
* @since 5.2.0
|
|
1355
1154
|
*/
|
|
1356
|
-
|
|
1155
|
+
RC_CONN_NOT_AUTHRORIZED = 31005,
|
|
1357
1156
|
/**
|
|
1358
1157
|
* 连接重定向
|
|
1158
|
+
* @since 5.2.0
|
|
1359
1159
|
*/
|
|
1360
|
-
|
|
1160
|
+
RC_CONN_REDIRECTED = 31006,
|
|
1361
1161
|
/**
|
|
1362
1162
|
* 包名与后台注册信息不匹配
|
|
1163
|
+
* @since 5.2.0
|
|
1363
1164
|
*/
|
|
1364
|
-
|
|
1165
|
+
RC_CONN_PACKAGE_NAME_INVALID = 31007,
|
|
1365
1166
|
/**
|
|
1366
1167
|
* AppKey 被封禁或已删除
|
|
1168
|
+
* @since 5.2.0
|
|
1367
1169
|
*/
|
|
1368
|
-
|
|
1170
|
+
RC_CONN_APP_BLOCKED_OR_DELETED = 31008,
|
|
1369
1171
|
/**
|
|
1370
1172
|
* 用户被封禁
|
|
1173
|
+
* @since 5.2.0
|
|
1371
1174
|
*/
|
|
1372
|
-
|
|
1175
|
+
RC_CONN_USER_BLOCKED = 31009,
|
|
1373
1176
|
/**
|
|
1374
1177
|
* 用户被踢下线
|
|
1178
|
+
* @since 5.2.0
|
|
1375
1179
|
*/
|
|
1376
|
-
|
|
1180
|
+
RC_DISCONN_KICK = 31010,
|
|
1377
1181
|
/**
|
|
1378
1182
|
* 与服务器的连接已断开,用户被封禁
|
|
1183
|
+
* @since 5.2.0
|
|
1379
1184
|
*/
|
|
1380
|
-
|
|
1185
|
+
RC_DISCONN_EXCEPTION = 31011,
|
|
1381
1186
|
/**
|
|
1382
1187
|
* 链路加密认证失败
|
|
1188
|
+
* @since 5.2.0
|
|
1383
1189
|
*/
|
|
1384
1190
|
CONNECTION_ENCRYPT_AUTHORIZED_ERROR = 31012,
|
|
1385
1191
|
/**
|
|
1386
1192
|
* Token 已过期
|
|
1193
|
+
* @since 5.7.0
|
|
1387
1194
|
*/
|
|
1388
|
-
|
|
1195
|
+
RC_CONN_TOKEN_EXPIRED = 31020,
|
|
1389
1196
|
/**
|
|
1390
1197
|
* Token 中携带 deviceId 时,检测 Token 中deviceId 与链接设备 deviceId 不一致
|
|
1198
|
+
* @since 5.7.0
|
|
1391
1199
|
*/
|
|
1392
|
-
|
|
1200
|
+
RC_CONN_DEVICE_ERROR = 31021,
|
|
1393
1201
|
/**
|
|
1394
1202
|
* 页面域名不在安全域名白名单内,需通过开发者后台添加安全域名配置
|
|
1203
|
+
* @since 5.7.0
|
|
1395
1204
|
*/
|
|
1396
|
-
|
|
1205
|
+
RC_CONN_HOSTNAME_ERROR = 31022,
|
|
1397
1206
|
/**
|
|
1398
1207
|
* 开启禁止把已在线客户端踢下线开关后,该错误码标识已有同类型端在线
|
|
1208
|
+
* @since 5.3.4
|
|
1399
1209
|
*/
|
|
1400
|
-
|
|
1210
|
+
RC_DISCONN_SAME_CLIENT_ON_LINE = 31023,
|
|
1401
1211
|
/**
|
|
1402
1212
|
* 连接总数量超过服务设定的并发限定值(私有云专属)
|
|
1213
|
+
* @since 5.7.0
|
|
1403
1214
|
*/
|
|
1404
|
-
|
|
1215
|
+
RC_LISCENSE_COUNT_OUT_OF_LIMIT = 31024,
|
|
1405
1216
|
/**
|
|
1406
1217
|
* 客户端连错环境,引发连接拒绝;如使用开发环境 Appkey 连接到生产环境
|
|
1218
|
+
* @since 5.7.0
|
|
1407
1219
|
*/
|
|
1408
|
-
|
|
1220
|
+
RC_CONN_WRONG_CLUSTER = 31025,
|
|
1409
1221
|
/**
|
|
1410
1222
|
* 开启AppServer联合鉴权功能后,到AppServer认证失败
|
|
1223
|
+
* @since 5.2.0
|
|
1411
1224
|
*/
|
|
1412
|
-
|
|
1225
|
+
RC_APP_AUTH_NOT_PASS = 31026,
|
|
1413
1226
|
/**
|
|
1414
1227
|
* 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
|
|
1228
|
+
* @since 5.2.0
|
|
1415
1229
|
*/
|
|
1416
|
-
|
|
1230
|
+
RC_OTP_USED = 31027,
|
|
1417
1231
|
/**
|
|
1418
1232
|
* Token 平台验证失败
|
|
1233
|
+
* @since 5.2.0
|
|
1419
1234
|
*/
|
|
1420
|
-
|
|
1235
|
+
RC_PLATFORM_ERROR = 31028,
|
|
1421
1236
|
/**
|
|
1422
1237
|
* 用户已销户
|
|
1238
|
+
* @since 5.5.7
|
|
1423
1239
|
*/
|
|
1424
|
-
|
|
1240
|
+
RC_ACCOUNT_CANCELLATION = 31029,
|
|
1425
1241
|
/**
|
|
1426
1242
|
* 私有云 License 检查不通过;APP License 过期
|
|
1243
|
+
* @since 5.5.1
|
|
1427
1244
|
*/
|
|
1428
|
-
|
|
1245
|
+
RC_LICENSE_EXPIRED = 31030,
|
|
1429
1246
|
/**
|
|
1430
1247
|
* 协议层内部错误,查询,上传,下载过程中数据错误
|
|
1248
|
+
* @since 5.2.0
|
|
1431
1249
|
*/
|
|
1432
|
-
|
|
1250
|
+
RC_QUERY_ACK_NO_DATA = 32001,
|
|
1433
1251
|
/**
|
|
1434
1252
|
* 协议层内部错误
|
|
1253
|
+
* @since 5.2.0
|
|
1254
|
+
*/
|
|
1255
|
+
RC_MSG_DATA_INCOMPLETE = 32002,
|
|
1256
|
+
/**
|
|
1257
|
+
* 服务器主动断开连接(仅 quic 协议下触发)
|
|
1435
1258
|
*/
|
|
1436
|
-
|
|
1259
|
+
RC_UDP_DISCONNECTED = 32011,
|
|
1437
1260
|
/**
|
|
1438
1261
|
* 链接被服务器中断,可能原因是运营商认为此链接非法或无效,直接断开 出现此错误码后,SDK 会自动触发重连,App 无需处理
|
|
1262
|
+
* @since 5.7.0
|
|
1439
1263
|
*/
|
|
1440
|
-
|
|
1264
|
+
RC_TCP_RESET = 32054,
|
|
1441
1265
|
/**
|
|
1442
1266
|
* 连接被拒绝
|
|
1267
|
+
* @since 5.2.0
|
|
1443
1268
|
*/
|
|
1444
1269
|
CONNECTION_REFUSED = 32061,
|
|
1445
1270
|
/**
|
|
1446
1271
|
* 将消息存储到本地数据时失败。 发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
|
|
1272
|
+
* @since 5.2.0
|
|
1447
1273
|
*/
|
|
1448
1274
|
PROTOCOL_MESSAGE_SAVED_ERROR = 33000,
|
|
1449
1275
|
/**
|
|
1450
1276
|
* 协议栈未初始化
|
|
1277
|
+
* @since 5.2.0
|
|
1451
1278
|
*/
|
|
1452
|
-
|
|
1279
|
+
BIZ_ERROR_CLIENT_NOT_INIT = 33001,
|
|
1453
1280
|
/**
|
|
1454
1281
|
* 数据库错误
|
|
1282
|
+
* @since 5.2.0
|
|
1455
1283
|
*/
|
|
1456
|
-
|
|
1284
|
+
BIZ_ERROR_DATABASE_ERROR = 33002,
|
|
1457
1285
|
/**
|
|
1458
1286
|
* 开发者接口调用时传入的参数错误
|
|
1287
|
+
* @since 5.2.0
|
|
1288
|
+
*/
|
|
1289
|
+
BIZ_ERROR_INVALID_PARAMETER = 33003,
|
|
1290
|
+
/**
|
|
1291
|
+
* 通道无效
|
|
1292
|
+
*/
|
|
1293
|
+
BIZ_ERROR_NO_CHANNEL = 33004,
|
|
1294
|
+
/**
|
|
1295
|
+
* 重新连接成功
|
|
1459
1296
|
*/
|
|
1460
|
-
|
|
1297
|
+
BIZ_ERROR_RECONNECT_SUCCESS = 33005,
|
|
1298
|
+
/**
|
|
1299
|
+
* 连接中,再调用 connect 被拒绝
|
|
1300
|
+
*/
|
|
1301
|
+
BIZ_ERROR_CONNECTING = 33006,
|
|
1461
1302
|
/**
|
|
1462
1303
|
* 历史消息云存储业务未开通
|
|
1304
|
+
* @since 5.2.0
|
|
1463
1305
|
*/
|
|
1464
|
-
|
|
1306
|
+
MSG_ROAMING_SERVICE_UNAVAILABLE = 33007,
|
|
1465
1307
|
/**
|
|
1466
1308
|
* 消息存入本地数据库失败
|
|
1309
|
+
* @since 5.2.0
|
|
1467
1310
|
*/
|
|
1468
|
-
|
|
1311
|
+
MSG_INSERT_ERROR = 33008,
|
|
1469
1312
|
/**
|
|
1470
1313
|
* 聊天室被回收
|
|
1314
|
+
* @since 5.2.0
|
|
1471
1315
|
*/
|
|
1472
|
-
|
|
1316
|
+
MSG_DEL_ERROR = 33009,
|
|
1473
1317
|
/**
|
|
1474
1318
|
* 标签不存在
|
|
1319
|
+
* @solution 建议用户使用 RongIMLib.addTag 先创建标签,再添加会话到标签中
|
|
1320
|
+
* @since 5.2.0
|
|
1475
1321
|
*/
|
|
1476
1322
|
TAG_NOT_EXIST = 33100,
|
|
1477
1323
|
/**
|
|
1478
1324
|
* 标签已存在
|
|
1325
|
+
* @since 5.2.0
|
|
1479
1326
|
*/
|
|
1480
|
-
|
|
1327
|
+
TAG_EXISTS = 33101,
|
|
1481
1328
|
/**
|
|
1482
1329
|
* 标签不在会话中
|
|
1330
|
+
* @since 5.2.0
|
|
1483
1331
|
*/
|
|
1484
|
-
|
|
1332
|
+
NO_TAG_IN_CONVER = 33102,
|
|
1485
1333
|
/**
|
|
1486
1334
|
* 连接已存在
|
|
1335
|
+
* @since 5.2.0
|
|
1487
1336
|
*/
|
|
1488
|
-
|
|
1337
|
+
RC_CONNECTION_EXIST = 34001,
|
|
1489
1338
|
/**
|
|
1490
1339
|
* 连接环境不正确
|
|
1340
|
+
* @since 5.2.0
|
|
1491
1341
|
*/
|
|
1492
|
-
|
|
1342
|
+
PACKAGE_ENVIRONMENT_ERROR = 34005,
|
|
1493
1343
|
/**
|
|
1494
1344
|
* 连接超时
|
|
1345
|
+
* @since 5.2.0
|
|
1495
1346
|
*/
|
|
1496
1347
|
CONNECTION_TIMEOUT = 34006,
|
|
1497
1348
|
/**
|
|
1498
1349
|
* 消息不能被扩展,只支持单群聊,其他类型消息会返回此错误,消息在发送时,Message 对象的属性 canIncludeExpansion 置为 true 才能进行扩展
|
|
1350
|
+
* @since 5.2.0
|
|
1499
1351
|
*/
|
|
1500
|
-
|
|
1352
|
+
MESSAGE_KV_NOT_SUPPORT = 34008,
|
|
1501
1353
|
/**
|
|
1502
1354
|
* 消息扩展失败,一般是网络原因导致的,请确保网络状态良好,并且融云 SDK 连接正常
|
|
1355
|
+
* @since 5.2.0
|
|
1503
1356
|
*/
|
|
1504
1357
|
MESSAGE_EXPANDED_ERROR = 34009,
|
|
1505
1358
|
/**
|
|
1506
|
-
* 消息扩展大小超出限制, 默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过
|
|
1359
|
+
* 消息扩展大小超出限制, 默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
|
|
1360
|
+
* @since 5.2.0
|
|
1507
1361
|
*/
|
|
1508
|
-
|
|
1362
|
+
EXPANSION_LIMIT_EXCEET = 34010,
|
|
1509
1363
|
/**
|
|
1510
1364
|
* 媒体消息媒体文件 http 上传失败
|
|
1365
|
+
* @since 5.2.0
|
|
1511
1366
|
*/
|
|
1512
|
-
|
|
1367
|
+
UPLOAD_FAIL = 34011,
|
|
1513
1368
|
/**
|
|
1514
1369
|
* 标签中添加/删除的会话数量超限,最多支持添加/删除 1000 个会话
|
|
1370
|
+
* @since 5.2.0
|
|
1515
1371
|
*/
|
|
1516
|
-
|
|
1372
|
+
CONVER_OUT_LIMIT_ERROR = 34013,
|
|
1517
1373
|
/**
|
|
1518
1374
|
* 群已读回执版本不支持
|
|
1375
|
+
* @since 5.2.0
|
|
1519
1376
|
*/
|
|
1520
|
-
|
|
1377
|
+
READ_RECEIPT_ERROR = 34014,
|
|
1521
1378
|
/**
|
|
1522
1379
|
* 用户级别设置未开通
|
|
1380
|
+
* @since 5.2.0
|
|
1523
1381
|
*/
|
|
1524
1382
|
PUSH_CONTENT_CONFIG_SERVICE_UNAVAILABLE = 34016,
|
|
1525
1383
|
/**
|
|
1526
1384
|
* 消息拦截器处理接口返回的消息为空
|
|
1385
|
+
* @since 5.2.0
|
|
1527
1386
|
*/
|
|
1528
1387
|
MESSAGE_INTERCEPTION_PRODUCED_NULL_MESSAGE = 34017,
|
|
1529
1388
|
/**
|
|
1530
1389
|
* 消息未被注册
|
|
1390
|
+
* @since 5.2.0
|
|
1531
1391
|
*/
|
|
1532
1392
|
MESSAGE_NOT_REGISTERED = 34021,
|
|
1533
1393
|
/**
|
|
1534
1394
|
* 该接口不支持超级群会话
|
|
1395
|
+
* @since 5.2.0
|
|
1535
1396
|
*/
|
|
1536
|
-
|
|
1397
|
+
METHOD_NOT_SUPPORT = 34022,
|
|
1537
1398
|
/**
|
|
1538
1399
|
* 超级群频道不存在
|
|
1400
|
+
* @since 5.2.0
|
|
1539
1401
|
*/
|
|
1540
1402
|
ULTRA_GROUP_CHANNEL_NOT_EXIST = 34024,
|
|
1541
1403
|
/**
|
|
1542
1404
|
* 扩展消息失败,因为消息中的会话类别与接口支持的会话类别不一致
|
|
1405
|
+
* @since 5.2.0
|
|
1543
1406
|
*/
|
|
1544
1407
|
INCONSISTENT_CONVERSATION_TYPE = 34025,
|
|
1408
|
+
/**
|
|
1409
|
+
* 开发者调用的接口不支持传入的会话类型
|
|
1410
|
+
*/
|
|
1411
|
+
METHOD_ONLY_SUPPORT_ULTRA_GROUP = 34201,
|
|
1412
|
+
/**
|
|
1413
|
+
* 开发者接口调用时传入的 messageList 非法
|
|
1414
|
+
*/
|
|
1415
|
+
MSG_LIMIT_ERROR = 34206,
|
|
1545
1416
|
/**
|
|
1546
1417
|
* 非法的代理配置,RongIMProxy 为空或者非法
|
|
1418
|
+
* @since 5.7.0
|
|
1547
1419
|
*/
|
|
1548
|
-
|
|
1420
|
+
INVALID_PARAMETER_PROXY = 34238,
|
|
1549
1421
|
/**
|
|
1550
1422
|
* 开发者接口调用 testProxy 时传入的代理测试服务非法
|
|
1423
|
+
* @since 5.7.0
|
|
1551
1424
|
*/
|
|
1552
|
-
|
|
1425
|
+
INVALID_PARAMETER_TESTHOST = 34239,
|
|
1553
1426
|
/**
|
|
1554
1427
|
* 开发者接口调用 testProxy 接口时无法联通
|
|
1428
|
+
* @since 5.7.0
|
|
1429
|
+
*/
|
|
1430
|
+
INVALID_CONNECT_TESTHOST_FAILED = 34240,
|
|
1431
|
+
/**
|
|
1432
|
+
* 设置的代理地址不可用
|
|
1433
|
+
*/
|
|
1434
|
+
RC_CONN_PROXY_UNAVAILABLE = 34245,
|
|
1435
|
+
/**
|
|
1436
|
+
* 主进程内方法错误
|
|
1437
|
+
*/
|
|
1438
|
+
MAIN_PROCESS_ERROR = 35001,
|
|
1439
|
+
/**
|
|
1440
|
+
* 保存草稿失败
|
|
1441
|
+
*/
|
|
1442
|
+
DRAFT_SAVE_ERROR = 35002,
|
|
1443
|
+
/**
|
|
1444
|
+
* 删除草稿失败
|
|
1445
|
+
*/
|
|
1446
|
+
DRAFT_REMOVE_ERROR = 35003,
|
|
1447
|
+
/**
|
|
1448
|
+
* 方法未支持
|
|
1449
|
+
*/
|
|
1450
|
+
NOT_SUPPORT = 35004,
|
|
1451
|
+
/**
|
|
1452
|
+
* 删除会话失败
|
|
1453
|
+
*/
|
|
1454
|
+
CONVER_REMOVE_ERROR = 35005,
|
|
1455
|
+
/**
|
|
1456
|
+
* 无可用的 IM 服务地址
|
|
1457
|
+
*/
|
|
1458
|
+
SERVER_UNAVAILABLE = 35008,
|
|
1459
|
+
/**
|
|
1460
|
+
* IM 在初次连接成功后,需立即同步消息,标记上线,然后获取全量超级群会话列表,列表同步完成前,所有超级群相关功能接口应不可用
|
|
1461
|
+
*/
|
|
1462
|
+
METHOD_NOT_AVAILABLE = 35011,
|
|
1463
|
+
/**
|
|
1464
|
+
* 获取会话失败
|
|
1465
|
+
*/
|
|
1466
|
+
CONVER_GET_ERROR = 35021,
|
|
1467
|
+
/**
|
|
1468
|
+
* 搜索字段对应消息错误
|
|
1555
1469
|
*/
|
|
1556
|
-
|
|
1470
|
+
SEARCH_PROPS_LIMIT_ERROR = 35022
|
|
1557
1471
|
}
|
|
1558
1472
|
|
|
1559
1473
|
/**
|
|
@@ -1910,15 +1824,6 @@ declare enum UploadMethod {
|
|
|
1910
1824
|
MINIO = 5
|
|
1911
1825
|
}
|
|
1912
1826
|
|
|
1913
|
-
/**
|
|
1914
|
-
* 聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
|
|
1915
|
-
* @category Enum
|
|
1916
|
-
*/
|
|
1917
|
-
declare enum ChatroomEntryType {
|
|
1918
|
-
UPDATE = 1,
|
|
1919
|
-
DELETE = 2
|
|
1920
|
-
}
|
|
1921
|
-
|
|
1922
1827
|
/**
|
|
1923
1828
|
* @deprecated
|
|
1924
1829
|
* 日志级别
|
|
@@ -2084,7 +1989,11 @@ declare enum LogTagId {
|
|
|
2084
1989
|
L_WEBSOCKET_DISACCORD_E = "L-websocket_disaccord-e",
|
|
2085
1990
|
/** electronExtension 相关 */
|
|
2086
1991
|
A_SEARCH_MESSAGE_BY_USER_T = "A-search_messages_by_user-T",
|
|
2087
|
-
A_SEARCH_MESSAGE_BY_USER_R = "A-search_messages_by_user-R"
|
|
1992
|
+
A_SEARCH_MESSAGE_BY_USER_R = "A-search_messages_by_user-R",
|
|
1993
|
+
/** 获取静态配置 */
|
|
1994
|
+
L_GET_STATIC_CONF_T = "L-get_static_conf-T",
|
|
1995
|
+
L_GET_STATIC_CONF_R = "L-get_static_conf-R",
|
|
1996
|
+
L_GET_STATIC_CONF_E = "L-get_static_conf-E"
|
|
2088
1997
|
}
|
|
2089
1998
|
|
|
2090
1999
|
/** 统计数据标签 */
|
|
@@ -2098,15 +2007,6 @@ declare enum StatisticsTag {
|
|
|
2098
2007
|
IM_NETWORK_CHANGE = "IM-stats_network_change-S"
|
|
2099
2008
|
}
|
|
2100
2009
|
|
|
2101
|
-
/**
|
|
2102
|
-
* 聊天室成员进入和退出状态
|
|
2103
|
-
* @category Enum
|
|
2104
|
-
*/
|
|
2105
|
-
declare enum ChatroomUserChangeType {
|
|
2106
|
-
QUIT = 0,
|
|
2107
|
-
JOIN = 1
|
|
2108
|
-
}
|
|
2109
|
-
|
|
2110
2010
|
/**
|
|
2111
2011
|
* 发送状态
|
|
2112
2012
|
* @category Enum
|
|
@@ -2139,91 +2039,19 @@ declare enum SentStatus {
|
|
|
2139
2039
|
}
|
|
2140
2040
|
|
|
2141
2041
|
/**
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
2144
|
-
*
|
|
2145
|
-
*/
|
|
2146
|
-
declare enum ChrmSyncStatus {
|
|
2147
|
-
/**
|
|
2148
|
-
* 离开
|
|
2149
|
-
*/
|
|
2150
|
-
QUIT = 0,
|
|
2151
|
-
/**
|
|
2152
|
-
* 加入
|
|
2153
|
-
*/
|
|
2154
|
-
JOIN = 1
|
|
2155
|
-
}
|
|
2156
|
-
|
|
2157
|
-
/**
|
|
2158
|
-
* 聊天室解封/封禁用户消息,操作类型枚举
|
|
2159
|
-
* @category Enum
|
|
2160
|
-
* @since 5.7.9
|
|
2161
|
-
*/
|
|
2162
|
-
declare enum ChrmMemOperateType {
|
|
2163
|
-
/**
|
|
2164
|
-
* 解封
|
|
2165
|
-
*/
|
|
2166
|
-
Deblock = 0,
|
|
2167
|
-
/**
|
|
2168
|
-
* 封禁
|
|
2169
|
-
*/
|
|
2170
|
-
Blocked = 1
|
|
2171
|
-
}
|
|
2172
|
-
|
|
2173
|
-
/**
|
|
2174
|
-
* 聊天室禁言/解除禁言操作类型枚举
|
|
2175
|
-
* @category Enum
|
|
2176
|
-
* @since 5.7.9
|
|
2177
|
-
*/
|
|
2178
|
-
declare enum ChrmMemBanType {
|
|
2179
|
-
/**
|
|
2180
|
-
* 解除指定聊天室中用户禁言
|
|
2181
|
-
*/
|
|
2182
|
-
UnmuteUsers = 0,
|
|
2183
|
-
/**
|
|
2184
|
-
* 禁言指定聊天室中用户
|
|
2185
|
-
*/
|
|
2186
|
-
MuteUsers = 1,
|
|
2187
|
-
/**
|
|
2188
|
-
* 解除聊天室全体禁言
|
|
2189
|
-
*/
|
|
2190
|
-
UnmuteAll = 2,
|
|
2191
|
-
/**
|
|
2192
|
-
* 聊天室全体禁言
|
|
2193
|
-
*/
|
|
2194
|
-
MuteAll = 3,
|
|
2195
|
-
/**
|
|
2196
|
-
* 移出禁言用户白名单
|
|
2197
|
-
*/
|
|
2198
|
-
RemoveWhitelist = 4,
|
|
2199
|
-
/**
|
|
2200
|
-
* 添加禁言用户白名单
|
|
2201
|
-
*/
|
|
2202
|
-
AddWhitelist = 5,
|
|
2203
|
-
/**
|
|
2204
|
-
* 解除用户聊天室全局禁言
|
|
2205
|
-
*/
|
|
2206
|
-
UnmuteGloble = 6,
|
|
2207
|
-
/**
|
|
2208
|
-
* 用户聊天室全局禁言
|
|
2209
|
-
*/
|
|
2210
|
-
MuteGloble = 7
|
|
2211
|
-
}
|
|
2212
|
-
|
|
2213
|
-
/**
|
|
2214
|
-
* 聊天室多端同步时,离开聊天室的原因
|
|
2215
|
-
* @category Enum
|
|
2216
|
-
* @since 5.7.9
|
|
2042
|
+
* 连接协议
|
|
2043
|
+
* 截止 5.7.4 版本,暂不支持 rpp 和 quic
|
|
2044
|
+
* v2 版本文档: https://a5bq662kv5.feishu.cn/wiki/wikcnfo3lEo2CPbonDxuXFvU0Kb#K7nbeN
|
|
2217
2045
|
*/
|
|
2218
|
-
declare enum
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2046
|
+
declare enum EConnectProtocol {
|
|
2047
|
+
RMTP = 1,
|
|
2048
|
+
TLS = 2,
|
|
2049
|
+
RPP = 3,
|
|
2050
|
+
QUIC = 4,
|
|
2051
|
+
WS = 5,
|
|
2052
|
+
WSS = 6,
|
|
2053
|
+
HTTP = 11,
|
|
2054
|
+
HTTPS = 12
|
|
2227
2055
|
}
|
|
2228
2056
|
|
|
2229
2057
|
declare enum StoreKeys {
|
|
@@ -3308,387 +3136,89 @@ interface IUpdatedConversation {
|
|
|
3308
3136
|
*/
|
|
3309
3137
|
channelId?: string;
|
|
3310
3138
|
tags?: IUpdatedConversation[];
|
|
3311
|
-
versionTime?: number;
|
|
3312
|
-
/**
|
|
3313
|
-
* @ 消息未读数
|
|
3314
|
-
*/
|
|
3315
|
-
unreadMentionedCount?: number;
|
|
3316
|
-
/**
|
|
3317
|
-
* @ 我的未读消息数
|
|
3318
|
-
* @since 5.7.9
|
|
3319
|
-
*/
|
|
3320
|
-
unreadMentionedMeCount?: number;
|
|
3321
|
-
}
|
|
3322
|
-
/**
|
|
3323
|
-
* @category Interface
|
|
3324
|
-
*/
|
|
3325
|
-
interface IBaseConversationInfo {
|
|
3326
|
-
conversationType: ConversationType;
|
|
3327
|
-
targetId: string;
|
|
3328
|
-
channelId: string;
|
|
3329
|
-
}
|
|
3330
|
-
/**
|
|
3331
|
-
* @category Interface
|
|
3332
|
-
*/
|
|
3333
|
-
interface IConversationState extends IBaseConversationInfo {
|
|
3334
|
-
unreadCount: number;
|
|
3335
|
-
unreadMentionedCount: number;
|
|
3336
|
-
}
|
|
3337
|
-
/**
|
|
3338
|
-
* 指定超级群会话传参
|
|
3339
|
-
* @category Interface
|
|
3340
|
-
*/
|
|
3341
|
-
interface IUltraGroupOption {
|
|
3342
|
-
targetId: string;
|
|
3343
|
-
channelId?: string;
|
|
3344
|
-
}
|
|
3345
|
-
/**
|
|
3346
|
-
* @category Interface
|
|
3347
|
-
*/
|
|
3348
|
-
interface IGetUltraGroupListOption {
|
|
3349
|
-
targetId?: string;
|
|
3350
|
-
channelType?: UltraGroupChannelType;
|
|
3351
|
-
}
|
|
3352
|
-
/**
|
|
3353
|
-
* 超级群频道变更通知内容
|
|
3354
|
-
*/
|
|
3355
|
-
interface IUltraChannelChangeInfo {
|
|
3356
|
-
targetId: string;
|
|
3357
|
-
channelId: string;
|
|
3358
|
-
channelType: UltraGroupChannelType;
|
|
3359
|
-
changeType: UltraGroupChannelChangeType;
|
|
3360
|
-
}
|
|
3361
|
-
/**
|
|
3362
|
-
* 超级群私有频道用户被踢出白名单通知内容
|
|
3363
|
-
*/
|
|
3364
|
-
interface IUltraChannelUserKickedInfo {
|
|
3365
|
-
targetId: string;
|
|
3366
|
-
channelId: string;
|
|
3367
|
-
channelType: UltraGroupChannelType;
|
|
3368
|
-
userId: string;
|
|
3369
|
-
}
|
|
3370
|
-
/**
|
|
3371
|
-
* 超级群频道被删除通知内容
|
|
3372
|
-
*/
|
|
3373
|
-
interface IUltraChannelDeleteInfo {
|
|
3374
|
-
targetId: string;
|
|
3375
|
-
channelId: string;
|
|
3376
|
-
channelType: UltraGroupChannelType;
|
|
3377
|
-
deleteTime: number;
|
|
3378
|
-
}
|
|
3379
|
-
/**
|
|
3380
|
-
* 获取超级群获取指定会话未读 @ 消息列表
|
|
3381
|
-
*/
|
|
3382
|
-
interface IUltraUnreadConversation {
|
|
3383
|
-
targetId: string;
|
|
3384
|
-
channelId?: string;
|
|
3385
|
-
}
|
|
3386
|
-
interface IUltraGroupUnreadInfo {
|
|
3387
|
-
type: ConversationType;
|
|
3388
|
-
targetId: string;
|
|
3389
|
-
channelId: string;
|
|
3390
|
-
unreadMessageCount: number;
|
|
3391
|
-
mentionedCount: number;
|
|
3392
|
-
mentionedMeCount: number;
|
|
3393
|
-
notificationLevel: NotificationLevel;
|
|
3394
|
-
}
|
|
3395
|
-
|
|
3396
|
-
/**
|
|
3397
|
-
* @category Interface
|
|
3398
|
-
*/
|
|
3399
|
-
interface IChatroomEntryListenerData {
|
|
3400
|
-
/**
|
|
3401
|
-
* 更新的键
|
|
3402
|
-
*/
|
|
3403
|
-
key: string;
|
|
3404
|
-
/**
|
|
3405
|
-
* 更新的值
|
|
3406
|
-
*/
|
|
3407
|
-
value: string;
|
|
3408
|
-
/**
|
|
3409
|
-
* 更新的时间
|
|
3410
|
-
*/
|
|
3411
|
-
timestamp: number;
|
|
3412
|
-
/**
|
|
3413
|
-
* 更新的聊天室 ID
|
|
3414
|
-
*/
|
|
3415
|
-
chatroomId: string;
|
|
3416
|
-
/**
|
|
3417
|
-
* 更新类型
|
|
3418
|
-
*/
|
|
3419
|
-
type: ChatroomEntryType;
|
|
3420
|
-
}
|
|
3421
|
-
/**
|
|
3422
|
-
* @category Interface
|
|
3423
|
-
*/
|
|
3424
|
-
interface IChatroomRejoinedFailed {
|
|
3425
|
-
/**
|
|
3426
|
-
* 自动重新加入的聊天室 ID
|
|
3427
|
-
*/
|
|
3428
|
-
chatroomId: string;
|
|
3429
|
-
/**
|
|
3430
|
-
* 自动重新加入失败的 code
|
|
3431
|
-
*/
|
|
3432
|
-
errorCode: number;
|
|
3433
|
-
}
|
|
3434
|
-
/**
|
|
3435
|
-
* @category Interface
|
|
3436
|
-
*/
|
|
3437
|
-
interface IChatroomRejoinedSuccessed {
|
|
3438
|
-
/**
|
|
3439
|
-
* 自动重新加入的聊天室 ID
|
|
3440
|
-
*/
|
|
3441
|
-
chatroomId: string;
|
|
3442
|
-
/**
|
|
3443
|
-
* 自动重新加入的聊天室拉取消息的数量
|
|
3444
|
-
*/
|
|
3445
|
-
count: number;
|
|
3446
|
-
}
|
|
3447
|
-
/**
|
|
3448
|
-
* @category Interface
|
|
3449
|
-
*/
|
|
3450
|
-
interface IChatroomUserChangeInfo {
|
|
3451
|
-
users: {
|
|
3452
|
-
[userId: string]: ChatroomUserChangeType;
|
|
3453
|
-
};
|
|
3454
|
-
chatroomId: string;
|
|
3455
|
-
}
|
|
3456
|
-
/**
|
|
3457
|
-
* @category Interface
|
|
3458
|
-
* @since 5.7.9
|
|
3459
|
-
*/
|
|
3460
|
-
interface IChatroomNotifyMultiLoginSync {
|
|
3461
|
-
/**
|
|
3462
|
-
* 聊天室ID
|
|
3463
|
-
*/
|
|
3464
|
-
chatroomId: string;
|
|
3465
|
-
/**
|
|
3466
|
-
* 变更的状态,0:离开, 1:加入
|
|
3467
|
-
*/
|
|
3468
|
-
status: ChrmSyncStatus;
|
|
3469
|
-
/**
|
|
3470
|
-
* 如果status是0的情况,区分离开类型,0:主动离开, 1:多端加入被踢
|
|
3471
|
-
*/
|
|
3472
|
-
reason: ChatroomSyncStatusReason;
|
|
3473
|
-
/**
|
|
3474
|
-
* 用户加入/退出/被踢的时间(毫秒时间戳)
|
|
3475
|
-
*/
|
|
3476
|
-
time: number;
|
|
3477
|
-
/**
|
|
3478
|
-
* 附加信息
|
|
3479
|
-
*/
|
|
3480
|
-
extra: string;
|
|
3481
|
-
}
|
|
3482
|
-
/**
|
|
3483
|
-
* @category Interface
|
|
3484
|
-
* @since 5.7.9
|
|
3485
|
-
*/
|
|
3486
|
-
interface IChatroomNotifyBlock {
|
|
3487
|
-
/**
|
|
3488
|
-
* 聊天室ID
|
|
3489
|
-
*/
|
|
3490
|
-
chatroomId: string;
|
|
3491
|
-
/**
|
|
3492
|
-
* 封禁类型,0是解封,1是封禁
|
|
3493
|
-
*/
|
|
3494
|
-
operateType: ChrmMemOperateType;
|
|
3495
|
-
/**
|
|
3496
|
-
* 封禁时长(毫秒),封禁时有此字段,封禁时长最大值为43200分钟(1个月), 最小值1分钟
|
|
3497
|
-
*/
|
|
3498
|
-
durationTime: number;
|
|
3499
|
-
/**
|
|
3500
|
-
* 操作时间(毫秒时间戳)
|
|
3501
|
-
*/
|
|
3502
|
-
operateTime: number;
|
|
3503
|
-
/**
|
|
3504
|
-
* 被封禁/解封的用户 ID 列表
|
|
3505
|
-
*/
|
|
3506
|
-
userIdList: string[];
|
|
3507
|
-
/**
|
|
3508
|
-
* 附加信息
|
|
3509
|
-
*/
|
|
3510
|
-
extra: string;
|
|
3511
|
-
}
|
|
3512
|
-
/**
|
|
3513
|
-
* @category Interface
|
|
3514
|
-
* @since 5.7.9
|
|
3515
|
-
*/
|
|
3516
|
-
interface IChatroomNotifyBan {
|
|
3517
|
-
/**
|
|
3518
|
-
* 聊天室ID
|
|
3519
|
-
*/
|
|
3520
|
-
chatroomId: string;
|
|
3521
|
-
/**
|
|
3522
|
-
* 禁言类型
|
|
3523
|
-
*/
|
|
3524
|
-
banType: ChrmMemBanType;
|
|
3525
|
-
/**
|
|
3526
|
-
* 禁言时长(毫秒),禁言时有此字段,禁言时长最大值为43200分钟(1个月), 最小值1分钟
|
|
3527
|
-
*/
|
|
3528
|
-
durationTime: number;
|
|
3529
|
-
/**
|
|
3530
|
-
* 操作时间(毫秒时间戳)
|
|
3531
|
-
*/
|
|
3532
|
-
operateTime: number;
|
|
3533
|
-
/**
|
|
3534
|
-
* 禁言/解禁言用户 ID 列表
|
|
3535
|
-
*/
|
|
3536
|
-
userIdList: string[];
|
|
3537
|
-
/**
|
|
3538
|
-
* 附加信息
|
|
3539
|
-
*/
|
|
3540
|
-
extra: string;
|
|
3541
|
-
}
|
|
3542
|
-
declare type IChatroomRejoinedInfo = IChatroomRejoinedFailed | IChatroomRejoinedSuccessed;
|
|
3543
|
-
/**
|
|
3544
|
-
* 聊天室信息
|
|
3545
|
-
* @category Interface
|
|
3546
|
-
*/
|
|
3547
|
-
interface IChatroomListenerData {
|
|
3548
|
-
/**
|
|
3549
|
-
* SDK 内部重连聊天室信息
|
|
3550
|
-
*/
|
|
3551
|
-
rejoinedRoom?: IChatroomRejoinedInfo;
|
|
3552
|
-
/**
|
|
3553
|
-
* 监听到的聊天室 KV 更新
|
|
3554
|
-
*/
|
|
3555
|
-
updatedEntries?: IChatroomEntryListenerData[];
|
|
3556
|
-
/**
|
|
3557
|
-
* 登录退出的用户通知
|
|
3558
|
-
*/
|
|
3559
|
-
userChange?: IChatroomUserChangeInfo;
|
|
3560
|
-
/**
|
|
3561
|
-
* 聊天室销毁
|
|
3562
|
-
*/
|
|
3563
|
-
chatroomDestroyed?: string;
|
|
3564
|
-
/**
|
|
3565
|
-
* 加入退出多端同步通知
|
|
3566
|
-
*/
|
|
3567
|
-
chatroomNotifyMultiLoginSync?: IChatroomNotifyMultiLoginSync;
|
|
3139
|
+
versionTime?: number;
|
|
3568
3140
|
/**
|
|
3569
|
-
*
|
|
3141
|
+
* @ 消息未读数
|
|
3570
3142
|
*/
|
|
3571
|
-
|
|
3143
|
+
unreadMentionedCount?: number;
|
|
3572
3144
|
/**
|
|
3573
|
-
*
|
|
3145
|
+
* @ 我的未读消息数
|
|
3146
|
+
* @since 5.7.9
|
|
3574
3147
|
*/
|
|
3575
|
-
|
|
3148
|
+
unreadMentionedMeCount?: number;
|
|
3576
3149
|
}
|
|
3577
3150
|
/**
|
|
3578
3151
|
* @category Interface
|
|
3579
3152
|
*/
|
|
3580
|
-
interface
|
|
3581
|
-
|
|
3582
|
-
|
|
3583
|
-
|
|
3584
|
-
key: string;
|
|
3585
|
-
/**
|
|
3586
|
-
* 属性对应的值, 最大长度 4096 字符
|
|
3587
|
-
*/
|
|
3588
|
-
value: string;
|
|
3589
|
-
/**
|
|
3590
|
-
* 设置成功后是否发送通知消息
|
|
3591
|
-
*/
|
|
3592
|
-
isSendNotification?: boolean;
|
|
3593
|
-
/**
|
|
3594
|
-
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
3595
|
-
*/
|
|
3596
|
-
notificationExtra?: string;
|
|
3597
|
-
/**
|
|
3598
|
-
* 用户退出聊天室时是否清除此属性
|
|
3599
|
-
*/
|
|
3600
|
-
isAutoDelete?: boolean;
|
|
3153
|
+
interface IBaseConversationInfo {
|
|
3154
|
+
conversationType: ConversationType;
|
|
3155
|
+
targetId: string;
|
|
3156
|
+
channelId: string;
|
|
3601
3157
|
}
|
|
3602
3158
|
/**
|
|
3603
3159
|
* @category Interface
|
|
3604
3160
|
*/
|
|
3605
|
-
interface
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
*/
|
|
3609
|
-
id: string;
|
|
3610
|
-
/**
|
|
3611
|
-
* 加入聊天室的时间
|
|
3612
|
-
*/
|
|
3613
|
-
time: number;
|
|
3161
|
+
interface IConversationState extends IBaseConversationInfo {
|
|
3162
|
+
unreadCount: number;
|
|
3163
|
+
unreadMentionedCount: number;
|
|
3614
3164
|
}
|
|
3615
3165
|
/**
|
|
3166
|
+
* 指定超级群会话传参
|
|
3616
3167
|
* @category Interface
|
|
3617
3168
|
*/
|
|
3618
|
-
interface
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
* @todo 需确认数组元素的数据结构
|
|
3622
|
-
*/
|
|
3623
|
-
userInfos: IChatroomUser[];
|
|
3624
|
-
/**
|
|
3625
|
-
* 房间内总人数
|
|
3626
|
-
*/
|
|
3627
|
-
userCount: number;
|
|
3169
|
+
interface IUltraGroupOption {
|
|
3170
|
+
targetId: string;
|
|
3171
|
+
channelId?: string;
|
|
3628
3172
|
}
|
|
3629
3173
|
/**
|
|
3630
3174
|
* @category Interface
|
|
3631
3175
|
*/
|
|
3632
|
-
interface
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
*/
|
|
3636
|
-
key: string;
|
|
3637
|
-
/**
|
|
3638
|
-
* 删除成功后是否发送通知消息
|
|
3639
|
-
*/
|
|
3640
|
-
isSendNotification?: boolean;
|
|
3641
|
-
/**
|
|
3642
|
-
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
3643
|
-
*/
|
|
3644
|
-
notificationExtra?: string;
|
|
3176
|
+
interface IGetUltraGroupListOption {
|
|
3177
|
+
targetId?: string;
|
|
3178
|
+
channelType?: UltraGroupChannelType;
|
|
3645
3179
|
}
|
|
3646
3180
|
/**
|
|
3647
|
-
*
|
|
3181
|
+
* 超级群频道变更通知内容
|
|
3648
3182
|
*/
|
|
3649
|
-
interface
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
key: string;
|
|
3655
|
-
}[];
|
|
3656
|
-
/**
|
|
3657
|
-
* 删除成功后是否发送通知消息
|
|
3658
|
-
*/
|
|
3659
|
-
/**
|
|
3660
|
-
* RC:chrmKVNotiMsg 消息中携带的附加信息
|
|
3661
|
-
*/
|
|
3662
|
-
notificationExtra?: string;
|
|
3183
|
+
interface IUltraChannelChangeInfo {
|
|
3184
|
+
targetId: string;
|
|
3185
|
+
channelId: string;
|
|
3186
|
+
channelType: UltraGroupChannelType;
|
|
3187
|
+
changeType: UltraGroupChannelChangeType;
|
|
3663
3188
|
}
|
|
3664
3189
|
/**
|
|
3665
|
-
*
|
|
3190
|
+
* 超级群私有频道用户被踢出白名单通知内容
|
|
3666
3191
|
*/
|
|
3667
|
-
interface
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
|
-
|
|
3686
|
-
|
|
3687
|
-
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3192
|
+
interface IUltraChannelUserKickedInfo {
|
|
3193
|
+
targetId: string;
|
|
3194
|
+
channelId: string;
|
|
3195
|
+
channelType: UltraGroupChannelType;
|
|
3196
|
+
userId: string;
|
|
3197
|
+
}
|
|
3198
|
+
/**
|
|
3199
|
+
* 超级群频道被删除通知内容
|
|
3200
|
+
*/
|
|
3201
|
+
interface IUltraChannelDeleteInfo {
|
|
3202
|
+
targetId: string;
|
|
3203
|
+
channelId: string;
|
|
3204
|
+
channelType: UltraGroupChannelType;
|
|
3205
|
+
deleteTime: number;
|
|
3206
|
+
}
|
|
3207
|
+
/**
|
|
3208
|
+
* 获取超级群获取指定会话未读 @ 消息列表
|
|
3209
|
+
*/
|
|
3210
|
+
interface IUltraUnreadConversation {
|
|
3211
|
+
targetId: string;
|
|
3212
|
+
channelId?: string;
|
|
3213
|
+
}
|
|
3214
|
+
interface IUltraGroupUnreadInfo {
|
|
3215
|
+
type: ConversationType;
|
|
3216
|
+
targetId: string;
|
|
3217
|
+
channelId: string;
|
|
3218
|
+
unreadMessageCount: number;
|
|
3219
|
+
mentionedCount: number;
|
|
3220
|
+
mentionedMeCount: number;
|
|
3221
|
+
notificationLevel: NotificationLevel;
|
|
3692
3222
|
}
|
|
3693
3223
|
|
|
3694
3224
|
/**
|
|
@@ -3791,6 +3321,22 @@ interface IUploadAuth {
|
|
|
3791
3321
|
* minio 存储空间名称
|
|
3792
3322
|
*/
|
|
3793
3323
|
minioBucketName: string;
|
|
3324
|
+
/**
|
|
3325
|
+
* 下载鉴权信息
|
|
3326
|
+
*/
|
|
3327
|
+
downloadAuthInfo?: IDownloadAuth;
|
|
3328
|
+
}
|
|
3329
|
+
/**
|
|
3330
|
+
* 下载鉴权信息
|
|
3331
|
+
*/
|
|
3332
|
+
interface IDownloadAuth {
|
|
3333
|
+
/**
|
|
3334
|
+
* 鉴权类型
|
|
3335
|
+
* 0: 不鉴权
|
|
3336
|
+
* 1: 直接使用 url
|
|
3337
|
+
*/
|
|
3338
|
+
type: 0 | 1;
|
|
3339
|
+
url?: string;
|
|
3794
3340
|
}
|
|
3795
3341
|
|
|
3796
3342
|
interface IRTCRoomInfo {
|
|
@@ -4052,21 +3598,6 @@ interface IExtraMethod {
|
|
|
4052
3598
|
updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
|
|
4053
3599
|
}
|
|
4054
3600
|
|
|
4055
|
-
/**
|
|
4056
|
-
* 连接协议
|
|
4057
|
-
* 截止 5.7.4 版本,暂不支持 rpp 和 quic
|
|
4058
|
-
* v2 版本文档: https://a5bq662kv5.feishu.cn/wiki/wikcnfo3lEo2CPbonDxuXFvU0Kb#K7nbeN
|
|
4059
|
-
*/
|
|
4060
|
-
declare enum EConnectProtocol {
|
|
4061
|
-
RMTP = 1,
|
|
4062
|
-
TLS = 2,
|
|
4063
|
-
RPP = 3,
|
|
4064
|
-
QUIC = 4,
|
|
4065
|
-
WS = 5,
|
|
4066
|
-
WSS = 6,
|
|
4067
|
-
HTTP = 11,
|
|
4068
|
-
HTTPS = 12
|
|
4069
|
-
}
|
|
4070
3601
|
interface INaviRequestOption {
|
|
4071
3602
|
appkey: string;
|
|
4072
3603
|
uri: string;
|
|
@@ -4542,6 +4073,18 @@ declare abstract class BasicStatisticReporter {
|
|
|
4542
4073
|
reportClass?: BasicLogger | BasicStatistic);
|
|
4543
4074
|
private timer;
|
|
4544
4075
|
protected started: boolean;
|
|
4076
|
+
/**
|
|
4077
|
+
* 请求失败次数
|
|
4078
|
+
*/
|
|
4079
|
+
private reportFailedNumber;
|
|
4080
|
+
/**
|
|
4081
|
+
* 导航下发的 itv 值
|
|
4082
|
+
*/
|
|
4083
|
+
private itvByNavi;
|
|
4084
|
+
/**
|
|
4085
|
+
* 导航下发的 times 值
|
|
4086
|
+
*/
|
|
4087
|
+
private timesByNavi;
|
|
4545
4088
|
/**
|
|
4546
4089
|
* 根据配置启动实时日志上报,在导航获取完成后启动,导航中包含 userId 信息
|
|
4547
4090
|
* 实时日志仅获取当前时间 - 10s 以前的日志上报,避免多页面并行写库造成数据遗漏
|
|
@@ -4619,6 +4162,47 @@ declare class IndexDBStatisticReporter extends BasicStatisticReporter {
|
|
|
4619
4162
|
protected realtimeReport(url: string, level: StatisticL, itv: number): Promise<void>;
|
|
4620
4163
|
}
|
|
4621
4164
|
|
|
4165
|
+
declare enum AreaCode {
|
|
4166
|
+
BJ = 1,
|
|
4167
|
+
SG = 2,
|
|
4168
|
+
NA = 3
|
|
4169
|
+
}
|
|
4170
|
+
|
|
4171
|
+
interface IStaticConfigData {
|
|
4172
|
+
navi: string[];
|
|
4173
|
+
}
|
|
4174
|
+
interface IStaticConfig {
|
|
4175
|
+
version: number;
|
|
4176
|
+
bootstrap: string[];
|
|
4177
|
+
areaCode: AreaCode;
|
|
4178
|
+
resources: {
|
|
4179
|
+
navi: IServerAddressData[];
|
|
4180
|
+
active: IServerAddressData[];
|
|
4181
|
+
log: IServerAddressData[];
|
|
4182
|
+
};
|
|
4183
|
+
}
|
|
4184
|
+
declare abstract class BasicStaticConfigManager {
|
|
4185
|
+
protected readonly appkey: string;
|
|
4186
|
+
protected readonly logger: BasicLogger;
|
|
4187
|
+
protected areaCode: AreaCode;
|
|
4188
|
+
constructor(appkey: string, logger: BasicLogger, areaCode?: AreaCode);
|
|
4189
|
+
protected staticUrls: string[];
|
|
4190
|
+
protected abstract getCache(): string | null;
|
|
4191
|
+
protected abstract setCache(data: string): void;
|
|
4192
|
+
protected abstract clearCache(): void;
|
|
4193
|
+
protected abstract sendRequest(url: string): Promise<{
|
|
4194
|
+
code: number;
|
|
4195
|
+
data?: string;
|
|
4196
|
+
}>;
|
|
4197
|
+
protected abstract decryptData(data: string): Promise<IStaticConfig | undefined>;
|
|
4198
|
+
getStaticConfig(): Promise<IStaticConfigData | undefined>;
|
|
4199
|
+
/**
|
|
4200
|
+
* 循环请求
|
|
4201
|
+
*/
|
|
4202
|
+
private _requestHandle;
|
|
4203
|
+
setAreaCode(areaCode: AreaCode): void;
|
|
4204
|
+
}
|
|
4205
|
+
|
|
4622
4206
|
declare type INaviCache = {
|
|
4623
4207
|
token: string;
|
|
4624
4208
|
naviInfo: INaviInfo;
|
|
@@ -4631,7 +4215,9 @@ declare abstract class BasicNavi {
|
|
|
4631
4215
|
protected readonly appkey: string;
|
|
4632
4216
|
protected readonly logger: BasicLogger;
|
|
4633
4217
|
protected readonly statisticLog: BasicStatistic;
|
|
4634
|
-
|
|
4218
|
+
protected readonly staticConfigManager: BasicStaticConfigManager;
|
|
4219
|
+
private readonly isRequestProfile;
|
|
4220
|
+
constructor(appkey: string, logger: BasicLogger, statisticLog: BasicStatistic, staticConfigManager: BasicStaticConfigManager, isRequestProfile?: boolean);
|
|
4635
4221
|
/**
|
|
4636
4222
|
* 当前进行中的导航请求
|
|
4637
4223
|
*/
|
|
@@ -4708,12 +4294,29 @@ declare abstract class BasicNavi {
|
|
|
4708
4294
|
useV2Navi(): boolean;
|
|
4709
4295
|
}
|
|
4710
4296
|
|
|
4297
|
+
declare class WebsocketStaticConfigManager extends BasicStaticConfigManager {
|
|
4298
|
+
readonly appkey: string;
|
|
4299
|
+
readonly logger: BasicLogger;
|
|
4300
|
+
private runtime;
|
|
4301
|
+
readonly areaCode: AreaCode;
|
|
4302
|
+
constructor(appkey: string, logger: BasicLogger, runtime: IRuntime, areaCode?: AreaCode);
|
|
4303
|
+
private _storageKey;
|
|
4304
|
+
protected getCache(): string | null;
|
|
4305
|
+
protected setCache(data: string): void;
|
|
4306
|
+
protected clearCache(): void;
|
|
4307
|
+
protected sendRequest(url: string): Promise<{
|
|
4308
|
+
code: number;
|
|
4309
|
+
data?: string;
|
|
4310
|
+
}>;
|
|
4311
|
+
protected decryptData(data: string): Promise<IStaticConfig | undefined>;
|
|
4312
|
+
}
|
|
4313
|
+
|
|
4711
4314
|
/**
|
|
4712
4315
|
* Websocket 导航工具类
|
|
4713
4316
|
*/
|
|
4714
4317
|
declare class WebSocketNavi extends BasicNavi {
|
|
4715
4318
|
private runtime;
|
|
4716
|
-
constructor(appkey: string, logger: BasicLogger, statisticLog: BasicStatistic, runtime: IRuntime);
|
|
4319
|
+
constructor(appkey: string, logger: BasicLogger, statisticLog: BasicStatistic, runtime: IRuntime, staticConfigManager: WebsocketStaticConfigManager);
|
|
4717
4320
|
protected httpRequest(uri: string, appkey: string, token: string, traceId: string, finished: boolean): IPromiseResult<INaviInfo>;
|
|
4718
4321
|
protected httpRequestV2(uri: string, appkey: string, token: string, traceId: string): IPromiseResult<INaviInfo>;
|
|
4719
4322
|
protected getNaviCache(formatedToken: string): INaviCache | null;
|
|
@@ -4893,6 +4496,10 @@ declare abstract class AConnectionMgr {
|
|
|
4893
4496
|
* 当前用户 ID
|
|
4894
4497
|
*/
|
|
4895
4498
|
protected _crtUserId: string;
|
|
4499
|
+
/**
|
|
4500
|
+
* 是否开启 call plus
|
|
4501
|
+
*/
|
|
4502
|
+
protected _openCallPlus: boolean;
|
|
4896
4503
|
/**
|
|
4897
4504
|
* 获取当前用户 ID
|
|
4898
4505
|
* @returns
|
|
@@ -4936,7 +4543,7 @@ declare abstract class AConnectionMgr {
|
|
|
4936
4543
|
* 这个字段就是为这种情况加的。
|
|
4937
4544
|
* 设置 reconnectKickEnable 为 true 时,SDK 重连的时候发现此时已有别的设备连接成功,不再强行踢出已有设备,而是踢出重连设备。
|
|
4938
4545
|
*/
|
|
4939
|
-
connect(token: string, reconnectKickEnable: boolean, traceId: string): IPromiseResult<string>;
|
|
4546
|
+
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
|
|
4940
4547
|
/**
|
|
4941
4548
|
* 执行中的连接事务
|
|
4942
4549
|
*/
|
|
@@ -5060,7 +4667,7 @@ interface IEngine {
|
|
|
5060
4667
|
* @param token
|
|
5061
4668
|
* @param reconnectKickEnable
|
|
5062
4669
|
*/
|
|
5063
|
-
connect(token: string, reconnectKickEnable: boolean, traceId: string): IPromiseResult<string>;
|
|
4670
|
+
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
|
|
5064
4671
|
getNaviInfoFromCache(): INaviInfo | null;
|
|
5065
4672
|
/**
|
|
5066
4673
|
* 上报版本信息
|
|
@@ -5263,7 +4870,7 @@ interface IEngine {
|
|
|
5263
4870
|
* 加入已存在的聊天室
|
|
5264
4871
|
* @param count 拉取消息数量
|
|
5265
4872
|
*/
|
|
5266
|
-
joinExistChatroom(chatroomId: string, count: number): Promise<
|
|
4873
|
+
joinExistChatroom(chatroomId: string, count: number): Promise<IAsyncRes<IChatroomJoinResponse>>;
|
|
5267
4874
|
/**
|
|
5268
4875
|
* 退出聊天室
|
|
5269
4876
|
*/
|
|
@@ -6020,6 +5627,18 @@ declare abstract class BasicReporter {
|
|
|
6020
5627
|
logger: BasicLogger);
|
|
6021
5628
|
private timer;
|
|
6022
5629
|
protected started: boolean;
|
|
5630
|
+
/**
|
|
5631
|
+
* 请求失败次数
|
|
5632
|
+
*/
|
|
5633
|
+
private reportFailedNumber;
|
|
5634
|
+
/**
|
|
5635
|
+
* 导航下发的 itv 值
|
|
5636
|
+
*/
|
|
5637
|
+
private itvByNavi;
|
|
5638
|
+
/**
|
|
5639
|
+
* 导航下发的 times 值
|
|
5640
|
+
*/
|
|
5641
|
+
private timesByNavi;
|
|
6023
5642
|
/**
|
|
6024
5643
|
* 根据配置启动实时日志上报,在导航获取完成后启动,导航中包含 userId 信息
|
|
6025
5644
|
* 实时日志仅获取当前时间 - 10s 以前的日志上报,避免多页面并行写库造成数据遗漏
|
|
@@ -6218,12 +5837,6 @@ declare const DelayTimer: {
|
|
|
6218
5837
|
getTime: () => number;
|
|
6219
5838
|
};
|
|
6220
5839
|
|
|
6221
|
-
declare enum AreaCode {
|
|
6222
|
-
BJ = 1,
|
|
6223
|
-
SG = 2,
|
|
6224
|
-
NA = 3
|
|
6225
|
-
}
|
|
6226
|
-
|
|
6227
5840
|
declare type IMessageListnenr = (message: IReceivedMessage, leftCount?: number, hasMore?: boolean) => void;
|
|
6228
5841
|
declare type IMessagesListnenr = (messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean) => void;
|
|
6229
5842
|
declare type IConnectionStatusListener = (status: RCConnectionStatus | ErrorCode | ConnectionStatus) => void;
|
|
@@ -6817,7 +6430,7 @@ declare class APIContext {
|
|
|
6817
6430
|
* @param roomId 聊天室房间 Id
|
|
6818
6431
|
* @param count 进入聊天室成功后,自动拉取的历史消息数量,默认值为 `10`,最大有效值为 `50`,`-1` 为不拉取
|
|
6819
6432
|
*/
|
|
6820
|
-
joinExistChatroom(roomId: string, count?: number, traceId?: string): Promise<
|
|
6433
|
+
joinExistChatroom(roomId: string, count?: number, traceId?: string): Promise<IAsyncRes<IChatroomJoinResponse>>;
|
|
6821
6434
|
/**
|
|
6822
6435
|
* 退出聊天室
|
|
6823
6436
|
* @param roomId
|
|
@@ -6920,7 +6533,7 @@ declare class APIContext {
|
|
|
6920
6533
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
6921
6534
|
* @returns
|
|
6922
6535
|
*/
|
|
6923
|
-
getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IUploadAuth & {
|
|
6536
|
+
getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string, url?: string): Promise<IUploadAuth & {
|
|
6924
6537
|
bos: string;
|
|
6925
6538
|
qiniu: string;
|
|
6926
6539
|
ossConfig: string;
|
|
@@ -7656,9 +7269,10 @@ declare abstract class AEngine {
|
|
|
7656
7269
|
* 建立连接
|
|
7657
7270
|
* @param token
|
|
7658
7271
|
* @param reconnectKickEnable
|
|
7272
|
+
* @param openCallPlus
|
|
7659
7273
|
* @param traceId
|
|
7660
7274
|
*/
|
|
7661
|
-
abstract connect(token: string, reconnectKickEnable: boolean, traceId: string): IPromiseResult<string>;
|
|
7275
|
+
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
|
|
7662
7276
|
/**
|
|
7663
7277
|
* 发送SDK版本
|
|
7664
7278
|
* @param versionInfo
|
|
@@ -7879,7 +7493,7 @@ declare abstract class AEngine {
|
|
|
7879
7493
|
* 加入已存在的聊天室
|
|
7880
7494
|
* @param count 拉取消息数量
|
|
7881
7495
|
*/
|
|
7882
|
-
abstract joinExistChatroom(chatroomId: string, count: number, traceId?: string): Promise<
|
|
7496
|
+
abstract joinExistChatroom(chatroomId: string, count: number, traceId?: string): Promise<IAsyncRes<IChatroomJoinResponse>>;
|
|
7883
7497
|
/**
|
|
7884
7498
|
* 退出聊天室
|
|
7885
7499
|
*/
|
|
@@ -7950,7 +7564,7 @@ declare abstract class AEngine {
|
|
|
7950
7564
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
7951
7565
|
* @returns
|
|
7952
7566
|
*/
|
|
7953
|
-
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryString?: string): Promise<IAsyncRes<IUploadAuth>>;
|
|
7567
|
+
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryString?: string, url?: string): Promise<IAsyncRes<IUploadAuth>>;
|
|
7954
7568
|
/**
|
|
7955
7569
|
* 获取文件的下载地址
|
|
7956
7570
|
* @param fileType 文件类型
|
|
@@ -8397,6 +8011,10 @@ declare class UrlCenter {
|
|
|
8397
8011
|
* 获取小程序平台 CMP 地址
|
|
8398
8012
|
*/
|
|
8399
8013
|
getMiniCmpUrlList(): string[];
|
|
8014
|
+
/**
|
|
8015
|
+
* 获取静态配置地址
|
|
8016
|
+
*/
|
|
8017
|
+
getStaticConfigUrl(): string[];
|
|
8400
8018
|
}
|
|
8401
8019
|
declare const urlCenter: UrlCenter;
|
|
8402
8020
|
|
|
@@ -8404,7 +8022,7 @@ declare class AppStorage {
|
|
|
8404
8022
|
private _cache;
|
|
8405
8023
|
private _storageKey;
|
|
8406
8024
|
private _rootStorage;
|
|
8407
|
-
constructor(runtime: IRuntime,
|
|
8025
|
+
constructor(runtime: IRuntime, key: string);
|
|
8408
8026
|
_get(): any;
|
|
8409
8027
|
_set(cache: {
|
|
8410
8028
|
[id: string]: any;
|
|
@@ -8714,6 +8332,17 @@ declare const isValidChrmEntryValue: (value: string) => Boolean;
|
|
|
8714
8332
|
*/
|
|
8715
8333
|
declare const getClientMessageId: () => number;
|
|
8716
8334
|
declare const getbundleId: () => string;
|
|
8335
|
+
/**
|
|
8336
|
+
* AES-CBC 解密
|
|
8337
|
+
* @param data 数据源,base64编码
|
|
8338
|
+
* @param key key
|
|
8339
|
+
* @param iv iv
|
|
8340
|
+
* @returns 源数据
|
|
8341
|
+
*/
|
|
8342
|
+
declare const decryptCBC: (data: string, key: string, iv: string) => Promise<string>;
|
|
8343
|
+
declare function fixUrlProtocol(url: string, protocol?: EConnectProtocol): string;
|
|
8344
|
+
|
|
8345
|
+
declare function httpRequest(options: IRequest): Promise<IResponse>;
|
|
8717
8346
|
|
|
8718
8347
|
/**
|
|
8719
8348
|
* @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
|
|
@@ -8789,10 +8418,6 @@ declare const MAX_MESSAGE_CONTENT_BYTES: number;
|
|
|
8789
8418
|
* IM 加入聊天室后定时拉取消息和 KV 时间间隔
|
|
8790
8419
|
*/
|
|
8791
8420
|
declare const IM_CHATROOM_PULL_INTERVAL_TIME: number;
|
|
8792
|
-
/**
|
|
8793
|
-
* storage key 使用的前缀
|
|
8794
|
-
*/
|
|
8795
|
-
declare const STORAGE_ROOT_KEY = "RCV4-";
|
|
8796
8421
|
/**
|
|
8797
8422
|
* 消息扩展字段 key 长度限制
|
|
8798
8423
|
*/
|
|
@@ -8801,6 +8426,8 @@ declare const MAX_MESSAGE_EXPANSION_KEY_LENGTH = 32;
|
|
|
8801
8426
|
* 消息扩展字段 value 长度限制
|
|
8802
8427
|
*/
|
|
8803
8428
|
declare const MAX_MESSAGE_EXPANSION_VAL_LENGTH: number;
|
|
8429
|
+
declare const STATIC_CONFIG_KEY = "cd4936151214ce45dc1d12673a59d94c";
|
|
8430
|
+
declare const STATIC_CONFIG_IV = "51ad078e5eb17a91";
|
|
8804
8431
|
declare const SEND_MESSAGE_TYPE_OPTION: {
|
|
8805
8432
|
[key: string]: {
|
|
8806
8433
|
isCounted: boolean;
|
|
@@ -8834,6 +8461,60 @@ declare const VERSION: string;
|
|
|
8834
8461
|
declare const FORMATED_VERSION: string;
|
|
8835
8462
|
declare const MAX_UPLOAD_FILE_SIZE: number;
|
|
8836
8463
|
declare const UPLOAD_FILE_CHUNK_SIZE: number;
|
|
8464
|
+
declare const STATIC_CONFIG_CACHE_TIME: number;
|
|
8465
|
+
/**
|
|
8466
|
+
* localStorage 中的 key 值
|
|
8467
|
+
*/
|
|
8468
|
+
declare const LOCAL_STORAGE_KEYS: {
|
|
8469
|
+
/**
|
|
8470
|
+
* 导航
|
|
8471
|
+
*/
|
|
8472
|
+
NAVI_KEY: (appKey: string) => string;
|
|
8473
|
+
/**
|
|
8474
|
+
* 拉取会话状态的时间戳
|
|
8475
|
+
*/
|
|
8476
|
+
CONVER_STATE_PULL_TIME_KEY: (appKey: string, curUserId: string) => string;
|
|
8477
|
+
/**
|
|
8478
|
+
* 会话状态(旧)
|
|
8479
|
+
*/
|
|
8480
|
+
OLD_CONVER_STATE_KEY: (appKey: string, curUserId: string) => string;
|
|
8481
|
+
/**
|
|
8482
|
+
* 会话状态
|
|
8483
|
+
*/
|
|
8484
|
+
CONVER_STATE_KEY: (appKey: string, curUserId: string) => string;
|
|
8485
|
+
/**
|
|
8486
|
+
* 超级群会话状态
|
|
8487
|
+
*/
|
|
8488
|
+
ULTRA_GROUP_STATE_KEY: (appKey: string, curUserId: string) => string;
|
|
8489
|
+
/**
|
|
8490
|
+
* 发件箱时间
|
|
8491
|
+
*/
|
|
8492
|
+
OUTBOX_TIME_KEY: (appKey: string, curUserId: string) => string;
|
|
8493
|
+
/**
|
|
8494
|
+
* 收件箱时间
|
|
8495
|
+
*/
|
|
8496
|
+
INBOX_TIME_KEY: (appKey: string, curUserId: string) => string;
|
|
8497
|
+
/**
|
|
8498
|
+
* 广播消息收件箱时间
|
|
8499
|
+
*/
|
|
8500
|
+
BROADCASTBOX_TIME_KEY: (appKey: string, curUserId: string) => string;
|
|
8501
|
+
/**
|
|
8502
|
+
* 本端发送消息记录:解决刷新页面后再次通知本端发送消息的问题
|
|
8503
|
+
*/
|
|
8504
|
+
SEND_MSG_KEY: (appKey: string, curUserId: string) => string;
|
|
8505
|
+
/**
|
|
8506
|
+
* tag 信息拉取时间戳
|
|
8507
|
+
*/
|
|
8508
|
+
USER_SETTING_TIME_KEY: (appKey: string, curUserId: string) => string;
|
|
8509
|
+
/**
|
|
8510
|
+
* tag 状态
|
|
8511
|
+
*/
|
|
8512
|
+
TAG_STATE_KEY: (appKey: string, curUserId: string) => string;
|
|
8513
|
+
/**
|
|
8514
|
+
* staticConfig 静态配置
|
|
8515
|
+
*/
|
|
8516
|
+
STATIC_CONFIG_KEY: (appKey: string) => string;
|
|
8517
|
+
};
|
|
8837
8518
|
|
|
8838
8519
|
/**
|
|
8839
8520
|
* 请使用 `Codec` 替代 `AbsCodec`
|
|
@@ -8847,4 +8528,4 @@ declare type AbsCodec<T> = Codec<T>;
|
|
|
8847
8528
|
*/
|
|
8848
8529
|
declare const version: string;
|
|
8849
8530
|
|
|
8850
|
-
export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BasicLogger, BasicNavi, BasicReporter, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EnableLogL, EnterpriseType, ErrorCode,
|
|
8531
|
+
export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PluginContext, ProtocalType, RCAssertError, RCConnectionStatus, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, VERSION, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, unInitStatisticDB, urlCenter, usingCppEngine, validate, version };
|