@rongcloud/engine 5.30.2 → 5.32.0-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.cjs +1 -1
- package/index.cjs.js +1 -1
- package/index.d.ts +1189 -906
- package/index.esm.js +1 -1
- package/index.mjs +1 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -75,6 +75,10 @@ declare const Log: {
|
|
|
75
75
|
readonly A_SEND_MSG_R: "A-send_msg-R";
|
|
76
76
|
readonly L_SEND_MSG_T: "L-send_msg-T";
|
|
77
77
|
readonly L_SEND_MSG_R: "L-send_msg-R";
|
|
78
|
+
readonly A_SEND_TYPING_STATUS_T: "A-send_typing_status-T";
|
|
79
|
+
readonly A_SEND_TYPING_STATUS_R: "A-send_typing_status-R";
|
|
80
|
+
readonly A_SEND_READ_RECEIPT_REQ_T: "A-send_read_receipt_req-T";
|
|
81
|
+
readonly A_SEND_READ_RECEIPT_REQ_R: "A-send_read_receipt_req-R";
|
|
78
82
|
readonly L_PULL_MSG_T: "L-pull_msg-T";
|
|
79
83
|
readonly L_PULL_MSG_R: "L-pull_msg-R";
|
|
80
84
|
readonly L_PULL_MSG_E: "L-pull_msg-E";
|
|
@@ -152,12 +156,6 @@ declare const Log: {
|
|
|
152
156
|
readonly A_SEND_READ_RECEIPT_R: "A-send_read_receipt-R";
|
|
153
157
|
readonly A_SEND_READ_RECEIPT_V2_T: "A-send_read_receipt_v2-T";
|
|
154
158
|
readonly A_SEND_READ_RECEIPT_V2_R: "A-send_read_receipt_v2-R";
|
|
155
|
-
readonly A_SEND_MESSAGE_READ_RECEIPT_V4_T: "A-send_message_read_receipt_V4-T";
|
|
156
|
-
readonly A_SEND_MESSAGE_READ_RECEIPT_V4_R: "A-send_message_read_receipt_V4-R";
|
|
157
|
-
readonly A_GET_MESSAGE_READ_RECEIPT_V4_T: "A-get_message_read_receipt_V4-T";
|
|
158
|
-
readonly A_GET_MESSAGE_READ_RECEIPT_V4_R: "A-get_message_read_receipt_V4-R";
|
|
159
|
-
readonly A_BATCH_GET_MESSAGE_READ_RECEIPT_INFO_V4_T: "A-batch_get_message_read_receipt_info_V4-T";
|
|
160
|
-
readonly A_BATCH_GET_MESSAGE_READ_RECEIPT_INFO_V4_R: "A-batch_get_message_read_receipt_info_V4-R";
|
|
161
159
|
readonly A_SYNC_READ_STATUS_T: "A-sync_read_status-T";
|
|
162
160
|
readonly A_SYNC_READ_STATUS_R: "A-sync_read_status-R";
|
|
163
161
|
/**
|
|
@@ -196,8 +194,9 @@ declare const Log: {
|
|
|
196
194
|
/** 未知的通知 */
|
|
197
195
|
readonly L_UNSUPPORT_NTF_FROM_MAIN_E: "L_UNSUPPORT_NTF_FROM_MAIN_E";
|
|
198
196
|
readonly A_REMOVE_PROXY_O: "A-remove_proxy-O";
|
|
199
|
-
readonly
|
|
200
|
-
readonly
|
|
197
|
+
readonly L_SET_PROXY_O: "L-set_proxy-O";
|
|
198
|
+
readonly L_TEST_PROXY_T: "L-test_proxy-T";
|
|
199
|
+
readonly L_TEST_PROXY_R: "L-test_proxy-R";
|
|
201
200
|
/** WebSocket 连接与接收数据链路不一致 */
|
|
202
201
|
readonly L_WS_DISACCORD_E: "L-ws_disaccord-E";
|
|
203
202
|
/** 获取静态配置 */
|
|
@@ -265,6 +264,8 @@ declare const Log: {
|
|
|
265
264
|
readonly L_EVENT_LOOP_BLOCKING_S: "L-event_loop_blocking-S";
|
|
266
265
|
readonly A_E_SEARCH_CONVERSATION_BY_CONTENT_T: "A-e_search_conversation_by_content-T";
|
|
267
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";
|
|
268
269
|
readonly P_GET_SYS_VERSION_E: "P-get_sys_version-E";
|
|
269
270
|
/** 清除本地缓存 */
|
|
270
271
|
readonly A_CLEAR_LOCAL_CACHE_O: "A-clear_local_cache-O";
|
|
@@ -426,6 +427,136 @@ declare const Log: {
|
|
|
426
427
|
readonly A_GET_UNREAD_MENTION_ME_CONVERSATION_LIST_R: "A-get_unread_mention_me_conversation_list-R";
|
|
427
428
|
readonly A_GET_USER_PROFILES_T: "A-get_user_profiles-T";
|
|
428
429
|
readonly A_GET_USER_PROFILES_R: "A-get_user_profiles-R";
|
|
430
|
+
readonly A_ADD_TO_BLACKLIST_T: "A-add_to_blacklist-T";
|
|
431
|
+
readonly A_ADD_TO_BLACKLIST_R: "A-add_to_blacklist-R";
|
|
432
|
+
readonly A_REMOVE_FROM_BLACKLIST_T: "A-remove_from_blacklist-T";
|
|
433
|
+
readonly A_REMOVE_FROM_BLACKLIST_R: "A-remove_from_blacklist-R";
|
|
434
|
+
readonly A_GET_BLACKLIST_T: "A-get_blacklist-T";
|
|
435
|
+
readonly A_GET_BLACKLIST_R: "A-get_blacklist-R";
|
|
436
|
+
readonly A_GET_BLACKLIST_STATUS_T: "A-get_blacklist_status-T";
|
|
437
|
+
readonly A_GET_BLACKLIST_STATUS_R: "A-get_blacklist_status-R";
|
|
438
|
+
readonly A_E_SET_MSG_RECEIVED_STATUS_T: "A-e_set_msg_received_status-T";
|
|
439
|
+
readonly A_E_SET_MSG_RECEIVED_STATUS_R: "A-e_set_msg_received_status-R";
|
|
440
|
+
readonly A_E_SET_MSG_SENT_STATUS_T: "A-e_set_msg_sent_status-T";
|
|
441
|
+
readonly A_E_SET_MSG_SENT_STATUS_R: "A-e_set_msg_sent_status-R";
|
|
442
|
+
readonly A_E_SET_CHECK_DUPLICATE_MSG_T: "A-e_set_check_duplicate_msg-T";
|
|
443
|
+
readonly A_E_SET_CHECK_DUPLICATE_MSG_R: "A-e_set_check_duplicate_msg-R";
|
|
444
|
+
readonly A_SET_PROXY_T: "A-set_proxy-T";
|
|
445
|
+
readonly A_SET_PROXY_R: "A-set_proxy-R";
|
|
446
|
+
readonly A_GET_PROXY_T: "A-get_proxy-T";
|
|
447
|
+
readonly A_GET_PROXY_R: "A-get_proxy-R";
|
|
448
|
+
readonly A_TEST_PROXY_T: "A-test_proxy-T";
|
|
449
|
+
readonly A_TEST_PROXY_R: "A-test_proxy-R";
|
|
450
|
+
readonly A_CLEAR_UNREAD_COUNT_BY_TIME_T: "A-clear_unread_count_by_time-T";
|
|
451
|
+
readonly A_CLEAR_UNREAD_COUNT_BY_TIME_R: "A-clear_unread_count_by_time-R";
|
|
452
|
+
readonly A_GET_MSG_READER_T: "A-get_msg_reader-T";
|
|
453
|
+
readonly A_GET_MSG_READER_R: "A-get_msg_reader-R";
|
|
454
|
+
readonly A_SEND_READ_RECEIPT_V4_T: "A-send_read_receipt_v4-T";
|
|
455
|
+
readonly A_SEND_READ_RECEIPT_V4_R: "A-send_read_receipt_v4-R";
|
|
456
|
+
readonly A_GET_READ_RECEIPT_V4_T: "A-get_read_receipt_V4-T";
|
|
457
|
+
readonly A_GET_READ_RECEIPT_V4_R: "A-get_read_receipt_V4-R";
|
|
458
|
+
readonly A_BATCH_GET_READ_RECEIPT_INFO_V4_T: "A-batch_get_read_receipt_info_V4-T";
|
|
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";
|
|
464
|
+
readonly A_ADD_FRIEND_T: "A-add_friend-T";
|
|
465
|
+
readonly A_ADD_FRIEND_R: "A-add_friend-R";
|
|
466
|
+
readonly A_DELETE_FRIENDS_T: "A-delete_friends-T";
|
|
467
|
+
readonly A_DELETE_FRIENDS_R: "A-delete_friends-R";
|
|
468
|
+
readonly A_ACCEPT_FRIEND_REQUEST_T: "A-accept_friend_request-T";
|
|
469
|
+
readonly A_ACCEPT_FRIEND_REQUEST_R: "A-accept_friend_request-R";
|
|
470
|
+
readonly A_REFUSE_FRIEND_REQUEST_T: "A-refuse_friend_request-T";
|
|
471
|
+
readonly A_REFUSE_FRIEND_REQUEST_R: "A-refuse_friend_request-R";
|
|
472
|
+
readonly A_SET_FRIEND_INFO_T: "A-set_friend_info-T";
|
|
473
|
+
readonly A_SET_FRIEND_INFO_R: "A-set_friend_info-R";
|
|
474
|
+
readonly A_CHECK_FRIENDS_T: "A-check_friends-T";
|
|
475
|
+
readonly A_CHECK_FRIENDS_R: "A-check_friends-R";
|
|
476
|
+
readonly A_GET_FRIENDS_T: "A-get_friends-T";
|
|
477
|
+
readonly A_GET_FRIENDS_R: "A-get_friends-R";
|
|
478
|
+
readonly A_GET_FRIEND_APPLICATIONS_T: "A-get_friend_applications-T";
|
|
479
|
+
readonly A_GET_FRIEND_APPLICATIONS_R: "A-get_friend_applications-R";
|
|
480
|
+
readonly A_GET_FRIENDS_INFO_T: "A-get_friends_info-T";
|
|
481
|
+
readonly A_GET_FRIENDS_INFO_R: "A-get_friends_info-R";
|
|
482
|
+
readonly A_SEARCH_FRIENDS_INFO_T: "A-search_friends_info-T";
|
|
483
|
+
readonly A_SEARCH_FRIENDS_INFO_R: "A-search_friends_info-R";
|
|
484
|
+
readonly A_SET_FRIEND_ADD_PERMISSION_T: "A-set_friend_add_permission-T";
|
|
485
|
+
readonly A_SET_FRIEND_ADD_PERMISSION_R: "A-set_friend_add_permission-R";
|
|
486
|
+
readonly A_GET_FRIEND_ADD_PERMISSION_T: "A-get_friend_add_permission-T";
|
|
487
|
+
readonly A_GET_FRIEND_ADD_PERMISSION_R: "A-get_friend_add_permission-R";
|
|
488
|
+
readonly A_CREATE_GROUP_T: "A-create_group-T";
|
|
489
|
+
readonly A_CREATE_GROUP_R: "A-create_group-R";
|
|
490
|
+
readonly A_UPDATE_GROUP_INFO_T: "A-update_group_info-T";
|
|
491
|
+
readonly A_UPDATE_GROUP_INFO_R: "A-update_group_info-R";
|
|
492
|
+
readonly A_GET_GROUPS_INFO_T: "A-get_groups_info-T";
|
|
493
|
+
readonly A_GET_GROUPS_INFO_R: "A-get_groups_info-R";
|
|
494
|
+
readonly A_KICK_GROUP_MEMBERS_T: "A-kick_group_members-T";
|
|
495
|
+
readonly A_KICK_GROUP_MEMBERS_R: "A-kick_group_members-R";
|
|
496
|
+
readonly A_QUIT_GROUP_T: "A-quit_group-T";
|
|
497
|
+
readonly A_QUIT_GROUP_R: "A-quit_group-R";
|
|
498
|
+
readonly A_DISMISS_GROUP_T: "A-dismiss_group-T";
|
|
499
|
+
readonly A_DISMISS_GROUP_R: "A-dismiss_group-R";
|
|
500
|
+
readonly A_TRANSFER_GROUP_OWNER_T: "A-transfer_group_owner-T";
|
|
501
|
+
readonly A_TRANSFER_GROUP_OWNER_R: "A-transfer_group_owner-R";
|
|
502
|
+
readonly A_ADD_GROUP_MANAGERS_T: "A-add_group_managers-T";
|
|
503
|
+
readonly A_ADD_GROUP_MANAGERS_R: "A-add_group_managers-R";
|
|
504
|
+
readonly A_REMOVE_GROUP_MANAGERS_T: "A-remove_group_managers-T";
|
|
505
|
+
readonly A_REMOVE_GROUP_MANAGERS_R: "A-remove_group_managers-R";
|
|
506
|
+
readonly A_GET_GROUP_MEMBERS_T: "A-get_group_members-T";
|
|
507
|
+
readonly A_GET_GROUP_MEMBERS_R: "A-get_group_members-R";
|
|
508
|
+
readonly A_SET_GROUP_MEMBER_INFO_T: "A-set_group_member_info-T";
|
|
509
|
+
readonly A_SET_GROUP_MEMBER_INFO_R: "A-set_group_member_info-R";
|
|
510
|
+
readonly A_SEARCH_GROUP_MEMBERS_T: "A-search_group_members-T";
|
|
511
|
+
readonly A_SEARCH_GROUP_MEMBERS_R: "A-search_group_members-R";
|
|
512
|
+
readonly A_JOIN_GROUP_T: "A-join_group-T";
|
|
513
|
+
readonly A_JOIN_GROUP_R: "A-join_group-R";
|
|
514
|
+
readonly A_INVITE_USERS_TO_GROUP_T: "A-invite_users_to_group-T";
|
|
515
|
+
readonly A_INVITE_USERS_TO_GROUP_R: "A-invite_users_to_group-R";
|
|
516
|
+
readonly A_ADD_GROUP_FOLLOWS_T: "A-add_group_follows-T";
|
|
517
|
+
readonly A_ADD_GROUP_FOLLOWS_R: "A-add_group_follows-R";
|
|
518
|
+
readonly A_REMOVE_GROUP_FOLLOWS_T: "A-remove_group_follows-T";
|
|
519
|
+
readonly A_REMOVE_GROUP_FOLLOWS_R: "A-remove_group_follows-R";
|
|
520
|
+
readonly A_GET_GROUP_FOLLOWS_T: "A-get_group_follows-T";
|
|
521
|
+
readonly A_GET_GROUP_FOLLOWS_R: "A-get_group_follows-R";
|
|
522
|
+
readonly A_SET_GROUP_REMARK_T: "A-set_group_remark-T";
|
|
523
|
+
readonly A_SET_GROUP_REMARK_R: "A-set_group_remark-R";
|
|
524
|
+
readonly A_GET_GROUP_MEMBERS_BY_ROLE_T: "A-get_group_members_by_role-T";
|
|
525
|
+
readonly A_GET_GROUP_MEMBERS_BY_ROLE_R: "A-get_group_members_by_role-R";
|
|
526
|
+
readonly A_ACCEPT_GROUP_INVITE_T: "A-accept_group_invite-T";
|
|
527
|
+
readonly A_ACCEPT_GROUP_INVITE_R: "A-accept_group_invite-R";
|
|
528
|
+
readonly A_REFUSE_GROUP_INVITE_T: "A-refuse_group_invite-T";
|
|
529
|
+
readonly A_REFUSE_GROUP_INVITE_R: "A-refuse_group_invite-R";
|
|
530
|
+
readonly A_ACCEPT_GROUP_APPLICATION_T: "A-accept_group_application-T";
|
|
531
|
+
readonly A_ACCEPT_GROUP_APPLICATION_R: "A-accept_group_application-R";
|
|
532
|
+
readonly A_REFUSE_GROUP_APPLICATION_T: "A-refuse_group_application-T";
|
|
533
|
+
readonly A_REFUSE_GROUP_APPLICATION_R: "A-refuse_group_application-R";
|
|
534
|
+
readonly A_GET_GROUP_APPLICATIONS_T: "A-get_group_applications-T";
|
|
535
|
+
readonly A_GET_GROUP_APPLICATIONS_R: "A-get_group_applications-R";
|
|
536
|
+
readonly A_GET_JOINED_GROUPS_BY_ROLES_T: "A-get_joined_groups_by_roles-T";
|
|
537
|
+
readonly A_GET_JOINED_GROUPS_BY_ROLES_R: "A-get_joined_groups_by_roles-R";
|
|
538
|
+
readonly A_SEARCH_JOINED_GROUPS_T: "A-search_joined_groups-T";
|
|
539
|
+
readonly A_SEARCH_JOINED_GROUPS_R: "A-search_joined_groups-R";
|
|
540
|
+
readonly A_GET_JOINED_GROUPS_T: "A-get_joined_groups-T";
|
|
541
|
+
readonly A_GET_JOINED_GROUPS_R: "A-get_joined_groups-R";
|
|
542
|
+
readonly A_SEARCH_USER_PROFILE_BY_UNIQUE_ID_T: "A-search_user_profile_by_unique_id-T";
|
|
543
|
+
readonly A_SEARCH_USER_PROFILE_BY_UNIQUE_ID_R: "A-search_user_profile_by_unique_id-R";
|
|
544
|
+
readonly A_UPDATE_MY_USER_PROFILE_VISIBILITY_T: "A-update_my_user_profile_visibility-T";
|
|
545
|
+
readonly A_UPDATE_MY_USER_PROFILE_VISIBILITY_R: "A-update_my_user_profile_visibility-R";
|
|
546
|
+
readonly A_GET_MY_USER_PROFILE_VISIBILITY_T: "A-get_my_user_profile_visibility-T";
|
|
547
|
+
readonly A_GET_MY_USER_PROFILE_VISIBILITY_R: "A-get_my_user_profile_visibility-R";
|
|
548
|
+
readonly A_SUBSCRIBE_USER_STATUS_T: "A-subscribe_user_status-T";
|
|
549
|
+
readonly A_SUBSCRIBE_USER_STATUS_R: "A-subscribe_user_status-R";
|
|
550
|
+
readonly A_UNSUBSCRIBE_USER_STATUS_T: "A-unsubscribe_user_status-T";
|
|
551
|
+
readonly A_UNSUBSCRIBE_USER_STATUS_R: "A-unsubscribe_user_status-R";
|
|
552
|
+
readonly A_GET_SUBSCRIBE_USER_STATUS_LIST_T: "A-get_subscribe_user_status_list-T";
|
|
553
|
+
readonly A_GET_SUBSCRIBE_USER_STATUS_LIST_R: "A-get_subscribe_user_status_list-R";
|
|
554
|
+
readonly A_GET_MY_USER_PROFILE_T: "A-get_my_user_profile-T";
|
|
555
|
+
readonly A_GET_MY_USER_PROFILE_R: "A-get_my_user_profile-R";
|
|
556
|
+
readonly A_UPDATE_MY_USER_PROFILE_T: "A-update_my_user_profile-T";
|
|
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";
|
|
429
560
|
};
|
|
430
561
|
|
|
431
562
|
/** [EN]
|
|
@@ -1145,6 +1276,11 @@ declare enum ErrorCode {
|
|
|
1145
1276
|
* 已被对方加入黑名单,消息发送失败
|
|
1146
1277
|
*/
|
|
1147
1278
|
REJECTED_BY_BLACKLIST = 405,
|
|
1279
|
+
/**
|
|
1280
|
+
* 407
|
|
1281
|
+
* 对方开启了只接收白名单的信息,但己方不在白名单中,发送消息失败
|
|
1282
|
+
*/
|
|
1283
|
+
NOT_IN_WHITELIST = 407,
|
|
1148
1284
|
/**
|
|
1149
1285
|
* 20106
|
|
1150
1286
|
* 在单聊中已被禁言
|
|
@@ -1169,12 +1305,24 @@ declare enum ErrorCode {
|
|
|
1169
1305
|
* @since 5.26.0
|
|
1170
1306
|
*/
|
|
1171
1307
|
CONTENT_REVIEW_REJECTED = 20113,
|
|
1308
|
+
/**
|
|
1309
|
+
* 20114
|
|
1310
|
+
* 消息超过可修改时间
|
|
1311
|
+
* @since 5.26.0
|
|
1312
|
+
*/
|
|
1313
|
+
MESSAGE_OVER_MODIFY_TIME_FAIL = 20114,
|
|
1172
1314
|
/**
|
|
1173
1315
|
* 20115
|
|
1174
1316
|
* 消息尺寸超出限制
|
|
1175
1317
|
* @since 5.26.0
|
|
1176
1318
|
*/
|
|
1177
1319
|
MESSAGE_SIZE_EXCEEDED = 20115,
|
|
1320
|
+
/**
|
|
1321
|
+
* 20116
|
|
1322
|
+
* 消息不支持修改
|
|
1323
|
+
* @since 5.26.0
|
|
1324
|
+
*/
|
|
1325
|
+
MESSAGE_UNSUPPORTED_MODIFY = 20116,
|
|
1178
1326
|
/**
|
|
1179
1327
|
* 20512
|
|
1180
1328
|
* appkey的数据中心与请求云控的数据中心不匹配
|
|
@@ -1304,7 +1452,7 @@ declare enum ErrorCode {
|
|
|
1304
1452
|
CHATROOM_KV_OVERWRITE_INVALID = 23424,
|
|
1305
1453
|
/**
|
|
1306
1454
|
* 23425
|
|
1307
|
-
*
|
|
1455
|
+
* 【已废弃】超过聊天室中状态设置频率,1 个聊天室 1 秒钟最多设置和删除状态 100 次
|
|
1308
1456
|
*/
|
|
1309
1457
|
CHATROOM_SET_PROPERTY_OVER_FREQUENCY = 23425,
|
|
1310
1458
|
/**
|
|
@@ -1329,7 +1477,7 @@ declare enum ErrorCode {
|
|
|
1329
1477
|
CHATROOM_KV_STORE_OUT_LIMIT = 23429,
|
|
1330
1478
|
/**
|
|
1331
1479
|
* 23431
|
|
1332
|
-
*
|
|
1480
|
+
* 【已废弃】聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
|
|
1333
1481
|
* @since 5.3.0
|
|
1334
1482
|
*/
|
|
1335
1483
|
CHATROOM_KV_SET_ERROR = 23431,
|
|
@@ -1768,6 +1916,11 @@ declare enum ErrorCode {
|
|
|
1768
1916
|
* @since 5.12.0
|
|
1769
1917
|
*/
|
|
1770
1918
|
RC_FRIEND_NOT_ALLOW_ADD_SELF = 25473,
|
|
1919
|
+
/**
|
|
1920
|
+
* 25474
|
|
1921
|
+
* 不支持添加机器人为好友
|
|
1922
|
+
*/
|
|
1923
|
+
RC_FRIEND_NOT_SUPPORT_ROBOT = 25474,
|
|
1771
1924
|
/**
|
|
1772
1925
|
* 25480
|
|
1773
1926
|
* 托管资料信息审核不通过
|
|
@@ -2327,6 +2480,12 @@ declare enum ErrorCode {
|
|
|
2327
2480
|
* @since 5.2.0
|
|
2328
2481
|
*/
|
|
2329
2482
|
NO_TAG_IN_CONVER = 33102,
|
|
2483
|
+
/**
|
|
2484
|
+
* 33103
|
|
2485
|
+
* 方法执行中,请勿重复调用。
|
|
2486
|
+
* @since 5.32.0
|
|
2487
|
+
*/
|
|
2488
|
+
METHOD_BUSY = 33103,
|
|
2330
2489
|
/**
|
|
2331
2490
|
* 33401
|
|
2332
2491
|
* 被编辑消息是接收的或者没有发送成功的
|
|
@@ -2959,13 +3118,13 @@ declare enum ErrorCode {
|
|
|
2959
3118
|
INVALID_PARAMETER_MESSAGE_INFO_MAP = 34345,
|
|
2960
3119
|
/**
|
|
2961
3120
|
* 35001
|
|
2962
|
-
*
|
|
3121
|
+
* 【已废弃】群组信息异常
|
|
2963
3122
|
* @deprecated
|
|
2964
3123
|
*/
|
|
2965
3124
|
GROUP_SYNC_ERROR = 35001,
|
|
2966
3125
|
/**
|
|
2967
3126
|
* 35002
|
|
2968
|
-
*
|
|
3127
|
+
* 【已废弃】匹配群信息异常
|
|
2969
3128
|
* @deprecated
|
|
2970
3129
|
*/
|
|
2971
3130
|
GROUP_MATCH_ERROR = 35002,
|
|
@@ -2981,7 +3140,7 @@ declare enum ErrorCode {
|
|
|
2981
3140
|
MAIN_PROCESS_ERROR = 35005,
|
|
2982
3141
|
/**
|
|
2983
3142
|
* 35007
|
|
2984
|
-
*
|
|
3143
|
+
* 【已废弃】已连接或者内部重连中,不允许调用重连,需先调用 disconnect 方法
|
|
2985
3144
|
* @deprecated
|
|
2986
3145
|
*/
|
|
2987
3146
|
CAN_NOT_RECONNECT = 35007,
|
|
@@ -2992,13 +3151,13 @@ declare enum ErrorCode {
|
|
|
2992
3151
|
SERVER_UNAVAILABLE = 35008,
|
|
2993
3152
|
/**
|
|
2994
3153
|
* 35009
|
|
2995
|
-
* Web 端设置安全域名后,连接端域名不在安全域名范围内
|
|
3154
|
+
* 【已废弃】Web 端设置安全域名后,连接端域名不在安全域名范围内
|
|
2996
3155
|
* @deprecated
|
|
2997
3156
|
*/
|
|
2998
3157
|
HOSTNAME_ERROR = 35009,
|
|
2999
3158
|
/**
|
|
3000
3159
|
* 35010
|
|
3001
|
-
*
|
|
3160
|
+
* 【已废弃】开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
|
|
3002
3161
|
* @deprecated
|
|
3003
3162
|
*/
|
|
3004
3163
|
HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
|
|
@@ -3163,24 +3322,6 @@ declare enum ErrorCode {
|
|
|
3163
3322
|
* 开发者调用时传入的 pushData 无效
|
|
3164
3323
|
*/
|
|
3165
3324
|
INVALID_PARAMETER_PUSH_DATA = 35050,
|
|
3166
|
-
/**
|
|
3167
|
-
* 35051
|
|
3168
|
-
* dns 代理超时
|
|
3169
|
-
* @since 5.12.2
|
|
3170
|
-
*/
|
|
3171
|
-
DNS_PROXY_TIMEOUT = 35051,
|
|
3172
|
-
/**
|
|
3173
|
-
* 35052
|
|
3174
|
-
* dns 代理错误
|
|
3175
|
-
* @since 5.12.2
|
|
3176
|
-
*/
|
|
3177
|
-
DNS_PROXY_ERROR = 35052,
|
|
3178
|
-
/**
|
|
3179
|
-
* 35053
|
|
3180
|
-
* dns 代理数据解构错误
|
|
3181
|
-
* @since 5.12.2
|
|
3182
|
-
*/
|
|
3183
|
-
DNS_PROXY_DATA_DESTRUCTUR_ERROR = 35053,
|
|
3184
3325
|
/**
|
|
3185
3326
|
* 35054
|
|
3186
3327
|
* 传入的 disableUpdateLastMessage 参数无效。在会话类型为 ULTRA GROUP 时,该字段不允许设置为 true
|
|
@@ -3255,49 +3396,49 @@ declare enum ErrorCode {
|
|
|
3255
3396
|
TRANSLATION_TEXT_INVALID = 35065,
|
|
3256
3397
|
/**
|
|
3257
3398
|
* 36001
|
|
3258
|
-
*
|
|
3399
|
+
* 【已废弃】加入聊天室Id为空
|
|
3259
3400
|
* @deprecated
|
|
3260
3401
|
*/
|
|
3261
3402
|
CHATROOM_ID_ISNULL = 36001,
|
|
3262
3403
|
/**
|
|
3263
3404
|
* 36002
|
|
3264
|
-
*
|
|
3405
|
+
* 【已废弃】加入聊天室失败
|
|
3265
3406
|
* @deprecated
|
|
3266
3407
|
*/
|
|
3267
3408
|
CHARTOOM_JOIN_ERROR = 36002,
|
|
3268
3409
|
/**
|
|
3269
3410
|
* 36003
|
|
3270
|
-
*
|
|
3411
|
+
* 【已废弃】拉取聊天室历史消息失败
|
|
3271
3412
|
* @deprecated
|
|
3272
3413
|
*/
|
|
3273
3414
|
CHATROOM_HISMESSAGE_ERROR = 36003,
|
|
3274
3415
|
/**
|
|
3275
3416
|
* 36004
|
|
3276
|
-
*
|
|
3417
|
+
* 【已废弃】聊天室 kv 未找到
|
|
3277
3418
|
* @deprecated
|
|
3278
3419
|
*/
|
|
3279
3420
|
CHATROOM_KV_NOT_FOUND = 36004,
|
|
3280
3421
|
/**
|
|
3281
3422
|
* 37001
|
|
3282
|
-
*
|
|
3423
|
+
* 【已废弃】加入黑名单异常
|
|
3283
3424
|
* @deprecated
|
|
3284
3425
|
*/
|
|
3285
3426
|
BLACK_ADD_ERROR = 37001,
|
|
3286
3427
|
/**
|
|
3287
3428
|
* 37002
|
|
3288
|
-
*
|
|
3429
|
+
* 【已废弃】获得指定人员再黑名单中的状态异常
|
|
3289
3430
|
* @deprecated
|
|
3290
3431
|
*/
|
|
3291
3432
|
BLACK_GETSTATUS_ERROR = 37002,
|
|
3292
3433
|
/**
|
|
3293
3434
|
* 37003
|
|
3294
|
-
*
|
|
3435
|
+
* 【已废弃】移除黑名单异常
|
|
3295
3436
|
* @deprecated
|
|
3296
3437
|
*/
|
|
3297
3438
|
BLACK_REMOVE_ERROR = 37003,
|
|
3298
3439
|
/**
|
|
3299
3440
|
* 38001
|
|
3300
|
-
*
|
|
3441
|
+
* 【已废弃】获取草稿失败
|
|
3301
3442
|
* @deprecated
|
|
3302
3443
|
*/
|
|
3303
3444
|
DRAF_GET_ERROR = 38001,
|
|
@@ -3339,7 +3480,7 @@ declare enum ErrorCode {
|
|
|
3339
3480
|
STREAM_MESSAGE_SYNCED = 39007,
|
|
3340
3481
|
/**
|
|
3341
3482
|
* 41002
|
|
3342
|
-
*
|
|
3483
|
+
* 【已废弃】获取七牛token失败
|
|
3343
3484
|
* @deprecated
|
|
3344
3485
|
*/
|
|
3345
3486
|
QNTKN_GET_ERROR = 41002,
|
|
@@ -3402,10 +3543,10 @@ declare enum ConversationType {
|
|
|
3402
3543
|
*/
|
|
3403
3544
|
CUSTOMER_SERVICE = 5,
|
|
3404
3545
|
/** [EN]
|
|
3405
|
-
* System
|
|
3546
|
+
* System conversation
|
|
3406
3547
|
*/
|
|
3407
3548
|
/**
|
|
3408
|
-
*
|
|
3549
|
+
* 系统会话
|
|
3409
3550
|
*/
|
|
3410
3551
|
SYSTEM = 6,
|
|
3411
3552
|
/** [EN]
|
|
@@ -4370,6 +4511,31 @@ declare enum PushNotificationQuietHoursLevel {
|
|
|
4370
4511
|
PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_BLOCKED = 5
|
|
4371
4512
|
}
|
|
4372
4513
|
|
|
4514
|
+
declare const FilterRobotType: {
|
|
4515
|
+
/** [EN]
|
|
4516
|
+
* Get results containing robots
|
|
4517
|
+
*/
|
|
4518
|
+
/**
|
|
4519
|
+
* 获取结果包含机器人
|
|
4520
|
+
*/
|
|
4521
|
+
readonly ALL: 0;
|
|
4522
|
+
/** [EN]
|
|
4523
|
+
* Get results not containing robots
|
|
4524
|
+
*/
|
|
4525
|
+
/**
|
|
4526
|
+
* 获取结果不包含机器人
|
|
4527
|
+
*/
|
|
4528
|
+
readonly EXCLUDE_ROBOT: 1;
|
|
4529
|
+
/** [EN]
|
|
4530
|
+
* Get results only containing robots
|
|
4531
|
+
*/
|
|
4532
|
+
/**
|
|
4533
|
+
* 获取结果仅包含机器人
|
|
4534
|
+
*/
|
|
4535
|
+
readonly ROBOT_ONLY: 2;
|
|
4536
|
+
};
|
|
4537
|
+
declare type FilterRobotType = (typeof FilterRobotType)[keyof typeof FilterRobotType];
|
|
4538
|
+
|
|
4373
4539
|
/**
|
|
4374
4540
|
* 消息审核类型
|
|
4375
4541
|
* @category Enum
|
|
@@ -4491,6 +4657,125 @@ declare const UUId: {
|
|
|
4491
4657
|
genWithLen(strLen?: number): string;
|
|
4492
4658
|
};
|
|
4493
4659
|
|
|
4660
|
+
/**
|
|
4661
|
+
* 检查参数是否为字符串
|
|
4662
|
+
* 只做类型检查,不做长度检查,故当字符串长度为 0,结果依然为 true
|
|
4663
|
+
* @param value
|
|
4664
|
+
*/
|
|
4665
|
+
declare const isString: (value: unknown) => boolean;
|
|
4666
|
+
/**
|
|
4667
|
+
* 检测参数是否为布尔值
|
|
4668
|
+
* @param value
|
|
4669
|
+
*/
|
|
4670
|
+
declare const isBoolean: (value: unknown) => boolean;
|
|
4671
|
+
/**
|
|
4672
|
+
* 检查参数是否为 number 数据
|
|
4673
|
+
* @param value
|
|
4674
|
+
*/
|
|
4675
|
+
declare const isNumber: (value: unknown) => boolean;
|
|
4676
|
+
/**
|
|
4677
|
+
* 检查参数是否为整数,可以指定最小值和最大值,区间包含最小值和最大值,
|
|
4678
|
+
*/
|
|
4679
|
+
declare const isInteger: (option: {
|
|
4680
|
+
min?: number;
|
|
4681
|
+
max?: number;
|
|
4682
|
+
}) => (value: number) => boolean;
|
|
4683
|
+
/**
|
|
4684
|
+
* 检查参数是否为数组
|
|
4685
|
+
* 只做类型检查,不做长度检查
|
|
4686
|
+
* 如 UnitArray、BufferArray 等也属于数组
|
|
4687
|
+
* @param arr
|
|
4688
|
+
*/
|
|
4689
|
+
declare const isArray: (arr: unknown) => boolean;
|
|
4690
|
+
/**
|
|
4691
|
+
* 有限制的字符串
|
|
4692
|
+
* 做长度检查、自定义检查
|
|
4693
|
+
* 先检测前后去空格是否为空
|
|
4694
|
+
*/
|
|
4695
|
+
declare const isLimitedString: (option: {
|
|
4696
|
+
minLength?: number | undefined;
|
|
4697
|
+
maxLength?: number | undefined;
|
|
4698
|
+
validator?: ((val: string) => boolean) | undefined;
|
|
4699
|
+
isTrim?: boolean | undefined;
|
|
4700
|
+
}) => (str: unknown) => boolean;
|
|
4701
|
+
/**
|
|
4702
|
+
* 检查参数是否为长度非 0 的字符串
|
|
4703
|
+
* @param str
|
|
4704
|
+
*/
|
|
4705
|
+
declare const notEmptyString: (str: unknown) => boolean;
|
|
4706
|
+
/**
|
|
4707
|
+
* 检查参数是否为长度非 0 的数组
|
|
4708
|
+
* @param str
|
|
4709
|
+
*/
|
|
4710
|
+
declare const notEmptyArray: (arr: any[]) => boolean;
|
|
4711
|
+
/**
|
|
4712
|
+
* 检查参数是否为对象
|
|
4713
|
+
* @param val
|
|
4714
|
+
*/
|
|
4715
|
+
declare const isObject: (val: any) => boolean;
|
|
4716
|
+
/**
|
|
4717
|
+
* 检查参数是否为函数
|
|
4718
|
+
* @param val
|
|
4719
|
+
*/
|
|
4720
|
+
declare const isFunction: (val: any) => boolean;
|
|
4721
|
+
/**
|
|
4722
|
+
* 检查参数是否为 undefined
|
|
4723
|
+
* @param val
|
|
4724
|
+
*/
|
|
4725
|
+
declare const isUndefined: (val: any) => boolean;
|
|
4726
|
+
/**
|
|
4727
|
+
* 检查参数是否为有效 http(s) 协议 url
|
|
4728
|
+
* @param value
|
|
4729
|
+
*/
|
|
4730
|
+
declare const isHttpUrl: (value: any) => boolean;
|
|
4731
|
+
/**
|
|
4732
|
+
* 检查对象不为空
|
|
4733
|
+
* @param val
|
|
4734
|
+
*/
|
|
4735
|
+
declare const notEmptyObject: (val: Object) => boolean;
|
|
4736
|
+
/**
|
|
4737
|
+
* @deprecated
|
|
4738
|
+
*/
|
|
4739
|
+
declare const isValidConversationType: (conversation: number) => boolean;
|
|
4740
|
+
declare const isValidEnum: (param: {
|
|
4741
|
+
value: unknown;
|
|
4742
|
+
type: object;
|
|
4743
|
+
}) => boolean;
|
|
4744
|
+
/**
|
|
4745
|
+
* 检查是否是有效的 targetId
|
|
4746
|
+
*/
|
|
4747
|
+
declare const isValidTargetId: (value: any) => boolean;
|
|
4748
|
+
/**
|
|
4749
|
+
* 检查是否是有效的 groupId
|
|
4750
|
+
*/
|
|
4751
|
+
declare const isValidGroupId: (value: any) => boolean;
|
|
4752
|
+
/**
|
|
4753
|
+
* 判断是否是一个有效的文件类型
|
|
4754
|
+
*/
|
|
4755
|
+
declare const isValidFileType: (fileType: number) => boolean;
|
|
4756
|
+
|
|
4757
|
+
declare class Codec$1<T> {
|
|
4758
|
+
#private;
|
|
4759
|
+
private readonly pbModules;
|
|
4760
|
+
constructor(
|
|
4761
|
+
/**
|
|
4762
|
+
* proto 协议描述
|
|
4763
|
+
*/
|
|
4764
|
+
desc: string);
|
|
4765
|
+
/**
|
|
4766
|
+
* PB 数据序列化
|
|
4767
|
+
* @param pbname - PB 名称
|
|
4768
|
+
* @param params - 待序列化数据
|
|
4769
|
+
*/
|
|
4770
|
+
encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
|
|
4771
|
+
/**
|
|
4772
|
+
* 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
|
|
4773
|
+
* @param pbname 待解码数据的 PB 名
|
|
4774
|
+
* @param data 待解码数据
|
|
4775
|
+
*/
|
|
4776
|
+
decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
|
|
4777
|
+
}
|
|
4778
|
+
|
|
4494
4779
|
/**
|
|
4495
4780
|
* 翻译模式
|
|
4496
4781
|
*/
|
|
@@ -5247,11 +5532,11 @@ interface IUpdateItem {
|
|
|
5247
5532
|
};
|
|
5248
5533
|
}
|
|
5249
5534
|
/** [EN]
|
|
5250
|
-
*
|
|
5535
|
+
* Conversation data
|
|
5251
5536
|
* @category Interface
|
|
5252
5537
|
*/
|
|
5253
5538
|
/**
|
|
5254
|
-
*
|
|
5539
|
+
* 会话数据
|
|
5255
5540
|
* @category Interface
|
|
5256
5541
|
*/
|
|
5257
5542
|
interface IReceivedConversation {
|
|
@@ -5448,6 +5733,15 @@ interface IReceivedConversation {
|
|
|
5448
5733
|
* @since 5.28.0
|
|
5449
5734
|
*/
|
|
5450
5735
|
editedMessageDraft?: IEditedMessageDraft;
|
|
5736
|
+
/** [EN]
|
|
5737
|
+
* Whether the conversation contains a robot, currently only supported for single chat and system sessions.
|
|
5738
|
+
* @since 5.30.0
|
|
5739
|
+
*/
|
|
5740
|
+
/**
|
|
5741
|
+
* 是否包含机器人,当前仅支持单聊、系统会话。
|
|
5742
|
+
* @since 5.30.0
|
|
5743
|
+
*/
|
|
5744
|
+
includeRobot?: boolean;
|
|
5451
5745
|
}
|
|
5452
5746
|
/** [EN]
|
|
5453
5747
|
* @category Interface
|
|
@@ -5789,6 +6083,114 @@ interface IGetUnreadMentionMeConversationListParams {
|
|
|
5789
6083
|
*/
|
|
5790
6084
|
conversationTypes: ConversationType[];
|
|
5791
6085
|
}
|
|
6086
|
+
/**
|
|
6087
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6088
|
+
* @since 5.32.0
|
|
6089
|
+
*/
|
|
6090
|
+
declare enum TagFilterStrategy {
|
|
6091
|
+
/**
|
|
6092
|
+
* 用于获取包含任一标签的会话列表(逻辑或)
|
|
6093
|
+
*/
|
|
6094
|
+
UNION = 0,
|
|
6095
|
+
/**
|
|
6096
|
+
* 用于获取包含所有标签的会话列表(逻辑与)
|
|
6097
|
+
*/
|
|
6098
|
+
INTERSECTION = 1,
|
|
6099
|
+
/**
|
|
6100
|
+
* 用于获取不包含指定标签的会话列表(逻辑非)
|
|
6101
|
+
*/
|
|
6102
|
+
EXCLUSION = 2
|
|
6103
|
+
}
|
|
6104
|
+
/**
|
|
6105
|
+
* 标签过滤器
|
|
6106
|
+
* @since 5.32.0
|
|
6107
|
+
*/
|
|
6108
|
+
interface IConversationTagFilter {
|
|
6109
|
+
/**
|
|
6110
|
+
* 标签 ID 列表,不传或为 [] 时,不进行标签过滤
|
|
6111
|
+
*/
|
|
6112
|
+
tagIds?: string[];
|
|
6113
|
+
/**
|
|
6114
|
+
* 标签内是否置顶优先,默认 false;当 tagIds 为空时,该参数无效
|
|
6115
|
+
*/
|
|
6116
|
+
topPriority?: boolean;
|
|
6117
|
+
/**
|
|
6118
|
+
* 标签过滤策略,默认使用 TagFilterStrategy.UNION,取标签下的会话列表并集;当 tagIds 为空时,该参数无效
|
|
6119
|
+
* @hidden - 本期不对外,后续拓展预留
|
|
6120
|
+
*/
|
|
6121
|
+
strategy?: TagFilterStrategy;
|
|
6122
|
+
}
|
|
6123
|
+
/**
|
|
6124
|
+
* @since 5.32.0
|
|
6125
|
+
*/
|
|
6126
|
+
interface IConversationListLoaderOptions {
|
|
6127
|
+
/**
|
|
6128
|
+
* 会话类型筛选,不传或为 [] 时,取全部类型会话(不支持超级群会话类型)
|
|
6129
|
+
*/
|
|
6130
|
+
conversationTypes?: ConversationType[];
|
|
6131
|
+
/**
|
|
6132
|
+
* tag 过滤器,不传则不过滤
|
|
6133
|
+
*/
|
|
6134
|
+
tagFilter?: IConversationTagFilter;
|
|
6135
|
+
/**
|
|
6136
|
+
* 排序方向,默认值为 0;有效值如下:
|
|
6137
|
+
* * 0 - 表示按时间降序,从最新的会话开始
|
|
6138
|
+
* * 1 - 表示按时间升序,从最早的会话开始
|
|
6139
|
+
*/
|
|
6140
|
+
order?: 0 | 1;
|
|
6141
|
+
/**
|
|
6142
|
+
* 频道 Id,不传则取全部会话,传任意字符串都视为有效 channelId,包括 "" 空字符串
|
|
6143
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6144
|
+
*/
|
|
6145
|
+
channelId?: string;
|
|
6146
|
+
/**
|
|
6147
|
+
* 是否置顶优先。
|
|
6148
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6149
|
+
*/
|
|
6150
|
+
topPriority?: boolean;
|
|
6151
|
+
/**
|
|
6152
|
+
* 获取包含未读消息的会话
|
|
6153
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6154
|
+
*/
|
|
6155
|
+
hasUnreadMessage?: boolean;
|
|
6156
|
+
/**
|
|
6157
|
+
* 获取免打扰会话
|
|
6158
|
+
* @hidden - 本期不实现,不对外,后续拓展预留
|
|
6159
|
+
*/
|
|
6160
|
+
muted?: boolean;
|
|
6161
|
+
}
|
|
6162
|
+
/** [EN]
|
|
6163
|
+
* Get Conversation List Containing Robots Option, currently only supported for single chat and system sessions.
|
|
6164
|
+
* @since 5.32.0
|
|
6165
|
+
*/
|
|
6166
|
+
/**
|
|
6167
|
+
* 获取包含机器人的会话列表参数
|
|
6168
|
+
* @since 5.32.0
|
|
6169
|
+
*/
|
|
6170
|
+
interface IGetConversationsIncludingRobotsOption {
|
|
6171
|
+
/** [EN]
|
|
6172
|
+
* Conversation types, currently only supported for single chat and system sessions.
|
|
6173
|
+
*/
|
|
6174
|
+
/**
|
|
6175
|
+
* 会话类型列表,目前仅支持单聊会话、系统会话。
|
|
6176
|
+
*/
|
|
6177
|
+
conversationTypes: ConversationType[];
|
|
6178
|
+
/** [EN]
|
|
6179
|
+
* Get robot count, valid value range [1, 100]
|
|
6180
|
+
*/
|
|
6181
|
+
/**
|
|
6182
|
+
* 获取机器人数量,有效值范围 [1, 100]
|
|
6183
|
+
*/
|
|
6184
|
+
count: number;
|
|
6185
|
+
/**
|
|
6186
|
+
* 时间戳
|
|
6187
|
+
*/
|
|
6188
|
+
timestamp: number;
|
|
6189
|
+
/**
|
|
6190
|
+
* 是否置顶优先,默认 false;该参数仅 Electron 平台支持
|
|
6191
|
+
*/
|
|
6192
|
+
topPriority?: boolean;
|
|
6193
|
+
}
|
|
5792
6194
|
|
|
5793
6195
|
/** [EN]
|
|
5794
6196
|
* Read receipt response information
|
|
@@ -6310,82 +6712,44 @@ interface IFirstUnreadMessageInfo {
|
|
|
6310
6712
|
/**
|
|
6311
6713
|
* @category Interface
|
|
6312
6714
|
*/
|
|
6313
|
-
|
|
6715
|
+
declare type IUserProfile = IUserExtraValueInMessage;
|
|
6716
|
+
/** [EN]
|
|
6717
|
+
* Operation details
|
|
6718
|
+
* @category Interface
|
|
6719
|
+
*/
|
|
6720
|
+
/**
|
|
6721
|
+
* 操作明细信息
|
|
6722
|
+
* @category Interface
|
|
6723
|
+
*/
|
|
6724
|
+
interface IOperateInfo {
|
|
6314
6725
|
/** [EN]
|
|
6315
|
-
*
|
|
6726
|
+
* Target ID
|
|
6316
6727
|
*/
|
|
6317
6728
|
/**
|
|
6318
|
-
*
|
|
6729
|
+
* 操作目标 ID
|
|
6319
6730
|
*/
|
|
6320
|
-
|
|
6731
|
+
targetId: string;
|
|
6321
6732
|
/** [EN]
|
|
6322
|
-
*
|
|
6733
|
+
* Channel ID
|
|
6323
6734
|
*/
|
|
6324
6735
|
/**
|
|
6325
|
-
*
|
|
6736
|
+
* 频道 ID
|
|
6326
6737
|
*/
|
|
6327
|
-
|
|
6738
|
+
channelId?: string;
|
|
6328
6739
|
/** [EN]
|
|
6329
|
-
* User
|
|
6330
|
-
* @deprecated
|
|
6740
|
+
* User ID
|
|
6331
6741
|
*/
|
|
6332
6742
|
/**
|
|
6333
|
-
*
|
|
6334
|
-
* @deprecated
|
|
6743
|
+
* 用户 ID
|
|
6335
6744
|
*/
|
|
6336
|
-
|
|
6745
|
+
userId: string;
|
|
6337
6746
|
/** [EN]
|
|
6338
|
-
*
|
|
6747
|
+
* Operation type
|
|
6339
6748
|
*/
|
|
6340
6749
|
/**
|
|
6341
|
-
*
|
|
6750
|
+
* 操作类型
|
|
6342
6751
|
*/
|
|
6343
|
-
|
|
6344
|
-
/** [EN]
|
|
6345
|
-
* User avatar URL (compatible with mobile devices)
|
|
6346
|
-
*/
|
|
6347
|
-
/**
|
|
6348
|
-
* 用户头像地址(向移动端兼容)
|
|
6349
|
-
*/
|
|
6350
|
-
portrait?: string;
|
|
6351
|
-
}
|
|
6352
|
-
/** [EN]
|
|
6353
|
-
* Operation details
|
|
6354
|
-
* @category Interface
|
|
6355
|
-
*/
|
|
6356
|
-
/**
|
|
6357
|
-
* 操作明细信息
|
|
6358
|
-
* @category Interface
|
|
6359
|
-
*/
|
|
6360
|
-
interface IOperateInfo {
|
|
6361
|
-
/** [EN]
|
|
6362
|
-
* Target ID
|
|
6363
|
-
*/
|
|
6364
|
-
/**
|
|
6365
|
-
* 操作目标 ID
|
|
6366
|
-
*/
|
|
6367
|
-
targetId: string;
|
|
6368
|
-
/** [EN]
|
|
6369
|
-
* Channel ID
|
|
6370
|
-
*/
|
|
6371
|
-
/**
|
|
6372
|
-
* 频道 ID
|
|
6373
|
-
*/
|
|
6374
|
-
channelId?: string;
|
|
6375
|
-
/** [EN]
|
|
6376
|
-
* User ID
|
|
6377
|
-
*/
|
|
6378
|
-
/**
|
|
6379
|
-
* 用户 ID
|
|
6380
|
-
*/
|
|
6381
|
-
userId: string;
|
|
6382
|
-
/** [EN]
|
|
6383
|
-
* Operation type
|
|
6384
|
-
*/
|
|
6385
|
-
/**
|
|
6386
|
-
* 操作类型
|
|
6387
|
-
*/
|
|
6388
|
-
operationType: OperateStatus;
|
|
6752
|
+
operationType: OperateStatus;
|
|
6389
6753
|
/** [EN]
|
|
6390
6754
|
* Timestamp when the server receives the user operation.
|
|
6391
6755
|
*/
|
|
@@ -6477,6 +6841,9 @@ interface IOperateStatusNotify {
|
|
|
6477
6841
|
*/
|
|
6478
6842
|
summary: IOperateSummary[];
|
|
6479
6843
|
}
|
|
6844
|
+
/**
|
|
6845
|
+
* 消息撤回配置
|
|
6846
|
+
*/
|
|
6480
6847
|
declare type IRecallMsgOptions = {
|
|
6481
6848
|
/**
|
|
6482
6849
|
* 消息的唯一 id,客户端依赖此属性查找要撤回的消息
|
|
@@ -6526,9 +6893,9 @@ declare type IRecallMsgOptions = {
|
|
|
6526
6893
|
isAdmin?: boolean;
|
|
6527
6894
|
};
|
|
6528
6895
|
/**
|
|
6529
|
-
*
|
|
6896
|
+
* 消息发送配置项
|
|
6530
6897
|
*/
|
|
6531
|
-
interface
|
|
6898
|
+
interface IMessageSendOptions {
|
|
6532
6899
|
/**
|
|
6533
6900
|
* 消息类型,即消息结构的 ObjectName
|
|
6534
6901
|
*/
|
|
@@ -6551,28 +6918,10 @@ interface ISendMsgOptions {
|
|
|
6551
6918
|
extra?: string;
|
|
6552
6919
|
};
|
|
6553
6920
|
/**
|
|
6554
|
-
*
|
|
6555
|
-
* @description
|
|
6556
|
-
*/
|
|
6557
|
-
isPersited?: boolean;
|
|
6558
|
-
/**
|
|
6559
|
-
* 是否计数
|
|
6560
|
-
* @description 只在发送未注册过的自定义消息时有效,否则使用注册时的配置
|
|
6561
|
-
*/
|
|
6562
|
-
isCounted?: boolean;
|
|
6563
|
-
/**
|
|
6564
|
-
* 是否是状态消息,一般为无需注册的自定义消息
|
|
6565
|
-
* @description
|
|
6566
|
-
* 1. 状态消息只有 pub,没有 ack 应答
|
|
6567
|
-
* 2. 状态消息默认不存储,不计数,`isPersited` 与 `isCounted` 配置将失效
|
|
6921
|
+
* 发送时指定消息是否为状态消息,仅对 Web 端有效;
|
|
6922
|
+
* @description 该属性为 Web 端特有属性,为保持向前兼容,因此保留;理论上应该在注册消息时设置消息类型是否是状态消息,之后不可更改。
|
|
6568
6923
|
*/
|
|
6569
6924
|
isStatusMessage?: boolean;
|
|
6570
|
-
/**
|
|
6571
|
-
* 是否发送静默消息
|
|
6572
|
-
* @description
|
|
6573
|
-
* 当值为 `true` 时,服务器将不会发送 Push 信息,移动端也不会弹出本地通知提醒
|
|
6574
|
-
*/
|
|
6575
|
-
disableNotification?: boolean;
|
|
6576
6925
|
/**
|
|
6577
6926
|
* Push 信息
|
|
6578
6927
|
*/
|
|
@@ -6587,11 +6936,12 @@ interface ISendMsgOptions {
|
|
|
6587
6936
|
isMentioned?: boolean;
|
|
6588
6937
|
/**
|
|
6589
6938
|
* `@` 消息类型
|
|
6590
|
-
* @
|
|
6939
|
+
* @deprecated 推荐使用 content.mentionedInfo.type
|
|
6591
6940
|
*/
|
|
6592
|
-
mentionedType?:
|
|
6941
|
+
mentionedType?: MentionedType;
|
|
6593
6942
|
/**
|
|
6594
6943
|
* 被 @ 的用户 Id 列表,当 `mentionedType` 值为 `1` 时,该值可为空
|
|
6944
|
+
* @deprecated 推荐使用 content.mentionedInfo.userIdList
|
|
6595
6945
|
*/
|
|
6596
6946
|
mentionedUserIdList?: string[];
|
|
6597
6947
|
/**
|
|
@@ -6613,8 +6963,7 @@ interface ISendMsgOptions {
|
|
|
6613
6963
|
[key: string]: string;
|
|
6614
6964
|
};
|
|
6615
6965
|
/**
|
|
6616
|
-
*
|
|
6617
|
-
* @todo 功能未知,需确认
|
|
6966
|
+
* 过滤黑/白名单?TODO:功能未知,需确认
|
|
6618
6967
|
*/
|
|
6619
6968
|
isFilerWhiteBlacklist?: boolean;
|
|
6620
6969
|
/**
|
|
@@ -6622,11 +6971,11 @@ interface ISendMsgOptions {
|
|
|
6622
6971
|
*/
|
|
6623
6972
|
pushConfig?: IPushConfig;
|
|
6624
6973
|
/**
|
|
6625
|
-
*
|
|
6974
|
+
* 是否发送静默消息
|
|
6626
6975
|
* @description
|
|
6627
|
-
*
|
|
6976
|
+
* 当值为 `true` 时,服务器将不会发送 Push 信息,移动端也不会弹出本地通知提醒
|
|
6628
6977
|
*/
|
|
6629
|
-
|
|
6978
|
+
disableNotification?: boolean;
|
|
6630
6979
|
/**
|
|
6631
6980
|
* 客户端的消息标识
|
|
6632
6981
|
* 重发消息时用到,重发消息的消息 ID
|
|
@@ -8147,6 +8496,101 @@ interface ITextMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMes
|
|
|
8147
8496
|
*/
|
|
8148
8497
|
translateInfo?: TranslateInfo;
|
|
8149
8498
|
}
|
|
8499
|
+
/**
|
|
8500
|
+
* 服务器端定义的撤回通知消息结构,因历史原因,与 Electron 对外暴露的结构不一致
|
|
8501
|
+
* @hidden
|
|
8502
|
+
*/
|
|
8503
|
+
interface ISvrRecallNotificationMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMessage {
|
|
8504
|
+
/**
|
|
8505
|
+
* 发起撤回的用户 ID
|
|
8506
|
+
*/
|
|
8507
|
+
operatorId?: string;
|
|
8508
|
+
/**
|
|
8509
|
+
* 被撤回的原始消息的发送时间,单位:毫秒
|
|
8510
|
+
*/
|
|
8511
|
+
recallTime: number;
|
|
8512
|
+
/**
|
|
8513
|
+
* 被撤回的原始消息的类型
|
|
8514
|
+
*/
|
|
8515
|
+
originalObjectName?: string;
|
|
8516
|
+
/**
|
|
8517
|
+
* 被撤回的原始消息的内容
|
|
8518
|
+
*/
|
|
8519
|
+
originalMessageContent?: any;
|
|
8520
|
+
/**
|
|
8521
|
+
* 被撤回的文本消息内容
|
|
8522
|
+
*/
|
|
8523
|
+
recallContent?: string;
|
|
8524
|
+
/**
|
|
8525
|
+
* 撤回消息的发送时间,单位:毫秒
|
|
8526
|
+
*/
|
|
8527
|
+
recallActionTime?: number;
|
|
8528
|
+
/**
|
|
8529
|
+
* 是否为管理员操作
|
|
8530
|
+
*/
|
|
8531
|
+
admin?: boolean;
|
|
8532
|
+
/**
|
|
8533
|
+
* 是否删除接收端本地存储的原始消息
|
|
8534
|
+
*/
|
|
8535
|
+
delete?: boolean;
|
|
8536
|
+
/**
|
|
8537
|
+
* 撤回消息时携带的扩展信息
|
|
8538
|
+
*/
|
|
8539
|
+
extra?: string;
|
|
8540
|
+
}
|
|
8541
|
+
/** [EN]
|
|
8542
|
+
* Recall notification message content data
|
|
8543
|
+
* @category Interface
|
|
8544
|
+
*/
|
|
8545
|
+
/**
|
|
8546
|
+
* 撤回通知消息 content 数据
|
|
8547
|
+
* @category Interface
|
|
8548
|
+
*/
|
|
8549
|
+
interface IRecallNotificationMessageContent extends Partial<ISvrRecallNotificationMessageContent> {
|
|
8550
|
+
/**
|
|
8551
|
+
* Electron 历史版本中使用错误,目前已废弃,请使用 `delete` 替代
|
|
8552
|
+
* @deprecated - 已废弃,请使用 `delete` 替代
|
|
8553
|
+
*/
|
|
8554
|
+
isDelete?: boolean;
|
|
8555
|
+
}
|
|
8556
|
+
/**
|
|
8557
|
+
* 撤回命令消息 content 数据
|
|
8558
|
+
* @category Interface
|
|
8559
|
+
*/
|
|
8560
|
+
interface IRecallCommandMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMessage {
|
|
8561
|
+
/**
|
|
8562
|
+
* 会话类型
|
|
8563
|
+
*/
|
|
8564
|
+
conversationType: ConversationType;
|
|
8565
|
+
/**
|
|
8566
|
+
* 会话 TargetId
|
|
8567
|
+
*/
|
|
8568
|
+
targetId: string;
|
|
8569
|
+
/**
|
|
8570
|
+
* 会话 ChannelId
|
|
8571
|
+
*/
|
|
8572
|
+
channelId?: string;
|
|
8573
|
+
/**
|
|
8574
|
+
* 被撤回消息的唯一标识
|
|
8575
|
+
*/
|
|
8576
|
+
messageUId: string;
|
|
8577
|
+
/**
|
|
8578
|
+
* 被撤回消息的发送时间,Web 端依赖该时间对消息进行排序和会话更新处理
|
|
8579
|
+
*/
|
|
8580
|
+
sentTime: number;
|
|
8581
|
+
/**
|
|
8582
|
+
* 是否删除接收端本地存储的原始消息,对 Web 平台无效
|
|
8583
|
+
*/
|
|
8584
|
+
isDelete?: boolean;
|
|
8585
|
+
/**
|
|
8586
|
+
* 是否为管理员操作,当值为 true 时,允许撤回非本人发送的消息
|
|
8587
|
+
*/
|
|
8588
|
+
isAdmin?: boolean;
|
|
8589
|
+
/**
|
|
8590
|
+
* 撤回定向消息时,指定定向消息的接收者列表
|
|
8591
|
+
*/
|
|
8592
|
+
directionalUserIdList?: string[];
|
|
8593
|
+
}
|
|
8150
8594
|
|
|
8151
8595
|
/** [EN]
|
|
8152
8596
|
* @category Interface
|
|
@@ -9038,12 +9482,6 @@ interface INetwork {
|
|
|
9038
9482
|
type: NetworkType;
|
|
9039
9483
|
}
|
|
9040
9484
|
|
|
9041
|
-
interface IRTCRoomInfo {
|
|
9042
|
-
roomId: string;
|
|
9043
|
-
roomData: unknown[];
|
|
9044
|
-
userCount: number;
|
|
9045
|
-
list: unknown[];
|
|
9046
|
-
}
|
|
9047
9485
|
/** @deprecated */
|
|
9048
9486
|
interface IRtcTokenData {
|
|
9049
9487
|
rtcToken: string;
|
|
@@ -9426,6 +9864,7 @@ declare class RCResult<T = void> {
|
|
|
9426
9864
|
* @hidden
|
|
9427
9865
|
*/
|
|
9428
9866
|
constructor(code: number, msg: string, data?: T);
|
|
9867
|
+
static from<T = void>(code: number, msg?: string, data?: T): RCResult<T>;
|
|
9429
9868
|
/**
|
|
9430
9869
|
* 结果为 ok 时,进行后续异步操作
|
|
9431
9870
|
* @hidden
|
|
@@ -9587,12 +10026,18 @@ declare class Validator {
|
|
|
9587
10026
|
isObject(key: string, value: unknown, required?: boolean): Validator;
|
|
9588
10027
|
/** Object 类型检查 */
|
|
9589
10028
|
assertObject(key: string, value: unknown, required?: boolean): Validator;
|
|
9590
|
-
|
|
10029
|
+
isStringEnum<T extends Object>(key: string, value: unknown, target: T, required?: boolean): Validator;
|
|
10030
|
+
isNumberEnum<T extends Object>(key: string, value: unknown, target: T, required?: boolean): Validator;
|
|
9591
10031
|
assertValueOf<T extends Object>(key: string, value: unknown, target: T, required?: boolean): Validator;
|
|
9592
10032
|
isFunction(key: string, value: unknown, required?: boolean): Validator;
|
|
9593
10033
|
assertFunction(key: string, value: unknown, required?: boolean): Validator;
|
|
9594
10034
|
}
|
|
9595
10035
|
|
|
10036
|
+
declare const promiseWithResolvers: <T = void>() => {
|
|
10037
|
+
resolve: (value: T) => void;
|
|
10038
|
+
promise: Promise<T>;
|
|
10039
|
+
};
|
|
10040
|
+
|
|
9596
10041
|
interface IServerAddressData {
|
|
9597
10042
|
addr: string;
|
|
9598
10043
|
protocol: EConnectProtocol;
|
|
@@ -9960,6 +10405,13 @@ interface INaviInfo {
|
|
|
9960
10405
|
* 消息修改时间限制,单位:分钟
|
|
9961
10406
|
*/
|
|
9962
10407
|
msgModifyMinute?: number;
|
|
10408
|
+
/**
|
|
10409
|
+
* 是否开启单群聊消息撤回优化;(0 关闭,1 开启)
|
|
10410
|
+
* 开启后:
|
|
10411
|
+
* 1. 服务器会话列表 latestMessage 和历史消息中将存储 RC:RcNtf 消息。
|
|
10412
|
+
* 2. 拉取历史消息时,不再返回 RC:RcCmd 消息。
|
|
10413
|
+
*/
|
|
10414
|
+
supportRecallRefactor?: 0 | 1;
|
|
9963
10415
|
}
|
|
9964
10416
|
|
|
9965
10417
|
/** [EN]
|
|
@@ -9970,6 +10422,7 @@ interface INaviInfo {
|
|
|
9970
10422
|
* 异步任务结果
|
|
9971
10423
|
* @description 该结构即将废弃,请使用 {@link RCResult} 替代
|
|
9972
10424
|
* @category Interface
|
|
10425
|
+
* @deprecated 请使用 {@link RCResult} 替代
|
|
9973
10426
|
*/
|
|
9974
10427
|
interface IAsyncRes<T = void> extends Pick<RCResult<T>, 'code' | 'data'> {
|
|
9975
10428
|
msg?: string;
|
|
@@ -10628,10 +11081,10 @@ interface IFriendInfoChangedSync {
|
|
|
10628
11081
|
*/
|
|
10629
11082
|
interface IPagingQueryOption {
|
|
10630
11083
|
/** [EN]
|
|
10631
|
-
* Number of items per page,
|
|
11084
|
+
* Number of items per page, valid value [1, 100], default value 50
|
|
10632
11085
|
*/
|
|
10633
11086
|
/**
|
|
10634
|
-
*
|
|
11087
|
+
* 每页条数,有效值 [1, 100],默认值 50
|
|
10635
11088
|
*/
|
|
10636
11089
|
count: number;
|
|
10637
11090
|
/** [EN]
|
|
@@ -10642,13 +11095,22 @@ interface IPagingQueryOption {
|
|
|
10642
11095
|
*/
|
|
10643
11096
|
pageToken?: string;
|
|
10644
11097
|
/** [EN]
|
|
10645
|
-
* Sort type: Supports setting the order for retrieval. `true`: ascending order; `false`: descending order. Default is `
|
|
11098
|
+
* Sort type: Supports setting the order for retrieval. `true`: ascending order; `false`: descending order. Default is `false`.
|
|
10646
11099
|
*/
|
|
10647
11100
|
/**
|
|
10648
|
-
*
|
|
11101
|
+
* 排序类型:支持设置正序、倒序获取。`true`:正序;`false`:倒序。默认为 `false`
|
|
10649
11102
|
*/
|
|
10650
11103
|
order?: boolean;
|
|
10651
11104
|
}
|
|
11105
|
+
interface IGetGroupMembersOption extends IPagingQueryOption {
|
|
11106
|
+
/** [EN]
|
|
11107
|
+
* Robot filter rule
|
|
11108
|
+
*/
|
|
11109
|
+
/**
|
|
11110
|
+
* 机器人过滤
|
|
11111
|
+
*/
|
|
11112
|
+
filterRobotType?: FilterRobotType;
|
|
11113
|
+
}
|
|
10652
11114
|
/** [EN]
|
|
10653
11115
|
* Pagination request result
|
|
10654
11116
|
* @category Interface
|
|
@@ -10713,9 +11175,7 @@ interface IGroupInfoOption extends IGroupBaseInfo {
|
|
|
10713
11175
|
/**
|
|
10714
11176
|
* 扩展消息
|
|
10715
11177
|
*/
|
|
10716
|
-
extProfile?:
|
|
10717
|
-
[key: string]: string;
|
|
10718
|
-
};
|
|
11178
|
+
extProfile?: Record<string, string>;
|
|
10719
11179
|
/** [EN]
|
|
10720
11180
|
* Active join group permission mode
|
|
10721
11181
|
*/
|
|
@@ -10930,6 +11390,14 @@ interface IGroupMemberInfo {
|
|
|
10930
11390
|
* 入群时间:时间戳,精确到毫秒
|
|
10931
11391
|
*/
|
|
10932
11392
|
joinedTime?: number;
|
|
11393
|
+
/** [EN]
|
|
11394
|
+
* Whether the group member is a robot
|
|
11395
|
+
*/
|
|
11396
|
+
/**
|
|
11397
|
+
* 标识成员是否为机器人
|
|
11398
|
+
* @since 5.30.0
|
|
11399
|
+
*/
|
|
11400
|
+
isRobot?: boolean;
|
|
10933
11401
|
}
|
|
10934
11402
|
/** [EN]
|
|
10935
11403
|
* Special attention information
|
|
@@ -11390,6 +11858,14 @@ interface IServerGroupBaseInfo {
|
|
|
11390
11858
|
profilePerm?: number;
|
|
11391
11859
|
memProfilePerm?: number;
|
|
11392
11860
|
}
|
|
11861
|
+
interface IMemberInviteResponse {
|
|
11862
|
+
groupId: string;
|
|
11863
|
+
inviterId: string;
|
|
11864
|
+
optType: GroupOperationRole;
|
|
11865
|
+
optResult: GroupOperationStatus;
|
|
11866
|
+
joinUserId?: string;
|
|
11867
|
+
reason?: string;
|
|
11868
|
+
}
|
|
11393
11869
|
|
|
11394
11870
|
interface INotificationQuietHoursSetting {
|
|
11395
11871
|
/** [EN]
|
|
@@ -11453,34 +11929,57 @@ declare function getMessageTypeDescription(type: string): MessageTypeDescription
|
|
|
11453
11929
|
*/
|
|
11454
11930
|
declare function hasMessageTypeDescription(type: string): boolean;
|
|
11455
11931
|
|
|
11932
|
+
/** [EN]
|
|
11933
|
+
* Get Conversation List By Timestamp Params
|
|
11934
|
+
*/
|
|
11456
11935
|
/**
|
|
11457
11936
|
* 按时间戳查询会话列表参数
|
|
11458
11937
|
*/
|
|
11459
11938
|
declare type IGetConversationListByTimestampParams = {
|
|
11939
|
+
/** [EN]
|
|
11940
|
+
* Get Conversation Start Time, precision to milliseconds, 0 represents the current time
|
|
11941
|
+
*/
|
|
11460
11942
|
/**
|
|
11461
11943
|
* 获取会话起始时间,需要精确到毫秒,0 表示当前时间
|
|
11462
11944
|
*/
|
|
11463
11945
|
startTime: number;
|
|
11946
|
+
/** [EN]
|
|
11947
|
+
* Get Conversation Count
|
|
11948
|
+
*/
|
|
11464
11949
|
/**
|
|
11465
11950
|
* 分页数量
|
|
11466
11951
|
*/
|
|
11467
11952
|
count: number;
|
|
11953
|
+
/** [EN]
|
|
11954
|
+
* Get Conversation Order. The parameter is invalid for Electron platform, and the default value is 0 for Electron platform;
|
|
11955
|
+
* * 0 - Query from startTime forward, data sorted by time in descending order
|
|
11956
|
+
* * 1 - Query from startTime backward, data sorted by time in ascending order
|
|
11957
|
+
*/
|
|
11468
11958
|
/**
|
|
11469
11959
|
* 查询方向。该参数对 Electron 平台无效,Electron 平台下始终为 0;
|
|
11470
11960
|
* * 0 - 从 startTime 开始向前查询,数据按时间降序排序
|
|
11471
11961
|
* * 1 - 从 startTime 开始向后查询,数据按时间升序排序
|
|
11472
11962
|
*/
|
|
11473
11963
|
order?: 0 | 1;
|
|
11964
|
+
/** [EN]
|
|
11965
|
+
* Get Conversation Channel Id, used for multi-organization scene query; only Electron platform is valid
|
|
11966
|
+
*/
|
|
11474
11967
|
/**
|
|
11475
11968
|
* 单、群聊会话的组织 ID,用于多组织场景查询;仅 Electron 平台有效
|
|
11476
11969
|
*/
|
|
11477
11970
|
channelId?: string;
|
|
11971
|
+
/** [EN]
|
|
11972
|
+
* Get Conversation Top Priority, only Electron platform is valid
|
|
11973
|
+
*/
|
|
11478
11974
|
/**
|
|
11479
|
-
*
|
|
11975
|
+
* 是否置顶优先,仅对 Electron 平台有效
|
|
11480
11976
|
*/
|
|
11481
11977
|
topPriority?: boolean;
|
|
11978
|
+
/** [EN]
|
|
11979
|
+
* Get Conversation Types; the value is empty or the length is 0 to get all conversation types
|
|
11980
|
+
*/
|
|
11482
11981
|
/**
|
|
11483
|
-
* 会话类型,值为空或长度为 0
|
|
11982
|
+
* 会话类型,值为空或长度为 0 时,获取全部会话类型
|
|
11484
11983
|
*/
|
|
11485
11984
|
conversationTypes?: ConversationType[];
|
|
11486
11985
|
};
|
|
@@ -11669,7 +12168,7 @@ interface IProcessCache {
|
|
|
11669
12168
|
deltaTime: number;
|
|
11670
12169
|
}
|
|
11671
12170
|
/**
|
|
11672
|
-
*
|
|
12171
|
+
* 约束跨平台、跨进程通信方法定义,以便于代码检查
|
|
11673
12172
|
*/
|
|
11674
12173
|
interface IIPCMethods {
|
|
11675
12174
|
/**
|
|
@@ -11681,7 +12180,7 @@ interface IIPCMethods {
|
|
|
11681
12180
|
* @param token
|
|
11682
12181
|
* @param reconnectKickEnable
|
|
11683
12182
|
*/
|
|
11684
|
-
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string):
|
|
12183
|
+
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): Promise<RCResult<string>>;
|
|
11685
12184
|
getNaviInfoFromCache(): INaviInfo | null;
|
|
11686
12185
|
/**
|
|
11687
12186
|
* 上报版本信息
|
|
@@ -11824,11 +12323,11 @@ interface IIPCMethods {
|
|
|
11824
12323
|
clearTextMessageDraft(conversation: IConversationOption): Promise<RCResult>;
|
|
11825
12324
|
getConversationNotificationLevel(conversation: IConversationOption): Promise<RCResult<NotificationLevel>>;
|
|
11826
12325
|
getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<RCResult<number>>;
|
|
11827
|
-
sendMessage(
|
|
12326
|
+
sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
11828
12327
|
/**
|
|
11829
12328
|
* 断开连接
|
|
11830
12329
|
*/
|
|
11831
|
-
disconnect(closeDB?: boolean, disablePush?: boolean): Promise<
|
|
12330
|
+
disconnect(closeDB?: boolean, disablePush?: boolean): Promise<RCResult>;
|
|
11832
12331
|
/**
|
|
11833
12332
|
* 消息注册
|
|
11834
12333
|
* @description
|
|
@@ -11890,11 +12389,19 @@ interface IIPCMethods {
|
|
|
11890
12389
|
*/
|
|
11891
12390
|
setCheckChatRoomDuplicateMessage(enableCheck: boolean): Promise<RCResult>;
|
|
11892
12391
|
/**
|
|
11893
|
-
*
|
|
12392
|
+
* 获取存储服务鉴权信息
|
|
12393
|
+
* @param fileType 文件类型
|
|
12394
|
+
* @param fileName 文件名称
|
|
12395
|
+
* @param httpMethod STC 分段上传时的必填参数,有效值为 PUT | POST
|
|
12396
|
+
* @param queryString STC 分段上传时的查询字符串
|
|
11894
12397
|
* @description
|
|
11895
|
-
*
|
|
12398
|
+
* `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
|
|
12399
|
+
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
|
|
12400
|
+
* 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
|
|
12401
|
+
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
12402
|
+
* @returns
|
|
11896
12403
|
*/
|
|
11897
|
-
getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<
|
|
12404
|
+
getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth>>;
|
|
11898
12405
|
/**
|
|
11899
12406
|
* 获取文件上传后下载地址
|
|
11900
12407
|
*/
|
|
@@ -11970,19 +12477,19 @@ interface IIPCMethods {
|
|
|
11970
12477
|
/**
|
|
11971
12478
|
* 获取群组消息已读列表
|
|
11972
12479
|
*/
|
|
11973
|
-
getMessageReader(targetId: string, messageUId: string, channelId
|
|
12480
|
+
getMessageReader(targetId: string, messageUId: string, channelId: string): Promise<RCResult<IMessageReaderResponse>>;
|
|
11974
12481
|
/**
|
|
11975
12482
|
* 发送已读回执 (V4)
|
|
11976
12483
|
*/
|
|
11977
|
-
sendReadReceiptMessageV4(conversation:
|
|
12484
|
+
sendReadReceiptMessageV4(conversation: IConversationIdentifier, startMsgUid: string, endMsgUid: string): Promise<RCResult>;
|
|
11978
12485
|
/**
|
|
11979
12486
|
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
11980
12487
|
*/
|
|
11981
|
-
getMessageReadReceiptV4(conversation:
|
|
12488
|
+
getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUid: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
|
|
11982
12489
|
/**
|
|
11983
12490
|
* 多端同步会话的已读时间 (V4)
|
|
11984
12491
|
*/
|
|
11985
|
-
updateConversationReadTime(conversation:
|
|
12492
|
+
updateConversationReadTime(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
11986
12493
|
/**
|
|
11987
12494
|
* 获取服务器时间
|
|
11988
12495
|
*/
|
|
@@ -12012,9 +12519,9 @@ interface IIPCMethods {
|
|
|
12012
12519
|
/**
|
|
12013
12520
|
* 获取用户状态
|
|
12014
12521
|
*/
|
|
12015
|
-
getUserStatus(userId: string):
|
|
12522
|
+
getUserStatus(userId: string): Promise<RCResult<{
|
|
12016
12523
|
status: string;
|
|
12017
|
-
}
|
|
12524
|
+
}>>;
|
|
12018
12525
|
/**
|
|
12019
12526
|
* 清空所有会话,目前仅 v2-adapter 中提供
|
|
12020
12527
|
*/
|
|
@@ -12022,19 +12529,19 @@ interface IIPCMethods {
|
|
|
12022
12529
|
/**
|
|
12023
12530
|
* 加入黑名单
|
|
12024
12531
|
*/
|
|
12025
|
-
addToBlacklist(userId: string): Promise<
|
|
12532
|
+
addToBlacklist(userId: string): Promise<RCResult>;
|
|
12026
12533
|
/**
|
|
12027
12534
|
* 将指定用户移除黑名单
|
|
12028
12535
|
*/
|
|
12029
|
-
removeFromBlacklist(userId: string): Promise<
|
|
12536
|
+
removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
12030
12537
|
/**
|
|
12031
12538
|
* 获取黑名单列表
|
|
12032
12539
|
*/
|
|
12033
|
-
getBlacklist():
|
|
12540
|
+
getBlacklist(): Promise<RCResult<string[]>>;
|
|
12034
12541
|
/**
|
|
12035
12542
|
* 获取指定人员在黑名单中的状态
|
|
12036
12543
|
*/
|
|
12037
|
-
getBlacklistStatus(userId: string):
|
|
12544
|
+
getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
12038
12545
|
/**
|
|
12039
12546
|
* 向本地插入一条消息,不发送到服务器
|
|
12040
12547
|
*/
|
|
@@ -12079,7 +12586,7 @@ interface IIPCMethods {
|
|
|
12079
12586
|
* 通过关键字与 channelId 搜索所有会话
|
|
12080
12587
|
*/
|
|
12081
12588
|
searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
12082
|
-
searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]):
|
|
12589
|
+
searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
12083
12590
|
/**
|
|
12084
12591
|
* 通过指定搜索策略和搜索参数,进行消息搜索
|
|
12085
12592
|
* @param params
|
|
@@ -12096,11 +12603,11 @@ interface IIPCMethods {
|
|
|
12096
12603
|
/**
|
|
12097
12604
|
* 设置消息发送状态
|
|
12098
12605
|
*/
|
|
12099
|
-
setMessageSentStatus(messageId: number, sentStatus: number): Promise<
|
|
12606
|
+
setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
12100
12607
|
/**
|
|
12101
12608
|
* 设置消息接收状态
|
|
12102
12609
|
*/
|
|
12103
|
-
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<
|
|
12610
|
+
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
12104
12611
|
/**
|
|
12105
12612
|
* 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
|
|
12106
12613
|
*/
|
|
@@ -12108,7 +12615,7 @@ interface IIPCMethods {
|
|
|
12108
12615
|
/**
|
|
12109
12616
|
* 删除时间戳前的未读数
|
|
12110
12617
|
*/
|
|
12111
|
-
clearUnreadCountByTimestamp(
|
|
12618
|
+
clearUnreadCountByTimestamp(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
12112
12619
|
/**
|
|
12113
12620
|
* 获取所有群聊会话 @ 消息未读数,不包含超级群会话
|
|
12114
12621
|
*/
|
|
@@ -12125,85 +12632,122 @@ interface IIPCMethods {
|
|
|
12125
12632
|
/**
|
|
12126
12633
|
* 设置代理
|
|
12127
12634
|
*/
|
|
12128
|
-
setProxy(proxy: IProxy | null):
|
|
12635
|
+
setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
12129
12636
|
/**
|
|
12130
12637
|
* 获取代理
|
|
12131
12638
|
*/
|
|
12132
|
-
getProxy():
|
|
12639
|
+
getProxy(): Promise<RCResult<IProxy>>;
|
|
12133
12640
|
/**
|
|
12134
12641
|
* 测试代理
|
|
12135
12642
|
*/
|
|
12136
|
-
testProxy(proxy: IProxy, testHost: string): Promise<
|
|
12643
|
+
testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
12137
12644
|
/**
|
|
12138
12645
|
* 订阅用户状态事件
|
|
12139
12646
|
*/
|
|
12140
|
-
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
12647
|
+
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
12141
12648
|
/**
|
|
12142
12649
|
* 取消订阅用户状态事件
|
|
12143
12650
|
*/
|
|
12144
|
-
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
12651
|
+
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
12145
12652
|
/**
|
|
12146
12653
|
* 获取已订阅列表
|
|
12147
12654
|
*/
|
|
12148
|
-
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<
|
|
12655
|
+
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
12149
12656
|
/**
|
|
12150
12657
|
* 获取指定用户的在线状态
|
|
12151
12658
|
*/
|
|
12152
12659
|
getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
12153
|
-
updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
12660
|
+
updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
12154
12661
|
getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
12155
|
-
getMyUserProfile(): Promise<
|
|
12156
|
-
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<
|
|
12157
|
-
getMyUserProfileVisibility(): Promise<
|
|
12158
|
-
searchUserProfileByUniqueId(uniqueId: string): Promise<
|
|
12159
|
-
createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile:
|
|
12160
|
-
|
|
12161
|
-
|
|
12162
|
-
|
|
12163
|
-
|
|
12164
|
-
|
|
12165
|
-
|
|
12166
|
-
|
|
12167
|
-
|
|
12168
|
-
|
|
12169
|
-
|
|
12170
|
-
|
|
12171
|
-
|
|
12172
|
-
|
|
12173
|
-
|
|
12174
|
-
|
|
12175
|
-
|
|
12176
|
-
|
|
12177
|
-
|
|
12178
|
-
|
|
12179
|
-
|
|
12180
|
-
|
|
12181
|
-
|
|
12182
|
-
|
|
12183
|
-
|
|
12184
|
-
|
|
12185
|
-
|
|
12186
|
-
|
|
12187
|
-
|
|
12188
|
-
|
|
12189
|
-
|
|
12190
|
-
|
|
12191
|
-
|
|
12192
|
-
addFriend(userId: string, directionType: DirectionType, extra
|
|
12193
|
-
|
|
12194
|
-
|
|
12195
|
-
|
|
12196
|
-
|
|
12197
|
-
|
|
12198
|
-
|
|
12199
|
-
|
|
12200
|
-
|
|
12201
|
-
|
|
12202
|
-
|
|
12203
|
-
|
|
12204
|
-
|
|
12205
|
-
|
|
12206
|
-
|
|
12662
|
+
getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
12663
|
+
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<RCResult>;
|
|
12664
|
+
getMyUserProfileVisibility(): Promise<RCResult<UserProfileVisibility>>;
|
|
12665
|
+
searchUserProfileByUniqueId(uniqueId: string): Promise<RCResult<IUserProfileInfo>>;
|
|
12666
|
+
createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile?: Record<string, string>, inviteeUserIds?: string[]): Promise<RCResult<ICreateGroupFail>>;
|
|
12667
|
+
updateGroupInfo(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile?: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
12668
|
+
getGroupsInfo(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
12669
|
+
kickGroupMembers(groupId: string, userIds: string[], config: Required<IQuitGroupConfig>): Promise<RCResult>;
|
|
12670
|
+
quitGroup(groupId: string, config: Required<IQuitGroupConfig>): Promise<RCResult>;
|
|
12671
|
+
dismissGroup(groupId: string): Promise<RCResult>;
|
|
12672
|
+
transferGroupOwner(groupId: string, newOwnerId: string, quitGroupAfterTransfer: boolean, config: Required<IQuitGroupConfig>): Promise<RCResult>;
|
|
12673
|
+
setGroupManagers(type: GroupOperationType, groupId: string, userIds: string[]): Promise<RCResult>;
|
|
12674
|
+
getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: Required<IGetGroupMembersOption>): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
12675
|
+
getGroupMembers(groupId: string, userIds: string[]): Promise<RCResult<IGroupMemberInfo[]>>;
|
|
12676
|
+
setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<RCResult<IErrorKeys>>;
|
|
12677
|
+
searchGroupMembers(groupId: string, nickName: string, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
12678
|
+
joinGroup(groupId: string): Promise<RCResult<IProcessCode>>;
|
|
12679
|
+
inviteUsersToGroup(groupId: string, userIds: string[]): Promise<RCResult<IProcessCode>>;
|
|
12680
|
+
memberInviteResponse(params: IMemberInviteResponse): Promise<RCResult<IProcessCode>>;
|
|
12681
|
+
getGroupApplications(option: Required<IPagingQueryOption>, directions: GroupApplicationDirection[], status: GroupApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
12682
|
+
getJoinedGroupsByRole(role: GroupMemberRole, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
12683
|
+
searchJoinedGroups(groupName: string, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
12684
|
+
getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
12685
|
+
/**
|
|
12686
|
+
* 设置/移除 群组备注名
|
|
12687
|
+
* @param groupId
|
|
12688
|
+
* @param remark 备注名,设置为 '' 代表移除
|
|
12689
|
+
*/
|
|
12690
|
+
setGroupRemark(groupId: string, remark: string): Promise<RCResult>;
|
|
12691
|
+
setGroupFollows(optType: GroupOperationType, groupId: string, userIds: string[]): Promise<RCResult>;
|
|
12692
|
+
getGroupFollows(groupId: string): Promise<RCResult<IFollowsInfo[]>>;
|
|
12693
|
+
/**
|
|
12694
|
+
* 添加好友
|
|
12695
|
+
* @param userId
|
|
12696
|
+
* @param directionType
|
|
12697
|
+
* @param extra
|
|
12698
|
+
*/
|
|
12699
|
+
addFriend(userId: string, directionType: DirectionType, extra: string): Promise<RCResult<IProcessCode>>;
|
|
12700
|
+
/**
|
|
12701
|
+
* 删除好友
|
|
12702
|
+
* @param userIds
|
|
12703
|
+
* @param directionType
|
|
12704
|
+
*/
|
|
12705
|
+
deleteFriends(userIds: string[], directionType: DirectionType): Promise<RCResult>;
|
|
12706
|
+
/**
|
|
12707
|
+
* 接受好友请求
|
|
12708
|
+
* @param userId
|
|
12709
|
+
*/
|
|
12710
|
+
acceptFriendRequest(userId: string): Promise<RCResult>;
|
|
12711
|
+
/**
|
|
12712
|
+
* 拒绝好友请求
|
|
12713
|
+
* @param userId
|
|
12714
|
+
* @param reason
|
|
12715
|
+
*/
|
|
12716
|
+
refuseFriendRequest(userId: string, reason?: string): Promise<RCResult>;
|
|
12717
|
+
/**
|
|
12718
|
+
* 设置好友信息
|
|
12719
|
+
* @param userId
|
|
12720
|
+
* @param remark
|
|
12721
|
+
* @param extProfile
|
|
12722
|
+
*/
|
|
12723
|
+
setFriendInfo(userId: string, remark: string, extProfile: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
12724
|
+
/**
|
|
12725
|
+
* 检查好友关系
|
|
12726
|
+
* @param userIds
|
|
12727
|
+
* @param directionType
|
|
12728
|
+
*/
|
|
12729
|
+
checkFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<IFriendRelationInfo[]>>;
|
|
12730
|
+
/**
|
|
12731
|
+
* 获取好友列表
|
|
12732
|
+
* @param directionType
|
|
12733
|
+
* @param option 分页查询参数,对 Electron 平台无效
|
|
12734
|
+
*/
|
|
12735
|
+
getFriends(directionType: QueryFriendsDirectionType, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IFriendInfo>>>;
|
|
12736
|
+
/**
|
|
12737
|
+
* 获取好友请求列表
|
|
12738
|
+
* @param option 分页参数
|
|
12739
|
+
* @param types 请求类型
|
|
12740
|
+
* @param status 请求状态
|
|
12741
|
+
*/
|
|
12742
|
+
getFriendApplications(option: Required<IPagingQueryOption>, types: FriendApplicationType[], status: FriendApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
12743
|
+
/**
|
|
12744
|
+
* 获取好友信息
|
|
12745
|
+
* @param userIds
|
|
12746
|
+
*/
|
|
12747
|
+
getFriendsInfo(userIds: string[]): Promise<RCResult<IFriendInfo[]>>;
|
|
12748
|
+
searchFriendsInfo(nickname: string): Promise<RCResult<IFriendInfo[]>>;
|
|
12749
|
+
setFriendAddPermission(permission: FriendAddPermission): Promise<RCResult>;
|
|
12750
|
+
getFriendAddPermission(): Promise<RCResult<FriendAddPermission>>;
|
|
12207
12751
|
setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
12208
12752
|
removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
12209
12753
|
getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
@@ -12240,12 +12784,13 @@ interface IIPCMethods {
|
|
|
12240
12784
|
* 获取自动翻译全局开关
|
|
12241
12785
|
*/
|
|
12242
12786
|
getAutoTranslateEnabled(): Promise<RCResult<boolean>>;
|
|
12243
|
-
|
|
12787
|
+
setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
12788
|
+
key: string;
|
|
12789
|
+
value: string;
|
|
12790
|
+
}>>;
|
|
12791
|
+
rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
12244
12792
|
bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<RCResult>;
|
|
12245
|
-
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<
|
|
12246
|
-
code: ErrorCode;
|
|
12247
|
-
buffer?: any;
|
|
12248
|
-
}>;
|
|
12793
|
+
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<RCResult<Uint8Array>>;
|
|
12249
12794
|
requestSpeechToTextForMessage(messageUId: string, option?: IConvertSpeechToTextOption): Promise<RCResult>;
|
|
12250
12795
|
setMessageSpeechToTextVisible(messageId: number, isVisible: boolean): Promise<RCResult>;
|
|
12251
12796
|
/**
|
|
@@ -12393,6 +12938,13 @@ interface IIPCMethods {
|
|
|
12393
12938
|
* @param includeUG 会话列表支持超级群开关
|
|
12394
12939
|
*/
|
|
12395
12940
|
getUnreadMentionMeConversationList(params: IGetUnreadMentionMeConversationListParams, includeUG: boolean): Promise<RCResult<IReceivedConversation[]>>;
|
|
12941
|
+
/**
|
|
12942
|
+
* 设置融云消息重排开关
|
|
12943
|
+
* @param enableCheck 是否开启融云消息重排开关
|
|
12944
|
+
*/
|
|
12945
|
+
setCheckDuplicateMessage(enableCheck: boolean): Promise<RCResult<boolean>>;
|
|
12946
|
+
getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
12947
|
+
getConversationsIncludingRobots(options: Required<IGetConversationsIncludingRobotsOption>): Promise<RCResult<IReceivedConversation[]>>;
|
|
12396
12948
|
}
|
|
12397
12949
|
|
|
12398
12950
|
/**
|
|
@@ -12765,6 +13317,75 @@ interface IEngineWatcher extends IConnectionListener<false> {
|
|
|
12765
13317
|
* 消息编辑同步完成(目前只有单、群聊编辑同步事件,超级群不需要同步)
|
|
12766
13318
|
*/
|
|
12767
13319
|
messageModifiedSyncCompleted: () => void;
|
|
13320
|
+
/**
|
|
13321
|
+
* 机器人列表同步完成
|
|
13322
|
+
* @since 5.30.0
|
|
13323
|
+
* @param code 同步结果
|
|
13324
|
+
* @param updatedRobots 发生变更的机器人列表,如名称变更、或为新增机器人,不包含被删除的机器人数据
|
|
13325
|
+
*/
|
|
13326
|
+
robotsSynced: (code: number, updatedRobots: IRobotInfo[]) => void;
|
|
13327
|
+
}
|
|
13328
|
+
|
|
13329
|
+
/**
|
|
13330
|
+
* Robot information
|
|
13331
|
+
* @category Interface
|
|
13332
|
+
* @since 5.30.0
|
|
13333
|
+
*/
|
|
13334
|
+
/**
|
|
13335
|
+
* 机器人信息
|
|
13336
|
+
* @category Interface
|
|
13337
|
+
* @since 5.30.0
|
|
13338
|
+
*/
|
|
13339
|
+
interface IRobotInfo {
|
|
13340
|
+
/** [EN]
|
|
13341
|
+
* Robot ID
|
|
13342
|
+
*/
|
|
13343
|
+
/**
|
|
13344
|
+
* 机器人 ID
|
|
13345
|
+
*/
|
|
13346
|
+
robotId: string;
|
|
13347
|
+
/** [EN]
|
|
13348
|
+
* Robot name
|
|
13349
|
+
*/
|
|
13350
|
+
/**
|
|
13351
|
+
* 机器人名称
|
|
13352
|
+
*/
|
|
13353
|
+
name: string;
|
|
13354
|
+
/** [EN]
|
|
13355
|
+
* Robot portrait URL
|
|
13356
|
+
*/
|
|
13357
|
+
/**
|
|
13358
|
+
* 机器人头像 URL
|
|
13359
|
+
*/
|
|
13360
|
+
portraitUri: string;
|
|
13361
|
+
/** [EN]
|
|
13362
|
+
* Robot type
|
|
13363
|
+
*/
|
|
13364
|
+
/**
|
|
13365
|
+
* 机器人类型
|
|
13366
|
+
*/
|
|
13367
|
+
robotType: string;
|
|
13368
|
+
/** [EN]
|
|
13369
|
+
* Robot metadata
|
|
13370
|
+
*/
|
|
13371
|
+
/**
|
|
13372
|
+
* 机器人 metadata
|
|
13373
|
+
*/
|
|
13374
|
+
metadata: Record<string, string>;
|
|
13375
|
+
/** [EN]
|
|
13376
|
+
* Robot create time
|
|
13377
|
+
*/
|
|
13378
|
+
/**
|
|
13379
|
+
* 机器人创建时间
|
|
13380
|
+
*/
|
|
13381
|
+
createTime: number;
|
|
13382
|
+
/** [EN]
|
|
13383
|
+
* Robot update time
|
|
13384
|
+
*/
|
|
13385
|
+
/**
|
|
13386
|
+
* 机器人更新时间
|
|
13387
|
+
*/
|
|
13388
|
+
updateTime: number;
|
|
12768
13389
|
}
|
|
12769
13390
|
|
|
12770
13391
|
declare type IErrorKeys = {
|
|
@@ -12843,106 +13464,12 @@ declare type IUserSettingsChangedEvent = {
|
|
|
12843
13464
|
};
|
|
12844
13465
|
|
|
12845
13466
|
/**
|
|
12846
|
-
*
|
|
12847
|
-
* 只做类型检查,不做长度检查,故当字符串长度为 0,结果依然为 true
|
|
12848
|
-
* @param value
|
|
13467
|
+
* 判断当前是否运行在 electron 环境且搭配 c++ 协议栈使用
|
|
12849
13468
|
*/
|
|
12850
|
-
declare const
|
|
13469
|
+
declare const usingCppEngine: () => boolean;
|
|
12851
13470
|
/**
|
|
12852
|
-
*
|
|
12853
|
-
* @param
|
|
12854
|
-
*/
|
|
12855
|
-
declare const isBoolean: (value: unknown) => boolean;
|
|
12856
|
-
/**
|
|
12857
|
-
* 检查参数是否为 number 数据
|
|
12858
|
-
* @param value
|
|
12859
|
-
*/
|
|
12860
|
-
declare const isNumber: (value: unknown) => boolean;
|
|
12861
|
-
/**
|
|
12862
|
-
* 检查参数是否为整数,可以指定最小值和最大值,区间包含最小值和最大值,
|
|
12863
|
-
*/
|
|
12864
|
-
declare const isInteger: (option: {
|
|
12865
|
-
min?: number;
|
|
12866
|
-
max?: number;
|
|
12867
|
-
}) => (value: number) => boolean;
|
|
12868
|
-
/**
|
|
12869
|
-
* 检查参数是否为数组
|
|
12870
|
-
* 只做类型检查,不做长度检查
|
|
12871
|
-
* 如 UnitArray、BufferArray 等也属于数组
|
|
12872
|
-
* @param arr
|
|
12873
|
-
*/
|
|
12874
|
-
declare const isArray: (arr: unknown) => boolean;
|
|
12875
|
-
/**
|
|
12876
|
-
* 有限制的字符串
|
|
12877
|
-
* 做长度检查、自定义检查
|
|
12878
|
-
* 先检测前后去空格是否为空
|
|
12879
|
-
*/
|
|
12880
|
-
declare const isLimitedString: (option: {
|
|
12881
|
-
minLength?: number | undefined;
|
|
12882
|
-
maxLength?: number | undefined;
|
|
12883
|
-
validator?: ((val: string) => boolean) | undefined;
|
|
12884
|
-
isTrim?: boolean | undefined;
|
|
12885
|
-
}) => (str: unknown) => boolean;
|
|
12886
|
-
/**
|
|
12887
|
-
* 检查参数是否为长度非 0 的字符串
|
|
12888
|
-
* @param str
|
|
12889
|
-
*/
|
|
12890
|
-
declare const notEmptyString: (str: unknown) => boolean;
|
|
12891
|
-
/**
|
|
12892
|
-
* 检查参数是否为长度非 0 的数组
|
|
12893
|
-
* @param str
|
|
12894
|
-
*/
|
|
12895
|
-
declare const notEmptyArray: (arr: any[]) => boolean;
|
|
12896
|
-
/**
|
|
12897
|
-
* 检查参数是否为对象
|
|
12898
|
-
* @param val
|
|
12899
|
-
*/
|
|
12900
|
-
declare const isObject: (val: any) => boolean;
|
|
12901
|
-
/**
|
|
12902
|
-
* 检查参数是否为函数
|
|
12903
|
-
* @param val
|
|
12904
|
-
*/
|
|
12905
|
-
declare const isFunction: (val: any) => boolean;
|
|
12906
|
-
/**
|
|
12907
|
-
* 检查参数是否为 undefined
|
|
12908
|
-
* @param val
|
|
12909
|
-
*/
|
|
12910
|
-
declare const isUndefined: (val: any) => boolean;
|
|
12911
|
-
/**
|
|
12912
|
-
* 检查参数是否为有效 http(s) 协议 url
|
|
12913
|
-
* @param value
|
|
12914
|
-
*/
|
|
12915
|
-
declare const isHttpUrl: (value: any) => boolean;
|
|
12916
|
-
/**
|
|
12917
|
-
* 检查对象不为空
|
|
12918
|
-
* @param val
|
|
12919
|
-
*/
|
|
12920
|
-
declare const notEmptyObject: (val: Object) => boolean;
|
|
12921
|
-
declare const isValidConversationType: (conversation: number) => boolean;
|
|
12922
|
-
declare const isValidEnum: (param: {
|
|
12923
|
-
value: unknown;
|
|
12924
|
-
type: object;
|
|
12925
|
-
}) => boolean;
|
|
12926
|
-
/**
|
|
12927
|
-
* 检查是否是有效的 targetId
|
|
12928
|
-
*/
|
|
12929
|
-
declare const isValidTargetId: (value: any) => boolean;
|
|
12930
|
-
/**
|
|
12931
|
-
* 检查是否是有效的 groupId
|
|
12932
|
-
*/
|
|
12933
|
-
declare const isValidGroupId: (value: any) => boolean;
|
|
12934
|
-
/**
|
|
12935
|
-
* 判断是否是一个有效的文件类型
|
|
12936
|
-
*/
|
|
12937
|
-
declare const isValidFileType: (fileType: number) => boolean;
|
|
12938
|
-
|
|
12939
|
-
/**
|
|
12940
|
-
* 判断当前是否运行在 electron 环境且搭配 c++ 协议栈使用
|
|
12941
|
-
*/
|
|
12942
|
-
declare const usingCppEngine: () => boolean;
|
|
12943
|
-
/**
|
|
12944
|
-
* 将接收状态枚举值转换为接收转态详情
|
|
12945
|
-
* @param status 状态枚举值
|
|
13471
|
+
* 将接收状态枚举值转换为接收转态详情
|
|
13472
|
+
* @param status 状态枚举值
|
|
12946
13473
|
*/
|
|
12947
13474
|
declare const trans2IReceivedStatusInfo: (status: ReceivedStatus) => IReceivedStatusInfo;
|
|
12948
13475
|
/**
|
|
@@ -12951,50 +13478,6 @@ declare const trans2IReceivedStatusInfo: (status: ReceivedStatus) => IReceivedSt
|
|
|
12951
13478
|
*/
|
|
12952
13479
|
declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusInfo) => number;
|
|
12953
13480
|
|
|
12954
|
-
declare type PBModule = {
|
|
12955
|
-
toArrayBuffer: () => ArrayBuffer;
|
|
12956
|
-
getArrayData: never;
|
|
12957
|
-
[key: string]: Function;
|
|
12958
|
-
};
|
|
12959
|
-
declare class Codec$1<T> {
|
|
12960
|
-
#private;
|
|
12961
|
-
/**
|
|
12962
|
-
* 嵌套结构声明
|
|
12963
|
-
* key: pbname
|
|
12964
|
-
* value: [key: pbname + _ + 属性名,type: 值的 pbname ]
|
|
12965
|
-
*/
|
|
12966
|
-
private nestedMap;
|
|
12967
|
-
private readonly pbModules;
|
|
12968
|
-
constructor(
|
|
12969
|
-
/**
|
|
12970
|
-
* proto 协议描述
|
|
12971
|
-
*/
|
|
12972
|
-
desc: string,
|
|
12973
|
-
/**
|
|
12974
|
-
* 嵌套结构声明
|
|
12975
|
-
* key: pbname
|
|
12976
|
-
* value: [key: pbname + _ + 属性名,type: 值的 pbname ]
|
|
12977
|
-
*/
|
|
12978
|
-
nestedMap: Map<string, keyof T>);
|
|
12979
|
-
private _encode;
|
|
12980
|
-
/**
|
|
12981
|
-
* PB 数据序列化
|
|
12982
|
-
* @param pbname - PB 名称
|
|
12983
|
-
* @param params - 待序列化数据
|
|
12984
|
-
*/
|
|
12985
|
-
encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
|
|
12986
|
-
/**
|
|
12987
|
-
* 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
|
|
12988
|
-
* @param pbname 待解码数据的 PB 名
|
|
12989
|
-
* @param data 待解码数据
|
|
12990
|
-
*/
|
|
12991
|
-
decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
|
|
12992
|
-
/**
|
|
12993
|
-
* @deprecated
|
|
12994
|
-
*/
|
|
12995
|
-
getModule(pbname: string): PBModule;
|
|
12996
|
-
}
|
|
12997
|
-
|
|
12998
13481
|
/** [EN]
|
|
12999
13482
|
* Log level definitions
|
|
13000
13483
|
* @category Enum
|
|
@@ -13246,7 +13729,14 @@ declare enum AreaCode {
|
|
|
13246
13729
|
/**
|
|
13247
13730
|
* 沙特数据中心
|
|
13248
13731
|
*/
|
|
13249
|
-
SA = 5
|
|
13732
|
+
SA = 5,
|
|
13733
|
+
/** [EN]
|
|
13734
|
+
* Oman data center
|
|
13735
|
+
*/
|
|
13736
|
+
/**
|
|
13737
|
+
* 阿曼数据中心
|
|
13738
|
+
*/
|
|
13739
|
+
OM = 6
|
|
13250
13740
|
}
|
|
13251
13741
|
|
|
13252
13742
|
interface ISSERequestOpts {
|
|
@@ -13684,6 +14174,24 @@ declare type IChatRoomEntries = IChatroomEntries;
|
|
|
13684
14174
|
* @deprecated
|
|
13685
14175
|
*/
|
|
13686
14176
|
declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
|
|
14177
|
+
/**
|
|
14178
|
+
* 发送消息时的可选项信息
|
|
14179
|
+
* @deprecated
|
|
14180
|
+
*/
|
|
14181
|
+
interface ISendMsgOptions extends IMessageSendOptions {
|
|
14182
|
+
/**
|
|
14183
|
+
* @deprecated 参数废弃。SDK 通过注册的消息类型来确定是否计数,发送时不可修改
|
|
14184
|
+
*/
|
|
14185
|
+
isCounted?: boolean;
|
|
14186
|
+
/**
|
|
14187
|
+
* @deprecated 参数废弃。SDK 通过注册的消息类型来确定是否存储,发送时不可修改
|
|
14188
|
+
*/
|
|
14189
|
+
isPersited?: boolean;
|
|
14190
|
+
/**
|
|
14191
|
+
* 会话 Channel ID
|
|
14192
|
+
*/
|
|
14193
|
+
channelId?: string;
|
|
14194
|
+
}
|
|
13687
14195
|
|
|
13688
14196
|
/**
|
|
13689
14197
|
* @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
|
|
@@ -13717,27 +14225,9 @@ declare type ModuleType<T> = {
|
|
|
13717
14225
|
* @deprecated 因该工具已向 RTC 业务暴露,因此暂时不可删除,待 RTC 迁移到新工具后删除
|
|
13718
14226
|
*/
|
|
13719
14227
|
declare class Codec<T> {
|
|
13720
|
-
|
|
13721
|
-
* Key 对应的 Value 结构映射表,用于不同 Key 数据的编解码
|
|
13722
|
-
*/
|
|
13723
|
-
private pbmaps;
|
|
13724
|
-
/**
|
|
13725
|
-
* 允许不传 logger 实例以向前兼容
|
|
13726
|
-
*/
|
|
13727
|
-
private logger?;
|
|
13728
|
-
private readonly pbModules;
|
|
14228
|
+
private readonly pbCodec;
|
|
13729
14229
|
/** @deprecated */
|
|
13730
|
-
constructor(
|
|
13731
|
-
/**
|
|
13732
|
-
* Key 对应的 Value 结构映射表,用于不同 Key 数据的编解码
|
|
13733
|
-
*/
|
|
13734
|
-
pbmaps: T, pbDefined: string,
|
|
13735
|
-
/**
|
|
13736
|
-
* 允许不传 logger 实例以向前兼容
|
|
13737
|
-
*/
|
|
13738
|
-
logger?: ILogger | undefined);
|
|
13739
|
-
/** @deprecated */
|
|
13740
|
-
getModule(pbname: string): any;
|
|
14230
|
+
constructor(pbDefined: string);
|
|
13741
14231
|
/**
|
|
13742
14232
|
* 数据序列化
|
|
13743
14233
|
* @param pbname 待编码数据的 PB 名
|
|
@@ -13760,11 +14250,6 @@ declare class Codec<T> {
|
|
|
13760
14250
|
* @deprecated
|
|
13761
14251
|
*/
|
|
13762
14252
|
decode(pbname: string, uint8array: Uint8Array): any;
|
|
13763
|
-
/**
|
|
13764
|
-
* protobuf 结构中,int64 类型数据无法直接转为 JS 的 number 数据,需计算获取
|
|
13765
|
-
* @param data
|
|
13766
|
-
*/
|
|
13767
|
-
private fixInt64Values;
|
|
13768
14253
|
}
|
|
13769
14254
|
/**
|
|
13770
14255
|
* 请使用 `Codec` 替代 `AbsCodec`
|
|
@@ -13772,12 +14257,6 @@ declare class Codec<T> {
|
|
|
13772
14257
|
*/
|
|
13773
14258
|
declare type AbsCodec<T> = Codec<T>;
|
|
13774
14259
|
|
|
13775
|
-
declare const RTCPBMap: CodecPBMaps;
|
|
13776
|
-
/**
|
|
13777
|
-
* 仅限 RCCppEngine 内用于类型约束,RTCLib 内不可直接使用
|
|
13778
|
-
*/
|
|
13779
|
-
declare type InnerRTCKeyMaps = typeof RTCPBMap;
|
|
13780
|
-
|
|
13781
14260
|
declare class PluginContext {
|
|
13782
14261
|
protected readonly _context: APIContext;
|
|
13783
14262
|
constructor(_context: APIContext);
|
|
@@ -13785,9 +14264,13 @@ declare class PluginContext {
|
|
|
13785
14264
|
* 获取 context
|
|
13786
14265
|
*/
|
|
13787
14266
|
__getContext(): APIContext;
|
|
13788
|
-
/**
|
|
13789
|
-
|
|
13790
|
-
|
|
14267
|
+
/**
|
|
14268
|
+
* 创建 PB 编解码器,目前仅对 RTC 业务使用
|
|
14269
|
+
* @param _ 废弃参数
|
|
14270
|
+
* @param pbDesc PB 描述
|
|
14271
|
+
*/
|
|
14272
|
+
createCodec<T extends CodecPBMaps>(_: T, pbDesc: string): Codec<T>;
|
|
14273
|
+
createPBCodec<T>(desc: string, _?: Map<string, keyof T>): Codec$1<T>;
|
|
13791
14274
|
/**
|
|
13792
14275
|
* 重新请求服务导航数据
|
|
13793
14276
|
*/
|
|
@@ -13855,8 +14338,10 @@ declare class PluginContext {
|
|
|
13855
14338
|
setPushConfig(config: IAppPushConfig): void;
|
|
13856
14339
|
/**
|
|
13857
14340
|
* 发送消息
|
|
14341
|
+
* @deprecated
|
|
13858
14342
|
*/
|
|
13859
|
-
sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions):
|
|
14343
|
+
sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): Promise<RCResult<IReceivedMessage>>;
|
|
14344
|
+
sendMessageTo(identifier: IConversationIdentifier, options: IMessageSendOptions): Promise<RCResult<IReceivedMessage>>;
|
|
13860
14345
|
/**
|
|
13861
14346
|
* 消息注册
|
|
13862
14347
|
* @description 消息注册需在应用初始化完成前进行
|
|
@@ -13882,10 +14367,10 @@ declare class PluginContext {
|
|
|
13882
14367
|
* 获取应用主进程信息,仅限 Electron 平台可用
|
|
13883
14368
|
*/
|
|
13884
14369
|
getMainProcessInfo(): IPromiseResult<IProcessInfo>;
|
|
13885
|
-
setCallInfo(targetId: string, key: string, value: string):
|
|
14370
|
+
setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
13886
14371
|
key: string;
|
|
13887
14372
|
value: string;
|
|
13888
|
-
}
|
|
14373
|
+
}>>;
|
|
13889
14374
|
/**
|
|
13890
14375
|
* 创建 logger 实例
|
|
13891
14376
|
* @param id 日志工具 ID,用于区分日志实例,以确定日志调用者身份
|
|
@@ -13966,6 +14451,13 @@ interface IWatcher {
|
|
|
13966
14451
|
* 会话状态数据同步完成
|
|
13967
14452
|
*/
|
|
13968
14453
|
conversationStatusSynced?: (code: number) => void;
|
|
14454
|
+
/**
|
|
14455
|
+
* 机器人列表同步完成
|
|
14456
|
+
* @since 5.30.0
|
|
14457
|
+
* @param code 同步结果
|
|
14458
|
+
* @param updatedRobots 发生变更的机器人列表,如名称变更、或为新增机器人,不包含被删除的机器人数据
|
|
14459
|
+
*/
|
|
14460
|
+
robotsSynced?: (code: number, updatedRobots: IRobotInfo[]) => void;
|
|
13969
14461
|
/**
|
|
13970
14462
|
* 会话中标签状态变更监听
|
|
13971
14463
|
*/
|
|
@@ -14104,16 +14596,6 @@ interface IAPIContextOption {
|
|
|
14104
14596
|
*/
|
|
14105
14597
|
loggerProxy?: LogDBProxy;
|
|
14106
14598
|
}
|
|
14107
|
-
interface IConnectResult {
|
|
14108
|
-
/**
|
|
14109
|
-
* 连接错误码
|
|
14110
|
-
*/
|
|
14111
|
-
code: ErrorCode;
|
|
14112
|
-
/**
|
|
14113
|
-
* 导航获取成功后即可有相应的值,在导航数据获取完成之前该值为 undefined
|
|
14114
|
-
*/
|
|
14115
|
-
userId?: string;
|
|
14116
|
-
}
|
|
14117
14599
|
|
|
14118
14600
|
/**
|
|
14119
14601
|
* 应用设置
|
|
@@ -14153,7 +14635,7 @@ declare class AppSettings {
|
|
|
14153
14635
|
interface IChatroomService extends Pick<IIPCMethods, 'getChatroomHistoryMessages' | 'joinChatroom' | 'quitChatroom' | 'getChatroomInfo' | 'setChatroomEntry' | 'setChatroomEntries' | 'removeChatroomEntry' | 'removeChatroomEntries' | 'getChatroomEntry' | 'getAllChatroomEntries' | 'bindRTCRoomForChatroom' | 'setCheckChatRoomDuplicateMessage'> {
|
|
14154
14636
|
}
|
|
14155
14637
|
|
|
14156
|
-
interface IModuleContext {
|
|
14638
|
+
interface IModuleContext extends Pick<IIPCMethods, 'sendMessage'> {
|
|
14157
14639
|
/**
|
|
14158
14640
|
* 应用 Key
|
|
14159
14641
|
*/
|
|
@@ -14190,25 +14672,41 @@ interface IModuleContext {
|
|
|
14190
14672
|
* 日志工具
|
|
14191
14673
|
*/
|
|
14192
14674
|
get logger(): BasicLogger;
|
|
14675
|
+
/**
|
|
14676
|
+
* 是否使用 C++ 引擎
|
|
14677
|
+
*/
|
|
14678
|
+
get usingCppEngine(): boolean;
|
|
14193
14679
|
}
|
|
14194
14680
|
|
|
14195
14681
|
declare class BaseModule {
|
|
14196
|
-
protected readonly ctx: IModuleContext;
|
|
14197
14682
|
/**
|
|
14198
14683
|
* 日志工具
|
|
14684
|
+
* @hidden
|
|
14199
14685
|
*/
|
|
14200
14686
|
protected readonly logger: BasicLogger;
|
|
14687
|
+
/**
|
|
14688
|
+
* @hidden
|
|
14689
|
+
*/
|
|
14690
|
+
protected readonly ctx: IModuleContext;
|
|
14691
|
+
/**
|
|
14692
|
+
* @hidden
|
|
14693
|
+
*/
|
|
14201
14694
|
constructor(ctx: IModuleContext);
|
|
14202
|
-
/**
|
|
14695
|
+
/**
|
|
14696
|
+
* 高阶函数,生成一个验证方法,验证是否处于连接中状态,并在连接状态可用时返回导航数据
|
|
14697
|
+
* @hidden
|
|
14698
|
+
*/
|
|
14203
14699
|
protected get validateConnected(): () => RCResult<INaviInfo>;
|
|
14204
14700
|
/**
|
|
14205
14701
|
* 高阶函数,生成一个验证方法,验证是否处于登录状态
|
|
14206
14702
|
* * 本地数据查询时,只需要验证用户已经登录过且未主动断开,无需校验当前连接状态
|
|
14703
|
+
* @hidden
|
|
14207
14704
|
*/
|
|
14208
14705
|
protected get validateLogin(): () => RCResult<INaviInfo>;
|
|
14209
14706
|
/**
|
|
14210
14707
|
* 检查是否已登录
|
|
14211
14708
|
* @param allowSuspended 是否允许已登录但连接状态为中断状态;Electron 平台一些接口为本地数据查询,允许连接状态为中断状态
|
|
14709
|
+
* @hidden
|
|
14212
14710
|
* @returns
|
|
14213
14711
|
*/
|
|
14214
14712
|
protected checkAuthed(allowSuspended: boolean): RCResult<INaviInfo>;
|
|
@@ -14218,12 +14716,12 @@ declare class ChatroomModule extends BaseModule {
|
|
|
14218
14716
|
/**
|
|
14219
14717
|
* 聊天室服务
|
|
14220
14718
|
*/
|
|
14221
|
-
private readonly
|
|
14719
|
+
private readonly svr;
|
|
14222
14720
|
constructor(ctx: IModuleContext,
|
|
14223
14721
|
/**
|
|
14224
14722
|
* 聊天室服务
|
|
14225
14723
|
*/
|
|
14226
|
-
|
|
14724
|
+
svr: IChatroomService);
|
|
14227
14725
|
/**
|
|
14228
14726
|
* 加入聊天室,若聊天室不存在则创建聊天室
|
|
14229
14727
|
* @param chatroomId 聊天室房间 Id
|
|
@@ -14300,15 +14798,130 @@ declare class ChatroomModule extends BaseModule {
|
|
|
14300
14798
|
bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<RCResult>;
|
|
14301
14799
|
}
|
|
14302
14800
|
|
|
14801
|
+
interface IDataHostingService extends Pick<IIPCMethods, 'searchUserProfileByUniqueId' | 'updateMyUserProfileVisibility' | 'getMyUserProfileVisibility' | 'createGroup' | 'updateGroupInfo' | 'getGroupsInfo' | 'kickGroupMembers' | 'quitGroup' | 'joinGroup' | 'inviteUsersToGroup' | 'memberInviteResponse' | 'getGroupApplications' | 'getJoinedGroupsByRole' | 'searchJoinedGroups' | 'getJoinedGroups' | 'dismissGroup' | 'transferGroupOwner' | 'setGroupManagers' | 'setGroupFollows' | 'getGroupFollows' | 'setGroupRemark' | 'addFriend' | 'deleteFriends' | 'acceptFriendRequest' | 'refuseFriendRequest' | 'setFriendInfo' | 'checkFriends' | 'getFriends' | 'getFriendApplications' | 'getFriendsInfo' | 'searchFriendsInfo' | 'setFriendAddPermission' | 'getFriendAddPermission' | 'getGroupMembersByRole' | 'getGroupMembers' | 'setGroupMemberInfo' | 'searchGroupMembers'> {
|
|
14802
|
+
}
|
|
14803
|
+
|
|
14804
|
+
/**
|
|
14805
|
+
* 数据托管模块
|
|
14806
|
+
*/
|
|
14807
|
+
declare class DataHosting extends BaseModule {
|
|
14808
|
+
private readonly svr;
|
|
14809
|
+
constructor(ctx: IModuleContext, svr: IDataHostingService);
|
|
14810
|
+
/**
|
|
14811
|
+
* 验证用户信息托管是否可用
|
|
14812
|
+
*/
|
|
14813
|
+
private _userProfileEnabled;
|
|
14814
|
+
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<RCResult>;
|
|
14815
|
+
getMyUserProfileVisibility(): Promise<RCResult<UserProfileVisibility>>;
|
|
14816
|
+
searchUserProfileByUniqueId(uniqueId: string): Promise<RCResult<IUserProfileInfo>>;
|
|
14817
|
+
addFriend(userId: string, directionType: DirectionType, extra?: string): Promise<RCResult<IProcessCode>>;
|
|
14818
|
+
deleteFriends(userIds: string[], directionType: DirectionType): Promise<RCResult>;
|
|
14819
|
+
acceptFriendRequest(userId: string): Promise<RCResult>;
|
|
14820
|
+
refuseFriendRequest(userId: string, reason?: string): Promise<RCResult>;
|
|
14821
|
+
setFriendInfo(userId: string, remark: string, extProfile?: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
14822
|
+
checkFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<IFriendRelationInfo[]>>;
|
|
14823
|
+
getFriends(directionType: QueryFriendsDirectionType, option?: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IFriendInfo>>>;
|
|
14824
|
+
getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
14825
|
+
getFriendsInfo(userIds: string[]): Promise<RCResult<IFriendInfo[]>>;
|
|
14826
|
+
searchFriendsInfo(nickname: string): Promise<RCResult<IFriendInfo[]>>;
|
|
14827
|
+
setFriendAddPermission(permission: FriendAddPermission): Promise<RCResult>;
|
|
14828
|
+
getFriendAddPermission(): Promise<RCResult<FriendAddPermission>>;
|
|
14829
|
+
createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<RCResult<ICreateGroupFail>>;
|
|
14830
|
+
updateGroupInfo(groupInfo: IGroupInfoOption): Promise<RCResult<IErrorKeys>>;
|
|
14831
|
+
getGroupsInfo(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
14832
|
+
kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<RCResult>;
|
|
14833
|
+
quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<RCResult>;
|
|
14834
|
+
dismissGroup(groupId: string): Promise<RCResult>;
|
|
14835
|
+
transferGroupOwner(groupId: string, newOwnerId: string, quit?: boolean, config?: IQuitGroupConfig): Promise<RCResult>;
|
|
14836
|
+
addGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14837
|
+
removeGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14838
|
+
getGroupMembers(groupId: string, userIds: string[]): Promise<RCResult<IGroupMemberInfo[]>>;
|
|
14839
|
+
setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<RCResult<IErrorKeys>>;
|
|
14840
|
+
searchGroupMembers(groupId: string, nickName: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
14841
|
+
getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IGetGroupMembersOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
14842
|
+
addGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14843
|
+
removeGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14844
|
+
getGroupFollows(groupId: string): Promise<RCResult<IFollowsInfo[]>>;
|
|
14845
|
+
setGroupRemark(groupId: string, remark: string): Promise<RCResult>;
|
|
14846
|
+
joinGroup(groupId: string): Promise<RCResult<IProcessCode>>;
|
|
14847
|
+
inviteUsersToGroup(groupId: string, userIds: string[]): Promise<RCResult<IProcessCode>>;
|
|
14848
|
+
acceptGroupInvite(groupId: string, inviterId: string): Promise<RCResult>;
|
|
14849
|
+
refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<RCResult>;
|
|
14850
|
+
acceptGroupApplication(groupId: string, joinUserId: string, inviterId?: string): Promise<RCResult<IProcessCode>>;
|
|
14851
|
+
refuseGroupApplication(groupId: string, joinUserId: string, inviterId?: string, reason?: string): Promise<RCResult>;
|
|
14852
|
+
/**
|
|
14853
|
+
* 获取群组请求列表
|
|
14854
|
+
* @param option 分页查询参数
|
|
14855
|
+
* @param directions 群组请求方向,参数仅 Electron 平台支持,且 Electron 为必填项,Web 传递无效
|
|
14856
|
+
* @param status 群组请求状态,参数仅 Electron 平台支持,且 Electron 为必填项,Web 传递无效
|
|
14857
|
+
*/
|
|
14858
|
+
getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
14859
|
+
getJoinedGroupsByRole(role: GroupMemberRole, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
14860
|
+
searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
14861
|
+
getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
14862
|
+
}
|
|
14863
|
+
|
|
14303
14864
|
/**
|
|
14304
14865
|
* 会话聊天模块
|
|
14305
14866
|
*/
|
|
14306
|
-
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'> {
|
|
14867
|
+
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' | 'getConversationsIncludingRobots'> {
|
|
14307
14868
|
getRealtimeConversations(count: number, startTime: number, order: 0 | 1): Promise<RCResult<IReceivedConversation[]>>;
|
|
14308
14869
|
getRealtimeConTotalUnreadCount(): Promise<RCResult<number>>;
|
|
14309
14870
|
clearRealtimeConUnreadCount(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14310
14871
|
removeRealtimeConversations(identifiers: IConversationIdentifier[]): Promise<RCResult>;
|
|
14311
14872
|
batchGetRealtimeConUnreadCount(identifiers: IConversationIdentifier[]): Promise<RCResult<IConversationUnreadCount[]>>;
|
|
14873
|
+
/**
|
|
14874
|
+
* 分页加载会话列表
|
|
14875
|
+
* @param pageToken 分页 token
|
|
14876
|
+
* @param count 分页数量
|
|
14877
|
+
* @param options 会话列表加载器选项,仅 pageToken 无值时有效
|
|
14878
|
+
*/
|
|
14879
|
+
loadConversationList(pageToken: string, count: number, options: IConversationListLoaderOptions): Promise<RCResult<{
|
|
14880
|
+
pageToken: string;
|
|
14881
|
+
finished: boolean;
|
|
14882
|
+
list: IReceivedConversation[];
|
|
14883
|
+
}>>;
|
|
14884
|
+
/**
|
|
14885
|
+
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
14886
|
+
*/
|
|
14887
|
+
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
14888
|
+
}
|
|
14889
|
+
|
|
14890
|
+
/**
|
|
14891
|
+
* 会话列表加载器,暂不支持用于获取超级群会话列表,不支持 Electron 平台
|
|
14892
|
+
* @since 5.32.0
|
|
14893
|
+
*/
|
|
14894
|
+
declare class ConversationListLoader extends BaseModule {
|
|
14895
|
+
#private;
|
|
14896
|
+
/**
|
|
14897
|
+
* @hidden
|
|
14898
|
+
*/
|
|
14899
|
+
private readonly _svr;
|
|
14900
|
+
/**
|
|
14901
|
+
* @hidden
|
|
14902
|
+
*/
|
|
14903
|
+
private _id;
|
|
14904
|
+
/**
|
|
14905
|
+
* @hidden
|
|
14906
|
+
*/
|
|
14907
|
+
constructor(options: IConversationListLoaderOptions,
|
|
14908
|
+
/**
|
|
14909
|
+
* @hidden
|
|
14910
|
+
*/
|
|
14911
|
+
_svr: IChatService, ctx: IModuleContext);
|
|
14912
|
+
/**
|
|
14913
|
+
* 是否还有更多会话
|
|
14914
|
+
*/
|
|
14915
|
+
get hasMore(): boolean;
|
|
14916
|
+
/**
|
|
14917
|
+
* 是否正在加载会话列表
|
|
14918
|
+
*/
|
|
14919
|
+
get isLoading(): boolean;
|
|
14920
|
+
/**
|
|
14921
|
+
* 加载会话列表
|
|
14922
|
+
* @param count 获取数量
|
|
14923
|
+
*/
|
|
14924
|
+
load(count: number): Promise<RCResult<IReceivedConversation[]>>;
|
|
14312
14925
|
}
|
|
14313
14926
|
|
|
14314
14927
|
declare class ChatModule extends BaseModule {
|
|
@@ -14318,6 +14931,62 @@ declare class ChatModule extends BaseModule {
|
|
|
14318
14931
|
saveEditedMessageDraft(draft: IEditedMessageDraft, identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14319
14932
|
getEditedMessageDraft(identifier: IConversationIdentifier): Promise<RCResult<IEditedMessageDraft | null>>;
|
|
14320
14933
|
clearEditedMessageDraft(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14934
|
+
createConversationListLoader(options?: IConversationListLoaderOptions): Promise<RCResult<ConversationListLoader>>;
|
|
14935
|
+
/**
|
|
14936
|
+
* 超级群正在输入中
|
|
14937
|
+
* @param identifier 会话标识
|
|
14938
|
+
*/
|
|
14939
|
+
sendUltraGroupTypingStatus(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14940
|
+
/**
|
|
14941
|
+
* 发送单群聊输入状态中状态消息
|
|
14942
|
+
* @param identifier 会话标识
|
|
14943
|
+
* @param typingContentType 输入状态消息类型
|
|
14944
|
+
*/
|
|
14945
|
+
sendTypingStatus(identifier: IConversationIdentifier, typingContentType: string): Promise<RCResult<IReceivedMessage>>;
|
|
14946
|
+
/**
|
|
14947
|
+
* 多端未读数同步
|
|
14948
|
+
* @param identifier 会话标识
|
|
14949
|
+
* @param timestamp 同步时间戳
|
|
14950
|
+
*/
|
|
14951
|
+
sendSyncReadStatusMessage(identifier: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
14952
|
+
clearUnreadCountByTimestamp(identifier: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
14953
|
+
/**
|
|
14954
|
+
* 发送群已读回执请求(v1 版本)
|
|
14955
|
+
* @param identifier 会话标识
|
|
14956
|
+
* @param messageUId 消息 UID
|
|
14957
|
+
* @returns
|
|
14958
|
+
*/
|
|
14959
|
+
sendReadReceiptRequest(identifier: IConversationIdentifier, messageUId: string): Promise<RCResult>;
|
|
14960
|
+
/**
|
|
14961
|
+
* 发送单聊已读回执
|
|
14962
|
+
* @param identifier 会话标识
|
|
14963
|
+
* @param messageUId 消息 UID
|
|
14964
|
+
* @param timestamp 消息发送时间
|
|
14965
|
+
*/
|
|
14966
|
+
sendReadReceiptMessage(identifier: IConversationIdentifier, messageUId: string, timestamp: number): Promise<RCResult>;
|
|
14967
|
+
/**
|
|
14968
|
+
* 发送群组消息已读回执
|
|
14969
|
+
* @description 根据导航开关配置确定发送 v1 或 v2 版本;不支持处理其他已读回执版本
|
|
14970
|
+
* @param identifier 会话标识
|
|
14971
|
+
* @param messageList 消息列表
|
|
14972
|
+
*/
|
|
14973
|
+
sendReadReceipt(identifier: IConversationIdentifier, messageList: Record<string, string[]>): Promise<RCResult>;
|
|
14974
|
+
/**
|
|
14975
|
+
* 获取群组消息已读列表(V2)
|
|
14976
|
+
* @param targetId
|
|
14977
|
+
* @param messageUId
|
|
14978
|
+
*/
|
|
14979
|
+
getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<RCResult<IMessageReaderResponse>>;
|
|
14980
|
+
/**
|
|
14981
|
+
* 发送已读回执 (V4)
|
|
14982
|
+
*/
|
|
14983
|
+
sendReadReceiptMessageV4(conversation: IConversationIdentifier, endMsgUid: string, startMsgUid?: string): Promise<RCResult>;
|
|
14984
|
+
/**
|
|
14985
|
+
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
14986
|
+
*/
|
|
14987
|
+
getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUId: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
|
|
14988
|
+
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
14989
|
+
getConversationsIncludingRobots(options: IGetConversationsIncludingRobotsOption): Promise<RCResult<IReceivedConversation[]>>;
|
|
14321
14990
|
}
|
|
14322
14991
|
|
|
14323
14992
|
declare class APIContext {
|
|
@@ -14349,14 +15018,9 @@ declare class APIContext {
|
|
|
14349
15018
|
readonly sse: SSEModule;
|
|
14350
15019
|
readonly chatroom: ChatroomModule;
|
|
14351
15020
|
readonly chat: ChatModule;
|
|
15021
|
+
readonly dataHosting: DataHosting;
|
|
14352
15022
|
private _versionInfo;
|
|
14353
15023
|
private _typingInfo;
|
|
14354
|
-
/**
|
|
14355
|
-
* RTC 相关的编解码模块,用于向前兼容 RTC 旧版本的编解码,
|
|
14356
|
-
* 包括向 CppEngine 提供 RTC 业务编解码能力
|
|
14357
|
-
* @deprecated
|
|
14358
|
-
*/
|
|
14359
|
-
readonly rtcCodec: Codec<InnerRTCKeyMaps>;
|
|
14360
15024
|
/**
|
|
14361
15025
|
* engine 内部日志工具
|
|
14362
15026
|
*/
|
|
@@ -14413,6 +15077,7 @@ declare class APIContext {
|
|
|
14413
15077
|
private _onUserSettingsSynced;
|
|
14414
15078
|
private _onUserSettingsChanged;
|
|
14415
15079
|
private _onConversationStatusSynced;
|
|
15080
|
+
private _onRobotsSynced;
|
|
14416
15081
|
/**
|
|
14417
15082
|
* 会话标签状态监听
|
|
14418
15083
|
*/
|
|
@@ -14522,22 +15187,9 @@ declare class APIContext {
|
|
|
14522
15187
|
private checkAuthed;
|
|
14523
15188
|
get token(): string;
|
|
14524
15189
|
refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
|
|
14525
|
-
|
|
14526
|
-
* 建立连接,连接失败则抛出异常,连接成功后返回用户 userId,否则返回相应的错误码
|
|
14527
|
-
* @param token
|
|
14528
|
-
* @param refreshNavi 是否需要重新请求导航,当值为 `false` 时,优先使用有效缓存导航,若缓存失效则重新获取导航
|
|
14529
|
-
* @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
|
|
14530
|
-
* 同一个账号在一台新设备上登录的时候,会把这个账号在之前登录的设备上踢出。
|
|
14531
|
-
由于 SDK 有断线重连功能,存在下面情况。
|
|
14532
|
-
用户在 A 设备登录,A 设备网络不稳定,没有连接成功,SDK 启动重连机制。
|
|
14533
|
-
用户此时又在 B 设备登录,B 设备连接成功。
|
|
14534
|
-
A 设备网络稳定之后,用户在 A 设备连接成功,B 设备被踢出。
|
|
14535
|
-
这个字段就是为这种情况加的。
|
|
14536
|
-
设置 reconnectKickEnable 为 true 时,SDK 重连的时候发现此时已有别的设备连接成功,不再强行踢出已有设备,而是踢出重连设备。
|
|
14537
|
-
*/
|
|
14538
|
-
connect(token: string, reconnectKickEnable: boolean, traceId: string): Promise<IConnectResult>;
|
|
15190
|
+
connect(token: string, reconnectKickEnable: boolean): Promise<RCResult<string>>;
|
|
14539
15191
|
disconnect(closeDB?: boolean, disablePush?: boolean): Promise<void>;
|
|
14540
|
-
reconnect(reconnectKickEnable?: boolean): Promise<
|
|
15192
|
+
reconnect(reconnectKickEnable?: boolean): Promise<RCResult<string>>;
|
|
14541
15193
|
/**
|
|
14542
15194
|
* 超级群 channelId 转换
|
|
14543
15195
|
* @param type 会话类型
|
|
@@ -14564,19 +15216,21 @@ declare class APIContext {
|
|
|
14564
15216
|
*/
|
|
14565
15217
|
registerRTCSignalingListener(listener?: (buffer: Uint8Array) => void): void;
|
|
14566
15218
|
/**
|
|
14567
|
-
*
|
|
14568
|
-
* @param
|
|
15219
|
+
* 内部发送消息,日志记录不同于 sendMessage
|
|
15220
|
+
* @param identifier 会话标识
|
|
15221
|
+
* @param options 消息发送配置
|
|
15222
|
+
* @param traceId 追踪 ID
|
|
15223
|
+
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
14569
15224
|
*/
|
|
14570
|
-
|
|
15225
|
+
innerSendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
14571
15226
|
/**
|
|
14572
15227
|
* 发送消息
|
|
14573
|
-
* @param
|
|
14574
|
-
* @param
|
|
14575
|
-
* @param
|
|
14576
|
-
* @param
|
|
14577
|
-
* @param options
|
|
15228
|
+
* @param identifier 会话标识
|
|
15229
|
+
* @param options 消息发送配置
|
|
15230
|
+
* @param traceId 追踪 ID
|
|
15231
|
+
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
14578
15232
|
*/
|
|
14579
|
-
sendMessage(
|
|
15233
|
+
sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
14580
15234
|
/**
|
|
14581
15235
|
* 更新消息拓展
|
|
14582
15236
|
* @param expansion 拓展数据
|
|
@@ -14596,14 +15250,6 @@ declare class APIContext {
|
|
|
14596
15250
|
* Web 历史版本中提供了超级群的消息拓展全删能力,需向前兼容,因此保留该接口;底层能力全支持,目前暂不开放。
|
|
14597
15251
|
*/
|
|
14598
15252
|
removeAllMessageExpansion(attrs: IMessageAttrsForUpdateExpansion): Promise<RCResult>;
|
|
14599
|
-
/**
|
|
14600
|
-
* 发送群组消息已读回执,根据导航开关配置确定发送 v1 或 v2 版本;不支持处理其他已读回执版本
|
|
14601
|
-
* @param targetId 群组会话 Id
|
|
14602
|
-
* @param messageList 消息列表
|
|
14603
|
-
* @param channelId 频道 Id
|
|
14604
|
-
* @returns
|
|
14605
|
-
*/
|
|
14606
|
-
sendReadReceipt(targetId: string, messageList: Record<string, string[]>, channelId?: string): Promise<RCResult>;
|
|
14607
15253
|
/**
|
|
14608
15254
|
* 发送群组消息已读回执 V2
|
|
14609
15255
|
* 导航下发已读回执开关为 true 时调用
|
|
@@ -14612,29 +15258,6 @@ declare class APIContext {
|
|
|
14612
15258
|
* @param channelId 频道 Id
|
|
14613
15259
|
*/
|
|
14614
15260
|
sendReadReceiptV2(targetId: string, messageUIds: string[], channelId?: string, traceId?: string): Promise<RCResult>;
|
|
14615
|
-
/**
|
|
14616
|
-
* 获取群组消息已读列表
|
|
14617
|
-
* 已读回执目前 3 个版本 有 naviInfo.grpRRVer 字段区分。
|
|
14618
|
-
* 0:为目前有公有先支持版本,调用 sendReadReceiptResponseV2
|
|
14619
|
-
* 1. 为 v2 版本,仅供 beem 使用目前公有云已废弃
|
|
14620
|
-
* 3. 为 v4 版本,目前仅海外 IMkit 使用
|
|
14621
|
-
* @param targetId
|
|
14622
|
-
* @param messageUIds
|
|
14623
|
-
*/
|
|
14624
|
-
getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
|
|
14625
|
-
/**
|
|
14626
|
-
* 发送已读回执 (V4)
|
|
14627
|
-
*/
|
|
14628
|
-
sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
14629
|
-
/**
|
|
14630
|
-
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
14631
|
-
*/
|
|
14632
|
-
getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
14633
|
-
batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
|
|
14634
|
-
/**
|
|
14635
|
-
* 多端同步会话的已读时间(V4)
|
|
14636
|
-
*/
|
|
14637
|
-
updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
|
|
14638
15261
|
/**
|
|
14639
15262
|
* 反初始化,清空所有监听及计时器
|
|
14640
15263
|
*/
|
|
@@ -14751,8 +15374,6 @@ declare class APIContext {
|
|
|
14751
15374
|
/**
|
|
14752
15375
|
* 撤回消息
|
|
14753
15376
|
* @param conversation 会话信息
|
|
14754
|
-
* @param messageUId
|
|
14755
|
-
* @param sentTime - 目前公有云已撤回消息已不再依赖消息的发送时间,私有云因存在一些老客户服务版本过旧,暂时仍需发送该参数
|
|
14756
15377
|
* @param recallMsgOptions
|
|
14757
15378
|
* @returns
|
|
14758
15379
|
*/
|
|
@@ -14786,10 +15407,10 @@ declare class APIContext {
|
|
|
14786
15407
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
14787
15408
|
* @returns
|
|
14788
15409
|
*/
|
|
14789
|
-
getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string, url?: string, size?: number): Promise<IUploadAuth & {
|
|
15410
|
+
getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth & {
|
|
14790
15411
|
qiniu: string;
|
|
14791
15412
|
ossConfig: string;
|
|
14792
|
-
}
|
|
15413
|
+
}>>;
|
|
14793
15414
|
/**
|
|
14794
15415
|
* 获取 七牛、阿里云上传后的可下载 URL
|
|
14795
15416
|
* @param fileType 文件类型
|
|
@@ -14866,11 +15487,6 @@ declare class APIContext {
|
|
|
14866
15487
|
* 获取所有群聊会话 @ 消息未读数,不包含超级群会话
|
|
14867
15488
|
*/
|
|
14868
15489
|
getAllUnreadMentionedCount(): Promise<RCResult<number>>;
|
|
14869
|
-
/**
|
|
14870
|
-
* 超级群正在输入中
|
|
14871
|
-
* @param options
|
|
14872
|
-
*/
|
|
14873
|
-
sendUltraGroupTypingStatus(options: IConversationOption): Promise<RCResult>;
|
|
14874
15490
|
/**
|
|
14875
15491
|
* 根据消息 ID 查询消息列表
|
|
14876
15492
|
* @param options
|
|
@@ -14910,34 +15526,31 @@ declare class APIContext {
|
|
|
14910
15526
|
* 获取应用主进程信息,仅限 Electron 平台可用
|
|
14911
15527
|
*/
|
|
14912
15528
|
getMainProcessInfo(): IPromiseResult<IProcessInfo>;
|
|
14913
|
-
setCallInfo(targetId: string, key: string, value: string): Promise<
|
|
15529
|
+
setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
14914
15530
|
key: string;
|
|
14915
15531
|
value: string;
|
|
14916
15532
|
}>>;
|
|
14917
|
-
private
|
|
15533
|
+
private _validateSubDriven;
|
|
14918
15534
|
/**
|
|
14919
15535
|
* 订阅用户状态事件
|
|
14920
15536
|
*/
|
|
14921
|
-
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
15537
|
+
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
14922
15538
|
/**
|
|
14923
15539
|
* 取消订阅用户状态事件
|
|
14924
15540
|
*/
|
|
14925
|
-
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
15541
|
+
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
14926
15542
|
/**
|
|
14927
15543
|
* 获取已订阅列表
|
|
14928
15544
|
*/
|
|
14929
|
-
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<
|
|
15545
|
+
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
14930
15546
|
/**
|
|
14931
15547
|
* 获取指定用户的在线状态
|
|
14932
15548
|
*/
|
|
14933
15549
|
getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
14934
15550
|
getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCResult<ISubscribeUserOnlineStatus[]>>;
|
|
14935
|
-
updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
15551
|
+
updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
14936
15552
|
getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
14937
|
-
getMyUserProfile(): Promise<
|
|
14938
|
-
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
|
|
14939
|
-
getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
|
|
14940
|
-
searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
|
|
15553
|
+
getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
14941
15554
|
/**
|
|
14942
15555
|
* 删除所有会话,目前仅 v2 提供
|
|
14943
15556
|
*/
|
|
@@ -14950,20 +15563,20 @@ declare class APIContext {
|
|
|
14950
15563
|
}, listener: Function): void;
|
|
14951
15564
|
/**
|
|
14952
15565
|
* 添加用户黑名单
|
|
14953
|
-
|
|
14954
|
-
addToBlacklist(userId: string): Promise<
|
|
15566
|
+
*/
|
|
15567
|
+
addToBlacklist(userId: string): Promise<RCResult>;
|
|
14955
15568
|
/**
|
|
14956
15569
|
* 将指定用户移除黑名单
|
|
14957
15570
|
*/
|
|
14958
|
-
removeFromBlacklist(userId: string): Promise<
|
|
15571
|
+
removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
14959
15572
|
/**
|
|
14960
15573
|
* 获取黑名单列表
|
|
14961
15574
|
*/
|
|
14962
|
-
getBlacklist(): Promise<
|
|
15575
|
+
getBlacklist(): Promise<RCResult<string[]>>;
|
|
14963
15576
|
/**
|
|
14964
15577
|
* 获取指定人员在黑名单中的状态
|
|
14965
15578
|
*/
|
|
14966
|
-
getBlacklistStatus(userId: string): Promise<
|
|
15579
|
+
getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
14967
15580
|
/**
|
|
14968
15581
|
* 向本地插入一条消息,不发送到服务器
|
|
14969
15582
|
*/
|
|
@@ -15006,11 +15619,11 @@ declare class APIContext {
|
|
|
15006
15619
|
/**
|
|
15007
15620
|
* 设置消息发送状态
|
|
15008
15621
|
*/
|
|
15009
|
-
setMessageSentStatus(messageId: number, sentStatus: number): Promise<
|
|
15622
|
+
setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
15010
15623
|
/**
|
|
15011
15624
|
* 设置消息接收状态
|
|
15012
15625
|
*/
|
|
15013
|
-
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<
|
|
15626
|
+
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
15014
15627
|
/**
|
|
15015
15628
|
* 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
|
|
15016
15629
|
*/
|
|
@@ -15029,11 +15642,11 @@ declare class APIContext {
|
|
|
15029
15642
|
* 获取用户在线状态
|
|
15030
15643
|
* @deprecated 老版 V2 中用到
|
|
15031
15644
|
*/
|
|
15032
|
-
getUserStatus(userId: string): Promise<
|
|
15645
|
+
getUserStatus(userId: string): Promise<RCResult<{
|
|
15033
15646
|
status: string;
|
|
15034
15647
|
}>>;
|
|
15035
15648
|
searchConversationByContent(keyword: string, messageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
15036
|
-
searchConversationByContentWithAllChannel(keyword: string, messageTypes?: string[], conversationTypes?: ConversationType[]): Promise<
|
|
15649
|
+
searchConversationByContentWithAllChannel(keyword: string, messageTypes?: string[], conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
15037
15650
|
/**
|
|
15038
15651
|
* 单会话搜索,为兼容老版本参数校验错误码和校验规则
|
|
15039
15652
|
* @param conversation
|
|
@@ -15049,7 +15662,6 @@ declare class APIContext {
|
|
|
15049
15662
|
searchMessagesWithParams(params: ISearchMessageParams): Promise<RCResult<ISearchMessagesResult>>;
|
|
15050
15663
|
getMessagesAroundTimestamp(conversation: IConversationOption, timestamp: number, beforeCount: number, afterCount: number): Promise<RCResult<IReceivedMessage[]>>;
|
|
15051
15664
|
getUnreadMentionedMessages(conversation: IConversationOption): Promise<RCResult<IReceivedMessage[]>>;
|
|
15052
|
-
clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
|
|
15053
15665
|
/**
|
|
15054
15666
|
* 查询指定超级群默认通知配置
|
|
15055
15667
|
*/
|
|
@@ -15078,68 +15690,21 @@ declare class APIContext {
|
|
|
15078
15690
|
/**
|
|
15079
15691
|
* 设置融云消息重排开关
|
|
15080
15692
|
*/
|
|
15081
|
-
setCheckDuplicateMessage(enableCheck
|
|
15082
|
-
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<
|
|
15083
|
-
|
|
15084
|
-
buffer?: Uint8Array;
|
|
15085
|
-
}>;
|
|
15086
|
-
rtcPing(roomId: string, mode: number, mediaType?: number): Promise<IAsyncRes<any>>;
|
|
15693
|
+
setCheckDuplicateMessage(enableCheck?: boolean): Promise<RCResult<boolean>>;
|
|
15694
|
+
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<RCResult<Uint8Array>>;
|
|
15695
|
+
rtcPing(roomId: string, mode: number, mediaType?: number): Promise<RCResult<any>>;
|
|
15087
15696
|
/**
|
|
15088
15697
|
* 设置代理
|
|
15089
15698
|
*/
|
|
15090
|
-
setProxy(proxy: IProxy | null):
|
|
15699
|
+
setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
15091
15700
|
/**
|
|
15092
15701
|
* 获取代理
|
|
15093
15702
|
*/
|
|
15094
|
-
getProxy():
|
|
15703
|
+
getProxy(): Promise<RCResult<IProxy>>;
|
|
15095
15704
|
/**
|
|
15096
15705
|
* 测试代理
|
|
15097
15706
|
*/
|
|
15098
|
-
testProxy(proxy: IProxy, testHost: string): Promise<
|
|
15099
|
-
createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15100
|
-
[key: string]: string;
|
|
15101
|
-
} | undefined, inviteeUserIds?: string[]): Promise<IAsyncRes<ICreateGroupFail>>;
|
|
15102
|
-
updateGroupInfo(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15103
|
-
[key: string]: string;
|
|
15104
|
-
} | undefined): Promise<IAsyncRes<IErrorKeys>>;
|
|
15105
|
-
getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15106
|
-
kickGroupMembers(groupId: string, userIds: string[], config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15107
|
-
quitGroup(groupId: string, config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15108
|
-
dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
|
|
15109
|
-
transferGroupOwner(groupId: string, newOwnerId: string, config: IQuitGroupConfig, quitGroupAfterTransfer?: boolean): Promise<IAsyncRes<void>>;
|
|
15110
|
-
setGroupManagers(type: GroupOperationType, groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15111
|
-
getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15112
|
-
getGroupMembers(groupId: string, userIds: string[]): Promise<IAsyncRes<IGroupMemberInfo[]>>;
|
|
15113
|
-
setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<IAsyncRes<IErrorKeys>>;
|
|
15114
|
-
searchGroupMembers(groupId: string, nickName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15115
|
-
joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15116
|
-
inviteUsersToGroup(groupId: string, userIds: string[]): Promise<IAsyncRes<IProcessCode>>;
|
|
15117
|
-
acceptGroupInvite(groupId: string, inviterId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15118
|
-
refuseGroupInvite(groupId: string, inviterId: string, reason: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15119
|
-
acceptGroupApplication(groupId: string, joinUserId: string, inviterId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15120
|
-
refuseGroupApplication(groupId: string, joinUserId: string, inviterId: string, reason?: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15121
|
-
getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
15122
|
-
getJoinedGroupsByRole(role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15123
|
-
searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15124
|
-
getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15125
|
-
setGroupRemark(groupId: string, remark: string | null): Promise<IAsyncRes<void>>;
|
|
15126
|
-
addGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15127
|
-
removeGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15128
|
-
getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInfo[]>>;
|
|
15129
|
-
addFriend(userId: string, directionType: DirectionType, extra: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15130
|
-
deleteFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<void>>;
|
|
15131
|
-
acceptFriendApplication(userId: string): Promise<IAsyncRes<void>>;
|
|
15132
|
-
refuseFriendApplication(userId: string, reason: string): Promise<IAsyncRes<void>>;
|
|
15133
|
-
setFriendInfo(userId: string, remark: string, extProfile: {
|
|
15134
|
-
[key: string]: string;
|
|
15135
|
-
}): Promise<IAsyncRes<IErrorKeys>>;
|
|
15136
|
-
checkFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<IFriendRelationInfo[]>>;
|
|
15137
|
-
getFriends(directionType: QueryFriendsDirectionType, option: IPagingQueryOption | undefined): Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>;
|
|
15138
|
-
getFriendApplications(option: IPagingQueryOption, type?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
15139
|
-
getFriendsInfo(userIds: string[]): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15140
|
-
searchFriendsInfo(nickname: string): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15141
|
-
setFriendAddPermission(permission: FriendAddPermission): Promise<IAsyncRes<void>>;
|
|
15142
|
-
getFriendAddPermission(): Promise<IAsyncRes<FriendAddPermission>>;
|
|
15707
|
+
testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
15143
15708
|
/**
|
|
15144
15709
|
* 查询实时会话列表
|
|
15145
15710
|
*/
|
|
@@ -15194,6 +15759,8 @@ declare class APIContext {
|
|
|
15194
15759
|
*/
|
|
15195
15760
|
deleteLocalUGMessagesForAllChannel(targetId: string, timestamp: number): Promise<RCResult>;
|
|
15196
15761
|
getUnreadMentionMeConversationList(params: IGetUnreadMentionMeConversationListParams): Promise<RCResult<IReceivedConversation[]>>;
|
|
15762
|
+
getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
15763
|
+
getRobotById(id: string): Promise<RCResult<IRobotInfo | null>>;
|
|
15197
15764
|
}
|
|
15198
15765
|
|
|
15199
15766
|
declare class RTCPluginContext extends PluginContext {
|
|
@@ -15221,15 +15788,7 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
15221
15788
|
* rtc 房间保活
|
|
15222
15789
|
* 新版本 rtc ping 返回值增加 version 信息
|
|
15223
15790
|
*/
|
|
15224
|
-
rtcPingResVersion(roomId: string, mode: number, broadcastType?: number): Promise<
|
|
15225
|
-
/**
|
|
15226
|
-
* @deprecated 兼容 rtc v3 方法调用
|
|
15227
|
-
*/
|
|
15228
|
-
getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
|
|
15229
|
-
/**
|
|
15230
|
-
* @deprecated 兼容 rtc v3 方法调用
|
|
15231
|
-
*/
|
|
15232
|
-
getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
|
|
15791
|
+
rtcPingResVersion(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
15233
15792
|
/**
|
|
15234
15793
|
* @deprecated
|
|
15235
15794
|
*/
|
|
@@ -15400,9 +15959,8 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
15400
15959
|
*/
|
|
15401
15960
|
declare type IUserSettingsModule = Pick<IIPCMethods, 'setTranslationLanguage' | 'getTranslationLanguage' | 'setAutoTranslateEnabled' | 'getAutoTranslateEnabled'>;
|
|
15402
15961
|
|
|
15403
|
-
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' | 'getUserProfiles'>;
|
|
15962
|
+
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' | 'setUserStatusListener' | 'getFileToken' | 'rtcSignaling' | 'rtcPing' | 'setCallInfo' | 'getUserStatus' | 'searchConversationByContentWithAllChannel' | 'getAllRobots'>;
|
|
15404
15963
|
declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContext {
|
|
15405
|
-
protected readonly rtcCodec: Codec<InnerRTCKeyMaps>;
|
|
15406
15964
|
protected readonly _watcher: IEngineWatcher;
|
|
15407
15965
|
protected readonly _options: IAPIContextOption;
|
|
15408
15966
|
private readonly _logger;
|
|
@@ -15417,6 +15975,9 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15417
15975
|
*/
|
|
15418
15976
|
abstract get chat(): IChatService;
|
|
15419
15977
|
abstract get chatroom(): IChatroomService;
|
|
15978
|
+
/**
|
|
15979
|
+
* 用户级配置模块
|
|
15980
|
+
*/
|
|
15420
15981
|
abstract get userSettings(): IUserSettingsModule;
|
|
15421
15982
|
abstract get naviInfo(): INaviInfo | null;
|
|
15422
15983
|
get appkey(): string;
|
|
@@ -15424,11 +15985,16 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15424
15985
|
abstract get connectionStatus(): RCConnectionStatus;
|
|
15425
15986
|
abstract get userId(): string;
|
|
15426
15987
|
get logger(): BasicLogger;
|
|
15988
|
+
abstract get usingCppEngine(): boolean;
|
|
15989
|
+
/**
|
|
15990
|
+
* 用户信息托管模块
|
|
15991
|
+
*/
|
|
15992
|
+
abstract get dataHosting(): IDataHostingService;
|
|
15427
15993
|
/**
|
|
15428
15994
|
* 引擎初始化
|
|
15429
15995
|
* @param _appkey
|
|
15430
15996
|
*/
|
|
15431
|
-
constructor(
|
|
15997
|
+
constructor(_watcher: IEngineWatcher, _options: IAPIContextOption, _logger: BasicLogger);
|
|
15432
15998
|
protected _rtcSignalingListener?: (buffer: Uint8Array) => void;
|
|
15433
15999
|
/**
|
|
15434
16000
|
* 注册 RTC KV 变更监听器
|
|
@@ -15450,7 +16016,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15450
16016
|
* @param openCallPlus
|
|
15451
16017
|
* @param traceId
|
|
15452
16018
|
*/
|
|
15453
|
-
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string):
|
|
16019
|
+
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): Promise<RCResult<string>>;
|
|
15454
16020
|
/**
|
|
15455
16021
|
* 发送 SDK 版本
|
|
15456
16022
|
* @param versionInfo
|
|
@@ -15472,59 +16038,27 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15472
16038
|
* 清除指定会话消息草稿
|
|
15473
16039
|
*/
|
|
15474
16040
|
abstract clearTextMessageDraft(conversation: IConversationOption): Promise<RCResult>;
|
|
15475
|
-
abstract sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, traceId: string,
|
|
15476
16041
|
/**
|
|
15477
|
-
*
|
|
15478
|
-
|
|
15479
|
-
|
|
15480
|
-
|
|
15481
|
-
*
|
|
15482
|
-
* @param targetId
|
|
15483
|
-
* @param messageUIds
|
|
15484
|
-
*/
|
|
15485
|
-
abstract getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
|
|
15486
|
-
/**
|
|
15487
|
-
* 发送已读回执 (V4)
|
|
15488
|
-
*/
|
|
15489
|
-
abstract sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
15490
|
-
/**
|
|
15491
|
-
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
15492
|
-
*/
|
|
15493
|
-
abstract getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
15494
|
-
/**
|
|
15495
|
-
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
15496
|
-
*/
|
|
15497
|
-
abstract batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
|
|
15498
|
-
/**
|
|
15499
|
-
* 多端同步会话的已读时间 (V4)
|
|
16042
|
+
* 发送消息
|
|
16043
|
+
* @param identifier 会话标识
|
|
16044
|
+
* @param options 消息发送配置
|
|
16045
|
+
* @param traceId 追踪 ID
|
|
16046
|
+
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
15500
16047
|
*/
|
|
15501
|
-
abstract
|
|
16048
|
+
abstract sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
15502
16049
|
/**
|
|
15503
16050
|
* 断开连接
|
|
15504
16051
|
* @param closeDB 是否关闭数据库,默认为 true,仅 Electron 平台有效
|
|
15505
16052
|
* @param disablePush 是否禁用推送,默认为 false(≥ 5.20.0)
|
|
15506
16053
|
*/
|
|
15507
|
-
abstract disconnect(closeDB?: boolean, disablePush?: boolean): Promise<
|
|
16054
|
+
abstract disconnect(closeDB?: boolean, disablePush?: boolean): Promise<RCResult>;
|
|
15508
16055
|
/**
|
|
15509
16056
|
* 消息注册
|
|
15510
16057
|
* @description
|
|
15511
16058
|
* 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
15512
16059
|
*/
|
|
15513
16060
|
abstract registerMessageType(objectName: string, desc: MessageRegisterParams): void;
|
|
15514
|
-
|
|
15515
|
-
* 获取存储服务鉴权信息
|
|
15516
|
-
* @param fileType 文件类型
|
|
15517
|
-
* @param fileName 文件名称
|
|
15518
|
-
* @param httpMethod STC 分段上传时的必填参数,有效值为 PUT | POST
|
|
15519
|
-
* @param queryString STC 分段上传时的查询字符串
|
|
15520
|
-
* @description
|
|
15521
|
-
* `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
|
|
15522
|
-
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
|
|
15523
|
-
* 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
|
|
15524
|
-
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
15525
|
-
* @returns
|
|
15526
|
-
*/
|
|
15527
|
-
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryString?: string, url?: string, size?: number): Promise<IAsyncRes<IUploadAuth>>;
|
|
16061
|
+
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth>>;
|
|
15528
16062
|
/**
|
|
15529
16063
|
* 获取文件的下载地址
|
|
15530
16064
|
* @param fileType 文件类型
|
|
@@ -15573,7 +16107,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15573
16107
|
* @param targetId
|
|
15574
16108
|
* @param options
|
|
15575
16109
|
*/
|
|
15576
|
-
abstract sendUltraMessage(
|
|
16110
|
+
abstract sendUltraMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onSendBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
15577
16111
|
/**
|
|
15578
16112
|
* 设置用户在线状态监听器
|
|
15579
16113
|
*/
|
|
@@ -15591,25 +16125,25 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15591
16125
|
/**
|
|
15592
16126
|
* 获取用户状态
|
|
15593
16127
|
*/
|
|
15594
|
-
abstract getUserStatus(userId: string):
|
|
16128
|
+
abstract getUserStatus(userId: string): Promise<RCResult<{
|
|
15595
16129
|
status: string;
|
|
15596
|
-
}
|
|
16130
|
+
}>>;
|
|
15597
16131
|
/**
|
|
15598
16132
|
* 加入黑名单
|
|
15599
16133
|
*/
|
|
15600
|
-
abstract addToBlacklist(userId: string): Promise<
|
|
16134
|
+
abstract addToBlacklist(userId: string): Promise<RCResult>;
|
|
15601
16135
|
/**
|
|
15602
16136
|
* 将指定用户移除黑名单
|
|
15603
16137
|
*/
|
|
15604
|
-
abstract removeFromBlacklist(userId: string): Promise<
|
|
16138
|
+
abstract removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
15605
16139
|
/**
|
|
15606
16140
|
* 获取黑名单列表
|
|
15607
16141
|
*/
|
|
15608
|
-
abstract getBlacklist():
|
|
16142
|
+
abstract getBlacklist(): Promise<RCResult<string[]>>;
|
|
15609
16143
|
/**
|
|
15610
16144
|
* 获取指定人员在黑名单中的状态
|
|
15611
16145
|
*/
|
|
15612
|
-
abstract getBlacklistStatus(userId: string):
|
|
16146
|
+
abstract getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
15613
16147
|
/**
|
|
15614
16148
|
* 向本地插入一条消息,不发送到服务器
|
|
15615
16149
|
*/
|
|
@@ -15651,28 +16185,24 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15651
16185
|
/**
|
|
15652
16186
|
* 通过关键字搜索所有会话
|
|
15653
16187
|
*/
|
|
15654
|
-
abstract searchConversationByContentWithAllChannel(keyword: string, messageTypes: string[], conversationTypes: ConversationType[]):
|
|
16188
|
+
abstract searchConversationByContentWithAllChannel(keyword: string, messageTypes: string[], conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
15655
16189
|
abstract searchMessagesWithParams(params: ISearchMessageParams): Promise<RCResult<ISearchMessagesResult>>;
|
|
15656
16190
|
/**
|
|
15657
16191
|
* 设置消息发送状态
|
|
15658
16192
|
*/
|
|
15659
|
-
abstract setMessageSentStatus(messageId: number, sentStatus: number): Promise<
|
|
16193
|
+
abstract setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
15660
16194
|
/**
|
|
15661
16195
|
* 设置消息接收状态
|
|
15662
16196
|
*/
|
|
15663
|
-
abstract setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<
|
|
16197
|
+
abstract setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
15664
16198
|
/**
|
|
15665
16199
|
* 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
|
|
15666
16200
|
*/
|
|
15667
16201
|
abstract updateMessageReceiptStatus(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<RCResult<boolean>>;
|
|
15668
|
-
|
|
15669
|
-
* 删除时间戳前的未读数
|
|
15670
|
-
*/
|
|
15671
|
-
abstract clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
|
|
15672
|
-
abstract setCallInfo(targetId: string, key: string, value: string): IPromiseResult<{
|
|
16202
|
+
abstract setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
15673
16203
|
key: string;
|
|
15674
16204
|
value: string;
|
|
15675
|
-
}
|
|
16205
|
+
}>>;
|
|
15676
16206
|
abstract clearLocalData(): Promise<RCResult<boolean>>;
|
|
15677
16207
|
/**
|
|
15678
16208
|
* 获取运行时的系统信息,仅限 Electron 平台可用
|
|
@@ -15689,7 +16219,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15689
16219
|
/**
|
|
15690
16220
|
* 设置融云消息重排开关
|
|
15691
16221
|
*/
|
|
15692
|
-
abstract setCheckDuplicateMessage(enableCheck: boolean):
|
|
16222
|
+
abstract setCheckDuplicateMessage(enableCheck: boolean): Promise<RCResult<boolean>>;
|
|
15693
16223
|
/**
|
|
15694
16224
|
* RTC 通用调用接口
|
|
15695
16225
|
* 在非 Comet 协议下,入参 sourceData 应为 ArrayBuffer 数据,返回结果为 Uint8Array 数据
|
|
@@ -15698,12 +16228,9 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15698
16228
|
* @param isQuery 使用 `qry` or `pub` 进行请求,按服务要求传递
|
|
15699
16229
|
* @param sourceData PB 数据
|
|
15700
16230
|
*/
|
|
15701
|
-
abstract rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: ArrayBuffer): Promise<
|
|
15702
|
-
|
|
15703
|
-
|
|
15704
|
-
}>;
|
|
15705
|
-
abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
|
|
15706
|
-
pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<IAsyncRes<number>>;
|
|
16231
|
+
abstract rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: ArrayBuffer): Promise<RCResult<Uint8Array>>;
|
|
16232
|
+
abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
16233
|
+
pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<RCResult<number>>;
|
|
15707
16234
|
/**
|
|
15708
16235
|
* 接收 rtc 资源变更
|
|
15709
16236
|
*/
|
|
@@ -15715,15 +16242,15 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15715
16242
|
/**
|
|
15716
16243
|
* 设置代理
|
|
15717
16244
|
*/
|
|
15718
|
-
abstract setProxy(proxy: IProxy | null):
|
|
16245
|
+
abstract setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
15719
16246
|
/**
|
|
15720
16247
|
* 获取代理
|
|
15721
16248
|
*/
|
|
15722
|
-
abstract getProxy():
|
|
16249
|
+
abstract getProxy(): Promise<RCResult<IProxy>>;
|
|
15723
16250
|
/**
|
|
15724
16251
|
* 测试代理
|
|
15725
16252
|
*/
|
|
15726
|
-
abstract testProxy(proxy: IProxy, testHost: string): Promise<
|
|
16253
|
+
abstract testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
15727
16254
|
/**
|
|
15728
16255
|
* 设置当前网络
|
|
15729
16256
|
*/
|
|
@@ -15731,73 +16258,22 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15731
16258
|
/**
|
|
15732
16259
|
* 订阅用户状态事件
|
|
15733
16260
|
*/
|
|
15734
|
-
abstract subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
16261
|
+
abstract subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
15735
16262
|
/**
|
|
15736
16263
|
* 取消订阅用户状态事件
|
|
15737
16264
|
*/
|
|
15738
|
-
abstract unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
16265
|
+
abstract unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
15739
16266
|
/**
|
|
15740
16267
|
* 获取已订阅列表
|
|
15741
16268
|
*/
|
|
15742
|
-
abstract getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<
|
|
16269
|
+
abstract getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
15743
16270
|
/**
|
|
15744
16271
|
* 获取指定用户的在线状态
|
|
15745
16272
|
*/
|
|
15746
16273
|
abstract getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
15747
|
-
abstract updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
16274
|
+
abstract updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
15748
16275
|
abstract getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
15749
|
-
abstract getMyUserProfile(): Promise<
|
|
15750
|
-
abstract updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
|
|
15751
|
-
abstract getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
|
|
15752
|
-
abstract searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
|
|
15753
|
-
abstract createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15754
|
-
[key: string]: string;
|
|
15755
|
-
} | undefined, inviteeUserIds: string[]): Promise<IAsyncRes<ICreateGroupFail>>;
|
|
15756
|
-
abstract updateGroupInfo(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15757
|
-
[key: string]: string;
|
|
15758
|
-
} | undefined): Promise<IAsyncRes<IErrorKeys>>;
|
|
15759
|
-
abstract getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15760
|
-
abstract kickGroupMembers(groupId: string, userIds: string[], config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15761
|
-
abstract quitGroup(groupId: string, config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15762
|
-
abstract dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
|
|
15763
|
-
abstract transferGroupOwner(groupId: string, newOwnerId: string, quitGroupAfterTransfer: boolean, config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15764
|
-
abstract setGroupManagers(type: GroupOperationType, groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15765
|
-
abstract getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15766
|
-
abstract getGroupMembers(groupId: string, userIds: string[]): Promise<IAsyncRes<IGroupMemberInfo[]>>;
|
|
15767
|
-
abstract setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<IAsyncRes<IErrorKeys>>;
|
|
15768
|
-
abstract searchGroupMembers(groupId: string, nickName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15769
|
-
abstract joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15770
|
-
abstract inviteUsersToGroup(groupId: string, userIds: string[]): Promise<IAsyncRes<IProcessCode>>;
|
|
15771
|
-
abstract memberInviteResponse(params: {
|
|
15772
|
-
groupId: string;
|
|
15773
|
-
inviterId: string;
|
|
15774
|
-
optType: GroupOperationRole;
|
|
15775
|
-
optResult: GroupOperationStatus;
|
|
15776
|
-
joinUserId?: string;
|
|
15777
|
-
reason?: string;
|
|
15778
|
-
}): Promise<IAsyncRes<IProcessCode>>;
|
|
15779
|
-
abstract getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
15780
|
-
abstract getJoinedGroupsByRole(role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15781
|
-
abstract searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15782
|
-
abstract getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15783
|
-
abstract setGroupRemark(groupId: string, remark: string | null): Promise<IAsyncRes<void>>;
|
|
15784
|
-
abstract setGroupFollows(optType: GroupOperationType, groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15785
|
-
abstract getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInfo[]>>;
|
|
15786
|
-
abstract addFriend(userId: string, directionType: DirectionType, extra: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15787
|
-
abstract deleteFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<void>>;
|
|
15788
|
-
abstract acceptFriendApplication(userId: string): Promise<IAsyncRes<void>>;
|
|
15789
|
-
abstract refuseFriendApplication(userId: string, reason: string): Promise<IAsyncRes<void>>;
|
|
15790
|
-
abstract setFriendInfo(userId: string, remark: string, extProfile: {
|
|
15791
|
-
[key: string]: string;
|
|
15792
|
-
}): Promise<IAsyncRes<IErrorKeys>>;
|
|
15793
|
-
abstract checkFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<IFriendRelationInfo[]>>;
|
|
15794
|
-
abstract getFriends(directionType: QueryFriendsDirectionType, option: IPagingQueryOption | undefined): Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>;
|
|
15795
|
-
abstract getFriendApplications(option: IPagingQueryOption, type?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
15796
|
-
abstract deleteFriendApplication(userId: string, type: FriendApplicationType): Promise<IAsyncRes<void>>;
|
|
15797
|
-
abstract getFriendsInfo(userIds: string[]): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15798
|
-
abstract searchFriendsInfo(nickname: string): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15799
|
-
abstract setFriendAddPermission(permission: FriendAddPermission): Promise<IAsyncRes<void>>;
|
|
15800
|
-
abstract getFriendAddPermission(): Promise<IAsyncRes<FriendAddPermission>>;
|
|
16276
|
+
abstract getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
15801
16277
|
abstract setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
15802
16278
|
abstract removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
15803
16279
|
abstract getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
@@ -15808,6 +16284,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15808
16284
|
abstract translateWithParams(list: InnerTransParam[], mode: TranslateMode, force: boolean, from: 0 | 1): Promise<RCResult>;
|
|
15809
16285
|
abstract getLocalMessageCount(conversation: IConversationOption): Promise<RCResult<number>>;
|
|
15810
16286
|
abstract getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCResult<ISubscribeUserOnlineStatus[]>>;
|
|
16287
|
+
abstract getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
15811
16288
|
}
|
|
15812
16289
|
|
|
15813
16290
|
/**
|
|
@@ -15870,107 +16347,6 @@ declare class SSEModule extends EventDispatcher<{
|
|
|
15870
16347
|
requestStreamMessageContent(messageUId: string): Promise<RCResult>;
|
|
15871
16348
|
}
|
|
15872
16349
|
|
|
15873
|
-
interface IDataHostingModule {
|
|
15874
|
-
}
|
|
15875
|
-
|
|
15876
|
-
/**
|
|
15877
|
-
* 错误码映射表,单个标签且对应唯一错误码
|
|
15878
|
-
*/
|
|
15879
|
-
interface IErrorCodeKey {
|
|
15880
|
-
'set.proxy': number;
|
|
15881
|
-
'test.proxy': number;
|
|
15882
|
-
'test.proxy.socksHost': number;
|
|
15883
|
-
'test.proxy.socksPort': number;
|
|
15884
|
-
channelId: number;
|
|
15885
|
-
count: number;
|
|
15886
|
-
startTime: number;
|
|
15887
|
-
keyword: number;
|
|
15888
|
-
messageTypes: number;
|
|
15889
|
-
conversation: number;
|
|
15890
|
-
conversationType: number;
|
|
15891
|
-
targetId: number;
|
|
15892
|
-
endTime: number;
|
|
15893
|
-
offset: number;
|
|
15894
|
-
limit: number;
|
|
15895
|
-
userId: number;
|
|
15896
|
-
timestamp: number;
|
|
15897
|
-
sentTime: number;
|
|
15898
|
-
order: number;
|
|
15899
|
-
messageId: number;
|
|
15900
|
-
receivedStatus: number;
|
|
15901
|
-
receivedStatusInfo: number;
|
|
15902
|
-
sentStatus: number;
|
|
15903
|
-
content: number;
|
|
15904
|
-
messageType: number;
|
|
15905
|
-
messageIds: number;
|
|
15906
|
-
typingContentType: number;
|
|
15907
|
-
messageDirection: number;
|
|
15908
|
-
canIncludeExpansion: number;
|
|
15909
|
-
expansion: number;
|
|
15910
|
-
disableNotification: number;
|
|
15911
|
-
messages: number;
|
|
15912
|
-
checkDuplicate: number;
|
|
15913
|
-
messageUId: number;
|
|
15914
|
-
key: number;
|
|
15915
|
-
value: number;
|
|
15916
|
-
isAutoDelete: number;
|
|
15917
|
-
isSendNotification: number;
|
|
15918
|
-
notificationExtra: number;
|
|
15919
|
-
entries: number;
|
|
15920
|
-
isForce: number;
|
|
15921
|
-
rtcRoomId: number;
|
|
15922
|
-
token: number;
|
|
15923
|
-
conversations: number;
|
|
15924
|
-
conversationTypes: number;
|
|
15925
|
-
levels: number;
|
|
15926
|
-
notificationLevel: number;
|
|
15927
|
-
notificationLevels: number;
|
|
15928
|
-
notificationStatus: number;
|
|
15929
|
-
isTop: number;
|
|
15930
|
-
isUpdateTime: number;
|
|
15931
|
-
message: number;
|
|
15932
|
-
isStatusMessage: number;
|
|
15933
|
-
pushContent: number;
|
|
15934
|
-
pushData: number;
|
|
15935
|
-
isMentioned: number;
|
|
15936
|
-
mentionedType: number;
|
|
15937
|
-
mentionedUserIdList: number;
|
|
15938
|
-
directionalUserIdList: number;
|
|
15939
|
-
directedUserIds: number;
|
|
15940
|
-
isVoipPush: number;
|
|
15941
|
-
pushConfig: number;
|
|
15942
|
-
startMsgUId: number;
|
|
15943
|
-
endMsgUId: number;
|
|
15944
|
-
clearMessageOption: number;
|
|
15945
|
-
keys: number;
|
|
15946
|
-
searchContent: number;
|
|
15947
|
-
senderUserId: number;
|
|
15948
|
-
tagId: number;
|
|
15949
|
-
tagName: number;
|
|
15950
|
-
tagIds: number;
|
|
15951
|
-
containMuted: number;
|
|
15952
|
-
channelType: number;
|
|
15953
|
-
targetIds: number;
|
|
15954
|
-
file: number;
|
|
15955
|
-
fileType: number;
|
|
15956
|
-
contentDisposition: number;
|
|
15957
|
-
mediaUrl: number;
|
|
15958
|
-
filename: number;
|
|
15959
|
-
saveName: number;
|
|
15960
|
-
serverType: number;
|
|
15961
|
-
subscribeType: number;
|
|
15962
|
-
expiry: number;
|
|
15963
|
-
subscribeUserIds: number;
|
|
15964
|
-
subscribePageSize: number;
|
|
15965
|
-
conversationList: number;
|
|
15966
|
-
conversationTypeNotSupport: number;
|
|
15967
|
-
profile: number;
|
|
15968
|
-
userProfileVisibility: number;
|
|
15969
|
-
uniqueId: number;
|
|
15970
|
-
extra: number;
|
|
15971
|
-
disableUpdateLastMessage: number;
|
|
15972
|
-
}
|
|
15973
|
-
|
|
15974
16350
|
/**
|
|
15975
16351
|
* 预定义的验证规则,只包含 `值类型` 数据验证
|
|
15976
16352
|
* 引用类型数据需使用自定义 validator 校验函数进行校验
|
|
@@ -16007,15 +16383,7 @@ declare enum AssertRules {
|
|
|
16007
16383
|
/**
|
|
16008
16384
|
* ChannelId 验证,必须为 String 且不超过 20 位 且不能包含下划线
|
|
16009
16385
|
*/
|
|
16010
|
-
CHANNEL_ID = 7
|
|
16011
|
-
/**
|
|
16012
|
-
* 类型为会话
|
|
16013
|
-
*/
|
|
16014
|
-
CONVERSATION = 8,
|
|
16015
|
-
/**
|
|
16016
|
-
* 会话类型验证,必须为 ConversationType
|
|
16017
|
-
*/
|
|
16018
|
-
CONVERSATION_TYPE = 9
|
|
16386
|
+
CHANNEL_ID = 7
|
|
16019
16387
|
}
|
|
16020
16388
|
/**
|
|
16021
16389
|
* 参数校验,该方法用于对业务层入参数据检查,及时抛出异常通知业务层进行修改
|
|
@@ -16041,91 +16409,6 @@ declare const assert: (key: string, value: any, validator: AssertRules | ((value
|
|
|
16041
16409
|
*/
|
|
16042
16410
|
declare const validate: (key: string, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean) => boolean;
|
|
16043
16411
|
|
|
16044
|
-
/**
|
|
16045
|
-
* @deprecated
|
|
16046
|
-
*/
|
|
16047
|
-
declare class ValidatorManage<T> {
|
|
16048
|
-
private _logTagT;
|
|
16049
|
-
private _logTagR;
|
|
16050
|
-
private verificationFaileList;
|
|
16051
|
-
private context?;
|
|
16052
|
-
private logger?;
|
|
16053
|
-
private option?;
|
|
16054
|
-
constructor(_logTagT: string, _logTagR: string);
|
|
16055
|
-
/**
|
|
16056
|
-
* 添加效验参数
|
|
16057
|
-
* @param key 错误码标签
|
|
16058
|
-
* @param value 需要校验的值
|
|
16059
|
-
* @param validator 效验规则
|
|
16060
|
-
* @param required 是否必填
|
|
16061
|
-
* @param message 自定义错误信息
|
|
16062
|
-
*/
|
|
16063
|
-
validate(key: keyof IErrorCodeKey, value: any, validator: AssertRules | ((value?: any) => {
|
|
16064
|
-
errorKey?: keyof IErrorCodeKey;
|
|
16065
|
-
valid: boolean;
|
|
16066
|
-
}) | ((value?: any) => boolean), required?: boolean, message?: string): this;
|
|
16067
|
-
/**
|
|
16068
|
-
* 验证参数
|
|
16069
|
-
* @param key 错误码标签
|
|
16070
|
-
* @param value 需要校验的值
|
|
16071
|
-
* @param validator 效验规则
|
|
16072
|
-
* @param errorCode 错误码
|
|
16073
|
-
* @param required 是否必填
|
|
16074
|
-
* @param message 自定义错误信息
|
|
16075
|
-
* @description 代替 validate 方法,支持传入错误码,无需定义 Key
|
|
16076
|
-
*/
|
|
16077
|
-
validateParameters(key: string, value: any, validator: AssertRules | ((value?: any) => {
|
|
16078
|
-
errorKey?: string;
|
|
16079
|
-
valid: boolean;
|
|
16080
|
-
errorCode?: ErrorCode;
|
|
16081
|
-
}) | ((value?: any) => boolean), errorCode: ErrorCode, required?: boolean, message?: string): this;
|
|
16082
|
-
private _getValidationResult;
|
|
16083
|
-
/**
|
|
16084
|
-
* 内部验证接口是否完成初始化,若未完成初始化,返回状态码 `ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT`
|
|
16085
|
-
* @param handler 验证初始化完成的回调,其接收 APIContext, BasicLogger 与 IAPIContextOption 两个类型参数
|
|
16086
|
-
* @param errorTag 验证失败时,需要留存的日志信息
|
|
16087
|
-
* @description 对外接口定义中,使用此函数验证 SDK 初始化是否完成。
|
|
16088
|
-
*/
|
|
16089
|
-
ifReady(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption, traceId: string) => Promise<IAsyncRes<T>>): Promise<IAsyncRes<T>>;
|
|
16090
|
-
/**
|
|
16091
|
-
* 尝试调用需要初始化完成的函数,若未完成初始化,抛出异常 `Not initialized yet!`
|
|
16092
|
-
* @param handler
|
|
16093
|
-
* @returns
|
|
16094
|
-
* @throw `Not initialized yet!`
|
|
16095
|
-
* @description 对外接口定义中,若无明确 code 码返回的情况下,使用该函数验证 SDK 初始化是否完成。
|
|
16096
|
-
* 新增接口不可使用。
|
|
16097
|
-
*/
|
|
16098
|
-
try2do(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => T): T;
|
|
16099
|
-
/**
|
|
16100
|
-
* `_ifReady` 同步版本,若未完成初始化,返回状态码 `ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT`
|
|
16101
|
-
* @param handler 验证初始化完成的回调,其接收 APIContext, BasicLogger 与 IAPIContextOption 两个类型参数
|
|
16102
|
-
* @description 对外接口定义中,使用此函数验证 SDK 初始化是否完成。
|
|
16103
|
-
*/
|
|
16104
|
-
ifReadySync<T>(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => IAsyncRes<T>): IAsyncRes<T>;
|
|
16105
|
-
}
|
|
16106
|
-
|
|
16107
|
-
/**
|
|
16108
|
-
* 检查参数是否为数组
|
|
16109
|
-
* 做长度检查、每一项的类型检查
|
|
16110
|
-
*/
|
|
16111
|
-
declare const isLimitedArray: (option: {
|
|
16112
|
-
minLength?: number | undefined;
|
|
16113
|
-
maxLength?: number | undefined;
|
|
16114
|
-
itemValidator?: ((val: unknown) => boolean) | ((val: unknown) => {
|
|
16115
|
-
errorKey?: keyof IErrorCodeKey;
|
|
16116
|
-
valid: boolean;
|
|
16117
|
-
}) | undefined;
|
|
16118
|
-
}) => (arr: any[]) => boolean;
|
|
16119
|
-
/**
|
|
16120
|
-
* @param conversation 会话信息
|
|
16121
|
-
* @param conversationTypeList 接口支持的会话类型列表,不传则不校验
|
|
16122
|
-
* @returns
|
|
16123
|
-
*/
|
|
16124
|
-
declare const isValidConversation: (conversation: any, conversationTypeList?: ConversationType[] | undefined) => {
|
|
16125
|
-
errorKey?: keyof IErrorCodeKey | undefined;
|
|
16126
|
-
valid: boolean;
|
|
16127
|
-
};
|
|
16128
|
-
|
|
16129
16412
|
/**
|
|
16130
16413
|
* @deprecated 使用 UUId.gen() 替代
|
|
16131
16414
|
*/
|
|
@@ -16158,4 +16441,4 @@ declare class AppStorage {
|
|
|
16158
16441
|
}): void;
|
|
16159
16442
|
}
|
|
16160
16443
|
|
|
16161
|
-
export { APIContext, AbsCodec, AppSettings, AppStorage, AreaCode, AssertRules, BasicEngine, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationBatchDeletionParams, ConversationType, 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,
|
|
16444
|
+
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 };
|