@rongcloud/engine 5.32.0-c-rtc-alpha.3 → 5.32.0-c-dq.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs +1 -1
- package/index.cjs.js +1 -1
- package/index.d.ts +502 -108
- package/index.esm.js +1 -1
- package/index.mjs +1 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -264,6 +264,8 @@ declare const Log: {
|
|
|
264
264
|
readonly L_EVENT_LOOP_BLOCKING_S: "L-event_loop_blocking-S";
|
|
265
265
|
readonly A_E_SEARCH_CONVERSATION_BY_CONTENT_T: "A-e_search_conversation_by_content-T";
|
|
266
266
|
readonly A_E_SEARCH_CONVERSATION_BY_CONTENT_R: "A-e_search_conversation_by_content-R";
|
|
267
|
+
readonly A_LOAD_CONVERSATION_LIST_T: "A-load_conversation_list-T";
|
|
268
|
+
readonly A_LOAD_CONVERSATION_LIST_R: "A-load_conversation_list-R";
|
|
267
269
|
readonly P_GET_SYS_VERSION_E: "P-get_sys_version-E";
|
|
268
270
|
/** 清除本地缓存 */
|
|
269
271
|
readonly A_CLEAR_LOCAL_CACHE_O: "A-clear_local_cache-O";
|
|
@@ -455,6 +457,10 @@ declare const Log: {
|
|
|
455
457
|
readonly A_GET_READ_RECEIPT_V4_R: "A-get_read_receipt_V4-R";
|
|
456
458
|
readonly A_BATCH_GET_READ_RECEIPT_INFO_V4_T: "A-batch_get_read_receipt_info_V4-T";
|
|
457
459
|
readonly A_BATCH_GET_READ_RECEIPT_INFO_V4_R: "A-batch_get_read_receipt_info_V4-R";
|
|
460
|
+
readonly A_GET_ALL_ROBOTS_T: "A-get_all_robots-T";
|
|
461
|
+
readonly A_GET_ALL_ROBOTS_R: "A-get_all_robots-R";
|
|
462
|
+
readonly A_GET_ROBOT_BY_ID_T: "A-get_robot_by_id-T";
|
|
463
|
+
readonly A_GET_ROBOT_BY_ID_R: "A-get_robot_by_id-R";
|
|
458
464
|
readonly A_ADD_FRIEND_T: "A-add_friend-T";
|
|
459
465
|
readonly A_ADD_FRIEND_R: "A-add_friend-R";
|
|
460
466
|
readonly A_DELETE_FRIENDS_T: "A-delete_friends-T";
|
|
@@ -549,6 +555,12 @@ declare const Log: {
|
|
|
549
555
|
readonly A_GET_MY_USER_PROFILE_R: "A-get_my_user_profile-R";
|
|
550
556
|
readonly A_UPDATE_MY_USER_PROFILE_T: "A-update_my_user_profile-T";
|
|
551
557
|
readonly A_UPDATE_MY_USER_PROFILE_R: "A-update_my_user_profile-R";
|
|
558
|
+
readonly A_GET_CONVERSATIONS_INCLUDING_ROBOTS_T: "A-get_conversations_including_robots-T";
|
|
559
|
+
readonly A_GET_CONVERSATIONS_INCLUDING_ROBOTS_R: "A-get_conversations_including_robots-R";
|
|
560
|
+
readonly L_PULL_SG_UNREAD_COUNT_T: "L-pull_sg_unread_count-T";
|
|
561
|
+
readonly L_PULL_SG_UNREAD_COUNT_R: "L-pull_sg_unread_count-R";
|
|
562
|
+
readonly A_MARK_REMOTE_CONVERSATION_AS_READ_T: "A-mark_remote_conversation_as_read-T";
|
|
563
|
+
readonly A_MARK_REMOTE_CONVERSATION_AS_READ_R: "A-mark_remote_conversation_as_read-R";
|
|
552
564
|
};
|
|
553
565
|
|
|
554
566
|
/** [EN]
|
|
@@ -1268,6 +1280,11 @@ declare enum ErrorCode {
|
|
|
1268
1280
|
* 已被对方加入黑名单,消息发送失败
|
|
1269
1281
|
*/
|
|
1270
1282
|
REJECTED_BY_BLACKLIST = 405,
|
|
1283
|
+
/**
|
|
1284
|
+
* 407
|
|
1285
|
+
* 对方开启了只接收白名单的信息,但己方不在白名单中,发送消息失败
|
|
1286
|
+
*/
|
|
1287
|
+
NOT_IN_WHITELIST = 407,
|
|
1271
1288
|
/**
|
|
1272
1289
|
* 20106
|
|
1273
1290
|
* 在单聊中已被禁言
|
|
@@ -1292,12 +1309,24 @@ declare enum ErrorCode {
|
|
|
1292
1309
|
* @since 5.26.0
|
|
1293
1310
|
*/
|
|
1294
1311
|
CONTENT_REVIEW_REJECTED = 20113,
|
|
1312
|
+
/**
|
|
1313
|
+
* 20114
|
|
1314
|
+
* 消息超过可修改时间
|
|
1315
|
+
* @since 5.26.0
|
|
1316
|
+
*/
|
|
1317
|
+
MESSAGE_OVER_MODIFY_TIME_FAIL = 20114,
|
|
1295
1318
|
/**
|
|
1296
1319
|
* 20115
|
|
1297
1320
|
* 消息尺寸超出限制
|
|
1298
1321
|
* @since 5.26.0
|
|
1299
1322
|
*/
|
|
1300
1323
|
MESSAGE_SIZE_EXCEEDED = 20115,
|
|
1324
|
+
/**
|
|
1325
|
+
* 20116
|
|
1326
|
+
* 消息不支持修改
|
|
1327
|
+
* @since 5.26.0
|
|
1328
|
+
*/
|
|
1329
|
+
MESSAGE_UNSUPPORTED_MODIFY = 20116,
|
|
1301
1330
|
/**
|
|
1302
1331
|
* 20512
|
|
1303
1332
|
* appkey的数据中心与请求云控的数据中心不匹配
|
|
@@ -1427,7 +1456,7 @@ declare enum ErrorCode {
|
|
|
1427
1456
|
CHATROOM_KV_OVERWRITE_INVALID = 23424,
|
|
1428
1457
|
/**
|
|
1429
1458
|
* 23425
|
|
1430
|
-
*
|
|
1459
|
+
* 【已废弃】超过聊天室中状态设置频率,1 个聊天室 1 秒钟最多设置和删除状态 100 次
|
|
1431
1460
|
*/
|
|
1432
1461
|
CHATROOM_SET_PROPERTY_OVER_FREQUENCY = 23425,
|
|
1433
1462
|
/**
|
|
@@ -1452,7 +1481,7 @@ declare enum ErrorCode {
|
|
|
1452
1481
|
CHATROOM_KV_STORE_OUT_LIMIT = 23429,
|
|
1453
1482
|
/**
|
|
1454
1483
|
* 23431
|
|
1455
|
-
*
|
|
1484
|
+
* 【已废弃】聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
|
|
1456
1485
|
* @since 5.3.0
|
|
1457
1486
|
*/
|
|
1458
1487
|
CHATROOM_KV_SET_ERROR = 23431,
|
|
@@ -1891,6 +1920,11 @@ declare enum ErrorCode {
|
|
|
1891
1920
|
* @since 5.12.0
|
|
1892
1921
|
*/
|
|
1893
1922
|
RC_FRIEND_NOT_ALLOW_ADD_SELF = 25473,
|
|
1923
|
+
/**
|
|
1924
|
+
* 25474
|
|
1925
|
+
* 不支持添加机器人为好友
|
|
1926
|
+
*/
|
|
1927
|
+
RC_FRIEND_NOT_SUPPORT_ROBOT = 25474,
|
|
1894
1928
|
/**
|
|
1895
1929
|
* 25480
|
|
1896
1930
|
* 托管资料信息审核不通过
|
|
@@ -2450,6 +2484,12 @@ declare enum ErrorCode {
|
|
|
2450
2484
|
* @since 5.2.0
|
|
2451
2485
|
*/
|
|
2452
2486
|
NO_TAG_IN_CONVER = 33102,
|
|
2487
|
+
/**
|
|
2488
|
+
* 33103
|
|
2489
|
+
* 方法执行中,请勿重复调用。
|
|
2490
|
+
* @since 5.32.0
|
|
2491
|
+
*/
|
|
2492
|
+
METHOD_BUSY = 33103,
|
|
2453
2493
|
/**
|
|
2454
2494
|
* 33401
|
|
2455
2495
|
* 被编辑消息是接收的或者没有发送成功的
|
|
@@ -3080,15 +3120,27 @@ declare enum ErrorCode {
|
|
|
3080
3120
|
* @since 5.26.0
|
|
3081
3121
|
*/
|
|
3082
3122
|
INVALID_PARAMETER_MESSAGE_INFO_MAP = 34345,
|
|
3123
|
+
/**
|
|
3124
|
+
* 34435
|
|
3125
|
+
* 服务端记录会话未读数功能开启时禁止调用此方法
|
|
3126
|
+
* @since 5.32.0
|
|
3127
|
+
*/
|
|
3128
|
+
SERVER_RECORD_UNREAD_COUNT_ENABLED_FORBIDDEN = 34435,
|
|
3129
|
+
/**
|
|
3130
|
+
* 34436
|
|
3131
|
+
* 服务端记录会话未读数功能未开启
|
|
3132
|
+
* @since 5.32.0
|
|
3133
|
+
*/
|
|
3134
|
+
SERVER_RECORD_UNREAD_COUNT_DISABLED = 34436,
|
|
3083
3135
|
/**
|
|
3084
3136
|
* 35001
|
|
3085
|
-
*
|
|
3137
|
+
* 【已废弃】群组信息异常
|
|
3086
3138
|
* @deprecated
|
|
3087
3139
|
*/
|
|
3088
3140
|
GROUP_SYNC_ERROR = 35001,
|
|
3089
3141
|
/**
|
|
3090
3142
|
* 35002
|
|
3091
|
-
*
|
|
3143
|
+
* 【已废弃】匹配群信息异常
|
|
3092
3144
|
* @deprecated
|
|
3093
3145
|
*/
|
|
3094
3146
|
GROUP_MATCH_ERROR = 35002,
|
|
@@ -3104,7 +3156,7 @@ declare enum ErrorCode {
|
|
|
3104
3156
|
MAIN_PROCESS_ERROR = 35005,
|
|
3105
3157
|
/**
|
|
3106
3158
|
* 35007
|
|
3107
|
-
*
|
|
3159
|
+
* 【已废弃】已连接或者内部重连中,不允许调用重连,需先调用 disconnect 方法
|
|
3108
3160
|
* @deprecated
|
|
3109
3161
|
*/
|
|
3110
3162
|
CAN_NOT_RECONNECT = 35007,
|
|
@@ -3115,13 +3167,13 @@ declare enum ErrorCode {
|
|
|
3115
3167
|
SERVER_UNAVAILABLE = 35008,
|
|
3116
3168
|
/**
|
|
3117
3169
|
* 35009
|
|
3118
|
-
* Web 端设置安全域名后,连接端域名不在安全域名范围内
|
|
3170
|
+
* 【已废弃】Web 端设置安全域名后,连接端域名不在安全域名范围内
|
|
3119
3171
|
* @deprecated
|
|
3120
3172
|
*/
|
|
3121
3173
|
HOSTNAME_ERROR = 35009,
|
|
3122
3174
|
/**
|
|
3123
3175
|
* 35010
|
|
3124
|
-
*
|
|
3176
|
+
* 【已废弃】开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
|
|
3125
3177
|
* @deprecated
|
|
3126
3178
|
*/
|
|
3127
3179
|
HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
|
|
@@ -3286,24 +3338,6 @@ declare enum ErrorCode {
|
|
|
3286
3338
|
* 开发者调用时传入的 pushData 无效
|
|
3287
3339
|
*/
|
|
3288
3340
|
INVALID_PARAMETER_PUSH_DATA = 35050,
|
|
3289
|
-
/**
|
|
3290
|
-
* 35051
|
|
3291
|
-
* dns 代理超时
|
|
3292
|
-
* @since 5.12.2
|
|
3293
|
-
*/
|
|
3294
|
-
DNS_PROXY_TIMEOUT = 35051,
|
|
3295
|
-
/**
|
|
3296
|
-
* 35052
|
|
3297
|
-
* dns 代理错误
|
|
3298
|
-
* @since 5.12.2
|
|
3299
|
-
*/
|
|
3300
|
-
DNS_PROXY_ERROR = 35052,
|
|
3301
|
-
/**
|
|
3302
|
-
* 35053
|
|
3303
|
-
* dns 代理数据解构错误
|
|
3304
|
-
* @since 5.12.2
|
|
3305
|
-
*/
|
|
3306
|
-
DNS_PROXY_DATA_DESTRUCTUR_ERROR = 35053,
|
|
3307
3341
|
/**
|
|
3308
3342
|
* 35054
|
|
3309
3343
|
* 传入的 disableUpdateLastMessage 参数无效。在会话类型为 ULTRA GROUP 时,该字段不允许设置为 true
|
|
@@ -3378,49 +3412,49 @@ declare enum ErrorCode {
|
|
|
3378
3412
|
TRANSLATION_TEXT_INVALID = 35065,
|
|
3379
3413
|
/**
|
|
3380
3414
|
* 36001
|
|
3381
|
-
*
|
|
3415
|
+
* 【已废弃】加入聊天室Id为空
|
|
3382
3416
|
* @deprecated
|
|
3383
3417
|
*/
|
|
3384
3418
|
CHATROOM_ID_ISNULL = 36001,
|
|
3385
3419
|
/**
|
|
3386
3420
|
* 36002
|
|
3387
|
-
*
|
|
3421
|
+
* 【已废弃】加入聊天室失败
|
|
3388
3422
|
* @deprecated
|
|
3389
3423
|
*/
|
|
3390
3424
|
CHARTOOM_JOIN_ERROR = 36002,
|
|
3391
3425
|
/**
|
|
3392
3426
|
* 36003
|
|
3393
|
-
*
|
|
3427
|
+
* 【已废弃】拉取聊天室历史消息失败
|
|
3394
3428
|
* @deprecated
|
|
3395
3429
|
*/
|
|
3396
3430
|
CHATROOM_HISMESSAGE_ERROR = 36003,
|
|
3397
3431
|
/**
|
|
3398
3432
|
* 36004
|
|
3399
|
-
*
|
|
3433
|
+
* 【已废弃】聊天室 kv 未找到
|
|
3400
3434
|
* @deprecated
|
|
3401
3435
|
*/
|
|
3402
3436
|
CHATROOM_KV_NOT_FOUND = 36004,
|
|
3403
3437
|
/**
|
|
3404
3438
|
* 37001
|
|
3405
|
-
*
|
|
3439
|
+
* 【已废弃】加入黑名单异常
|
|
3406
3440
|
* @deprecated
|
|
3407
3441
|
*/
|
|
3408
3442
|
BLACK_ADD_ERROR = 37001,
|
|
3409
3443
|
/**
|
|
3410
3444
|
* 37002
|
|
3411
|
-
*
|
|
3445
|
+
* 【已废弃】获得指定人员再黑名单中的状态异常
|
|
3412
3446
|
* @deprecated
|
|
3413
3447
|
*/
|
|
3414
3448
|
BLACK_GETSTATUS_ERROR = 37002,
|
|
3415
3449
|
/**
|
|
3416
3450
|
* 37003
|
|
3417
|
-
*
|
|
3451
|
+
* 【已废弃】移除黑名单异常
|
|
3418
3452
|
* @deprecated
|
|
3419
3453
|
*/
|
|
3420
3454
|
BLACK_REMOVE_ERROR = 37003,
|
|
3421
3455
|
/**
|
|
3422
3456
|
* 38001
|
|
3423
|
-
*
|
|
3457
|
+
* 【已废弃】获取草稿失败
|
|
3424
3458
|
* @deprecated
|
|
3425
3459
|
*/
|
|
3426
3460
|
DRAF_GET_ERROR = 38001,
|
|
@@ -3462,7 +3496,7 @@ declare enum ErrorCode {
|
|
|
3462
3496
|
STREAM_MESSAGE_SYNCED = 39007,
|
|
3463
3497
|
/**
|
|
3464
3498
|
* 41002
|
|
3465
|
-
*
|
|
3499
|
+
* 【已废弃】获取七牛token失败
|
|
3466
3500
|
* @deprecated
|
|
3467
3501
|
*/
|
|
3468
3502
|
QNTKN_GET_ERROR = 41002,
|
|
@@ -3525,10 +3559,10 @@ declare enum ConversationType {
|
|
|
3525
3559
|
*/
|
|
3526
3560
|
CUSTOMER_SERVICE = 5,
|
|
3527
3561
|
/** [EN]
|
|
3528
|
-
* System
|
|
3562
|
+
* System conversation
|
|
3529
3563
|
*/
|
|
3530
3564
|
/**
|
|
3531
|
-
*
|
|
3565
|
+
* 系统会话
|
|
3532
3566
|
*/
|
|
3533
3567
|
SYSTEM = 6,
|
|
3534
3568
|
/** [EN]
|
|
@@ -4493,6 +4527,40 @@ declare enum PushNotificationQuietHoursLevel {
|
|
|
4493
4527
|
PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_BLOCKED = 5
|
|
4494
4528
|
}
|
|
4495
4529
|
|
|
4530
|
+
/**
|
|
4531
|
+
* @since 5.32.0
|
|
4532
|
+
* 机器人过滤类型
|
|
4533
|
+
* @category Enum
|
|
4534
|
+
*/
|
|
4535
|
+
declare const FilterRobotType: {
|
|
4536
|
+
/** [EN]
|
|
4537
|
+
* Get results containing robots
|
|
4538
|
+
*/
|
|
4539
|
+
/**
|
|
4540
|
+
* 获取结果包含机器人
|
|
4541
|
+
*/
|
|
4542
|
+
readonly ALL: 0;
|
|
4543
|
+
/** [EN]
|
|
4544
|
+
* Get results not containing robots
|
|
4545
|
+
*/
|
|
4546
|
+
/**
|
|
4547
|
+
* 获取结果不包含机器人
|
|
4548
|
+
*/
|
|
4549
|
+
readonly EXCLUDE_ROBOT: 1;
|
|
4550
|
+
/** [EN]
|
|
4551
|
+
* Get results only containing robots
|
|
4552
|
+
*/
|
|
4553
|
+
/**
|
|
4554
|
+
* 获取结果仅包含机器人
|
|
4555
|
+
*/
|
|
4556
|
+
readonly ROBOT_ONLY: 2;
|
|
4557
|
+
};
|
|
4558
|
+
declare type FilterRobotType = (typeof FilterRobotType)[keyof typeof FilterRobotType];
|
|
4559
|
+
|
|
4560
|
+
/** [EN]
|
|
4561
|
+
* Message moderation status
|
|
4562
|
+
* @category Enum
|
|
4563
|
+
*/
|
|
4496
4564
|
/**
|
|
4497
4565
|
* 消息审核类型
|
|
4498
4566
|
* @category Enum
|
|
@@ -5489,11 +5557,11 @@ interface IUpdateItem {
|
|
|
5489
5557
|
};
|
|
5490
5558
|
}
|
|
5491
5559
|
/** [EN]
|
|
5492
|
-
*
|
|
5560
|
+
* Conversation data
|
|
5493
5561
|
* @category Interface
|
|
5494
5562
|
*/
|
|
5495
5563
|
/**
|
|
5496
|
-
*
|
|
5564
|
+
* 会话数据
|
|
5497
5565
|
* @category Interface
|
|
5498
5566
|
*/
|
|
5499
5567
|
interface IReceivedConversation {
|
|
@@ -5690,6 +5758,15 @@ interface IReceivedConversation {
|
|
|
5690
5758
|
* @since 5.28.0
|
|
5691
5759
|
*/
|
|
5692
5760
|
editedMessageDraft?: IEditedMessageDraft;
|
|
5761
|
+
/** [EN]
|
|
5762
|
+
* Whether the conversation contains a robot, currently only supported for single chat and system sessions.
|
|
5763
|
+
* @since 5.30.0
|
|
5764
|
+
*/
|
|
5765
|
+
/**
|
|
5766
|
+
* 是否包含机器人,当前仅支持单聊、系统会话。
|
|
5767
|
+
* @since 5.30.0
|
|
5768
|
+
*/
|
|
5769
|
+
includeRobot?: boolean;
|
|
5693
5770
|
}
|
|
5694
5771
|
/** [EN]
|
|
5695
5772
|
* @category Interface
|
|
@@ -6031,6 +6108,114 @@ interface IGetUnreadMentionMeConversationListParams {
|
|
|
6031
6108
|
*/
|
|
6032
6109
|
conversationTypes: ConversationType[];
|
|
6033
6110
|
}
|
|
6111
|
+
/**
|
|
6112
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6113
|
+
* @since 5.32.0
|
|
6114
|
+
*/
|
|
6115
|
+
declare enum TagFilterStrategy {
|
|
6116
|
+
/**
|
|
6117
|
+
* 用于获取包含任一标签的会话列表(逻辑或)
|
|
6118
|
+
*/
|
|
6119
|
+
UNION = 0,
|
|
6120
|
+
/**
|
|
6121
|
+
* 用于获取包含所有标签的会话列表(逻辑与)
|
|
6122
|
+
*/
|
|
6123
|
+
INTERSECTION = 1,
|
|
6124
|
+
/**
|
|
6125
|
+
* 用于获取不包含指定标签的会话列表(逻辑非)
|
|
6126
|
+
*/
|
|
6127
|
+
EXCLUSION = 2
|
|
6128
|
+
}
|
|
6129
|
+
/**
|
|
6130
|
+
* 标签过滤器
|
|
6131
|
+
* @since 5.32.0
|
|
6132
|
+
*/
|
|
6133
|
+
interface IConversationTagFilter {
|
|
6134
|
+
/**
|
|
6135
|
+
* 标签 ID 列表,不传或为 [] 时,不进行标签过滤
|
|
6136
|
+
*/
|
|
6137
|
+
tagIds?: string[];
|
|
6138
|
+
/**
|
|
6139
|
+
* 标签内是否置顶优先,默认 false;当 tagIds 为空时,该参数无效
|
|
6140
|
+
*/
|
|
6141
|
+
topPriority?: boolean;
|
|
6142
|
+
/**
|
|
6143
|
+
* 标签过滤策略,默认使用 TagFilterStrategy.UNION,取标签下的会话列表并集;当 tagIds 为空时,该参数无效
|
|
6144
|
+
* @hidden - 本期不对外,后续拓展预留
|
|
6145
|
+
*/
|
|
6146
|
+
strategy?: TagFilterStrategy;
|
|
6147
|
+
}
|
|
6148
|
+
/**
|
|
6149
|
+
* @since 5.32.0
|
|
6150
|
+
*/
|
|
6151
|
+
interface IConversationListLoaderOptions {
|
|
6152
|
+
/**
|
|
6153
|
+
* 会话类型筛选,不传或为 [] 时,取全部类型会话(不支持超级群会话类型)
|
|
6154
|
+
*/
|
|
6155
|
+
conversationTypes?: ConversationType[];
|
|
6156
|
+
/**
|
|
6157
|
+
* tag 过滤器,不传则不过滤
|
|
6158
|
+
*/
|
|
6159
|
+
tagFilter?: IConversationTagFilter;
|
|
6160
|
+
/**
|
|
6161
|
+
* 排序方向,默认值为 0;有效值如下:
|
|
6162
|
+
* * 0 - 表示按时间降序,从最新的会话开始
|
|
6163
|
+
* * 1 - 表示按时间升序,从最早的会话开始
|
|
6164
|
+
*/
|
|
6165
|
+
order?: 0 | 1;
|
|
6166
|
+
/**
|
|
6167
|
+
* 频道 Id,不传则取全部会话,传任意字符串都视为有效 channelId,包括 "" 空字符串
|
|
6168
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6169
|
+
*/
|
|
6170
|
+
channelId?: string;
|
|
6171
|
+
/**
|
|
6172
|
+
* 是否置顶优先。
|
|
6173
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6174
|
+
*/
|
|
6175
|
+
topPriority?: boolean;
|
|
6176
|
+
/**
|
|
6177
|
+
* 获取包含未读消息的会话
|
|
6178
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6179
|
+
*/
|
|
6180
|
+
hasUnreadMessage?: boolean;
|
|
6181
|
+
/**
|
|
6182
|
+
* 获取免打扰会话
|
|
6183
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6184
|
+
*/
|
|
6185
|
+
muted?: boolean;
|
|
6186
|
+
}
|
|
6187
|
+
/** [EN]
|
|
6188
|
+
* Get Conversation List Containing Robots Option, currently only supported for single chat and system sessions.
|
|
6189
|
+
* @since 5.32.0
|
|
6190
|
+
*/
|
|
6191
|
+
/**
|
|
6192
|
+
* 获取包含机器人的会话列表参数
|
|
6193
|
+
* @since 5.32.0
|
|
6194
|
+
*/
|
|
6195
|
+
interface IGetConversationsIncludingRobotsOption {
|
|
6196
|
+
/** [EN]
|
|
6197
|
+
* Conversation types, currently only supported for single chat and system sessions.
|
|
6198
|
+
*/
|
|
6199
|
+
/**
|
|
6200
|
+
* 会话类型列表,目前仅支持单聊会话、系统会话。
|
|
6201
|
+
*/
|
|
6202
|
+
conversationTypes: ConversationType[];
|
|
6203
|
+
/** [EN]
|
|
6204
|
+
* Get robot count, valid value range [1, 100]
|
|
6205
|
+
*/
|
|
6206
|
+
/**
|
|
6207
|
+
* 获取机器人数量,有效值范围 [1, 100]
|
|
6208
|
+
*/
|
|
6209
|
+
count: number;
|
|
6210
|
+
/**
|
|
6211
|
+
* 时间戳
|
|
6212
|
+
*/
|
|
6213
|
+
timestamp: number;
|
|
6214
|
+
/**
|
|
6215
|
+
* 是否置顶优先,默认 false;该参数仅 Electron 平台支持
|
|
6216
|
+
*/
|
|
6217
|
+
topPriority?: boolean;
|
|
6218
|
+
}
|
|
6034
6219
|
|
|
6035
6220
|
/** [EN]
|
|
6036
6221
|
* Read receipt response information
|
|
@@ -6160,7 +6345,7 @@ interface IReadReceiptData {
|
|
|
6160
6345
|
* @since 5.9.0
|
|
6161
6346
|
* @hidden
|
|
6162
6347
|
*/
|
|
6163
|
-
interface IPrivateReadReceiptData extends
|
|
6348
|
+
interface IPrivateReadReceiptData extends IConversationIdentifier {
|
|
6164
6349
|
/**
|
|
6165
6350
|
* 最后已读消息时间 (单聊)
|
|
6166
6351
|
*/
|
|
@@ -6172,7 +6357,7 @@ interface IPrivateReadReceiptData extends IConversationOption {
|
|
|
6172
6357
|
* @since 5.9.0
|
|
6173
6358
|
* @hidden
|
|
6174
6359
|
*/
|
|
6175
|
-
interface IGroupReadReceiptData extends
|
|
6360
|
+
interface IGroupReadReceiptData extends IConversationIdentifier {
|
|
6176
6361
|
/**
|
|
6177
6362
|
* 已读人数 (群聊)
|
|
6178
6363
|
*/
|
|
@@ -6192,7 +6377,7 @@ interface IGroupReadReceiptData extends IConversationOption {
|
|
|
6192
6377
|
* @since 5.9.0
|
|
6193
6378
|
* @hidden
|
|
6194
6379
|
*/
|
|
6195
|
-
interface ISyncReadStatusData extends
|
|
6380
|
+
interface ISyncReadStatusData extends IConversationIdentifier {
|
|
6196
6381
|
/**
|
|
6197
6382
|
* 已读消息时间
|
|
6198
6383
|
*/
|
|
@@ -6240,15 +6425,33 @@ interface IReceivedStatusInfo {
|
|
|
6240
6425
|
*/
|
|
6241
6426
|
isRetrieved?: boolean;
|
|
6242
6427
|
}
|
|
6243
|
-
|
|
6244
|
-
|
|
6245
|
-
|
|
6246
|
-
|
|
6428
|
+
interface IMessageExtraData {
|
|
6429
|
+
/**
|
|
6430
|
+
* 业务层自定义排序 ID
|
|
6431
|
+
*/
|
|
6432
|
+
seqId?: string;
|
|
6433
|
+
/**
|
|
6434
|
+
* 第三方消息发送时间戳,为毫秒时间
|
|
6435
|
+
*/
|
|
6436
|
+
sentTime?: number;
|
|
6437
|
+
}
|
|
6247
6438
|
/**
|
|
6248
|
-
*
|
|
6249
|
-
* @
|
|
6439
|
+
* 内部消息结构定义,上面会携带一些不适合透漏给业务层的字段定义,用于内部业务处理。
|
|
6440
|
+
* @hidden
|
|
6250
6441
|
*/
|
|
6251
|
-
interface
|
|
6442
|
+
interface IInnerMessage<T = any> {
|
|
6443
|
+
/**
|
|
6444
|
+
* 内部数据,用于内部业务处理
|
|
6445
|
+
* @hidden
|
|
6446
|
+
*/
|
|
6447
|
+
__innerData__?: {
|
|
6448
|
+
/**
|
|
6449
|
+
* 接收到的该条撤回消息,是否保持本地未读数不变,仅当消息为 RC:RcCmd 撤回消息时有效
|
|
6450
|
+
* * 开启服务器记录会话未读数功能时,从服务器解析获取。
|
|
6451
|
+
* * 未开启服务器记录会话未读数功能时,该值默认赋值为 false,表示需要本地未读数 -1,保持原有逻辑不变
|
|
6452
|
+
*/
|
|
6453
|
+
keepUnreadCount?: boolean;
|
|
6454
|
+
};
|
|
6252
6455
|
/** [EN]
|
|
6253
6456
|
* The business identifier of the conversation
|
|
6254
6457
|
*/
|
|
@@ -6506,6 +6709,22 @@ interface IReceivedMessage<T = any> {
|
|
|
6506
6709
|
* * 仅支持单聊、群聊历史消息,接收在线、离线消息时无效
|
|
6507
6710
|
*/
|
|
6508
6711
|
modifyInfo?: MessageModifyInfo;
|
|
6712
|
+
/**
|
|
6713
|
+
* 业务层发送消息时的透传数据,仅允许通过 serverApi 进行发送,SDK 不支持发送该字段
|
|
6714
|
+
* @hidden 暂为和讯网定制化需求
|
|
6715
|
+
* @since 5.30.1
|
|
6716
|
+
*/
|
|
6717
|
+
extraData?: IMessageExtraData;
|
|
6718
|
+
}
|
|
6719
|
+
/** [EN]
|
|
6720
|
+
* Message data received from the server
|
|
6721
|
+
* @category Interface
|
|
6722
|
+
*/
|
|
6723
|
+
/**
|
|
6724
|
+
* 从服务端接收到的消息数据
|
|
6725
|
+
* @category Interface
|
|
6726
|
+
*/
|
|
6727
|
+
interface IReceivedMessage<T = any> extends Omit<IInnerMessage<T>, '__innerData__'> {
|
|
6509
6728
|
}
|
|
6510
6729
|
/** [EN]
|
|
6511
6730
|
* First unread message information
|
|
@@ -7178,7 +7397,7 @@ interface MentionedInfo {
|
|
|
7178
7397
|
/**
|
|
7179
7398
|
* @category Interface
|
|
7180
7399
|
*/
|
|
7181
|
-
interface IClearMessageOption extends
|
|
7400
|
+
interface IClearMessageOption extends IConversationIdentifier {
|
|
7182
7401
|
/** [EN]
|
|
7183
7402
|
* Timestamp
|
|
7184
7403
|
*/
|
|
@@ -7246,7 +7465,7 @@ interface IModifyMessageParams {
|
|
|
7246
7465
|
/**
|
|
7247
7466
|
* 会话信息
|
|
7248
7467
|
*/
|
|
7249
|
-
conversation:
|
|
7468
|
+
conversation: IConversationIdentifier;
|
|
7250
7469
|
}
|
|
7251
7470
|
/**
|
|
7252
7471
|
* 刷新引用消息参数
|
|
@@ -7260,7 +7479,7 @@ interface IRefreshReferenceMessageParams {
|
|
|
7260
7479
|
/**
|
|
7261
7480
|
* 会话信息
|
|
7262
7481
|
*/
|
|
7263
|
-
conversationIdentifier:
|
|
7482
|
+
conversationIdentifier: IConversationIdentifier;
|
|
7264
7483
|
/**
|
|
7265
7484
|
* 本地消息回调
|
|
7266
7485
|
*/
|
|
@@ -8358,6 +8577,10 @@ interface ISvrRecallNotificationMessageContent extends IExtraDataKeyInMessage, I
|
|
|
8358
8577
|
* 是否删除接收端本地存储的原始消息
|
|
8359
8578
|
*/
|
|
8360
8579
|
delete?: boolean;
|
|
8580
|
+
/**
|
|
8581
|
+
* 撤回消息时携带的扩展信息
|
|
8582
|
+
*/
|
|
8583
|
+
extra?: string;
|
|
8361
8584
|
}
|
|
8362
8585
|
/** [EN]
|
|
8363
8586
|
* Recall notification message content data
|
|
@@ -9659,9 +9882,10 @@ declare class EventDispatcher<T> {
|
|
|
9659
9882
|
* 连接目标事件监听器,本实例派发的事件会被传递给入参事件监听器
|
|
9660
9883
|
* 举例:a.pipe(b) 后,当 a.emit 后,b 的所有监听器也会触发,但会晚于所有 a 的监听器;
|
|
9661
9884
|
* @param emitter
|
|
9885
|
+
* @param types 指定事件类型列表,如果指定,则只有指定类型的事件会被传递给入参事件监听器
|
|
9662
9886
|
* @hidden
|
|
9663
9887
|
*/
|
|
9664
|
-
pipe
|
|
9888
|
+
pipe(emitter: EventDispatcher<T>, types?: Array<keyof T>): void;
|
|
9665
9889
|
}
|
|
9666
9890
|
|
|
9667
9891
|
declare class RCResult<T = void> {
|
|
@@ -9847,7 +10071,8 @@ declare class Validator {
|
|
|
9847
10071
|
isObject(key: string, value: unknown, required?: boolean): Validator;
|
|
9848
10072
|
/** Object 类型检查 */
|
|
9849
10073
|
assertObject(key: string, value: unknown, required?: boolean): Validator;
|
|
9850
|
-
|
|
10074
|
+
isStringEnum<T extends Object>(key: string, value: unknown, target: T, required?: boolean): Validator;
|
|
10075
|
+
isNumberEnum<T extends Object>(key: string, value: unknown, target: T, required?: boolean): Validator;
|
|
9851
10076
|
assertValueOf<T extends Object>(key: string, value: unknown, target: T, required?: boolean): Validator;
|
|
9852
10077
|
isFunction(key: string, value: unknown, required?: boolean): Validator;
|
|
9853
10078
|
assertFunction(key: string, value: unknown, required?: boolean): Validator;
|
|
@@ -10113,8 +10338,8 @@ interface INaviInfo {
|
|
|
10113
10338
|
grpRRVer?: number;
|
|
10114
10339
|
/**
|
|
10115
10340
|
* 会话驱动类型
|
|
10116
|
-
* 0: 默认,客户端离线消息驱动计算未读数 (客户端通过 pullMsg 结果计算)
|
|
10117
|
-
* 1: 服务端会话驱动计算未读数 (调用 pullSes 进行初始化),暂只影响更新会话已读时间接口
|
|
10341
|
+
* * 0: 默认,客户端离线消息驱动计算未读数 (客户端通过 pullMsg 结果计算)
|
|
10342
|
+
* * 1: 服务端会话驱动计算未读数 (调用 pullSes 进行初始化),暂只影响更新会话已读时间接口
|
|
10118
10343
|
*/
|
|
10119
10344
|
sesDriven?: number;
|
|
10120
10345
|
/**
|
|
@@ -10232,6 +10457,13 @@ interface INaviInfo {
|
|
|
10232
10457
|
* 2. 拉取历史消息时,不再返回 RC:RcCmd 消息。
|
|
10233
10458
|
*/
|
|
10234
10459
|
supportRecallRefactor?: 0 | 1;
|
|
10460
|
+
/**
|
|
10461
|
+
* 是否开启服务器记录单群聊会话未读数;
|
|
10462
|
+
* 0: 关闭,未读数由客户端计算,保持原有逻辑不变;
|
|
10463
|
+
* 1: 开启,未读数由服务器保存,SDK 连接后先同步服务器未读数信息,再拉离线消息。
|
|
10464
|
+
* @since 5.34.0
|
|
10465
|
+
*/
|
|
10466
|
+
serverSaveUnread?: 0 | 1;
|
|
10235
10467
|
}
|
|
10236
10468
|
|
|
10237
10469
|
/** [EN]
|
|
@@ -10923,6 +11155,15 @@ interface IPagingQueryOption {
|
|
|
10923
11155
|
order?: boolean;
|
|
10924
11156
|
}
|
|
10925
11157
|
interface IGetGroupMembersOption extends IPagingQueryOption {
|
|
11158
|
+
/** [EN]
|
|
11159
|
+
* Robot filter rule
|
|
11160
|
+
* @since 5.32.0
|
|
11161
|
+
*/
|
|
11162
|
+
/**
|
|
11163
|
+
* 机器人过滤规则
|
|
11164
|
+
* @since 5.32.0
|
|
11165
|
+
*/
|
|
11166
|
+
filterRobotType?: FilterRobotType;
|
|
10926
11167
|
}
|
|
10927
11168
|
/** [EN]
|
|
10928
11169
|
* Pagination request result
|
|
@@ -11203,6 +11444,15 @@ interface IGroupMemberInfo {
|
|
|
11203
11444
|
* 入群时间:时间戳,精确到毫秒
|
|
11204
11445
|
*/
|
|
11205
11446
|
joinedTime?: number;
|
|
11447
|
+
/** [EN]
|
|
11448
|
+
* Whether the group member is a robot
|
|
11449
|
+
* @since 5.32.0
|
|
11450
|
+
*/
|
|
11451
|
+
/**
|
|
11452
|
+
* 标识成员是否为机器人
|
|
11453
|
+
* @since 5.32.0
|
|
11454
|
+
*/
|
|
11455
|
+
isRobot?: boolean;
|
|
11206
11456
|
}
|
|
11207
11457
|
/** [EN]
|
|
11208
11458
|
* Special attention information
|
|
@@ -11784,7 +12034,7 @@ declare type IGetConversationListByTimestampParams = {
|
|
|
11784
12034
|
* Get Conversation Types; the value is empty or the length is 0 to get all conversation types
|
|
11785
12035
|
*/
|
|
11786
12036
|
/**
|
|
11787
|
-
* 会话类型,值为空或长度为 0
|
|
12037
|
+
* 会话类型,值为空或长度为 0 时,获取全部会话类型
|
|
11788
12038
|
*/
|
|
11789
12039
|
conversationTypes?: ConversationType[];
|
|
11790
12040
|
};
|
|
@@ -11998,6 +12248,10 @@ interface IIPCMethods {
|
|
|
11998
12248
|
* 连接时间
|
|
11999
12249
|
*/
|
|
12000
12250
|
getConnectedTime(): number;
|
|
12251
|
+
/**
|
|
12252
|
+
* 忽视缓存,重新请求导航数据
|
|
12253
|
+
*/
|
|
12254
|
+
refetchNaviInfo(): Promise<RCResult<INaviInfo | null>>;
|
|
12001
12255
|
/**
|
|
12002
12256
|
* 获取历史消息
|
|
12003
12257
|
*/
|
|
@@ -12150,7 +12404,7 @@ interface IIPCMethods {
|
|
|
12150
12404
|
/**
|
|
12151
12405
|
* 退出聊天室
|
|
12152
12406
|
*/
|
|
12153
|
-
quitChatroom(chatroomId: string): Promise<RCResult>;
|
|
12407
|
+
quitChatroom(chatroomId: string, extra?: string): Promise<RCResult>;
|
|
12154
12408
|
/**
|
|
12155
12409
|
* 获取聊天室信息
|
|
12156
12410
|
* @param count 获取人数,范围 0 - 20
|
|
@@ -12307,12 +12561,6 @@ interface IIPCMethods {
|
|
|
12307
12561
|
* 获取当前 userId
|
|
12308
12562
|
*/
|
|
12309
12563
|
getCurrentUserId(): string;
|
|
12310
|
-
/**
|
|
12311
|
-
* 设置用户在线状态监听器
|
|
12312
|
-
*/
|
|
12313
|
-
setUserStatusListener(config: {
|
|
12314
|
-
userIds: string[];
|
|
12315
|
-
}, listener: Function): void;
|
|
12316
12564
|
/**
|
|
12317
12565
|
* 设置当前用户在线状态
|
|
12318
12566
|
*/
|
|
@@ -12421,6 +12669,10 @@ interface IIPCMethods {
|
|
|
12421
12669
|
* 删除时间戳前的未读数
|
|
12422
12670
|
*/
|
|
12423
12671
|
clearUnreadCountByTimestamp(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
12672
|
+
/**
|
|
12673
|
+
* 标记远程会话为已读,发送 SRSMsg 消息到服务器,并在发送成功后清理本地未读数信息
|
|
12674
|
+
*/
|
|
12675
|
+
markRemoteConversationAsRead(identifier: IConversationIdentifier, sendOpts: IMessageSendOptions, traceId: string): Promise<RCResult>;
|
|
12424
12676
|
/**
|
|
12425
12677
|
* 获取所有群聊会话 @ 消息未读数,不包含超级群会话
|
|
12426
12678
|
*/
|
|
@@ -12748,18 +13000,21 @@ interface IIPCMethods {
|
|
|
12748
13000
|
* @param enableCheck 是否开启融云消息重排开关
|
|
12749
13001
|
*/
|
|
12750
13002
|
setCheckDuplicateMessage(enableCheck: boolean): Promise<RCResult<boolean>>;
|
|
13003
|
+
getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
13004
|
+
getConversationsIncludingRobots(options: Required<IGetConversationsIncludingRobotsOption>): Promise<RCResult<IReceivedConversation[]>>;
|
|
12751
13005
|
}
|
|
12752
13006
|
|
|
12753
13007
|
/**
|
|
12754
13008
|
* 连接事件监听器
|
|
12755
|
-
* @typeParam T - onConnected 是否包含 fromSuspend 参数
|
|
12756
13009
|
*/
|
|
12757
|
-
declare type IConnectionListener
|
|
13010
|
+
declare type IConnectionListener = {
|
|
12758
13011
|
/**
|
|
12759
13012
|
* 连接成功
|
|
12760
13013
|
* @description 仅 Electron 平台会返回 processCache 参数,用于同步主进程缓存数据
|
|
13014
|
+
* @param fromSuspend 是否从暂停状态连接
|
|
13015
|
+
* @param processCache 主进程缓存数据,仅 Electron 平台有效
|
|
12761
13016
|
*/
|
|
12762
|
-
onConnected
|
|
13017
|
+
onConnected(fromSuspend: boolean, processCache?: IProcessCache): void;
|
|
12763
13018
|
/**
|
|
12764
13019
|
* 连接中止,SDK 内部会进行重连
|
|
12765
13020
|
* @param code 中止原因
|
|
@@ -13032,7 +13287,7 @@ interface IUserGroupStatusInfo {
|
|
|
13032
13287
|
userGroupUnBindChannel?: IChannelAndUserGroupChangeData[];
|
|
13033
13288
|
}
|
|
13034
13289
|
|
|
13035
|
-
interface IEngineWatcher extends IConnectionListener
|
|
13290
|
+
interface IEngineWatcher extends IConnectionListener {
|
|
13036
13291
|
/**
|
|
13037
13292
|
* @param message 消息
|
|
13038
13293
|
* @param leftCount 参数废弃,值始终为 undefined
|
|
@@ -13120,6 +13375,75 @@ interface IEngineWatcher extends IConnectionListener<false> {
|
|
|
13120
13375
|
* 消息编辑同步完成(目前只有单、群聊编辑同步事件,超级群不需要同步)
|
|
13121
13376
|
*/
|
|
13122
13377
|
messageModifiedSyncCompleted: () => void;
|
|
13378
|
+
/**
|
|
13379
|
+
* 机器人列表同步完成
|
|
13380
|
+
* @since 5.30.0
|
|
13381
|
+
* @param code 同步结果
|
|
13382
|
+
* @param updatedRobots 发生变更的机器人列表,如名称变更、或为新增机器人,不包含被删除的机器人数据
|
|
13383
|
+
*/
|
|
13384
|
+
robotsSynced: (code: number, updatedRobots: IRobotInfo[]) => void;
|
|
13385
|
+
}
|
|
13386
|
+
|
|
13387
|
+
/**
|
|
13388
|
+
* Robot information
|
|
13389
|
+
* @category Interface
|
|
13390
|
+
* @since 5.32.0
|
|
13391
|
+
*/
|
|
13392
|
+
/**
|
|
13393
|
+
* 机器人信息
|
|
13394
|
+
* @category Interface
|
|
13395
|
+
* @since 5.32.0
|
|
13396
|
+
*/
|
|
13397
|
+
interface IRobotInfo {
|
|
13398
|
+
/** [EN]
|
|
13399
|
+
* Robot ID
|
|
13400
|
+
*/
|
|
13401
|
+
/**
|
|
13402
|
+
* 机器人 ID
|
|
13403
|
+
*/
|
|
13404
|
+
robotId: string;
|
|
13405
|
+
/** [EN]
|
|
13406
|
+
* Robot name
|
|
13407
|
+
*/
|
|
13408
|
+
/**
|
|
13409
|
+
* 机器人名称
|
|
13410
|
+
*/
|
|
13411
|
+
name: string;
|
|
13412
|
+
/** [EN]
|
|
13413
|
+
* Robot portrait URL
|
|
13414
|
+
*/
|
|
13415
|
+
/**
|
|
13416
|
+
* 机器人头像 URL
|
|
13417
|
+
*/
|
|
13418
|
+
portraitUri: string;
|
|
13419
|
+
/** [EN]
|
|
13420
|
+
* Robot type
|
|
13421
|
+
*/
|
|
13422
|
+
/**
|
|
13423
|
+
* 机器人类型
|
|
13424
|
+
*/
|
|
13425
|
+
robotType: string;
|
|
13426
|
+
/** [EN]
|
|
13427
|
+
* Robot metadata
|
|
13428
|
+
*/
|
|
13429
|
+
/**
|
|
13430
|
+
* 机器人 metadata
|
|
13431
|
+
*/
|
|
13432
|
+
metadata: Record<string, string>;
|
|
13433
|
+
/** [EN]
|
|
13434
|
+
* Robot create time
|
|
13435
|
+
*/
|
|
13436
|
+
/**
|
|
13437
|
+
* 机器人创建时间
|
|
13438
|
+
*/
|
|
13439
|
+
createTime: number;
|
|
13440
|
+
/** [EN]
|
|
13441
|
+
* Robot update time
|
|
13442
|
+
*/
|
|
13443
|
+
/**
|
|
13444
|
+
* 机器人更新时间
|
|
13445
|
+
*/
|
|
13446
|
+
updateTime: number;
|
|
13123
13447
|
}
|
|
13124
13448
|
|
|
13125
13449
|
declare type IErrorKeys = {
|
|
@@ -13349,12 +13673,12 @@ declare abstract class BasicLogger {
|
|
|
13349
13673
|
protected readonly _appkey: string;
|
|
13350
13674
|
protected readonly _id: string;
|
|
13351
13675
|
protected readonly _type: LogType;
|
|
13352
|
-
protected readonly
|
|
13676
|
+
protected readonly proxy: LogDBProxy;
|
|
13353
13677
|
/**
|
|
13354
13678
|
* traceId 计数
|
|
13355
13679
|
*/
|
|
13356
13680
|
private static _traceIdCount;
|
|
13357
|
-
constructor(_appkey: string, _id: string, _type: LogType,
|
|
13681
|
+
constructor(_appkey: string, _id: string, _type: LogType, proxy: LogDBProxy);
|
|
13358
13682
|
protected _write(logData: ILogData): void;
|
|
13359
13683
|
/**
|
|
13360
13684
|
* 生成事务追踪 ID,全局唯一,便于跨进程、异步事务追踪,需要考虑多进程
|
|
@@ -13463,7 +13787,14 @@ declare enum AreaCode {
|
|
|
13463
13787
|
/**
|
|
13464
13788
|
* 沙特数据中心
|
|
13465
13789
|
*/
|
|
13466
|
-
SA = 5
|
|
13790
|
+
SA = 5,
|
|
13791
|
+
/** [EN]
|
|
13792
|
+
* Oman data center
|
|
13793
|
+
*/
|
|
13794
|
+
/**
|
|
13795
|
+
* 阿曼数据中心
|
|
13796
|
+
*/
|
|
13797
|
+
OM = 6
|
|
13467
13798
|
}
|
|
13468
13799
|
|
|
13469
13800
|
interface ISSERequestOpts {
|
|
@@ -14068,6 +14399,12 @@ declare class PluginContext {
|
|
|
14068
14399
|
* @deprecated
|
|
14069
14400
|
*/
|
|
14070
14401
|
sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): Promise<RCResult<IReceivedMessage>>;
|
|
14402
|
+
/**
|
|
14403
|
+
* 发送消息
|
|
14404
|
+
* @param identifier 会话标识
|
|
14405
|
+
* @param options 消息发送配置
|
|
14406
|
+
* @returns 发送结果
|
|
14407
|
+
*/
|
|
14071
14408
|
sendMessageTo(identifier: IConversationIdentifier, options: IMessageSendOptions): Promise<RCResult<IReceivedMessage>>;
|
|
14072
14409
|
/**
|
|
14073
14410
|
* 消息注册
|
|
@@ -14178,6 +14515,13 @@ interface IWatcher {
|
|
|
14178
14515
|
* 会话状态数据同步完成
|
|
14179
14516
|
*/
|
|
14180
14517
|
conversationStatusSynced?: (code: number) => void;
|
|
14518
|
+
/**
|
|
14519
|
+
* 机器人列表同步完成
|
|
14520
|
+
* @since 5.30.0
|
|
14521
|
+
* @param code 同步结果
|
|
14522
|
+
* @param updatedRobots 发生变更的机器人列表,如名称变更、或为新增机器人,不包含被删除的机器人数据
|
|
14523
|
+
*/
|
|
14524
|
+
robotsSynced?: (code: number, updatedRobots: IRobotInfo[]) => void;
|
|
14181
14525
|
/**
|
|
14182
14526
|
* 会话中标签状态变更监听
|
|
14183
14527
|
*/
|
|
@@ -14399,22 +14743,35 @@ interface IModuleContext extends Pick<IIPCMethods, 'sendMessage'> {
|
|
|
14399
14743
|
}
|
|
14400
14744
|
|
|
14401
14745
|
declare class BaseModule {
|
|
14402
|
-
protected readonly ctx: IModuleContext;
|
|
14403
14746
|
/**
|
|
14404
14747
|
* 日志工具
|
|
14748
|
+
* @hidden
|
|
14405
14749
|
*/
|
|
14406
14750
|
protected readonly logger: BasicLogger;
|
|
14751
|
+
/**
|
|
14752
|
+
* 目前为 engine 实例
|
|
14753
|
+
* @hidden
|
|
14754
|
+
*/
|
|
14755
|
+
protected readonly ctx: IModuleContext;
|
|
14756
|
+
/**
|
|
14757
|
+
* @hidden
|
|
14758
|
+
*/
|
|
14407
14759
|
constructor(ctx: IModuleContext);
|
|
14408
|
-
/**
|
|
14760
|
+
/**
|
|
14761
|
+
* 高阶函数,生成一个验证方法,验证是否处于连接中状态,并在连接状态可用时返回导航数据
|
|
14762
|
+
* @hidden
|
|
14763
|
+
*/
|
|
14409
14764
|
protected get validateConnected(): () => RCResult<INaviInfo>;
|
|
14410
14765
|
/**
|
|
14411
14766
|
* 高阶函数,生成一个验证方法,验证是否处于登录状态
|
|
14412
14767
|
* * 本地数据查询时,只需要验证用户已经登录过且未主动断开,无需校验当前连接状态
|
|
14768
|
+
* @hidden
|
|
14413
14769
|
*/
|
|
14414
14770
|
protected get validateLogin(): () => RCResult<INaviInfo>;
|
|
14415
14771
|
/**
|
|
14416
14772
|
* 检查是否已登录
|
|
14417
14773
|
* @param allowSuspended 是否允许已登录但连接状态为中断状态;Electron 平台一些接口为本地数据查询,允许连接状态为中断状态
|
|
14774
|
+
* @hidden
|
|
14418
14775
|
* @returns
|
|
14419
14776
|
*/
|
|
14420
14777
|
protected checkAuthed(allowSuspended: boolean): RCResult<INaviInfo>;
|
|
@@ -14442,7 +14799,7 @@ declare class ChatroomModule extends BaseModule {
|
|
|
14442
14799
|
* 退出聊天室
|
|
14443
14800
|
* @param roomId
|
|
14444
14801
|
*/
|
|
14445
|
-
quitChatroom(roomId: string): Promise<RCResult>;
|
|
14802
|
+
quitChatroom(roomId: string, extra?: string): Promise<RCResult>;
|
|
14446
14803
|
/**
|
|
14447
14804
|
* 获取聊天室房间数据
|
|
14448
14805
|
* @description count 或 order 有一个为 0 时,只返回成员总数,不返回成员列表信息
|
|
@@ -14572,18 +14929,68 @@ declare class DataHosting extends BaseModule {
|
|
|
14572
14929
|
/**
|
|
14573
14930
|
* 会话聊天模块
|
|
14574
14931
|
*/
|
|
14575
|
-
interface IChatService extends Pick<IIPCMethods, 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllSGUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5ByIdentifiers' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent' | 'requestSpeechToTextForMessage' | 'setMessageSpeechToTextVisible' | 'addTagForConversations' | 'getTagsForConversation' | 'setConversationStatusInTag' | 'removeTagForConversations' | 'removeTagsForConversation' | 'getConversationListByTag' | 'getUnreadCountByTag' | 'getUntaggedConversationListByPage' | 'batchSetConversationTranslateStrategy' | 'modifyMessageWithParams' | 'refreshReferenceMessageWithParams' | 'batchDeleteConversations' | 'sendReadReceiptV2' | 'syncRemoteConversations' | 'sendUltraGroupTypingStatus' | 'getUltraGroupList' | 'getRemoteMessagesByUIds' | 'getUGUnreadMentionedDigest' | 'getHistoryMessagesByObjectNames' | 'getContinuousMessages' | 'getMessagesAroundTimestamp' | 'deleteLocalUGMessagesForAllChannel' | 'updateUGMessageExpansion' | 'setUGDefaultNotificationLevel' | 'getUGDefaultNotificationLevel' | 'getUnreadMentionedMessages' | 'getUnreadMentionedCount' | 'getAllUnreadMentionedCount' | 'getTotalUnreadCountByLevels' | 'getConversationUnreadCount' | 'getFirstUnreadMessage' | 'getFirstUnreadMessageDigest' | 'getUGUnreadCountForAllChannels' | 'getUGUnreadInfoList' | 'getUGFirstUnreadMessageDigest' | 'getConversations' | 'clearConversationUnreadCount' | 'getTopConversationList' | 'getUnreadConversationList' | 'getConversationListByPageIndex' | 'getAllConversationList' | 'getConversationListByTimestamp' | 'clearConversations' | 'getBlockedConversationList' | 'getBlockedUGList' | 'saveEditedMessageDraft' | 'getEditedMessageDraft' | 'clearEditedMessageDraft' | 'getUnreadMentionMeConversationList' | 'sendUltraGroupTypingStatus' | 'updateConversationReadTime' | 'clearUnreadCountByTimestamp' | 'getMessageReader' | 'getMessageReadReceiptV4' | 'sendReadReceiptMessageV4'> {
|
|
14932
|
+
interface IChatService extends Pick<IIPCMethods, 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllSGUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5ByIdentifiers' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent' | 'requestSpeechToTextForMessage' | 'setMessageSpeechToTextVisible' | 'addTagForConversations' | 'getTagsForConversation' | 'setConversationStatusInTag' | 'removeTagForConversations' | 'removeTagsForConversation' | 'getConversationListByTag' | 'getUnreadCountByTag' | 'getUntaggedConversationListByPage' | 'batchSetConversationTranslateStrategy' | 'modifyMessageWithParams' | 'refreshReferenceMessageWithParams' | 'batchDeleteConversations' | 'sendReadReceiptV2' | 'syncRemoteConversations' | 'sendUltraGroupTypingStatus' | 'getUltraGroupList' | 'getRemoteMessagesByUIds' | 'getUGUnreadMentionedDigest' | 'getHistoryMessagesByObjectNames' | 'getContinuousMessages' | 'getMessagesAroundTimestamp' | 'deleteLocalUGMessagesForAllChannel' | 'updateUGMessageExpansion' | 'setUGDefaultNotificationLevel' | 'getUGDefaultNotificationLevel' | 'getUnreadMentionedMessages' | 'getUnreadMentionedCount' | 'getAllUnreadMentionedCount' | 'getTotalUnreadCountByLevels' | 'getConversationUnreadCount' | 'getFirstUnreadMessage' | 'getFirstUnreadMessageDigest' | 'getUGUnreadCountForAllChannels' | 'getUGUnreadInfoList' | 'getUGFirstUnreadMessageDigest' | 'getConversations' | 'clearConversationUnreadCount' | 'markRemoteConversationAsRead' | 'getTopConversationList' | 'getUnreadConversationList' | 'getConversationListByPageIndex' | 'getAllConversationList' | 'getConversationListByTimestamp' | 'clearConversations' | 'getBlockedConversationList' | 'getBlockedUGList' | 'saveEditedMessageDraft' | 'getEditedMessageDraft' | 'clearEditedMessageDraft' | 'getUnreadMentionMeConversationList' | 'sendUltraGroupTypingStatus' | 'updateConversationReadTime' | 'clearUnreadCountByTimestamp' | 'getMessageReader' | 'getMessageReadReceiptV4' | 'sendReadReceiptMessageV4' | 'getConversationsIncludingRobots'> {
|
|
14933
|
+
/** 超级群是否已同步完成 */
|
|
14934
|
+
get ugSynced(): boolean;
|
|
14576
14935
|
getRealtimeConversations(count: number, startTime: number, order: 0 | 1): Promise<RCResult<IReceivedConversation[]>>;
|
|
14577
14936
|
getRealtimeConTotalUnreadCount(): Promise<RCResult<number>>;
|
|
14578
14937
|
clearRealtimeConUnreadCount(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14579
14938
|
removeRealtimeConversations(identifiers: IConversationIdentifier[]): Promise<RCResult>;
|
|
14580
14939
|
batchGetRealtimeConUnreadCount(identifiers: IConversationIdentifier[]): Promise<RCResult<IConversationUnreadCount[]>>;
|
|
14940
|
+
/**
|
|
14941
|
+
* 分页加载会话列表
|
|
14942
|
+
* @param pageToken 分页 token
|
|
14943
|
+
* @param count 分页数量
|
|
14944
|
+
* @param options 会话列表加载器选项,仅 pageToken 无值时有效
|
|
14945
|
+
*/
|
|
14946
|
+
loadConversationList(pageToken: string, count: number, options: IConversationListLoaderOptions): Promise<RCResult<{
|
|
14947
|
+
pageToken: string;
|
|
14948
|
+
finished: boolean;
|
|
14949
|
+
list: IReceivedConversation[];
|
|
14950
|
+
}>>;
|
|
14581
14951
|
/**
|
|
14582
14952
|
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
14583
14953
|
*/
|
|
14584
14954
|
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
14585
14955
|
}
|
|
14586
14956
|
|
|
14957
|
+
/**
|
|
14958
|
+
* 会话列表加载器,暂不支持用于获取超级群会话列表,不支持 Electron 平台
|
|
14959
|
+
* @since 5.32.0
|
|
14960
|
+
*/
|
|
14961
|
+
declare class ConversationListLoader extends BaseModule {
|
|
14962
|
+
#private;
|
|
14963
|
+
/**
|
|
14964
|
+
* @hidden
|
|
14965
|
+
*/
|
|
14966
|
+
private readonly _svr;
|
|
14967
|
+
/**
|
|
14968
|
+
* @hidden
|
|
14969
|
+
*/
|
|
14970
|
+
private _id;
|
|
14971
|
+
/**
|
|
14972
|
+
* @hidden
|
|
14973
|
+
*/
|
|
14974
|
+
constructor(options: IConversationListLoaderOptions,
|
|
14975
|
+
/**
|
|
14976
|
+
* @hidden
|
|
14977
|
+
*/
|
|
14978
|
+
_svr: IChatService, ctx: IModuleContext);
|
|
14979
|
+
/**
|
|
14980
|
+
* 是否还有更多会话
|
|
14981
|
+
*/
|
|
14982
|
+
get hasMore(): boolean;
|
|
14983
|
+
/**
|
|
14984
|
+
* 是否正在加载会话列表
|
|
14985
|
+
*/
|
|
14986
|
+
get isLoading(): boolean;
|
|
14987
|
+
/**
|
|
14988
|
+
* 加载会话列表
|
|
14989
|
+
* @param count 获取数量,有效值 [1, 100]
|
|
14990
|
+
*/
|
|
14991
|
+
load(count: number): Promise<RCResult<IReceivedConversation[]>>;
|
|
14992
|
+
}
|
|
14993
|
+
|
|
14587
14994
|
declare class ChatModule extends BaseModule {
|
|
14588
14995
|
#private;
|
|
14589
14996
|
private readonly svr;
|
|
@@ -14591,6 +14998,7 @@ declare class ChatModule extends BaseModule {
|
|
|
14591
14998
|
saveEditedMessageDraft(draft: IEditedMessageDraft, identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14592
14999
|
getEditedMessageDraft(identifier: IConversationIdentifier): Promise<RCResult<IEditedMessageDraft | null>>;
|
|
14593
15000
|
clearEditedMessageDraft(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
15001
|
+
createConversationListLoader(options?: IConversationListLoaderOptions): Promise<RCResult<ConversationListLoader>>;
|
|
14594
15002
|
/**
|
|
14595
15003
|
* 超级群正在输入中
|
|
14596
15004
|
* @param identifier 会话标识
|
|
@@ -14608,6 +15016,14 @@ declare class ChatModule extends BaseModule {
|
|
|
14608
15016
|
* @param timestamp 同步时间戳
|
|
14609
15017
|
*/
|
|
14610
15018
|
sendSyncReadStatusMessage(identifier: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
15019
|
+
/**
|
|
15020
|
+
* 清除会话消息未读数
|
|
15021
|
+
*/
|
|
15022
|
+
clearUnreadCount(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
15023
|
+
/**
|
|
15024
|
+
* 清除全部会话消息未读数,不包含超级群会话
|
|
15025
|
+
*/
|
|
15026
|
+
clearAllUnreadCount(): Promise<RCResult>;
|
|
14611
15027
|
clearUnreadCountByTimestamp(identifier: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
14612
15028
|
/**
|
|
14613
15029
|
* 发送群已读回执请求(v1 版本)
|
|
@@ -14645,6 +15061,8 @@ declare class ChatModule extends BaseModule {
|
|
|
14645
15061
|
*/
|
|
14646
15062
|
getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUId: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
|
|
14647
15063
|
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
15064
|
+
getConversationsIncludingRobots(options: IGetConversationsIncludingRobotsOption): Promise<RCResult<IReceivedConversation[]>>;
|
|
15065
|
+
markRemoteConversationAsRead(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14648
15066
|
}
|
|
14649
15067
|
|
|
14650
15068
|
declare class APIContext {
|
|
@@ -14683,10 +15101,6 @@ declare class APIContext {
|
|
|
14683
15101
|
* engine 内部日志工具
|
|
14684
15102
|
*/
|
|
14685
15103
|
readonly logger: BasicLogger;
|
|
14686
|
-
/**
|
|
14687
|
-
* 超级群同步完成记录
|
|
14688
|
-
*/
|
|
14689
|
-
private _ugSynced;
|
|
14690
15104
|
constructor(options: IAPIContextOption);
|
|
14691
15105
|
/**
|
|
14692
15106
|
* 安装使用插件,并初始化插件实例
|
|
@@ -14735,6 +15149,7 @@ declare class APIContext {
|
|
|
14735
15149
|
private _onUserSettingsSynced;
|
|
14736
15150
|
private _onUserSettingsChanged;
|
|
14737
15151
|
private _onConversationStatusSynced;
|
|
15152
|
+
private _onRobotsSynced;
|
|
14738
15153
|
/**
|
|
14739
15154
|
* 会话标签状态监听
|
|
14740
15155
|
*/
|
|
@@ -14879,7 +15294,7 @@ declare class APIContext {
|
|
|
14879
15294
|
* @param traceId 追踪 ID
|
|
14880
15295
|
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
14881
15296
|
*/
|
|
14882
|
-
|
|
15297
|
+
sendMessageByPlugin(identifier: IConversationIdentifier, options: IMessageSendOptions, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
14883
15298
|
/**
|
|
14884
15299
|
* 发送消息
|
|
14885
15300
|
* @param identifier 会话标识
|
|
@@ -14989,14 +15404,6 @@ declare class APIContext {
|
|
|
14989
15404
|
* 获取超级群免打扰列表
|
|
14990
15405
|
*/
|
|
14991
15406
|
getBlockedUGList(): Promise<RCResult<IReceivedConversation[]>>;
|
|
14992
|
-
/**
|
|
14993
|
-
* 清除会话消息未读数
|
|
14994
|
-
*/
|
|
14995
|
-
clearUnreadCount(conversation: IConversationOption): Promise<RCResult>;
|
|
14996
|
-
/**
|
|
14997
|
-
* 清除全部会话消息未读数,不包含超级群会话
|
|
14998
|
-
*/
|
|
14999
|
-
clearAllUnreadCount(): Promise<RCResult>;
|
|
15000
15407
|
/**
|
|
15001
15408
|
* 获取指定会话消息未读数
|
|
15002
15409
|
*/
|
|
@@ -15212,12 +15619,6 @@ declare class APIContext {
|
|
|
15212
15619
|
* 删除所有会话,目前仅 v2 提供
|
|
15213
15620
|
*/
|
|
15214
15621
|
clearConversations(conversationTypes?: ConversationType[], tag?: string): Promise<RCResult>;
|
|
15215
|
-
/**
|
|
15216
|
-
* 设置用户连接状态监听器
|
|
15217
|
-
*/
|
|
15218
|
-
setUserStatusListener(config: {
|
|
15219
|
-
userIds: string[];
|
|
15220
|
-
}, listener: Function): void;
|
|
15221
15622
|
/**
|
|
15222
15623
|
* 添加用户黑名单
|
|
15223
15624
|
*/
|
|
@@ -15416,6 +15817,8 @@ declare class APIContext {
|
|
|
15416
15817
|
*/
|
|
15417
15818
|
deleteLocalUGMessagesForAllChannel(targetId: string, timestamp: number): Promise<RCResult>;
|
|
15418
15819
|
getUnreadMentionMeConversationList(params: IGetUnreadMentionMeConversationListParams): Promise<RCResult<IReceivedConversation[]>>;
|
|
15820
|
+
getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
15821
|
+
getRobotById(id: string): Promise<RCResult<IRobotInfo | null>>;
|
|
15419
15822
|
}
|
|
15420
15823
|
|
|
15421
15824
|
declare class RTCPluginContext extends PluginContext {
|
|
@@ -15614,11 +16017,10 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
15614
16017
|
*/
|
|
15615
16018
|
declare type IUserSettingsModule = Pick<IIPCMethods, 'setTranslationLanguage' | 'getTranslationLanguage' | 'setAutoTranslateEnabled' | 'getAutoTranslateEnabled'>;
|
|
15616
16019
|
|
|
15617
|
-
declare type IIPCMethodsInEngine = Pick<IIPCMethods, 'searchMessagesWithParams' | 'createTag' | 'removeTag' | 'updateTag' | 'getTagList' | 'translateWithParams' | 'getFileUrl' | 'saveTextMessageDraft' | 'getTextMessageDraft' | 'clearTextMessageDraft' | 'getHistoryMessage' | 'clearLocalMessages' | 'deleteLocalMessages' | 'deleteLocalMessagesByTimestamp' | 'batchClearLocalMessagesByTimestamp' | 'insertMessage' | 'batchInsertMessage' | 'setMessageContent' | 'getLocalMessageCount' | 'recallMsg' | 'getSubscribeUsersOnlineStatus' | 'getSubscribeUserStatus' | 'subscribeUser' | 'unSubscribeUser' | 'getSubscribeUserList' | 'getUserProfiles' | 'getMyUserProfile' | 'updateMyUserProfile' | 'sendMessage' | 'connect' | 'disconnect' | 'addToBlacklist' | 'removeFromBlacklist' | 'getBlacklist' | 'getBlacklistStatus' | 'setMessageReceivedStatus' | 'setMessageSentStatus' | 'setCheckDuplicateMessage' | 'setProxy' | 'getProxy' | 'testProxy' | '
|
|
16020
|
+
declare type IIPCMethodsInEngine = Pick<IIPCMethods, 'searchMessagesWithParams' | 'createTag' | 'removeTag' | 'updateTag' | 'getTagList' | 'translateWithParams' | 'getFileUrl' | 'saveTextMessageDraft' | 'getTextMessageDraft' | 'clearTextMessageDraft' | 'getHistoryMessage' | 'clearLocalMessages' | 'deleteLocalMessages' | 'deleteLocalMessagesByTimestamp' | 'batchClearLocalMessagesByTimestamp' | 'insertMessage' | 'batchInsertMessage' | 'setMessageContent' | 'getLocalMessageCount' | 'recallMsg' | 'getSubscribeUsersOnlineStatus' | 'getSubscribeUserStatus' | 'subscribeUser' | 'unSubscribeUser' | 'getSubscribeUserList' | 'getUserProfiles' | 'getMyUserProfile' | 'updateMyUserProfile' | 'sendMessage' | 'refetchNaviInfo' | 'connect' | 'disconnect' | 'addToBlacklist' | 'removeFromBlacklist' | 'getBlacklist' | 'getBlacklistStatus' | 'setMessageReceivedStatus' | 'setMessageSentStatus' | 'setCheckDuplicateMessage' | 'setProxy' | 'getProxy' | 'testProxy' | 'getFileToken' | 'rtcSignaling' | 'rtcPing' | 'setCallInfo' | 'getUserStatus' | 'searchConversationByContentWithAllChannel' | 'getAllRobots'>;
|
|
15618
16021
|
declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContext {
|
|
15619
16022
|
protected readonly _watcher: IEngineWatcher;
|
|
15620
16023
|
protected readonly _options: IAPIContextOption;
|
|
15621
|
-
private readonly _logger;
|
|
15622
16024
|
/**
|
|
15623
16025
|
* 连接时间
|
|
15624
16026
|
*/
|
|
@@ -15639,7 +16041,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15639
16041
|
get initOption(): IAPIContextOption;
|
|
15640
16042
|
abstract get connectionStatus(): RCConnectionStatus;
|
|
15641
16043
|
abstract get userId(): string;
|
|
15642
|
-
get logger(): BasicLogger;
|
|
16044
|
+
abstract get logger(): BasicLogger;
|
|
15643
16045
|
abstract get usingCppEngine(): boolean;
|
|
15644
16046
|
/**
|
|
15645
16047
|
* 用户信息托管模块
|
|
@@ -15649,17 +16051,14 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15649
16051
|
* 引擎初始化
|
|
15650
16052
|
* @param _appkey
|
|
15651
16053
|
*/
|
|
15652
|
-
constructor(_watcher: IEngineWatcher, _options: IAPIContextOption
|
|
16054
|
+
constructor(_watcher: IEngineWatcher, _options: IAPIContextOption);
|
|
15653
16055
|
protected _rtcSignalingListener?: (buffer: Uint8Array) => void;
|
|
15654
16056
|
/**
|
|
15655
16057
|
* 注册 RTC KV 变更监听器
|
|
15656
16058
|
* @param listener
|
|
15657
16059
|
*/
|
|
15658
16060
|
registerRTCSignalingListener(listener: ((buffer: Uint8Array) => void) | undefined): void;
|
|
15659
|
-
|
|
15660
|
-
* 忽视缓存,重新请求导航数据
|
|
15661
|
-
*/
|
|
15662
|
-
abstract refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
|
|
16061
|
+
abstract refetchNaviInfo(): Promise<RCResult<INaviInfo | null>>;
|
|
15663
16062
|
/**
|
|
15664
16063
|
* 为非 engine 包创建 logger 工具实例
|
|
15665
16064
|
*/
|
|
@@ -15763,12 +16162,6 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15763
16162
|
* @param options
|
|
15764
16163
|
*/
|
|
15765
16164
|
abstract sendUltraMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onSendBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
15766
|
-
/**
|
|
15767
|
-
* 设置用户在线状态监听器
|
|
15768
|
-
*/
|
|
15769
|
-
abstract setUserStatusListener(config: {
|
|
15770
|
-
userIds: string[];
|
|
15771
|
-
}, listener: Function): void;
|
|
15772
16165
|
/**
|
|
15773
16166
|
* 设置当前用户在线状态
|
|
15774
16167
|
*/
|
|
@@ -15939,6 +16332,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15939
16332
|
abstract translateWithParams(list: InnerTransParam[], mode: TranslateMode, force: boolean, from: 0 | 1): Promise<RCResult>;
|
|
15940
16333
|
abstract getLocalMessageCount(conversation: IConversationOption): Promise<RCResult<number>>;
|
|
15941
16334
|
abstract getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCResult<ISubscribeUserOnlineStatus[]>>;
|
|
16335
|
+
abstract getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
15942
16336
|
}
|
|
15943
16337
|
|
|
15944
16338
|
/**
|
|
@@ -16095,4 +16489,4 @@ declare class AppStorage {
|
|
|
16095
16489
|
}): void;
|
|
16096
16490
|
}
|
|
16097
16491
|
|
|
16098
|
-
export { APIContext, AbsCodec, AppSettings, AppStorage, AreaCode, AssertRules, BasicEngine, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationBatchDeletionParams, ConversationType, DataHosting, DirectionType, EnableLogL, ErrorCode, EventEmitter, FileType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupOperationRole, GroupOperationStatus, GroupOperationType, GroupReadReceiptVersion, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAppPushConfig, IAsyncRes, IAuditInfoKeyInMessage, IAuditInfoValueInMessage, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatService, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomErrorKeys, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomService, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineMessageContent, ICombineV2MessageContent, ICombinedMessage, ICommandMessageContent, IConnectionStatusListener, IConversationFilter, IConversationIdentifier, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IConversationUnreadCount, IConvertHQVoiceMessageToTextOption, IConvertSpeechToTextOption, IConvertVoiceMessageToTextOption, ICreateGroupFail, IDataHostingService, IDeletedExpansion, IDownloadAuth, IEditedMessageDraft, IEnginRefreshReferenceMessageResult, IEngineWatcher, IErrorKeys, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraDataKeyInMessage, IFileMessageContent, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGIFMessageContent, IGetConversationListByTimestampParams, IGetGroupMembersOption, IGetHistoryMessageOption, IGetHistoryMessageResult, IGetHistoryMessagesByTypesOption, IGetUltraGroupListOption, IGetUnreadMentionMeConversationListParams, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupNotificationMessageContent, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHQVoiceMessageContent, IHarmonyOSPushConfig, IIPCMethods, IImageMessageContent, IInformationNotificationMessageContent, IInsertMessage, ILocalTagStatus, ILocationMessageContent, ILogData, ILogger, IMemberInviteResponse, IMentionedInfoKeyInMessage, IMessageAttrsForUpdateExpansion, IMessageDesc, IMessageFilter, IMessageIdentifier, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMessageSendOptions, IModifyMessageParams, INaviInfo, INetwork, INotificationQuietHoursSetting, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPlatformOnlineStatus, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessCode, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallCommandMessageContent, IRecallMsgOptions, IRecallNotificationMessageContent, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRefreshReferenceMessageParams, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRichContentMessageContent, IRuntime, ISearchMessageParams, ISearchMessagesResult, ISendMsgOptions, IServerGroupBaseInfo, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStorage, IStreamMessageContent, IStreamMessageResponseChunkData, IStreamMessageResponseEventData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IUserSettingsModule, IVoiceMessageContent, IWatcher, IiOSPushConfig, InnerInsertMessageParams, InnerTransParam, InterruptionLevel, ItypingStateListener, KVString, LogDBProxy, LogL, LogLevel, LogSource, Log as LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_U32_INTEGER, MAX_UPLOAD_FILE_SIZE, MentionedInfo, MentionedType, MessageAuditType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageRegisterParams, MessageType, MessageTypeDescription, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Codec$1 as PBCodec, Platform, PluginContext, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, RTCApiType, RTCJoinType, RTCMode, RTCPluginContext, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, ReferenceMessageStatus, SSEModule, SentStatus, SpeechToTextStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, SuspendablePromise, TranslateInfo, TranslateItem, TranslateMessageParam, TranslateMessagesParams, TranslateMode, TranslateStatus, TranslateStrategy, TranslateTextParam, TranslateTextsParams, UPLOAD_FILE_CHUNK_SIZE, UUId, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, UserSettingsChangedKey, UserType, Validator, VersionManage, assert, createLogDBProxy, fail, fixUrlProtocol, forEach, getMessageTypeDescription, getUUID, getUUID22, hasMessageTypeDescription, httpRequest, isArray, isBoolean, isFunction, isHttpUrl, isInteger, isLimitedString, isNull, isNumber, isObject, isString, isUndefined, isValidConversationType, isValidEnum, isValidFileType, isValidGroupId, isValidTargetId, logger, map, notEmptyArray, notEmptyObject, notEmptyString, ok, promiseWithResolvers, runtime, trans2IReceivedStatusInfo, trans2NotificationLevel, trans2NotificationStatus, transformReceivedStatusFlag, usingCppEngine, validate };
|
|
16492
|
+
export { APIContext, AbsCodec, AppSettings, AppStorage, AreaCode, AssertRules, BasicEngine, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationBatchDeletionParams, ConversationListLoader, ConversationType, DataHosting, DirectionType, EnableLogL, ErrorCode, EventEmitter, FileType, FilterRobotType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupOperationRole, GroupOperationStatus, GroupOperationType, GroupReadReceiptVersion, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAppPushConfig, IAsyncRes, IAuditInfoKeyInMessage, IAuditInfoValueInMessage, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatService, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomErrorKeys, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomService, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineMessageContent, ICombineV2MessageContent, ICombinedMessage, ICommandMessageContent, IConnectionStatusListener, IConversationFilter, IConversationIdentifier, IConversationListLoaderOptions, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagFilter, IConversationTagListener, IConversationUnreadCount, IConvertHQVoiceMessageToTextOption, IConvertSpeechToTextOption, IConvertVoiceMessageToTextOption, ICreateGroupFail, IDataHostingService, IDeletedExpansion, IDownloadAuth, IEditedMessageDraft, IEnginRefreshReferenceMessageResult, IEngineWatcher, IErrorKeys, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraDataKeyInMessage, IFileMessageContent, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGIFMessageContent, IGetConversationListByTimestampParams, IGetConversationsIncludingRobotsOption, IGetGroupMembersOption, IGetHistoryMessageOption, IGetHistoryMessageResult, IGetHistoryMessagesByTypesOption, IGetUltraGroupListOption, IGetUnreadMentionMeConversationListParams, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupNotificationMessageContent, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHQVoiceMessageContent, IHarmonyOSPushConfig, IIPCMethods, IImageMessageContent, IInformationNotificationMessageContent, IInsertMessage, ILocalTagStatus, ILocationMessageContent, ILogData, ILogger, IMemberInviteResponse, IMentionedInfoKeyInMessage, IMessageAttrsForUpdateExpansion, IMessageDesc, IMessageExtraData, IMessageFilter, IMessageIdentifier, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMessageSendOptions, IModifyMessageParams, INaviInfo, INetwork, INotificationQuietHoursSetting, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPlatformOnlineStatus, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessCode, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallCommandMessageContent, IRecallMsgOptions, IRecallNotificationMessageContent, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRefreshReferenceMessageParams, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRichContentMessageContent, IRobotInfo, IRuntime, ISearchMessageParams, ISearchMessagesResult, ISendMsgOptions, IServerGroupBaseInfo, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStorage, IStreamMessageContent, IStreamMessageResponseChunkData, IStreamMessageResponseEventData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IUserSettingsModule, IVoiceMessageContent, IWatcher, IiOSPushConfig, InnerInsertMessageParams, InnerTransParam, InterruptionLevel, ItypingStateListener, KVString, LogDBProxy, LogL, LogLevel, LogSource, Log as LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_U32_INTEGER, MAX_UPLOAD_FILE_SIZE, MentionedInfo, MentionedType, MessageAuditType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageRegisterParams, MessageType, MessageTypeDescription, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Codec$1 as PBCodec, Platform, PluginContext, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, RTCApiType, RTCJoinType, RTCMode, RTCPluginContext, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, ReferenceMessageStatus, SSEModule, SentStatus, SpeechToTextStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, SuspendablePromise, TranslateInfo, TranslateItem, TranslateMessageParam, TranslateMessagesParams, TranslateMode, TranslateStatus, TranslateStrategy, TranslateTextParam, TranslateTextsParams, UPLOAD_FILE_CHUNK_SIZE, UUId, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, UserSettingsChangedKey, UserType, Validator, VersionManage, assert, createLogDBProxy, fail, fixUrlProtocol, forEach, getMessageTypeDescription, getUUID, getUUID22, hasMessageTypeDescription, httpRequest, isArray, isBoolean, isFunction, isHttpUrl, isInteger, isLimitedString, isNull, isNumber, isObject, isString, isUndefined, isValidConversationType, isValidEnum, isValidFileType, isValidGroupId, isValidTargetId, logger, map, notEmptyArray, notEmptyObject, notEmptyString, ok, promiseWithResolvers, runtime, trans2IReceivedStatusInfo, trans2NotificationLevel, trans2NotificationStatus, transformReceivedStatusFlag, usingCppEngine, validate };
|