@rongcloud/engine 5.30.0-c-tmp-alpha.2 → 5.32.0-c-rtc-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 +10 -1
- package/index.cjs.js +10 -1
- package/index.d.ts +792 -840
- package/index.esm.js +10 -1
- package/index.mjs +10 -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
|
/** 获取静态配置 */
|
|
@@ -424,6 +423,132 @@ declare const Log: {
|
|
|
424
423
|
readonly A_CLEAR_EDITED_MSG_DRAFT_R: "A-clear_edited_msg_draft-R";
|
|
425
424
|
readonly A_GET_UNREAD_MENTION_ME_CONVERSATION_LIST_T: "A-get_unread_mention_me_conversation_list-T";
|
|
426
425
|
readonly A_GET_UNREAD_MENTION_ME_CONVERSATION_LIST_R: "A-get_unread_mention_me_conversation_list-R";
|
|
426
|
+
readonly A_GET_USER_PROFILES_T: "A-get_user_profiles-T";
|
|
427
|
+
readonly A_GET_USER_PROFILES_R: "A-get_user_profiles-R";
|
|
428
|
+
readonly A_ADD_TO_BLACKLIST_T: "A-add_to_blacklist-T";
|
|
429
|
+
readonly A_ADD_TO_BLACKLIST_R: "A-add_to_blacklist-R";
|
|
430
|
+
readonly A_REMOVE_FROM_BLACKLIST_T: "A-remove_from_blacklist-T";
|
|
431
|
+
readonly A_REMOVE_FROM_BLACKLIST_R: "A-remove_from_blacklist-R";
|
|
432
|
+
readonly A_GET_BLACKLIST_T: "A-get_blacklist-T";
|
|
433
|
+
readonly A_GET_BLACKLIST_R: "A-get_blacklist-R";
|
|
434
|
+
readonly A_GET_BLACKLIST_STATUS_T: "A-get_blacklist_status-T";
|
|
435
|
+
readonly A_GET_BLACKLIST_STATUS_R: "A-get_blacklist_status-R";
|
|
436
|
+
readonly A_E_SET_MSG_RECEIVED_STATUS_T: "A-e_set_msg_received_status-T";
|
|
437
|
+
readonly A_E_SET_MSG_RECEIVED_STATUS_R: "A-e_set_msg_received_status-R";
|
|
438
|
+
readonly A_E_SET_MSG_SENT_STATUS_T: "A-e_set_msg_sent_status-T";
|
|
439
|
+
readonly A_E_SET_MSG_SENT_STATUS_R: "A-e_set_msg_sent_status-R";
|
|
440
|
+
readonly A_E_SET_CHECK_DUPLICATE_MSG_T: "A-e_set_check_duplicate_msg-T";
|
|
441
|
+
readonly A_E_SET_CHECK_DUPLICATE_MSG_R: "A-e_set_check_duplicate_msg-R";
|
|
442
|
+
readonly A_SET_PROXY_T: "A-set_proxy-T";
|
|
443
|
+
readonly A_SET_PROXY_R: "A-set_proxy-R";
|
|
444
|
+
readonly A_GET_PROXY_T: "A-get_proxy-T";
|
|
445
|
+
readonly A_GET_PROXY_R: "A-get_proxy-R";
|
|
446
|
+
readonly A_TEST_PROXY_T: "A-test_proxy-T";
|
|
447
|
+
readonly A_TEST_PROXY_R: "A-test_proxy-R";
|
|
448
|
+
readonly A_CLEAR_UNREAD_COUNT_BY_TIME_T: "A-clear_unread_count_by_time-T";
|
|
449
|
+
readonly A_CLEAR_UNREAD_COUNT_BY_TIME_R: "A-clear_unread_count_by_time-R";
|
|
450
|
+
readonly A_GET_MSG_READER_T: "A-get_msg_reader-T";
|
|
451
|
+
readonly A_GET_MSG_READER_R: "A-get_msg_reader-R";
|
|
452
|
+
readonly A_SEND_READ_RECEIPT_V4_T: "A-send_read_receipt_v4-T";
|
|
453
|
+
readonly A_SEND_READ_RECEIPT_V4_R: "A-send_read_receipt_v4-R";
|
|
454
|
+
readonly A_GET_READ_RECEIPT_V4_T: "A-get_read_receipt_V4-T";
|
|
455
|
+
readonly A_GET_READ_RECEIPT_V4_R: "A-get_read_receipt_V4-R";
|
|
456
|
+
readonly A_BATCH_GET_READ_RECEIPT_INFO_V4_T: "A-batch_get_read_receipt_info_V4-T";
|
|
457
|
+
readonly A_BATCH_GET_READ_RECEIPT_INFO_V4_R: "A-batch_get_read_receipt_info_V4-R";
|
|
458
|
+
readonly A_ADD_FRIEND_T: "A-add_friend-T";
|
|
459
|
+
readonly A_ADD_FRIEND_R: "A-add_friend-R";
|
|
460
|
+
readonly A_DELETE_FRIENDS_T: "A-delete_friends-T";
|
|
461
|
+
readonly A_DELETE_FRIENDS_R: "A-delete_friends-R";
|
|
462
|
+
readonly A_ACCEPT_FRIEND_REQUEST_T: "A-accept_friend_request-T";
|
|
463
|
+
readonly A_ACCEPT_FRIEND_REQUEST_R: "A-accept_friend_request-R";
|
|
464
|
+
readonly A_REFUSE_FRIEND_REQUEST_T: "A-refuse_friend_request-T";
|
|
465
|
+
readonly A_REFUSE_FRIEND_REQUEST_R: "A-refuse_friend_request-R";
|
|
466
|
+
readonly A_SET_FRIEND_INFO_T: "A-set_friend_info-T";
|
|
467
|
+
readonly A_SET_FRIEND_INFO_R: "A-set_friend_info-R";
|
|
468
|
+
readonly A_CHECK_FRIENDS_T: "A-check_friends-T";
|
|
469
|
+
readonly A_CHECK_FRIENDS_R: "A-check_friends-R";
|
|
470
|
+
readonly A_GET_FRIENDS_T: "A-get_friends-T";
|
|
471
|
+
readonly A_GET_FRIENDS_R: "A-get_friends-R";
|
|
472
|
+
readonly A_GET_FRIEND_APPLICATIONS_T: "A-get_friend_applications-T";
|
|
473
|
+
readonly A_GET_FRIEND_APPLICATIONS_R: "A-get_friend_applications-R";
|
|
474
|
+
readonly A_GET_FRIENDS_INFO_T: "A-get_friends_info-T";
|
|
475
|
+
readonly A_GET_FRIENDS_INFO_R: "A-get_friends_info-R";
|
|
476
|
+
readonly A_SEARCH_FRIENDS_INFO_T: "A-search_friends_info-T";
|
|
477
|
+
readonly A_SEARCH_FRIENDS_INFO_R: "A-search_friends_info-R";
|
|
478
|
+
readonly A_SET_FRIEND_ADD_PERMISSION_T: "A-set_friend_add_permission-T";
|
|
479
|
+
readonly A_SET_FRIEND_ADD_PERMISSION_R: "A-set_friend_add_permission-R";
|
|
480
|
+
readonly A_GET_FRIEND_ADD_PERMISSION_T: "A-get_friend_add_permission-T";
|
|
481
|
+
readonly A_GET_FRIEND_ADD_PERMISSION_R: "A-get_friend_add_permission-R";
|
|
482
|
+
readonly A_CREATE_GROUP_T: "A-create_group-T";
|
|
483
|
+
readonly A_CREATE_GROUP_R: "A-create_group-R";
|
|
484
|
+
readonly A_UPDATE_GROUP_INFO_T: "A-update_group_info-T";
|
|
485
|
+
readonly A_UPDATE_GROUP_INFO_R: "A-update_group_info-R";
|
|
486
|
+
readonly A_GET_GROUPS_INFO_T: "A-get_groups_info-T";
|
|
487
|
+
readonly A_GET_GROUPS_INFO_R: "A-get_groups_info-R";
|
|
488
|
+
readonly A_KICK_GROUP_MEMBERS_T: "A-kick_group_members-T";
|
|
489
|
+
readonly A_KICK_GROUP_MEMBERS_R: "A-kick_group_members-R";
|
|
490
|
+
readonly A_QUIT_GROUP_T: "A-quit_group-T";
|
|
491
|
+
readonly A_QUIT_GROUP_R: "A-quit_group-R";
|
|
492
|
+
readonly A_DISMISS_GROUP_T: "A-dismiss_group-T";
|
|
493
|
+
readonly A_DISMISS_GROUP_R: "A-dismiss_group-R";
|
|
494
|
+
readonly A_TRANSFER_GROUP_OWNER_T: "A-transfer_group_owner-T";
|
|
495
|
+
readonly A_TRANSFER_GROUP_OWNER_R: "A-transfer_group_owner-R";
|
|
496
|
+
readonly A_ADD_GROUP_MANAGERS_T: "A-add_group_managers-T";
|
|
497
|
+
readonly A_ADD_GROUP_MANAGERS_R: "A-add_group_managers-R";
|
|
498
|
+
readonly A_REMOVE_GROUP_MANAGERS_T: "A-remove_group_managers-T";
|
|
499
|
+
readonly A_REMOVE_GROUP_MANAGERS_R: "A-remove_group_managers-R";
|
|
500
|
+
readonly A_GET_GROUP_MEMBERS_T: "A-get_group_members-T";
|
|
501
|
+
readonly A_GET_GROUP_MEMBERS_R: "A-get_group_members-R";
|
|
502
|
+
readonly A_SET_GROUP_MEMBER_INFO_T: "A-set_group_member_info-T";
|
|
503
|
+
readonly A_SET_GROUP_MEMBER_INFO_R: "A-set_group_member_info-R";
|
|
504
|
+
readonly A_SEARCH_GROUP_MEMBERS_T: "A-search_group_members-T";
|
|
505
|
+
readonly A_SEARCH_GROUP_MEMBERS_R: "A-search_group_members-R";
|
|
506
|
+
readonly A_JOIN_GROUP_T: "A-join_group-T";
|
|
507
|
+
readonly A_JOIN_GROUP_R: "A-join_group-R";
|
|
508
|
+
readonly A_INVITE_USERS_TO_GROUP_T: "A-invite_users_to_group-T";
|
|
509
|
+
readonly A_INVITE_USERS_TO_GROUP_R: "A-invite_users_to_group-R";
|
|
510
|
+
readonly A_ADD_GROUP_FOLLOWS_T: "A-add_group_follows-T";
|
|
511
|
+
readonly A_ADD_GROUP_FOLLOWS_R: "A-add_group_follows-R";
|
|
512
|
+
readonly A_REMOVE_GROUP_FOLLOWS_T: "A-remove_group_follows-T";
|
|
513
|
+
readonly A_REMOVE_GROUP_FOLLOWS_R: "A-remove_group_follows-R";
|
|
514
|
+
readonly A_GET_GROUP_FOLLOWS_T: "A-get_group_follows-T";
|
|
515
|
+
readonly A_GET_GROUP_FOLLOWS_R: "A-get_group_follows-R";
|
|
516
|
+
readonly A_SET_GROUP_REMARK_T: "A-set_group_remark-T";
|
|
517
|
+
readonly A_SET_GROUP_REMARK_R: "A-set_group_remark-R";
|
|
518
|
+
readonly A_GET_GROUP_MEMBERS_BY_ROLE_T: "A-get_group_members_by_role-T";
|
|
519
|
+
readonly A_GET_GROUP_MEMBERS_BY_ROLE_R: "A-get_group_members_by_role-R";
|
|
520
|
+
readonly A_ACCEPT_GROUP_INVITE_T: "A-accept_group_invite-T";
|
|
521
|
+
readonly A_ACCEPT_GROUP_INVITE_R: "A-accept_group_invite-R";
|
|
522
|
+
readonly A_REFUSE_GROUP_INVITE_T: "A-refuse_group_invite-T";
|
|
523
|
+
readonly A_REFUSE_GROUP_INVITE_R: "A-refuse_group_invite-R";
|
|
524
|
+
readonly A_ACCEPT_GROUP_APPLICATION_T: "A-accept_group_application-T";
|
|
525
|
+
readonly A_ACCEPT_GROUP_APPLICATION_R: "A-accept_group_application-R";
|
|
526
|
+
readonly A_REFUSE_GROUP_APPLICATION_T: "A-refuse_group_application-T";
|
|
527
|
+
readonly A_REFUSE_GROUP_APPLICATION_R: "A-refuse_group_application-R";
|
|
528
|
+
readonly A_GET_GROUP_APPLICATIONS_T: "A-get_group_applications-T";
|
|
529
|
+
readonly A_GET_GROUP_APPLICATIONS_R: "A-get_group_applications-R";
|
|
530
|
+
readonly A_GET_JOINED_GROUPS_BY_ROLES_T: "A-get_joined_groups_by_roles-T";
|
|
531
|
+
readonly A_GET_JOINED_GROUPS_BY_ROLES_R: "A-get_joined_groups_by_roles-R";
|
|
532
|
+
readonly A_SEARCH_JOINED_GROUPS_T: "A-search_joined_groups-T";
|
|
533
|
+
readonly A_SEARCH_JOINED_GROUPS_R: "A-search_joined_groups-R";
|
|
534
|
+
readonly A_GET_JOINED_GROUPS_T: "A-get_joined_groups-T";
|
|
535
|
+
readonly A_GET_JOINED_GROUPS_R: "A-get_joined_groups-R";
|
|
536
|
+
readonly A_SEARCH_USER_PROFILE_BY_UNIQUE_ID_T: "A-search_user_profile_by_unique_id-T";
|
|
537
|
+
readonly A_SEARCH_USER_PROFILE_BY_UNIQUE_ID_R: "A-search_user_profile_by_unique_id-R";
|
|
538
|
+
readonly A_UPDATE_MY_USER_PROFILE_VISIBILITY_T: "A-update_my_user_profile_visibility-T";
|
|
539
|
+
readonly A_UPDATE_MY_USER_PROFILE_VISIBILITY_R: "A-update_my_user_profile_visibility-R";
|
|
540
|
+
readonly A_GET_MY_USER_PROFILE_VISIBILITY_T: "A-get_my_user_profile_visibility-T";
|
|
541
|
+
readonly A_GET_MY_USER_PROFILE_VISIBILITY_R: "A-get_my_user_profile_visibility-R";
|
|
542
|
+
readonly A_SUBSCRIBE_USER_STATUS_T: "A-subscribe_user_status-T";
|
|
543
|
+
readonly A_SUBSCRIBE_USER_STATUS_R: "A-subscribe_user_status-R";
|
|
544
|
+
readonly A_UNSUBSCRIBE_USER_STATUS_T: "A-unsubscribe_user_status-T";
|
|
545
|
+
readonly A_UNSUBSCRIBE_USER_STATUS_R: "A-unsubscribe_user_status-R";
|
|
546
|
+
readonly A_GET_SUBSCRIBE_USER_STATUS_LIST_T: "A-get_subscribe_user_status_list-T";
|
|
547
|
+
readonly A_GET_SUBSCRIBE_USER_STATUS_LIST_R: "A-get_subscribe_user_status_list-R";
|
|
548
|
+
readonly A_GET_MY_USER_PROFILE_T: "A-get_my_user_profile-T";
|
|
549
|
+
readonly A_GET_MY_USER_PROFILE_R: "A-get_my_user_profile-R";
|
|
550
|
+
readonly A_UPDATE_MY_USER_PROFILE_T: "A-update_my_user_profile-T";
|
|
551
|
+
readonly A_UPDATE_MY_USER_PROFILE_R: "A-update_my_user_profile-R";
|
|
427
552
|
};
|
|
428
553
|
|
|
429
554
|
/** [EN]
|
|
@@ -4489,6 +4614,114 @@ declare const UUId: {
|
|
|
4489
4614
|
genWithLen(strLen?: number): string;
|
|
4490
4615
|
};
|
|
4491
4616
|
|
|
4617
|
+
/**
|
|
4618
|
+
* 检查参数是否为字符串
|
|
4619
|
+
* 只做类型检查,不做长度检查,故当字符串长度为 0,结果依然为 true
|
|
4620
|
+
* @param value
|
|
4621
|
+
*/
|
|
4622
|
+
declare const isString: (value: unknown) => boolean;
|
|
4623
|
+
/**
|
|
4624
|
+
* 检测参数是否为布尔值
|
|
4625
|
+
* @param value
|
|
4626
|
+
*/
|
|
4627
|
+
declare const isBoolean: (value: unknown) => boolean;
|
|
4628
|
+
/**
|
|
4629
|
+
* 检查参数是否为 number 数据
|
|
4630
|
+
* @param value
|
|
4631
|
+
*/
|
|
4632
|
+
declare const isNumber: (value: unknown) => boolean;
|
|
4633
|
+
/**
|
|
4634
|
+
* 检查参数是否为整数,可以指定最小值和最大值,区间包含最小值和最大值,
|
|
4635
|
+
*/
|
|
4636
|
+
declare const isInteger: (option: {
|
|
4637
|
+
min?: number;
|
|
4638
|
+
max?: number;
|
|
4639
|
+
}) => (value: number) => boolean;
|
|
4640
|
+
/**
|
|
4641
|
+
* 检查参数是否为数组
|
|
4642
|
+
* 只做类型检查,不做长度检查
|
|
4643
|
+
* 如 UnitArray、BufferArray 等也属于数组
|
|
4644
|
+
* @param arr
|
|
4645
|
+
*/
|
|
4646
|
+
declare const isArray: (arr: unknown) => boolean;
|
|
4647
|
+
/**
|
|
4648
|
+
* 有限制的字符串
|
|
4649
|
+
* 做长度检查、自定义检查
|
|
4650
|
+
* 先检测前后去空格是否为空
|
|
4651
|
+
*/
|
|
4652
|
+
declare const isLimitedString: (option: {
|
|
4653
|
+
minLength?: number | undefined;
|
|
4654
|
+
maxLength?: number | undefined;
|
|
4655
|
+
validator?: ((val: string) => boolean) | undefined;
|
|
4656
|
+
isTrim?: boolean | undefined;
|
|
4657
|
+
}) => (str: unknown) => boolean;
|
|
4658
|
+
/**
|
|
4659
|
+
* 检查参数是否为长度非 0 的字符串
|
|
4660
|
+
* @param str
|
|
4661
|
+
*/
|
|
4662
|
+
declare const notEmptyString: (str: unknown) => boolean;
|
|
4663
|
+
/**
|
|
4664
|
+
* 检查参数是否为长度非 0 的数组
|
|
4665
|
+
* @param str
|
|
4666
|
+
*/
|
|
4667
|
+
declare const notEmptyArray: (arr: any[]) => boolean;
|
|
4668
|
+
/**
|
|
4669
|
+
* 检查参数是否为对象
|
|
4670
|
+
* @param val
|
|
4671
|
+
*/
|
|
4672
|
+
declare const isObject: (val: any) => boolean;
|
|
4673
|
+
/**
|
|
4674
|
+
* 检查参数是否为函数
|
|
4675
|
+
* @param val
|
|
4676
|
+
*/
|
|
4677
|
+
declare const isFunction: (val: any) => boolean;
|
|
4678
|
+
/**
|
|
4679
|
+
* 检查参数是否为 undefined
|
|
4680
|
+
* @param val
|
|
4681
|
+
*/
|
|
4682
|
+
declare const isUndefined: (val: any) => boolean;
|
|
4683
|
+
/**
|
|
4684
|
+
* 检查参数是否为有效 http(s) 协议 url
|
|
4685
|
+
* @param value
|
|
4686
|
+
*/
|
|
4687
|
+
declare const isHttpUrl: (value: any) => boolean;
|
|
4688
|
+
/**
|
|
4689
|
+
* 检查对象不为空
|
|
4690
|
+
* @param val
|
|
4691
|
+
*/
|
|
4692
|
+
declare const notEmptyObject: (val: Object) => boolean;
|
|
4693
|
+
/**
|
|
4694
|
+
* @deprecated
|
|
4695
|
+
*/
|
|
4696
|
+
declare const isValidConversationType: (conversation: number) => boolean;
|
|
4697
|
+
declare const isValidEnum: (param: {
|
|
4698
|
+
value: unknown;
|
|
4699
|
+
type: object;
|
|
4700
|
+
}) => boolean;
|
|
4701
|
+
/**
|
|
4702
|
+
* 检查是否是有效的 targetId
|
|
4703
|
+
*/
|
|
4704
|
+
declare const isValidTargetId: (value: any) => boolean;
|
|
4705
|
+
/**
|
|
4706
|
+
* 检查是否是有效的 groupId
|
|
4707
|
+
*/
|
|
4708
|
+
declare const isValidGroupId: (value: any) => boolean;
|
|
4709
|
+
/**
|
|
4710
|
+
* 判断是否是一个有效的文件类型
|
|
4711
|
+
*/
|
|
4712
|
+
declare const isValidFileType: (fileType: number) => boolean;
|
|
4713
|
+
|
|
4714
|
+
declare class Codec$1<T> {
|
|
4715
|
+
private readonly protoRoot;
|
|
4716
|
+
/**
|
|
4717
|
+
* 构造函数
|
|
4718
|
+
* @param desc proto 协议描述
|
|
4719
|
+
*/
|
|
4720
|
+
constructor(desc: string);
|
|
4721
|
+
encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
|
|
4722
|
+
decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
|
|
4723
|
+
}
|
|
4724
|
+
|
|
4492
4725
|
/**
|
|
4493
4726
|
* 翻译模式
|
|
4494
4727
|
*/
|
|
@@ -4905,7 +5138,6 @@ interface IHarmonyOSPushConfig {
|
|
|
4905
5138
|
/** [EN]
|
|
4906
5139
|
* Push notification configuration
|
|
4907
5140
|
* @category interface
|
|
4908
|
-
|
|
4909
5141
|
*/
|
|
4910
5142
|
/**
|
|
4911
5143
|
* 推送配置
|
|
@@ -5248,7 +5480,6 @@ interface IUpdateItem {
|
|
|
5248
5480
|
/** [EN]
|
|
5249
5481
|
* Data structure of conversations pulled from the server
|
|
5250
5482
|
* @category Interface
|
|
5251
|
-
|
|
5252
5483
|
*/
|
|
5253
5484
|
/**
|
|
5254
5485
|
* 从服务器拉取到的会话数据结构
|
|
@@ -5475,18 +5706,15 @@ interface IReceivedConversationByTag extends IReceivedConversation {
|
|
|
5475
5706
|
* @deprecated
|
|
5476
5707
|
*/
|
|
5477
5708
|
declare type IUltraGroupConversation = IReceivedConversation;
|
|
5478
|
-
/** [EN]
|
|
5479
|
-
* Conversation update information
|
|
5480
|
-
* @category Interface
|
|
5481
|
-
*/
|
|
5482
5709
|
/**
|
|
5483
5710
|
* 会话更新信息
|
|
5484
5711
|
* @category Interface
|
|
5485
5712
|
*/
|
|
5486
|
-
interface IUpdatedConversation
|
|
5487
|
-
/**
|
|
5488
|
-
*
|
|
5713
|
+
interface IUpdatedConversation {
|
|
5714
|
+
/**
|
|
5715
|
+
* 会话数据
|
|
5489
5716
|
*/
|
|
5717
|
+
conversation: IReceivedConversation;
|
|
5490
5718
|
/**
|
|
5491
5719
|
* 更新项
|
|
5492
5720
|
*/
|
|
@@ -6298,49 +6526,10 @@ interface IFirstUnreadMessageInfo {
|
|
|
6298
6526
|
/**
|
|
6299
6527
|
* @category Interface
|
|
6300
6528
|
*/
|
|
6301
|
-
|
|
6302
|
-
/** [EN]
|
|
6303
|
-
* User ID
|
|
6304
|
-
*/
|
|
6305
|
-
/**
|
|
6306
|
-
* 用户 ID
|
|
6307
|
-
*/
|
|
6308
|
-
id?: string;
|
|
6309
|
-
/** [EN]
|
|
6310
|
-
* Username
|
|
6311
|
-
*/
|
|
6312
|
-
/**
|
|
6313
|
-
* 用户名
|
|
6314
|
-
*/
|
|
6315
|
-
name?: string;
|
|
6316
|
-
/** [EN]
|
|
6317
|
-
* User avatar URL
|
|
6318
|
-
* @deprecated
|
|
6319
|
-
*/
|
|
6320
|
-
/**
|
|
6321
|
-
* 用户头像地址
|
|
6322
|
-
* @deprecated
|
|
6323
|
-
*/
|
|
6324
|
-
portraitUri?: string;
|
|
6325
|
-
/** [EN]
|
|
6326
|
-
* Additional information in user info
|
|
6327
|
-
*/
|
|
6328
|
-
/**
|
|
6329
|
-
* user info 中附加信息
|
|
6330
|
-
*/
|
|
6331
|
-
extra?: string;
|
|
6332
|
-
/** [EN]
|
|
6333
|
-
* User avatar URL (compatible with mobile devices)
|
|
6334
|
-
*/
|
|
6335
|
-
/**
|
|
6336
|
-
* 用户头像地址(向移动端兼容)
|
|
6337
|
-
*/
|
|
6338
|
-
portrait?: string;
|
|
6339
|
-
}
|
|
6529
|
+
declare type IUserProfile = IUserExtraValueInMessage;
|
|
6340
6530
|
/** [EN]
|
|
6341
6531
|
* Operation details
|
|
6342
6532
|
* @category Interface
|
|
6343
|
-
|
|
6344
6533
|
*/
|
|
6345
6534
|
/**
|
|
6346
6535
|
* 操作明细信息
|
|
@@ -6466,6 +6655,9 @@ interface IOperateStatusNotify {
|
|
|
6466
6655
|
*/
|
|
6467
6656
|
summary: IOperateSummary[];
|
|
6468
6657
|
}
|
|
6658
|
+
/**
|
|
6659
|
+
* 消息撤回配置
|
|
6660
|
+
*/
|
|
6469
6661
|
declare type IRecallMsgOptions = {
|
|
6470
6662
|
/**
|
|
6471
6663
|
* 消息的唯一 id,客户端依赖此属性查找要撤回的消息
|
|
@@ -6515,9 +6707,9 @@ declare type IRecallMsgOptions = {
|
|
|
6515
6707
|
isAdmin?: boolean;
|
|
6516
6708
|
};
|
|
6517
6709
|
/**
|
|
6518
|
-
*
|
|
6710
|
+
* 消息发送配置项
|
|
6519
6711
|
*/
|
|
6520
|
-
interface
|
|
6712
|
+
interface IMessageSendOptions {
|
|
6521
6713
|
/**
|
|
6522
6714
|
* 消息类型,即消息结构的 ObjectName
|
|
6523
6715
|
*/
|
|
@@ -6540,28 +6732,10 @@ interface ISendMsgOptions {
|
|
|
6540
6732
|
extra?: string;
|
|
6541
6733
|
};
|
|
6542
6734
|
/**
|
|
6543
|
-
*
|
|
6544
|
-
* @description
|
|
6545
|
-
*/
|
|
6546
|
-
isPersited?: boolean;
|
|
6547
|
-
/**
|
|
6548
|
-
* 是否计数
|
|
6549
|
-
* @description 只在发送未注册过的自定义消息时有效,否则使用注册时的配置
|
|
6550
|
-
*/
|
|
6551
|
-
isCounted?: boolean;
|
|
6552
|
-
/**
|
|
6553
|
-
* 是否是状态消息,一般为无需注册的自定义消息
|
|
6554
|
-
* @description
|
|
6555
|
-
* 1. 状态消息只有 pub,没有 ack 应答
|
|
6556
|
-
* 2. 状态消息默认不存储,不计数,`isPersited` 与 `isCounted` 配置将失效
|
|
6735
|
+
* 发送时指定消息是否为状态消息,仅对 Web 端有效;
|
|
6736
|
+
* @description 该属性为 Web 端特有属性,为保持向前兼容,因此保留;理论上应该在注册消息时设置消息类型是否是状态消息,之后不可更改。
|
|
6557
6737
|
*/
|
|
6558
6738
|
isStatusMessage?: boolean;
|
|
6559
|
-
/**
|
|
6560
|
-
* 是否发送静默消息
|
|
6561
|
-
* @description
|
|
6562
|
-
* 当值为 `true` 时,服务器将不会发送 Push 信息,移动端也不会弹出本地通知提醒
|
|
6563
|
-
*/
|
|
6564
|
-
disableNotification?: boolean;
|
|
6565
6739
|
/**
|
|
6566
6740
|
* Push 信息
|
|
6567
6741
|
*/
|
|
@@ -6576,11 +6750,12 @@ interface ISendMsgOptions {
|
|
|
6576
6750
|
isMentioned?: boolean;
|
|
6577
6751
|
/**
|
|
6578
6752
|
* `@` 消息类型
|
|
6579
|
-
* @
|
|
6753
|
+
* @deprecated 推荐使用 content.mentionedInfo.type
|
|
6580
6754
|
*/
|
|
6581
|
-
mentionedType?:
|
|
6755
|
+
mentionedType?: MentionedType;
|
|
6582
6756
|
/**
|
|
6583
6757
|
* 被 @ 的用户 Id 列表,当 `mentionedType` 值为 `1` 时,该值可为空
|
|
6758
|
+
* @deprecated 推荐使用 content.mentionedInfo.userIdList
|
|
6584
6759
|
*/
|
|
6585
6760
|
mentionedUserIdList?: string[];
|
|
6586
6761
|
/**
|
|
@@ -6602,8 +6777,7 @@ interface ISendMsgOptions {
|
|
|
6602
6777
|
[key: string]: string;
|
|
6603
6778
|
};
|
|
6604
6779
|
/**
|
|
6605
|
-
*
|
|
6606
|
-
* @todo 功能未知,需确认
|
|
6780
|
+
* 过滤黑/白名单?TODO:功能未知,需确认
|
|
6607
6781
|
*/
|
|
6608
6782
|
isFilerWhiteBlacklist?: boolean;
|
|
6609
6783
|
/**
|
|
@@ -6611,11 +6785,11 @@ interface ISendMsgOptions {
|
|
|
6611
6785
|
*/
|
|
6612
6786
|
pushConfig?: IPushConfig;
|
|
6613
6787
|
/**
|
|
6614
|
-
*
|
|
6788
|
+
* 是否发送静默消息
|
|
6615
6789
|
* @description
|
|
6616
|
-
*
|
|
6790
|
+
* 当值为 `true` 时,服务器将不会发送 Push 信息,移动端也不会弹出本地通知提醒
|
|
6617
6791
|
*/
|
|
6618
|
-
|
|
6792
|
+
disableNotification?: boolean;
|
|
6619
6793
|
/**
|
|
6620
6794
|
* 客户端的消息标识
|
|
6621
6795
|
* 重发消息时用到,重发消息的消息 ID
|
|
@@ -6656,7 +6830,6 @@ interface InnerInsertMessageParams {
|
|
|
6656
6830
|
/** [EN]
|
|
6657
6831
|
* Insert message structure
|
|
6658
6832
|
* @category Interface
|
|
6659
|
-
|
|
6660
6833
|
*/
|
|
6661
6834
|
/**
|
|
6662
6835
|
* 插入消息结构
|
|
@@ -7954,9 +8127,9 @@ declare const ReferenceMessageStatus: {
|
|
|
7954
8127
|
* TODO(Translation)
|
|
7955
8128
|
*/
|
|
7956
8129
|
/**
|
|
7957
|
-
*
|
|
8130
|
+
* 引用的消息被修改。
|
|
7958
8131
|
*/
|
|
7959
|
-
|
|
8132
|
+
MODIFIED: number;
|
|
7960
8133
|
/** [EN]
|
|
7961
8134
|
* TODO(Translation)
|
|
7962
8135
|
*/
|
|
@@ -8023,7 +8196,7 @@ interface IReferenceMessageContent extends IExtraDataKeyInMessage, IUserExtraKey
|
|
|
8023
8196
|
/**
|
|
8024
8197
|
* 引用消息状态
|
|
8025
8198
|
* @since 5.26.0
|
|
8026
|
-
* @description
|
|
8199
|
+
* @description 在 Web 该属性仅在刷新引用消息回调数据中有效,其他情况下无效。
|
|
8027
8200
|
*/
|
|
8028
8201
|
referMsgStatus?: ReferenceMessageStatus;
|
|
8029
8202
|
}
|
|
@@ -8137,6 +8310,97 @@ interface ITextMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMes
|
|
|
8137
8310
|
*/
|
|
8138
8311
|
translateInfo?: TranslateInfo;
|
|
8139
8312
|
}
|
|
8313
|
+
/**
|
|
8314
|
+
* 服务器端定义的撤回通知消息结构,因历史原因,与 Electron 对外暴露的结构不一致
|
|
8315
|
+
* @hidden
|
|
8316
|
+
*/
|
|
8317
|
+
interface ISvrRecallNotificationMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMessage {
|
|
8318
|
+
/**
|
|
8319
|
+
* 发起撤回的用户 ID
|
|
8320
|
+
*/
|
|
8321
|
+
operatorId?: string;
|
|
8322
|
+
/**
|
|
8323
|
+
* 被撤回的原始消息的发送时间,单位:毫秒
|
|
8324
|
+
*/
|
|
8325
|
+
recallTime: number;
|
|
8326
|
+
/**
|
|
8327
|
+
* 被撤回的原始消息的类型
|
|
8328
|
+
*/
|
|
8329
|
+
originalObjectName?: string;
|
|
8330
|
+
/**
|
|
8331
|
+
* 被撤回的原始消息的内容
|
|
8332
|
+
*/
|
|
8333
|
+
originalMessageContent?: any;
|
|
8334
|
+
/**
|
|
8335
|
+
* 被撤回的文本消息内容
|
|
8336
|
+
*/
|
|
8337
|
+
recallContent?: string;
|
|
8338
|
+
/**
|
|
8339
|
+
* 撤回消息的发送时间,单位:毫秒
|
|
8340
|
+
*/
|
|
8341
|
+
recallActionTime?: number;
|
|
8342
|
+
/**
|
|
8343
|
+
* 是否为管理员操作
|
|
8344
|
+
*/
|
|
8345
|
+
admin?: boolean;
|
|
8346
|
+
/**
|
|
8347
|
+
* 是否删除接收端本地存储的原始消息
|
|
8348
|
+
*/
|
|
8349
|
+
delete?: boolean;
|
|
8350
|
+
}
|
|
8351
|
+
/** [EN]
|
|
8352
|
+
* Recall notification message content data
|
|
8353
|
+
* @category Interface
|
|
8354
|
+
*/
|
|
8355
|
+
/**
|
|
8356
|
+
* 撤回通知消息 content 数据
|
|
8357
|
+
* @category Interface
|
|
8358
|
+
*/
|
|
8359
|
+
interface IRecallNotificationMessageContent extends Partial<ISvrRecallNotificationMessageContent> {
|
|
8360
|
+
/**
|
|
8361
|
+
* Electron 历史版本中使用错误,目前已废弃,请使用 `delete` 替代
|
|
8362
|
+
* @deprecated - 已废弃,请使用 `delete` 替代
|
|
8363
|
+
*/
|
|
8364
|
+
isDelete?: boolean;
|
|
8365
|
+
}
|
|
8366
|
+
/**
|
|
8367
|
+
* 撤回命令消息 content 数据
|
|
8368
|
+
* @category Interface
|
|
8369
|
+
*/
|
|
8370
|
+
interface IRecallCommandMessageContent extends IExtraDataKeyInMessage, IUserExtraKeyInMessage {
|
|
8371
|
+
/**
|
|
8372
|
+
* 会话类型
|
|
8373
|
+
*/
|
|
8374
|
+
conversationType: ConversationType;
|
|
8375
|
+
/**
|
|
8376
|
+
* 会话 TargetId
|
|
8377
|
+
*/
|
|
8378
|
+
targetId: string;
|
|
8379
|
+
/**
|
|
8380
|
+
* 会话 ChannelId
|
|
8381
|
+
*/
|
|
8382
|
+
channelId?: string;
|
|
8383
|
+
/**
|
|
8384
|
+
* 被撤回消息的唯一标识
|
|
8385
|
+
*/
|
|
8386
|
+
messageUId: string;
|
|
8387
|
+
/**
|
|
8388
|
+
* 被撤回消息的发送时间,Web 端依赖该时间对消息进行排序和会话更新处理
|
|
8389
|
+
*/
|
|
8390
|
+
sentTime: number;
|
|
8391
|
+
/**
|
|
8392
|
+
* 是否删除接收端本地存储的原始消息,对 Web 平台无效
|
|
8393
|
+
*/
|
|
8394
|
+
isDelete?: boolean;
|
|
8395
|
+
/**
|
|
8396
|
+
* 是否为管理员操作,当值为 true 时,允许撤回非本人发送的消息
|
|
8397
|
+
*/
|
|
8398
|
+
isAdmin?: boolean;
|
|
8399
|
+
/**
|
|
8400
|
+
* 撤回定向消息时,指定定向消息的接收者列表
|
|
8401
|
+
*/
|
|
8402
|
+
directionalUserIdList?: string[];
|
|
8403
|
+
}
|
|
8140
8404
|
|
|
8141
8405
|
/** [EN]
|
|
8142
8406
|
* @category Interface
|
|
@@ -8384,7 +8648,6 @@ interface IChatroomNotifyBlock {
|
|
|
8384
8648
|
/** [EN]
|
|
8385
8649
|
* @category Interface
|
|
8386
8650
|
* @since 5.7.9
|
|
8387
|
-
|
|
8388
8651
|
*/
|
|
8389
8652
|
/**
|
|
8390
8653
|
* @category Interface
|
|
@@ -9417,6 +9680,7 @@ declare class RCResult<T = void> {
|
|
|
9417
9680
|
* @hidden
|
|
9418
9681
|
*/
|
|
9419
9682
|
constructor(code: number, msg: string, data?: T);
|
|
9683
|
+
static from<T = void>(code: number, msg?: string, data?: T): RCResult<T>;
|
|
9420
9684
|
/**
|
|
9421
9685
|
* 结果为 ok 时,进行后续异步操作
|
|
9422
9686
|
* @hidden
|
|
@@ -9488,8 +9752,9 @@ declare class Validator {
|
|
|
9488
9752
|
* 当验证结果为失败时,设置错误码和错误信息;若验证结果未失败,则不生效
|
|
9489
9753
|
* @param code 错误码
|
|
9490
9754
|
* @param msg 错误信息
|
|
9755
|
+
* @param coverCode 是否覆盖错误码,默认为 false,即仅在失败后赋值一次,避免未失败时赋值,避免修改赋值
|
|
9491
9756
|
*/
|
|
9492
|
-
fail(code: number, msg?: string): Validator;
|
|
9757
|
+
fail(code: number, msg?: string, coverCode?: boolean): Validator;
|
|
9493
9758
|
/**
|
|
9494
9759
|
* 设置验证结果为失败,并设置错误码和错误信息
|
|
9495
9760
|
* @param code 错误码
|
|
@@ -9529,6 +9794,7 @@ declare class Validator {
|
|
|
9529
9794
|
isString(key: string, value: unknown, required?: boolean): Validator;
|
|
9530
9795
|
/** string 类型检查 */
|
|
9531
9796
|
assertString(key: string, value: unknown, required?: boolean): Validator;
|
|
9797
|
+
isHttpUrl(key: string, value: unknown, required?: boolean): Validator;
|
|
9532
9798
|
/** 长度不为 0 的有效字符串 */
|
|
9533
9799
|
isNotEmptyString(key: string, value: unknown, required?: boolean): Validator;
|
|
9534
9800
|
assertNotEmptyString(key: string, value: unknown, required?: boolean): Validator;
|
|
@@ -9582,6 +9848,11 @@ declare class Validator {
|
|
|
9582
9848
|
assertFunction(key: string, value: unknown, required?: boolean): Validator;
|
|
9583
9849
|
}
|
|
9584
9850
|
|
|
9851
|
+
declare const promiseWithResolvers: <T = void>() => {
|
|
9852
|
+
resolve: (value: T) => void;
|
|
9853
|
+
promise: Promise<T>;
|
|
9854
|
+
};
|
|
9855
|
+
|
|
9585
9856
|
interface IServerAddressData {
|
|
9586
9857
|
addr: string;
|
|
9587
9858
|
protocol: EConnectProtocol;
|
|
@@ -9949,6 +10220,13 @@ interface INaviInfo {
|
|
|
9949
10220
|
* 消息修改时间限制,单位:分钟
|
|
9950
10221
|
*/
|
|
9951
10222
|
msgModifyMinute?: number;
|
|
10223
|
+
/**
|
|
10224
|
+
* 是否开启单群聊消息撤回优化;(0 关闭,1 开启)
|
|
10225
|
+
* 开启后:
|
|
10226
|
+
* 1. 服务器会话列表 latestMessage 和历史消息中将存储 RC:RcNtf 消息。
|
|
10227
|
+
* 2. 拉取历史消息时,不再返回 RC:RcCmd 消息。
|
|
10228
|
+
*/
|
|
10229
|
+
supportRecallRefactor?: 0 | 1;
|
|
9952
10230
|
}
|
|
9953
10231
|
|
|
9954
10232
|
/** [EN]
|
|
@@ -9959,6 +10237,7 @@ interface INaviInfo {
|
|
|
9959
10237
|
* 异步任务结果
|
|
9960
10238
|
* @description 该结构即将废弃,请使用 {@link RCResult} 替代
|
|
9961
10239
|
* @category Interface
|
|
10240
|
+
* @deprecated 请使用 {@link RCResult} 替代
|
|
9962
10241
|
*/
|
|
9963
10242
|
interface IAsyncRes<T = void> extends Pick<RCResult<T>, 'code' | 'data'> {
|
|
9964
10243
|
msg?: string;
|
|
@@ -10178,7 +10457,6 @@ interface ISubscribeUserStatusInfo {
|
|
|
10178
10457
|
* Online status information
|
|
10179
10458
|
* @category Interface
|
|
10180
10459
|
* @since 5.9.8
|
|
10181
|
-
|
|
10182
10460
|
*/
|
|
10183
10461
|
/**
|
|
10184
10462
|
* 在线状态信息
|
|
@@ -10618,10 +10896,10 @@ interface IFriendInfoChangedSync {
|
|
|
10618
10896
|
*/
|
|
10619
10897
|
interface IPagingQueryOption {
|
|
10620
10898
|
/** [EN]
|
|
10621
|
-
* Number of items per page,
|
|
10899
|
+
* Number of items per page, valid value [1, 100], default value 50
|
|
10622
10900
|
*/
|
|
10623
10901
|
/**
|
|
10624
|
-
*
|
|
10902
|
+
* 每页条数,有效值 [1, 100],默认值 50
|
|
10625
10903
|
*/
|
|
10626
10904
|
count: number;
|
|
10627
10905
|
/** [EN]
|
|
@@ -10632,13 +10910,15 @@ interface IPagingQueryOption {
|
|
|
10632
10910
|
*/
|
|
10633
10911
|
pageToken?: string;
|
|
10634
10912
|
/** [EN]
|
|
10635
|
-
* Sort type: Supports setting the order for retrieval. `true`: ascending order; `false`: descending order. Default is `
|
|
10913
|
+
* Sort type: Supports setting the order for retrieval. `true`: ascending order; `false`: descending order. Default is `false`.
|
|
10636
10914
|
*/
|
|
10637
10915
|
/**
|
|
10638
|
-
*
|
|
10916
|
+
* 排序类型:支持设置正序、倒序获取。`true`:正序;`false`:倒序。默认为 `false`
|
|
10639
10917
|
*/
|
|
10640
10918
|
order?: boolean;
|
|
10641
10919
|
}
|
|
10920
|
+
interface IGetGroupMembersOption extends IPagingQueryOption {
|
|
10921
|
+
}
|
|
10642
10922
|
/** [EN]
|
|
10643
10923
|
* Pagination request result
|
|
10644
10924
|
* @category Interface
|
|
@@ -10703,9 +10983,7 @@ interface IGroupInfoOption extends IGroupBaseInfo {
|
|
|
10703
10983
|
/**
|
|
10704
10984
|
* 扩展消息
|
|
10705
10985
|
*/
|
|
10706
|
-
extProfile?:
|
|
10707
|
-
[key: string]: string;
|
|
10708
|
-
};
|
|
10986
|
+
extProfile?: Record<string, string>;
|
|
10709
10987
|
/** [EN]
|
|
10710
10988
|
* Active join group permission mode
|
|
10711
10989
|
*/
|
|
@@ -10831,7 +11109,6 @@ interface IGroupInfo extends IGroupInfoOption {
|
|
|
10831
11109
|
* Configuration for being kicked out of a group or voluntarily leaving a group
|
|
10832
11110
|
* @category Interface
|
|
10833
11111
|
* @since 5.12.0
|
|
10834
|
-
|
|
10835
11112
|
*/
|
|
10836
11113
|
/**
|
|
10837
11114
|
* 踢出群组或者主动退群配置
|
|
@@ -11027,7 +11304,6 @@ interface IGroupApplicationInfo {
|
|
|
11027
11304
|
* Group application list
|
|
11028
11305
|
* @category Interface
|
|
11029
11306
|
* @since 5.12.0
|
|
11030
|
-
|
|
11031
11307
|
*/
|
|
11032
11308
|
/**
|
|
11033
11309
|
* 群申请列表
|
|
@@ -11087,7 +11363,6 @@ interface IGroupFollowsList {
|
|
|
11087
11363
|
* Users I follow information
|
|
11088
11364
|
* @category Interface
|
|
11089
11365
|
* @since 5.12.0
|
|
11090
|
-
|
|
11091
11366
|
*/
|
|
11092
11367
|
/**
|
|
11093
11368
|
* 特别关注用户信息
|
|
@@ -11142,7 +11417,6 @@ interface IGroupFollowsUserInfo {
|
|
|
11142
11417
|
* Group operation information
|
|
11143
11418
|
* @category Interface
|
|
11144
11419
|
* @since 5.12.0
|
|
11145
|
-
|
|
11146
11420
|
*/
|
|
11147
11421
|
/**
|
|
11148
11422
|
* 群组操作信息
|
|
@@ -11241,7 +11515,6 @@ interface IGroupMemberInfoChanged {
|
|
|
11241
11515
|
* Group profile change callback
|
|
11242
11516
|
* @category Interface
|
|
11243
11517
|
* @since 5.12.0
|
|
11244
|
-
|
|
11245
11518
|
*/
|
|
11246
11519
|
/**
|
|
11247
11520
|
* 群组资料变更回调
|
|
@@ -11259,7 +11532,6 @@ interface IGroupInfoChanged {
|
|
|
11259
11532
|
/** [EN]
|
|
11260
11533
|
* Changed group information, only includes the modified fields
|
|
11261
11534
|
* @deprecated - Starting from version 5.14.0, it is recommended to use the `changedGroupInfo` field instead
|
|
11262
|
-
|
|
11263
11535
|
*/
|
|
11264
11536
|
/**
|
|
11265
11537
|
* 变更的群组信息,仅包含变更字段
|
|
@@ -11294,7 +11566,6 @@ interface IGroupInfoChanged {
|
|
|
11294
11566
|
* Group alias update information
|
|
11295
11567
|
* @category Interface
|
|
11296
11568
|
* @since 5.12.0
|
|
11297
|
-
|
|
11298
11569
|
*/
|
|
11299
11570
|
/**
|
|
11300
11571
|
* 群组备注更新信息
|
|
@@ -11387,6 +11658,14 @@ interface IServerGroupBaseInfo {
|
|
|
11387
11658
|
profilePerm?: number;
|
|
11388
11659
|
memProfilePerm?: number;
|
|
11389
11660
|
}
|
|
11661
|
+
interface IMemberInviteResponse {
|
|
11662
|
+
groupId: string;
|
|
11663
|
+
inviterId: string;
|
|
11664
|
+
optType: GroupOperationRole;
|
|
11665
|
+
optResult: GroupOperationStatus;
|
|
11666
|
+
joinUserId?: string;
|
|
11667
|
+
reason?: string;
|
|
11668
|
+
}
|
|
11390
11669
|
|
|
11391
11670
|
interface INotificationQuietHoursSetting {
|
|
11392
11671
|
/** [EN]
|
|
@@ -11450,32 +11729,55 @@ declare function getMessageTypeDescription(type: string): MessageTypeDescription
|
|
|
11450
11729
|
*/
|
|
11451
11730
|
declare function hasMessageTypeDescription(type: string): boolean;
|
|
11452
11731
|
|
|
11732
|
+
/** [EN]
|
|
11733
|
+
* Get Conversation List By Timestamp Params
|
|
11734
|
+
*/
|
|
11453
11735
|
/**
|
|
11454
11736
|
* 按时间戳查询会话列表参数
|
|
11455
11737
|
*/
|
|
11456
11738
|
declare type IGetConversationListByTimestampParams = {
|
|
11739
|
+
/** [EN]
|
|
11740
|
+
* Get Conversation Start Time, precision to milliseconds, 0 represents the current time
|
|
11741
|
+
*/
|
|
11457
11742
|
/**
|
|
11458
11743
|
* 获取会话起始时间,需要精确到毫秒,0 表示当前时间
|
|
11459
11744
|
*/
|
|
11460
11745
|
startTime: number;
|
|
11746
|
+
/** [EN]
|
|
11747
|
+
* Get Conversation Count
|
|
11748
|
+
*/
|
|
11461
11749
|
/**
|
|
11462
11750
|
* 分页数量
|
|
11463
11751
|
*/
|
|
11464
11752
|
count: number;
|
|
11465
|
-
/**
|
|
11753
|
+
/** [EN]
|
|
11754
|
+
* Get Conversation Order. The parameter is invalid for Electron platform, and the default value is 0 for Electron platform;
|
|
11755
|
+
* * 0 - Query from startTime forward, data sorted by time in descending order
|
|
11756
|
+
* * 1 - Query from startTime backward, data sorted by time in ascending order
|
|
11757
|
+
*/
|
|
11758
|
+
/**
|
|
11466
11759
|
* 查询方向。该参数对 Electron 平台无效,Electron 平台下始终为 0;
|
|
11467
11760
|
* * 0 - 从 startTime 开始向前查询,数据按时间降序排序
|
|
11468
11761
|
* * 1 - 从 startTime 开始向后查询,数据按时间升序排序
|
|
11469
11762
|
*/
|
|
11470
11763
|
order?: 0 | 1;
|
|
11764
|
+
/** [EN]
|
|
11765
|
+
* Get Conversation Channel Id, used for multi-organization scene query; only Electron platform is valid
|
|
11766
|
+
*/
|
|
11471
11767
|
/**
|
|
11472
11768
|
* 单、群聊会话的组织 ID,用于多组织场景查询;仅 Electron 平台有效
|
|
11473
11769
|
*/
|
|
11474
11770
|
channelId?: string;
|
|
11771
|
+
/** [EN]
|
|
11772
|
+
* Get Conversation Top Priority, only Electron platform is valid
|
|
11773
|
+
*/
|
|
11475
11774
|
/**
|
|
11476
|
-
*
|
|
11775
|
+
* 是否置顶优先,仅对 Electron 平台有效
|
|
11477
11776
|
*/
|
|
11478
11777
|
topPriority?: boolean;
|
|
11778
|
+
/** [EN]
|
|
11779
|
+
* Get Conversation Types; the value is empty or the length is 0 to get all conversation types
|
|
11780
|
+
*/
|
|
11479
11781
|
/**
|
|
11480
11782
|
* 会话类型,值为空或长度为 0 时,获取全部会话类型;仅 Electron 平台有效
|
|
11481
11783
|
*/
|
|
@@ -11666,7 +11968,7 @@ interface IProcessCache {
|
|
|
11666
11968
|
deltaTime: number;
|
|
11667
11969
|
}
|
|
11668
11970
|
/**
|
|
11669
|
-
*
|
|
11971
|
+
* 约束跨平台、跨进程通信方法定义,以便于代码检查
|
|
11670
11972
|
*/
|
|
11671
11973
|
interface IIPCMethods {
|
|
11672
11974
|
/**
|
|
@@ -11678,7 +11980,7 @@ interface IIPCMethods {
|
|
|
11678
11980
|
* @param token
|
|
11679
11981
|
* @param reconnectKickEnable
|
|
11680
11982
|
*/
|
|
11681
|
-
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string):
|
|
11983
|
+
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): Promise<RCResult<string>>;
|
|
11682
11984
|
getNaviInfoFromCache(): INaviInfo | null;
|
|
11683
11985
|
/**
|
|
11684
11986
|
* 上报版本信息
|
|
@@ -11821,7 +12123,7 @@ interface IIPCMethods {
|
|
|
11821
12123
|
clearTextMessageDraft(conversation: IConversationOption): Promise<RCResult>;
|
|
11822
12124
|
getConversationNotificationLevel(conversation: IConversationOption): Promise<RCResult<NotificationLevel>>;
|
|
11823
12125
|
getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<RCResult<number>>;
|
|
11824
|
-
sendMessage(
|
|
12126
|
+
sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
11825
12127
|
/**
|
|
11826
12128
|
* 断开连接
|
|
11827
12129
|
*/
|
|
@@ -11887,11 +12189,19 @@ interface IIPCMethods {
|
|
|
11887
12189
|
*/
|
|
11888
12190
|
setCheckChatRoomDuplicateMessage(enableCheck: boolean): Promise<RCResult>;
|
|
11889
12191
|
/**
|
|
11890
|
-
*
|
|
12192
|
+
* 获取存储服务鉴权信息
|
|
12193
|
+
* @param fileType 文件类型
|
|
12194
|
+
* @param fileName 文件名称
|
|
12195
|
+
* @param httpMethod STC 分段上传时的必填参数,有效值为 PUT | POST
|
|
12196
|
+
* @param queryString STC 分段上传时的查询字符串
|
|
11891
12197
|
* @description
|
|
11892
|
-
*
|
|
12198
|
+
* `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
|
|
12199
|
+
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
|
|
12200
|
+
* 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
|
|
12201
|
+
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
12202
|
+
* @returns
|
|
11893
12203
|
*/
|
|
11894
|
-
getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<
|
|
12204
|
+
getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth>>;
|
|
11895
12205
|
/**
|
|
11896
12206
|
* 获取文件上传后下载地址
|
|
11897
12207
|
*/
|
|
@@ -11967,19 +12277,19 @@ interface IIPCMethods {
|
|
|
11967
12277
|
/**
|
|
11968
12278
|
* 获取群组消息已读列表
|
|
11969
12279
|
*/
|
|
11970
|
-
getMessageReader(targetId: string, messageUId: string, channelId
|
|
12280
|
+
getMessageReader(targetId: string, messageUId: string, channelId: string): Promise<RCResult<IMessageReaderResponse>>;
|
|
11971
12281
|
/**
|
|
11972
12282
|
* 发送已读回执 (V4)
|
|
11973
12283
|
*/
|
|
11974
|
-
sendReadReceiptMessageV4(conversation:
|
|
12284
|
+
sendReadReceiptMessageV4(conversation: IConversationIdentifier, startMsgUid: string, endMsgUid: string): Promise<RCResult>;
|
|
11975
12285
|
/**
|
|
11976
12286
|
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
11977
12287
|
*/
|
|
11978
|
-
getMessageReadReceiptV4(conversation:
|
|
12288
|
+
getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUid: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
|
|
11979
12289
|
/**
|
|
11980
12290
|
* 多端同步会话的已读时间 (V4)
|
|
11981
12291
|
*/
|
|
11982
|
-
updateConversationReadTime(conversation:
|
|
12292
|
+
updateConversationReadTime(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
11983
12293
|
/**
|
|
11984
12294
|
* 获取服务器时间
|
|
11985
12295
|
*/
|
|
@@ -12009,9 +12319,9 @@ interface IIPCMethods {
|
|
|
12009
12319
|
/**
|
|
12010
12320
|
* 获取用户状态
|
|
12011
12321
|
*/
|
|
12012
|
-
getUserStatus(userId: string):
|
|
12322
|
+
getUserStatus(userId: string): Promise<RCResult<{
|
|
12013
12323
|
status: string;
|
|
12014
|
-
}
|
|
12324
|
+
}>>;
|
|
12015
12325
|
/**
|
|
12016
12326
|
* 清空所有会话,目前仅 v2-adapter 中提供
|
|
12017
12327
|
*/
|
|
@@ -12019,19 +12329,19 @@ interface IIPCMethods {
|
|
|
12019
12329
|
/**
|
|
12020
12330
|
* 加入黑名单
|
|
12021
12331
|
*/
|
|
12022
|
-
addToBlacklist(userId: string): Promise<
|
|
12332
|
+
addToBlacklist(userId: string): Promise<RCResult>;
|
|
12023
12333
|
/**
|
|
12024
12334
|
* 将指定用户移除黑名单
|
|
12025
12335
|
*/
|
|
12026
|
-
removeFromBlacklist(userId: string): Promise<
|
|
12336
|
+
removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
12027
12337
|
/**
|
|
12028
12338
|
* 获取黑名单列表
|
|
12029
12339
|
*/
|
|
12030
|
-
getBlacklist():
|
|
12340
|
+
getBlacklist(): Promise<RCResult<string[]>>;
|
|
12031
12341
|
/**
|
|
12032
12342
|
* 获取指定人员在黑名单中的状态
|
|
12033
12343
|
*/
|
|
12034
|
-
getBlacklistStatus(userId: string):
|
|
12344
|
+
getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
12035
12345
|
/**
|
|
12036
12346
|
* 向本地插入一条消息,不发送到服务器
|
|
12037
12347
|
*/
|
|
@@ -12076,7 +12386,7 @@ interface IIPCMethods {
|
|
|
12076
12386
|
* 通过关键字与 channelId 搜索所有会话
|
|
12077
12387
|
*/
|
|
12078
12388
|
searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
12079
|
-
searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]):
|
|
12389
|
+
searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
12080
12390
|
/**
|
|
12081
12391
|
* 通过指定搜索策略和搜索参数,进行消息搜索
|
|
12082
12392
|
* @param params
|
|
@@ -12093,11 +12403,11 @@ interface IIPCMethods {
|
|
|
12093
12403
|
/**
|
|
12094
12404
|
* 设置消息发送状态
|
|
12095
12405
|
*/
|
|
12096
|
-
setMessageSentStatus(messageId: number, sentStatus: number): Promise<
|
|
12406
|
+
setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
12097
12407
|
/**
|
|
12098
12408
|
* 设置消息接收状态
|
|
12099
12409
|
*/
|
|
12100
|
-
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<
|
|
12410
|
+
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
12101
12411
|
/**
|
|
12102
12412
|
* 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
|
|
12103
12413
|
*/
|
|
@@ -12105,7 +12415,7 @@ interface IIPCMethods {
|
|
|
12105
12415
|
/**
|
|
12106
12416
|
* 删除时间戳前的未读数
|
|
12107
12417
|
*/
|
|
12108
|
-
clearUnreadCountByTimestamp(
|
|
12418
|
+
clearUnreadCountByTimestamp(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
12109
12419
|
/**
|
|
12110
12420
|
* 获取所有群聊会话 @ 消息未读数,不包含超级群会话
|
|
12111
12421
|
*/
|
|
@@ -12122,85 +12432,122 @@ interface IIPCMethods {
|
|
|
12122
12432
|
/**
|
|
12123
12433
|
* 设置代理
|
|
12124
12434
|
*/
|
|
12125
|
-
setProxy(proxy: IProxy | null):
|
|
12435
|
+
setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
12126
12436
|
/**
|
|
12127
12437
|
* 获取代理
|
|
12128
12438
|
*/
|
|
12129
|
-
getProxy():
|
|
12439
|
+
getProxy(): Promise<RCResult<IProxy>>;
|
|
12130
12440
|
/**
|
|
12131
12441
|
* 测试代理
|
|
12132
12442
|
*/
|
|
12133
|
-
testProxy(proxy: IProxy, testHost: string): Promise<
|
|
12443
|
+
testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
12134
12444
|
/**
|
|
12135
12445
|
* 订阅用户状态事件
|
|
12136
12446
|
*/
|
|
12137
|
-
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
12447
|
+
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
12138
12448
|
/**
|
|
12139
12449
|
* 取消订阅用户状态事件
|
|
12140
12450
|
*/
|
|
12141
|
-
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
12451
|
+
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
12142
12452
|
/**
|
|
12143
12453
|
* 获取已订阅列表
|
|
12144
12454
|
*/
|
|
12145
|
-
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<
|
|
12455
|
+
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
12146
12456
|
/**
|
|
12147
12457
|
* 获取指定用户的在线状态
|
|
12148
12458
|
*/
|
|
12149
12459
|
getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
12150
|
-
updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
12151
|
-
getUserProfiles(userIds: string[]): Promise<
|
|
12152
|
-
getMyUserProfile(): Promise<
|
|
12153
|
-
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<
|
|
12154
|
-
getMyUserProfileVisibility(): Promise<
|
|
12155
|
-
searchUserProfileByUniqueId(uniqueId: string): Promise<
|
|
12156
|
-
createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile:
|
|
12157
|
-
|
|
12158
|
-
|
|
12159
|
-
|
|
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
|
-
addFriend(userId: string, directionType: DirectionType, extra
|
|
12190
|
-
|
|
12191
|
-
|
|
12192
|
-
|
|
12193
|
-
|
|
12194
|
-
|
|
12195
|
-
|
|
12196
|
-
|
|
12197
|
-
|
|
12198
|
-
|
|
12199
|
-
|
|
12200
|
-
|
|
12201
|
-
|
|
12202
|
-
|
|
12203
|
-
|
|
12460
|
+
updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
12461
|
+
getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
12462
|
+
getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
12463
|
+
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<RCResult>;
|
|
12464
|
+
getMyUserProfileVisibility(): Promise<RCResult<UserProfileVisibility>>;
|
|
12465
|
+
searchUserProfileByUniqueId(uniqueId: string): Promise<RCResult<IUserProfileInfo>>;
|
|
12466
|
+
createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile?: Record<string, string>, inviteeUserIds?: string[]): Promise<RCResult<ICreateGroupFail>>;
|
|
12467
|
+
updateGroupInfo(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile?: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
12468
|
+
getGroupsInfo(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
12469
|
+
kickGroupMembers(groupId: string, userIds: string[], config: Required<IQuitGroupConfig>): Promise<RCResult>;
|
|
12470
|
+
quitGroup(groupId: string, config: Required<IQuitGroupConfig>): Promise<RCResult>;
|
|
12471
|
+
dismissGroup(groupId: string): Promise<RCResult>;
|
|
12472
|
+
transferGroupOwner(groupId: string, newOwnerId: string, quitGroupAfterTransfer: boolean, config: Required<IQuitGroupConfig>): Promise<RCResult>;
|
|
12473
|
+
setGroupManagers(type: GroupOperationType, groupId: string, userIds: string[]): Promise<RCResult>;
|
|
12474
|
+
getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: Required<IGetGroupMembersOption>): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
12475
|
+
getGroupMembers(groupId: string, userIds: string[]): Promise<RCResult<IGroupMemberInfo[]>>;
|
|
12476
|
+
setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<RCResult<IErrorKeys>>;
|
|
12477
|
+
searchGroupMembers(groupId: string, nickName: string, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
12478
|
+
joinGroup(groupId: string): Promise<RCResult<IProcessCode>>;
|
|
12479
|
+
inviteUsersToGroup(groupId: string, userIds: string[]): Promise<RCResult<IProcessCode>>;
|
|
12480
|
+
memberInviteResponse(params: IMemberInviteResponse): Promise<RCResult<IProcessCode>>;
|
|
12481
|
+
getGroupApplications(option: Required<IPagingQueryOption>, directions: GroupApplicationDirection[], status: GroupApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
12482
|
+
getJoinedGroupsByRole(role: GroupMemberRole, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
12483
|
+
searchJoinedGroups(groupName: string, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
12484
|
+
getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
12485
|
+
/**
|
|
12486
|
+
* 设置/移除 群组备注名
|
|
12487
|
+
* @param groupId
|
|
12488
|
+
* @param remark 备注名,设置为 '' 代表移除
|
|
12489
|
+
*/
|
|
12490
|
+
setGroupRemark(groupId: string, remark: string): Promise<RCResult>;
|
|
12491
|
+
setGroupFollows(optType: GroupOperationType, groupId: string, userIds: string[]): Promise<RCResult>;
|
|
12492
|
+
getGroupFollows(groupId: string): Promise<RCResult<IFollowsInfo[]>>;
|
|
12493
|
+
/**
|
|
12494
|
+
* 添加好友
|
|
12495
|
+
* @param userId
|
|
12496
|
+
* @param directionType
|
|
12497
|
+
* @param extra
|
|
12498
|
+
*/
|
|
12499
|
+
addFriend(userId: string, directionType: DirectionType, extra: string): Promise<RCResult<IProcessCode>>;
|
|
12500
|
+
/**
|
|
12501
|
+
* 删除好友
|
|
12502
|
+
* @param userIds
|
|
12503
|
+
* @param directionType
|
|
12504
|
+
*/
|
|
12505
|
+
deleteFriends(userIds: string[], directionType: DirectionType): Promise<RCResult>;
|
|
12506
|
+
/**
|
|
12507
|
+
* 接受好友请求
|
|
12508
|
+
* @param userId
|
|
12509
|
+
*/
|
|
12510
|
+
acceptFriendRequest(userId: string): Promise<RCResult>;
|
|
12511
|
+
/**
|
|
12512
|
+
* 拒绝好友请求
|
|
12513
|
+
* @param userId
|
|
12514
|
+
* @param reason
|
|
12515
|
+
*/
|
|
12516
|
+
refuseFriendRequest(userId: string, reason?: string): Promise<RCResult>;
|
|
12517
|
+
/**
|
|
12518
|
+
* 设置好友信息
|
|
12519
|
+
* @param userId
|
|
12520
|
+
* @param remark
|
|
12521
|
+
* @param extProfile
|
|
12522
|
+
*/
|
|
12523
|
+
setFriendInfo(userId: string, remark: string, extProfile: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
12524
|
+
/**
|
|
12525
|
+
* 检查好友关系
|
|
12526
|
+
* @param userIds
|
|
12527
|
+
* @param directionType
|
|
12528
|
+
*/
|
|
12529
|
+
checkFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<IFriendRelationInfo[]>>;
|
|
12530
|
+
/**
|
|
12531
|
+
* 获取好友列表
|
|
12532
|
+
* @param directionType
|
|
12533
|
+
* @param option 分页查询参数,对 Electron 平台无效
|
|
12534
|
+
*/
|
|
12535
|
+
getFriends(directionType: QueryFriendsDirectionType, option: Required<IPagingQueryOption>): Promise<RCResult<IPagingQueryResult<IFriendInfo>>>;
|
|
12536
|
+
/**
|
|
12537
|
+
* 获取好友请求列表
|
|
12538
|
+
* @param option 分页参数
|
|
12539
|
+
* @param types 请求类型
|
|
12540
|
+
* @param status 请求状态
|
|
12541
|
+
*/
|
|
12542
|
+
getFriendApplications(option: Required<IPagingQueryOption>, types: FriendApplicationType[], status: FriendApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
12543
|
+
/**
|
|
12544
|
+
* 获取好友信息
|
|
12545
|
+
* @param userIds
|
|
12546
|
+
*/
|
|
12547
|
+
getFriendsInfo(userIds: string[]): Promise<RCResult<IFriendInfo[]>>;
|
|
12548
|
+
searchFriendsInfo(nickname: string): Promise<RCResult<IFriendInfo[]>>;
|
|
12549
|
+
setFriendAddPermission(permission: FriendAddPermission): Promise<RCResult>;
|
|
12550
|
+
getFriendAddPermission(): Promise<RCResult<FriendAddPermission>>;
|
|
12204
12551
|
setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
12205
12552
|
removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
12206
12553
|
getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
@@ -12237,12 +12584,13 @@ interface IIPCMethods {
|
|
|
12237
12584
|
* 获取自动翻译全局开关
|
|
12238
12585
|
*/
|
|
12239
12586
|
getAutoTranslateEnabled(): Promise<RCResult<boolean>>;
|
|
12240
|
-
|
|
12587
|
+
setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
12588
|
+
key: string;
|
|
12589
|
+
value: string;
|
|
12590
|
+
}>>;
|
|
12591
|
+
rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
12241
12592
|
bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<RCResult>;
|
|
12242
|
-
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<
|
|
12243
|
-
code: ErrorCode;
|
|
12244
|
-
buffer?: any;
|
|
12245
|
-
}>;
|
|
12593
|
+
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<RCResult<Uint8Array>>;
|
|
12246
12594
|
requestSpeechToTextForMessage(messageUId: string, option?: IConvertSpeechToTextOption): Promise<RCResult>;
|
|
12247
12595
|
setMessageSpeechToTextVisible(messageId: number, isVisible: boolean): Promise<RCResult>;
|
|
12248
12596
|
/**
|
|
@@ -12390,6 +12738,11 @@ interface IIPCMethods {
|
|
|
12390
12738
|
* @param includeUG 会话列表支持超级群开关
|
|
12391
12739
|
*/
|
|
12392
12740
|
getUnreadMentionMeConversationList(params: IGetUnreadMentionMeConversationListParams, includeUG: boolean): Promise<RCResult<IReceivedConversation[]>>;
|
|
12741
|
+
/**
|
|
12742
|
+
* 设置融云消息重排开关
|
|
12743
|
+
* @param enableCheck 是否开启融云消息重排开关
|
|
12744
|
+
*/
|
|
12745
|
+
setCheckDuplicateMessage(enableCheck: boolean): Promise<RCResult<boolean>>;
|
|
12393
12746
|
}
|
|
12394
12747
|
|
|
12395
12748
|
/**
|
|
@@ -12839,100 +13192,6 @@ declare type IUserSettingsChangedEvent = {
|
|
|
12839
13192
|
value: boolean;
|
|
12840
13193
|
};
|
|
12841
13194
|
|
|
12842
|
-
/**
|
|
12843
|
-
* 检查参数是否为字符串
|
|
12844
|
-
* 只做类型检查,不做长度检查,故当字符串长度为 0,结果依然为 true
|
|
12845
|
-
* @param value
|
|
12846
|
-
*/
|
|
12847
|
-
declare const isString: (value: unknown) => boolean;
|
|
12848
|
-
/**
|
|
12849
|
-
* 检测参数是否为布尔值
|
|
12850
|
-
* @param value
|
|
12851
|
-
*/
|
|
12852
|
-
declare const isBoolean: (value: unknown) => boolean;
|
|
12853
|
-
/**
|
|
12854
|
-
* 检查参数是否为 number 数据
|
|
12855
|
-
* @param value
|
|
12856
|
-
*/
|
|
12857
|
-
declare const isNumber: (value: unknown) => boolean;
|
|
12858
|
-
/**
|
|
12859
|
-
* 检查参数是否为整数,可以指定最小值和最大值,区间包含最小值和最大值,
|
|
12860
|
-
*/
|
|
12861
|
-
declare const isInteger: (option: {
|
|
12862
|
-
min?: number;
|
|
12863
|
-
max?: number;
|
|
12864
|
-
}) => (value: number) => boolean;
|
|
12865
|
-
/**
|
|
12866
|
-
* 检查参数是否为数组
|
|
12867
|
-
* 只做类型检查,不做长度检查
|
|
12868
|
-
* 如 UnitArray、BufferArray 等也属于数组
|
|
12869
|
-
* @param arr
|
|
12870
|
-
*/
|
|
12871
|
-
declare const isArray: (arr: unknown) => boolean;
|
|
12872
|
-
/**
|
|
12873
|
-
* 有限制的字符串
|
|
12874
|
-
* 做长度检查、自定义检查
|
|
12875
|
-
* 先检测前后去空格是否为空
|
|
12876
|
-
*/
|
|
12877
|
-
declare const isLimitedString: (option: {
|
|
12878
|
-
minLength?: number | undefined;
|
|
12879
|
-
maxLength?: number | undefined;
|
|
12880
|
-
validator?: ((val: string) => boolean) | undefined;
|
|
12881
|
-
isTrim?: boolean | undefined;
|
|
12882
|
-
}) => (str: unknown) => boolean;
|
|
12883
|
-
/**
|
|
12884
|
-
* 检查参数是否为长度非 0 的字符串
|
|
12885
|
-
* @param str
|
|
12886
|
-
*/
|
|
12887
|
-
declare const notEmptyString: (str: unknown) => boolean;
|
|
12888
|
-
/**
|
|
12889
|
-
* 检查参数是否为长度非 0 的数组
|
|
12890
|
-
* @param str
|
|
12891
|
-
*/
|
|
12892
|
-
declare const notEmptyArray: (arr: any[]) => boolean;
|
|
12893
|
-
/**
|
|
12894
|
-
* 检查参数是否为对象
|
|
12895
|
-
* @param val
|
|
12896
|
-
*/
|
|
12897
|
-
declare const isObject: (val: any) => boolean;
|
|
12898
|
-
/**
|
|
12899
|
-
* 检查参数是否为函数
|
|
12900
|
-
* @param val
|
|
12901
|
-
*/
|
|
12902
|
-
declare const isFunction: (val: any) => boolean;
|
|
12903
|
-
/**
|
|
12904
|
-
* 检查参数是否为 undefined
|
|
12905
|
-
* @param val
|
|
12906
|
-
*/
|
|
12907
|
-
declare const isUndefined: (val: any) => boolean;
|
|
12908
|
-
/**
|
|
12909
|
-
* 检查参数是否为有效 http(s) 协议 url
|
|
12910
|
-
* @param value
|
|
12911
|
-
*/
|
|
12912
|
-
declare const isHttpUrl: (value: any) => boolean;
|
|
12913
|
-
/**
|
|
12914
|
-
* 检查对象不为空
|
|
12915
|
-
* @param val
|
|
12916
|
-
*/
|
|
12917
|
-
declare const notEmptyObject: (val: Object) => boolean;
|
|
12918
|
-
declare const isValidConversationType: (conversation: number) => boolean;
|
|
12919
|
-
declare const isValidEnum: (param: {
|
|
12920
|
-
value: unknown;
|
|
12921
|
-
type: object;
|
|
12922
|
-
}) => boolean;
|
|
12923
|
-
/**
|
|
12924
|
-
* 检查是否是有效的 targetId
|
|
12925
|
-
*/
|
|
12926
|
-
declare const isValidTargetId: (value: any) => boolean;
|
|
12927
|
-
/**
|
|
12928
|
-
* 检查是否是有效的 groupId
|
|
12929
|
-
*/
|
|
12930
|
-
declare const isValidGroupId: (value: any) => boolean;
|
|
12931
|
-
/**
|
|
12932
|
-
* 判断是否是一个有效的文件类型
|
|
12933
|
-
*/
|
|
12934
|
-
declare const isValidFileType: (fileType: number) => boolean;
|
|
12935
|
-
|
|
12936
13195
|
/**
|
|
12937
13196
|
* 判断当前是否运行在 electron 环境且搭配 c++ 协议栈使用
|
|
12938
13197
|
*/
|
|
@@ -12948,50 +13207,6 @@ declare const trans2IReceivedStatusInfo: (status: ReceivedStatus) => IReceivedSt
|
|
|
12948
13207
|
*/
|
|
12949
13208
|
declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusInfo) => number;
|
|
12950
13209
|
|
|
12951
|
-
declare type PBModule = {
|
|
12952
|
-
toArrayBuffer: () => ArrayBuffer;
|
|
12953
|
-
getArrayData: never;
|
|
12954
|
-
[key: string]: Function;
|
|
12955
|
-
};
|
|
12956
|
-
declare class Codec$1<T> {
|
|
12957
|
-
#private;
|
|
12958
|
-
/**
|
|
12959
|
-
* 嵌套结构声明
|
|
12960
|
-
* key: pbname
|
|
12961
|
-
* value: [key: pbname + _ + 属性名,type: 值的 pbname ]
|
|
12962
|
-
*/
|
|
12963
|
-
private nestedMap;
|
|
12964
|
-
private readonly pbModules;
|
|
12965
|
-
constructor(
|
|
12966
|
-
/**
|
|
12967
|
-
* proto 协议描述
|
|
12968
|
-
*/
|
|
12969
|
-
desc: string,
|
|
12970
|
-
/**
|
|
12971
|
-
* 嵌套结构声明
|
|
12972
|
-
* key: pbname
|
|
12973
|
-
* value: [key: pbname + _ + 属性名,type: 值的 pbname ]
|
|
12974
|
-
*/
|
|
12975
|
-
nestedMap: Map<string, keyof T>);
|
|
12976
|
-
private _encode;
|
|
12977
|
-
/**
|
|
12978
|
-
* PB 数据序列化
|
|
12979
|
-
* @param pbname - PB 名称
|
|
12980
|
-
* @param params - 待序列化数据
|
|
12981
|
-
*/
|
|
12982
|
-
encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
|
|
12983
|
-
/**
|
|
12984
|
-
* 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
|
|
12985
|
-
* @param pbname 待解码数据的 PB 名
|
|
12986
|
-
* @param data 待解码数据
|
|
12987
|
-
*/
|
|
12988
|
-
decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
|
|
12989
|
-
/**
|
|
12990
|
-
* @deprecated
|
|
12991
|
-
*/
|
|
12992
|
-
getModule(pbname: string): PBModule;
|
|
12993
|
-
}
|
|
12994
|
-
|
|
12995
13210
|
/** [EN]
|
|
12996
13211
|
* Log level definitions
|
|
12997
13212
|
* @category Enum
|
|
@@ -13640,10 +13855,9 @@ declare class EventEmitter {
|
|
|
13640
13855
|
}
|
|
13641
13856
|
|
|
13642
13857
|
/** [EN]
|
|
13643
|
-
* This definition is deprecated. Use `IRemoveChatroomEntries` instead.
|
|
13644
|
-
* @deprecated
|
|
13645
|
-
* @category Type
|
|
13646
|
-
|
|
13858
|
+
* This definition is deprecated. Use `IRemoveChatroomEntries` instead.
|
|
13859
|
+
* @deprecated
|
|
13860
|
+
* @category Type
|
|
13647
13861
|
*/
|
|
13648
13862
|
/**
|
|
13649
13863
|
* 定义已废弃,请使用 `IRemoveChatroomEntries` 替换
|
|
@@ -13652,7 +13866,7 @@ declare class EventEmitter {
|
|
|
13652
13866
|
*/
|
|
13653
13867
|
declare type IRemoveChatRoomEntries = IRemoveChatroomEntries;
|
|
13654
13868
|
/** [EN]
|
|
13655
|
-
*
|
|
13869
|
+
* This definition is deprecated. Please use `IChatroomEntry` instead.\n * @category Type\n * @deprecated
|
|
13656
13870
|
*/
|
|
13657
13871
|
/**
|
|
13658
13872
|
* 定义已废弃,请使用 `IChatroomEntry` 替换
|
|
@@ -13682,6 +13896,24 @@ declare type IChatRoomEntries = IChatroomEntries;
|
|
|
13682
13896
|
* @deprecated
|
|
13683
13897
|
*/
|
|
13684
13898
|
declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
|
|
13899
|
+
/**
|
|
13900
|
+
* 发送消息时的可选项信息
|
|
13901
|
+
* @deprecated
|
|
13902
|
+
*/
|
|
13903
|
+
interface ISendMsgOptions extends IMessageSendOptions {
|
|
13904
|
+
/**
|
|
13905
|
+
* @deprecated 参数废弃。SDK 通过注册的消息类型来确定是否计数,发送时不可修改
|
|
13906
|
+
*/
|
|
13907
|
+
isCounted?: boolean;
|
|
13908
|
+
/**
|
|
13909
|
+
* @deprecated 参数废弃。SDK 通过注册的消息类型来确定是否存储,发送时不可修改
|
|
13910
|
+
*/
|
|
13911
|
+
isPersited?: boolean;
|
|
13912
|
+
/**
|
|
13913
|
+
* 会话 Channel ID
|
|
13914
|
+
*/
|
|
13915
|
+
channelId?: string;
|
|
13916
|
+
}
|
|
13685
13917
|
|
|
13686
13918
|
/**
|
|
13687
13919
|
* @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
|
|
@@ -13715,27 +13947,9 @@ declare type ModuleType<T> = {
|
|
|
13715
13947
|
* @deprecated 因该工具已向 RTC 业务暴露,因此暂时不可删除,待 RTC 迁移到新工具后删除
|
|
13716
13948
|
*/
|
|
13717
13949
|
declare class Codec<T> {
|
|
13718
|
-
|
|
13719
|
-
* Key 对应的 Value 结构映射表,用于不同 Key 数据的编解码
|
|
13720
|
-
*/
|
|
13721
|
-
private pbmaps;
|
|
13722
|
-
/**
|
|
13723
|
-
* 允许不传 logger 实例以向前兼容
|
|
13724
|
-
*/
|
|
13725
|
-
private logger?;
|
|
13726
|
-
private readonly pbModules;
|
|
13727
|
-
/** @deprecated */
|
|
13728
|
-
constructor(
|
|
13729
|
-
/**
|
|
13730
|
-
* Key 对应的 Value 结构映射表,用于不同 Key 数据的编解码
|
|
13731
|
-
*/
|
|
13732
|
-
pbmaps: T, pbDefined: string,
|
|
13733
|
-
/**
|
|
13734
|
-
* 允许不传 logger 实例以向前兼容
|
|
13735
|
-
*/
|
|
13736
|
-
logger?: ILogger | undefined);
|
|
13950
|
+
private readonly protoRoot;
|
|
13737
13951
|
/** @deprecated */
|
|
13738
|
-
|
|
13952
|
+
constructor(pbDefined: string);
|
|
13739
13953
|
/**
|
|
13740
13954
|
* 数据序列化
|
|
13741
13955
|
* @param pbname 待编码数据的 PB 名
|
|
@@ -13758,11 +13972,6 @@ declare class Codec<T> {
|
|
|
13758
13972
|
* @deprecated
|
|
13759
13973
|
*/
|
|
13760
13974
|
decode(pbname: string, uint8array: Uint8Array): any;
|
|
13761
|
-
/**
|
|
13762
|
-
* protobuf 结构中,int64 类型数据无法直接转为 JS 的 number 数据,需计算获取
|
|
13763
|
-
* @param data
|
|
13764
|
-
*/
|
|
13765
|
-
private fixInt64Values;
|
|
13766
13975
|
}
|
|
13767
13976
|
/**
|
|
13768
13977
|
* 请使用 `Codec` 替代 `AbsCodec`
|
|
@@ -13784,8 +13993,8 @@ declare class PluginContext {
|
|
|
13784
13993
|
*/
|
|
13785
13994
|
__getContext(): APIContext;
|
|
13786
13995
|
/** @deprecated 使用 `createPBCodec` 替代 */
|
|
13787
|
-
createCodec<T extends CodecPBMaps>(
|
|
13788
|
-
createPBCodec<T>(desc: string,
|
|
13996
|
+
createCodec<T extends CodecPBMaps>(_: T, pbDesc: string): Codec<T>;
|
|
13997
|
+
createPBCodec<T>(desc: string, _?: Map<string, keyof T>): Codec$1<T>;
|
|
13789
13998
|
/**
|
|
13790
13999
|
* 重新请求服务导航数据
|
|
13791
14000
|
*/
|
|
@@ -13853,8 +14062,10 @@ declare class PluginContext {
|
|
|
13853
14062
|
setPushConfig(config: IAppPushConfig): void;
|
|
13854
14063
|
/**
|
|
13855
14064
|
* 发送消息
|
|
14065
|
+
* @deprecated
|
|
13856
14066
|
*/
|
|
13857
|
-
sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions):
|
|
14067
|
+
sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): Promise<RCResult<IReceivedMessage>>;
|
|
14068
|
+
sendMessageTo(identifier: IConversationIdentifier, options: IMessageSendOptions): Promise<RCResult<IReceivedMessage>>;
|
|
13858
14069
|
/**
|
|
13859
14070
|
* 消息注册
|
|
13860
14071
|
* @description 消息注册需在应用初始化完成前进行
|
|
@@ -13880,10 +14091,10 @@ declare class PluginContext {
|
|
|
13880
14091
|
* 获取应用主进程信息,仅限 Electron 平台可用
|
|
13881
14092
|
*/
|
|
13882
14093
|
getMainProcessInfo(): IPromiseResult<IProcessInfo>;
|
|
13883
|
-
setCallInfo(targetId: string, key: string, value: string):
|
|
14094
|
+
setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
13884
14095
|
key: string;
|
|
13885
14096
|
value: string;
|
|
13886
|
-
}
|
|
14097
|
+
}>>;
|
|
13887
14098
|
/**
|
|
13888
14099
|
* 创建 logger 实例
|
|
13889
14100
|
* @param id 日志工具 ID,用于区分日志实例,以确定日志调用者身份
|
|
@@ -14102,16 +14313,6 @@ interface IAPIContextOption {
|
|
|
14102
14313
|
*/
|
|
14103
14314
|
loggerProxy?: LogDBProxy;
|
|
14104
14315
|
}
|
|
14105
|
-
interface IConnectResult {
|
|
14106
|
-
/**
|
|
14107
|
-
* 连接错误码
|
|
14108
|
-
*/
|
|
14109
|
-
code: ErrorCode;
|
|
14110
|
-
/**
|
|
14111
|
-
* 导航获取成功后即可有相应的值,在导航数据获取完成之前该值为 undefined
|
|
14112
|
-
*/
|
|
14113
|
-
userId?: string;
|
|
14114
|
-
}
|
|
14115
14316
|
|
|
14116
14317
|
/**
|
|
14117
14318
|
* 应用设置
|
|
@@ -14151,7 +14352,7 @@ declare class AppSettings {
|
|
|
14151
14352
|
interface IChatroomService extends Pick<IIPCMethods, 'getChatroomHistoryMessages' | 'joinChatroom' | 'quitChatroom' | 'getChatroomInfo' | 'setChatroomEntry' | 'setChatroomEntries' | 'removeChatroomEntry' | 'removeChatroomEntries' | 'getChatroomEntry' | 'getAllChatroomEntries' | 'bindRTCRoomForChatroom' | 'setCheckChatRoomDuplicateMessage'> {
|
|
14152
14353
|
}
|
|
14153
14354
|
|
|
14154
|
-
interface IModuleContext {
|
|
14355
|
+
interface IModuleContext extends Pick<IIPCMethods, 'sendMessage'> {
|
|
14155
14356
|
/**
|
|
14156
14357
|
* 应用 Key
|
|
14157
14358
|
*/
|
|
@@ -14188,6 +14389,10 @@ interface IModuleContext {
|
|
|
14188
14389
|
* 日志工具
|
|
14189
14390
|
*/
|
|
14190
14391
|
get logger(): BasicLogger;
|
|
14392
|
+
/**
|
|
14393
|
+
* 是否使用 C++ 引擎
|
|
14394
|
+
*/
|
|
14395
|
+
get usingCppEngine(): boolean;
|
|
14191
14396
|
}
|
|
14192
14397
|
|
|
14193
14398
|
declare class BaseModule {
|
|
@@ -14216,12 +14421,12 @@ declare class ChatroomModule extends BaseModule {
|
|
|
14216
14421
|
/**
|
|
14217
14422
|
* 聊天室服务
|
|
14218
14423
|
*/
|
|
14219
|
-
private readonly
|
|
14424
|
+
private readonly svr;
|
|
14220
14425
|
constructor(ctx: IModuleContext,
|
|
14221
14426
|
/**
|
|
14222
14427
|
* 聊天室服务
|
|
14223
14428
|
*/
|
|
14224
|
-
|
|
14429
|
+
svr: IChatroomService);
|
|
14225
14430
|
/**
|
|
14226
14431
|
* 加入聊天室,若聊天室不存在则创建聊天室
|
|
14227
14432
|
* @param chatroomId 聊天室房间 Id
|
|
@@ -14298,15 +14503,82 @@ declare class ChatroomModule extends BaseModule {
|
|
|
14298
14503
|
bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<RCResult>;
|
|
14299
14504
|
}
|
|
14300
14505
|
|
|
14506
|
+
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'> {
|
|
14507
|
+
}
|
|
14508
|
+
|
|
14509
|
+
/**
|
|
14510
|
+
* 数据托管模块
|
|
14511
|
+
*/
|
|
14512
|
+
declare class DataHosting extends BaseModule {
|
|
14513
|
+
private readonly svr;
|
|
14514
|
+
constructor(ctx: IModuleContext, svr: IDataHostingService);
|
|
14515
|
+
/**
|
|
14516
|
+
* 验证用户信息托管是否可用
|
|
14517
|
+
*/
|
|
14518
|
+
private _userProfileEnabled;
|
|
14519
|
+
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<RCResult>;
|
|
14520
|
+
getMyUserProfileVisibility(): Promise<RCResult<UserProfileVisibility>>;
|
|
14521
|
+
searchUserProfileByUniqueId(uniqueId: string): Promise<RCResult<IUserProfileInfo>>;
|
|
14522
|
+
addFriend(userId: string, directionType: DirectionType, extra?: string): Promise<RCResult<IProcessCode>>;
|
|
14523
|
+
deleteFriends(userIds: string[], directionType: DirectionType): Promise<RCResult>;
|
|
14524
|
+
acceptFriendRequest(userId: string): Promise<RCResult>;
|
|
14525
|
+
refuseFriendRequest(userId: string, reason?: string): Promise<RCResult>;
|
|
14526
|
+
setFriendInfo(userId: string, remark: string, extProfile?: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
14527
|
+
checkFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<IFriendRelationInfo[]>>;
|
|
14528
|
+
getFriends(directionType: QueryFriendsDirectionType, option?: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IFriendInfo>>>;
|
|
14529
|
+
getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
14530
|
+
getFriendsInfo(userIds: string[]): Promise<RCResult<IFriendInfo[]>>;
|
|
14531
|
+
searchFriendsInfo(nickname: string): Promise<RCResult<IFriendInfo[]>>;
|
|
14532
|
+
setFriendAddPermission(permission: FriendAddPermission): Promise<RCResult>;
|
|
14533
|
+
getFriendAddPermission(): Promise<RCResult<FriendAddPermission>>;
|
|
14534
|
+
createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<RCResult<ICreateGroupFail>>;
|
|
14535
|
+
updateGroupInfo(groupInfo: IGroupInfoOption): Promise<RCResult<IErrorKeys>>;
|
|
14536
|
+
getGroupsInfo(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
14537
|
+
kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<RCResult>;
|
|
14538
|
+
quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<RCResult>;
|
|
14539
|
+
dismissGroup(groupId: string): Promise<RCResult>;
|
|
14540
|
+
transferGroupOwner(groupId: string, newOwnerId: string, quit?: boolean, config?: IQuitGroupConfig): Promise<RCResult>;
|
|
14541
|
+
addGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14542
|
+
removeGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14543
|
+
getGroupMembers(groupId: string, userIds: string[]): Promise<RCResult<IGroupMemberInfo[]>>;
|
|
14544
|
+
setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<RCResult<IErrorKeys>>;
|
|
14545
|
+
searchGroupMembers(groupId: string, nickName: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
14546
|
+
getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IGetGroupMembersOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
14547
|
+
addGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14548
|
+
removeGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
14549
|
+
getGroupFollows(groupId: string): Promise<RCResult<IFollowsInfo[]>>;
|
|
14550
|
+
setGroupRemark(groupId: string, remark: string): Promise<RCResult>;
|
|
14551
|
+
joinGroup(groupId: string): Promise<RCResult<IProcessCode>>;
|
|
14552
|
+
inviteUsersToGroup(groupId: string, userIds: string[]): Promise<RCResult<IProcessCode>>;
|
|
14553
|
+
acceptGroupInvite(groupId: string, inviterId: string): Promise<RCResult>;
|
|
14554
|
+
refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<RCResult>;
|
|
14555
|
+
acceptGroupApplication(groupId: string, joinUserId: string, inviterId?: string): Promise<RCResult<IProcessCode>>;
|
|
14556
|
+
refuseGroupApplication(groupId: string, joinUserId: string, inviterId?: string, reason?: string): Promise<RCResult>;
|
|
14557
|
+
/**
|
|
14558
|
+
* 获取群组请求列表
|
|
14559
|
+
* @param option 分页查询参数
|
|
14560
|
+
* @param directions 群组请求方向,参数仅 Electron 平台支持,且 Electron 为必填项,Web 传递无效
|
|
14561
|
+
* @param status 群组请求状态,参数仅 Electron 平台支持,且 Electron 为必填项,Web 传递无效
|
|
14562
|
+
*/
|
|
14563
|
+
getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
14564
|
+
getJoinedGroupsByRole(role: GroupMemberRole, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
14565
|
+
searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
14566
|
+
getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
14567
|
+
}
|
|
14568
|
+
|
|
14301
14569
|
/**
|
|
14302
14570
|
* 会话聊天模块
|
|
14303
14571
|
*/
|
|
14304
|
-
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'> {
|
|
14572
|
+
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'> {
|
|
14305
14573
|
getRealtimeConversations(count: number, startTime: number, order: 0 | 1): Promise<RCResult<IReceivedConversation[]>>;
|
|
14306
14574
|
getRealtimeConTotalUnreadCount(): Promise<RCResult<number>>;
|
|
14307
14575
|
clearRealtimeConUnreadCount(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14308
14576
|
removeRealtimeConversations(identifiers: IConversationIdentifier[]): Promise<RCResult>;
|
|
14309
14577
|
batchGetRealtimeConUnreadCount(identifiers: IConversationIdentifier[]): Promise<RCResult<IConversationUnreadCount[]>>;
|
|
14578
|
+
/**
|
|
14579
|
+
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
14580
|
+
*/
|
|
14581
|
+
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
14310
14582
|
}
|
|
14311
14583
|
|
|
14312
14584
|
declare class ChatModule extends BaseModule {
|
|
@@ -14316,6 +14588,60 @@ declare class ChatModule extends BaseModule {
|
|
|
14316
14588
|
saveEditedMessageDraft(draft: IEditedMessageDraft, identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14317
14589
|
getEditedMessageDraft(identifier: IConversationIdentifier): Promise<RCResult<IEditedMessageDraft | null>>;
|
|
14318
14590
|
clearEditedMessageDraft(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14591
|
+
/**
|
|
14592
|
+
* 超级群正在输入中
|
|
14593
|
+
* @param identifier 会话标识
|
|
14594
|
+
*/
|
|
14595
|
+
sendUltraGroupTypingStatus(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14596
|
+
/**
|
|
14597
|
+
* 发送单群聊输入状态中状态消息
|
|
14598
|
+
* @param identifier 会话标识
|
|
14599
|
+
* @param typingContentType 输入状态消息类型
|
|
14600
|
+
*/
|
|
14601
|
+
sendTypingStatus(identifier: IConversationIdentifier, typingContentType: string): Promise<RCResult<IReceivedMessage>>;
|
|
14602
|
+
/**
|
|
14603
|
+
* 多端未读数同步
|
|
14604
|
+
* @param identifier 会话标识
|
|
14605
|
+
* @param timestamp 同步时间戳
|
|
14606
|
+
*/
|
|
14607
|
+
sendSyncReadStatusMessage(identifier: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
14608
|
+
clearUnreadCountByTimestamp(identifier: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
14609
|
+
/**
|
|
14610
|
+
* 发送群已读回执请求(v1 版本)
|
|
14611
|
+
* @param identifier 会话标识
|
|
14612
|
+
* @param messageUId 消息 UID
|
|
14613
|
+
* @returns
|
|
14614
|
+
*/
|
|
14615
|
+
sendReadReceiptRequest(identifier: IConversationIdentifier, messageUId: string): Promise<RCResult>;
|
|
14616
|
+
/**
|
|
14617
|
+
* 发送单聊已读回执
|
|
14618
|
+
* @param identifier 会话标识
|
|
14619
|
+
* @param messageUId 消息 UID
|
|
14620
|
+
* @param timestamp 消息发送时间
|
|
14621
|
+
*/
|
|
14622
|
+
sendReadReceiptMessage(identifier: IConversationIdentifier, messageUId: string, timestamp: number): Promise<RCResult>;
|
|
14623
|
+
/**
|
|
14624
|
+
* 发送群组消息已读回执
|
|
14625
|
+
* @description 根据导航开关配置确定发送 v1 或 v2 版本;不支持处理其他已读回执版本
|
|
14626
|
+
* @param identifier 会话标识
|
|
14627
|
+
* @param messageList 消息列表
|
|
14628
|
+
*/
|
|
14629
|
+
sendReadReceipt(identifier: IConversationIdentifier, messageList: Record<string, string[]>): Promise<RCResult>;
|
|
14630
|
+
/**
|
|
14631
|
+
* 获取群组消息已读列表(V2)
|
|
14632
|
+
* @param targetId
|
|
14633
|
+
* @param messageUId
|
|
14634
|
+
*/
|
|
14635
|
+
getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<RCResult<IMessageReaderResponse>>;
|
|
14636
|
+
/**
|
|
14637
|
+
* 发送已读回执 (V4)
|
|
14638
|
+
*/
|
|
14639
|
+
sendReadReceiptMessageV4(conversation: IConversationIdentifier, endMsgUid: string, startMsgUid?: string): Promise<RCResult>;
|
|
14640
|
+
/**
|
|
14641
|
+
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
14642
|
+
*/
|
|
14643
|
+
getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUId: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
|
|
14644
|
+
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
14319
14645
|
}
|
|
14320
14646
|
|
|
14321
14647
|
declare class APIContext {
|
|
@@ -14347,6 +14673,7 @@ declare class APIContext {
|
|
|
14347
14673
|
readonly sse: SSEModule;
|
|
14348
14674
|
readonly chatroom: ChatroomModule;
|
|
14349
14675
|
readonly chat: ChatModule;
|
|
14676
|
+
readonly dataHosting: DataHosting;
|
|
14350
14677
|
private _versionInfo;
|
|
14351
14678
|
private _typingInfo;
|
|
14352
14679
|
/**
|
|
@@ -14504,6 +14831,7 @@ declare class APIContext {
|
|
|
14504
14831
|
setPushConfig(config: IAppPushConfig): void;
|
|
14505
14832
|
getCurrentUserId(): string;
|
|
14506
14833
|
getConnectionStatus(): RCConnectionStatus;
|
|
14834
|
+
private _validateUserProfile;
|
|
14507
14835
|
/** 高阶函数,生成一个验证方法,验证是否处于连接中状态,并在连接状态可用时返回导航数据 */
|
|
14508
14836
|
get validateConnected(): () => RCResult<INaviInfo>;
|
|
14509
14837
|
/**
|
|
@@ -14519,22 +14847,9 @@ declare class APIContext {
|
|
|
14519
14847
|
private checkAuthed;
|
|
14520
14848
|
get token(): string;
|
|
14521
14849
|
refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
|
|
14522
|
-
|
|
14523
|
-
* 建立连接,连接失败则抛出异常,连接成功后返回用户 userId,否则返回相应的错误码
|
|
14524
|
-
* @param token
|
|
14525
|
-
* @param refreshNavi 是否需要重新请求导航,当值为 `false` 时,优先使用有效缓存导航,若缓存失效则重新获取导航
|
|
14526
|
-
* @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
|
|
14527
|
-
* 同一个账号在一台新设备上登录的时候,会把这个账号在之前登录的设备上踢出。
|
|
14528
|
-
由于 SDK 有断线重连功能,存在下面情况。
|
|
14529
|
-
用户在 A 设备登录,A 设备网络不稳定,没有连接成功,SDK 启动重连机制。
|
|
14530
|
-
用户此时又在 B 设备登录,B 设备连接成功。
|
|
14531
|
-
A 设备网络稳定之后,用户在 A 设备连接成功,B 设备被踢出。
|
|
14532
|
-
这个字段就是为这种情况加的。
|
|
14533
|
-
设置 reconnectKickEnable 为 true 时,SDK 重连的时候发现此时已有别的设备连接成功,不再强行踢出已有设备,而是踢出重连设备。
|
|
14534
|
-
*/
|
|
14535
|
-
connect(token: string, reconnectKickEnable: boolean, traceId: string): Promise<IConnectResult>;
|
|
14850
|
+
connect(token: string, reconnectKickEnable: boolean): Promise<RCResult<string>>;
|
|
14536
14851
|
disconnect(closeDB?: boolean, disablePush?: boolean): Promise<void>;
|
|
14537
|
-
reconnect(reconnectKickEnable?: boolean): Promise<
|
|
14852
|
+
reconnect(reconnectKickEnable?: boolean): Promise<RCResult<string>>;
|
|
14538
14853
|
/**
|
|
14539
14854
|
* 超级群 channelId 转换
|
|
14540
14855
|
* @param type 会话类型
|
|
@@ -14561,19 +14876,21 @@ declare class APIContext {
|
|
|
14561
14876
|
*/
|
|
14562
14877
|
registerRTCSignalingListener(listener?: (buffer: Uint8Array) => void): void;
|
|
14563
14878
|
/**
|
|
14564
|
-
*
|
|
14565
|
-
* @param
|
|
14879
|
+
* 内部发送消息,日志记录不同于 sendMessage
|
|
14880
|
+
* @param identifier 会话标识
|
|
14881
|
+
* @param options 消息发送配置
|
|
14882
|
+
* @param traceId 追踪 ID
|
|
14883
|
+
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
14566
14884
|
*/
|
|
14567
|
-
|
|
14885
|
+
innerSendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
14568
14886
|
/**
|
|
14569
14887
|
* 发送消息
|
|
14570
|
-
* @param
|
|
14571
|
-
* @param
|
|
14572
|
-
* @param
|
|
14573
|
-
* @param
|
|
14574
|
-
* @param options
|
|
14888
|
+
* @param identifier 会话标识
|
|
14889
|
+
* @param options 消息发送配置
|
|
14890
|
+
* @param traceId 追踪 ID
|
|
14891
|
+
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
14575
14892
|
*/
|
|
14576
|
-
sendMessage(
|
|
14893
|
+
sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
14577
14894
|
/**
|
|
14578
14895
|
* 更新消息拓展
|
|
14579
14896
|
* @param expansion 拓展数据
|
|
@@ -14593,14 +14910,6 @@ declare class APIContext {
|
|
|
14593
14910
|
* Web 历史版本中提供了超级群的消息拓展全删能力,需向前兼容,因此保留该接口;底层能力全支持,目前暂不开放。
|
|
14594
14911
|
*/
|
|
14595
14912
|
removeAllMessageExpansion(attrs: IMessageAttrsForUpdateExpansion): Promise<RCResult>;
|
|
14596
|
-
/**
|
|
14597
|
-
* 发送群组消息已读回执,根据导航开关配置确定发送 v1 或 v2 版本;不支持处理其他已读回执版本
|
|
14598
|
-
* @param targetId 群组会话 Id
|
|
14599
|
-
* @param messageList 消息列表
|
|
14600
|
-
* @param channelId 频道 Id
|
|
14601
|
-
* @returns
|
|
14602
|
-
*/
|
|
14603
|
-
sendReadReceipt(targetId: string, messageList: Record<string, string[]>, channelId?: string): Promise<RCResult>;
|
|
14604
14913
|
/**
|
|
14605
14914
|
* 发送群组消息已读回执 V2
|
|
14606
14915
|
* 导航下发已读回执开关为 true 时调用
|
|
@@ -14609,29 +14918,6 @@ declare class APIContext {
|
|
|
14609
14918
|
* @param channelId 频道 Id
|
|
14610
14919
|
*/
|
|
14611
14920
|
sendReadReceiptV2(targetId: string, messageUIds: string[], channelId?: string, traceId?: string): Promise<RCResult>;
|
|
14612
|
-
/**
|
|
14613
|
-
* 获取群组消息已读列表
|
|
14614
|
-
* 已读回执目前 3 个版本 有 naviInfo.grpRRVer 字段区分。
|
|
14615
|
-
* 0:为目前有公有先支持版本,调用 sendReadReceiptResponseV2
|
|
14616
|
-
* 1. 为 v2 版本,仅供 beem 使用目前公有云已废弃
|
|
14617
|
-
* 3. 为 v4 版本,目前仅海外 IMkit 使用
|
|
14618
|
-
* @param targetId
|
|
14619
|
-
* @param messageUIds
|
|
14620
|
-
*/
|
|
14621
|
-
getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
|
|
14622
|
-
/**
|
|
14623
|
-
* 发送已读回执 (V4)
|
|
14624
|
-
*/
|
|
14625
|
-
sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
14626
|
-
/**
|
|
14627
|
-
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
14628
|
-
*/
|
|
14629
|
-
getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
14630
|
-
batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
|
|
14631
|
-
/**
|
|
14632
|
-
* 多端同步会话的已读时间(V4)
|
|
14633
|
-
*/
|
|
14634
|
-
updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
|
|
14635
14921
|
/**
|
|
14636
14922
|
* 反初始化,清空所有监听及计时器
|
|
14637
14923
|
*/
|
|
@@ -14748,8 +15034,6 @@ declare class APIContext {
|
|
|
14748
15034
|
/**
|
|
14749
15035
|
* 撤回消息
|
|
14750
15036
|
* @param conversation 会话信息
|
|
14751
|
-
* @param messageUId
|
|
14752
|
-
* @param sentTime - 目前公有云已撤回消息已不再依赖消息的发送时间,私有云因存在一些老客户服务版本过旧,暂时仍需发送该参数
|
|
14753
15037
|
* @param recallMsgOptions
|
|
14754
15038
|
* @returns
|
|
14755
15039
|
*/
|
|
@@ -14783,10 +15067,10 @@ declare class APIContext {
|
|
|
14783
15067
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
14784
15068
|
* @returns
|
|
14785
15069
|
*/
|
|
14786
|
-
getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string, url?: string, size?: number): Promise<IUploadAuth & {
|
|
15070
|
+
getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth & {
|
|
14787
15071
|
qiniu: string;
|
|
14788
15072
|
ossConfig: string;
|
|
14789
|
-
}
|
|
15073
|
+
}>>;
|
|
14790
15074
|
/**
|
|
14791
15075
|
* 获取 七牛、阿里云上传后的可下载 URL
|
|
14792
15076
|
* @param fileType 文件类型
|
|
@@ -14863,11 +15147,6 @@ declare class APIContext {
|
|
|
14863
15147
|
* 获取所有群聊会话 @ 消息未读数,不包含超级群会话
|
|
14864
15148
|
*/
|
|
14865
15149
|
getAllUnreadMentionedCount(): Promise<RCResult<number>>;
|
|
14866
|
-
/**
|
|
14867
|
-
* 超级群正在输入中
|
|
14868
|
-
* @param options
|
|
14869
|
-
*/
|
|
14870
|
-
sendUltraGroupTypingStatus(options: IConversationOption): Promise<RCResult>;
|
|
14871
15150
|
/**
|
|
14872
15151
|
* 根据消息 ID 查询消息列表
|
|
14873
15152
|
* @param options
|
|
@@ -14907,34 +15186,31 @@ declare class APIContext {
|
|
|
14907
15186
|
* 获取应用主进程信息,仅限 Electron 平台可用
|
|
14908
15187
|
*/
|
|
14909
15188
|
getMainProcessInfo(): IPromiseResult<IProcessInfo>;
|
|
14910
|
-
setCallInfo(targetId: string, key: string, value: string): Promise<
|
|
15189
|
+
setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
14911
15190
|
key: string;
|
|
14912
15191
|
value: string;
|
|
14913
15192
|
}>>;
|
|
14914
|
-
private
|
|
15193
|
+
private _validateSubDriven;
|
|
14915
15194
|
/**
|
|
14916
15195
|
* 订阅用户状态事件
|
|
14917
15196
|
*/
|
|
14918
|
-
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
15197
|
+
subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
14919
15198
|
/**
|
|
14920
15199
|
* 取消订阅用户状态事件
|
|
14921
15200
|
*/
|
|
14922
|
-
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
15201
|
+
unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
14923
15202
|
/**
|
|
14924
15203
|
* 获取已订阅列表
|
|
14925
15204
|
*/
|
|
14926
|
-
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<
|
|
15205
|
+
getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
14927
15206
|
/**
|
|
14928
15207
|
* 获取指定用户的在线状态
|
|
14929
15208
|
*/
|
|
14930
15209
|
getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
14931
15210
|
getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCResult<ISubscribeUserOnlineStatus[]>>;
|
|
14932
|
-
updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
14933
|
-
getUserProfiles(userIds: string[]): Promise<
|
|
14934
|
-
getMyUserProfile(): Promise<
|
|
14935
|
-
updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
|
|
14936
|
-
getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
|
|
14937
|
-
searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
|
|
15211
|
+
updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
15212
|
+
getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
15213
|
+
getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
14938
15214
|
/**
|
|
14939
15215
|
* 删除所有会话,目前仅 v2 提供
|
|
14940
15216
|
*/
|
|
@@ -14947,20 +15223,20 @@ declare class APIContext {
|
|
|
14947
15223
|
}, listener: Function): void;
|
|
14948
15224
|
/**
|
|
14949
15225
|
* 添加用户黑名单
|
|
14950
|
-
|
|
14951
|
-
addToBlacklist(userId: string): Promise<
|
|
15226
|
+
*/
|
|
15227
|
+
addToBlacklist(userId: string): Promise<RCResult>;
|
|
14952
15228
|
/**
|
|
14953
15229
|
* 将指定用户移除黑名单
|
|
14954
15230
|
*/
|
|
14955
|
-
removeFromBlacklist(userId: string): Promise<
|
|
15231
|
+
removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
14956
15232
|
/**
|
|
14957
15233
|
* 获取黑名单列表
|
|
14958
15234
|
*/
|
|
14959
|
-
getBlacklist(): Promise<
|
|
15235
|
+
getBlacklist(): Promise<RCResult<string[]>>;
|
|
14960
15236
|
/**
|
|
14961
15237
|
* 获取指定人员在黑名单中的状态
|
|
14962
15238
|
*/
|
|
14963
|
-
getBlacklistStatus(userId: string): Promise<
|
|
15239
|
+
getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
14964
15240
|
/**
|
|
14965
15241
|
* 向本地插入一条消息,不发送到服务器
|
|
14966
15242
|
*/
|
|
@@ -15003,11 +15279,11 @@ declare class APIContext {
|
|
|
15003
15279
|
/**
|
|
15004
15280
|
* 设置消息发送状态
|
|
15005
15281
|
*/
|
|
15006
|
-
setMessageSentStatus(messageId: number, sentStatus: number): Promise<
|
|
15282
|
+
setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
15007
15283
|
/**
|
|
15008
15284
|
* 设置消息接收状态
|
|
15009
15285
|
*/
|
|
15010
|
-
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<
|
|
15286
|
+
setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
15011
15287
|
/**
|
|
15012
15288
|
* 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
|
|
15013
15289
|
*/
|
|
@@ -15026,11 +15302,11 @@ declare class APIContext {
|
|
|
15026
15302
|
* 获取用户在线状态
|
|
15027
15303
|
* @deprecated 老版 V2 中用到
|
|
15028
15304
|
*/
|
|
15029
|
-
getUserStatus(userId: string): Promise<
|
|
15305
|
+
getUserStatus(userId: string): Promise<RCResult<{
|
|
15030
15306
|
status: string;
|
|
15031
15307
|
}>>;
|
|
15032
15308
|
searchConversationByContent(keyword: string, messageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
15033
|
-
searchConversationByContentWithAllChannel(keyword: string, messageTypes?: string[], conversationTypes?: ConversationType[]): Promise<
|
|
15309
|
+
searchConversationByContentWithAllChannel(keyword: string, messageTypes?: string[], conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
15034
15310
|
/**
|
|
15035
15311
|
* 单会话搜索,为兼容老版本参数校验错误码和校验规则
|
|
15036
15312
|
* @param conversation
|
|
@@ -15046,7 +15322,6 @@ declare class APIContext {
|
|
|
15046
15322
|
searchMessagesWithParams(params: ISearchMessageParams): Promise<RCResult<ISearchMessagesResult>>;
|
|
15047
15323
|
getMessagesAroundTimestamp(conversation: IConversationOption, timestamp: number, beforeCount: number, afterCount: number): Promise<RCResult<IReceivedMessage[]>>;
|
|
15048
15324
|
getUnreadMentionedMessages(conversation: IConversationOption): Promise<RCResult<IReceivedMessage[]>>;
|
|
15049
|
-
clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
|
|
15050
15325
|
/**
|
|
15051
15326
|
* 查询指定超级群默认通知配置
|
|
15052
15327
|
*/
|
|
@@ -15075,68 +15350,21 @@ declare class APIContext {
|
|
|
15075
15350
|
/**
|
|
15076
15351
|
* 设置融云消息重排开关
|
|
15077
15352
|
*/
|
|
15078
|
-
setCheckDuplicateMessage(enableCheck
|
|
15079
|
-
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<
|
|
15080
|
-
|
|
15081
|
-
buffer?: Uint8Array;
|
|
15082
|
-
}>;
|
|
15083
|
-
rtcPing(roomId: string, mode: number, mediaType?: number): Promise<IAsyncRes<any>>;
|
|
15353
|
+
setCheckDuplicateMessage(enableCheck?: boolean): Promise<RCResult<boolean>>;
|
|
15354
|
+
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<RCResult<Uint8Array>>;
|
|
15355
|
+
rtcPing(roomId: string, mode: number, mediaType?: number): Promise<RCResult<any>>;
|
|
15084
15356
|
/**
|
|
15085
15357
|
* 设置代理
|
|
15086
15358
|
*/
|
|
15087
|
-
setProxy(proxy: IProxy | null):
|
|
15359
|
+
setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
15088
15360
|
/**
|
|
15089
15361
|
* 获取代理
|
|
15090
15362
|
*/
|
|
15091
|
-
getProxy():
|
|
15363
|
+
getProxy(): Promise<RCResult<IProxy>>;
|
|
15092
15364
|
/**
|
|
15093
15365
|
* 测试代理
|
|
15094
15366
|
*/
|
|
15095
|
-
testProxy(proxy: IProxy, testHost: string): Promise<
|
|
15096
|
-
createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15097
|
-
[key: string]: string;
|
|
15098
|
-
} | undefined, inviteeUserIds?: string[]): Promise<IAsyncRes<ICreateGroupFail>>;
|
|
15099
|
-
updateGroupInfo(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15100
|
-
[key: string]: string;
|
|
15101
|
-
} | undefined): Promise<IAsyncRes<IErrorKeys>>;
|
|
15102
|
-
getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15103
|
-
kickGroupMembers(groupId: string, userIds: string[], config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15104
|
-
quitGroup(groupId: string, config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15105
|
-
dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
|
|
15106
|
-
transferGroupOwner(groupId: string, newOwnerId: string, config: IQuitGroupConfig, quitGroupAfterTransfer?: boolean): Promise<IAsyncRes<void>>;
|
|
15107
|
-
setGroupManagers(type: GroupOperationType, groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15108
|
-
getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15109
|
-
getGroupMembers(groupId: string, userIds: string[]): Promise<IAsyncRes<IGroupMemberInfo[]>>;
|
|
15110
|
-
setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<IAsyncRes<IErrorKeys>>;
|
|
15111
|
-
searchGroupMembers(groupId: string, nickName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15112
|
-
joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15113
|
-
inviteUsersToGroup(groupId: string, userIds: string[]): Promise<IAsyncRes<IProcessCode>>;
|
|
15114
|
-
acceptGroupInvite(groupId: string, inviterId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15115
|
-
refuseGroupInvite(groupId: string, inviterId: string, reason: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15116
|
-
acceptGroupApplication(groupId: string, joinUserId: string, inviterId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15117
|
-
refuseGroupApplication(groupId: string, joinUserId: string, inviterId: string, reason?: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15118
|
-
getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
15119
|
-
getJoinedGroupsByRole(role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15120
|
-
searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15121
|
-
getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15122
|
-
setGroupRemark(groupId: string, remark: string | null): Promise<IAsyncRes<void>>;
|
|
15123
|
-
addGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15124
|
-
removeGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15125
|
-
getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInfo[]>>;
|
|
15126
|
-
addFriend(userId: string, directionType: DirectionType, extra: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15127
|
-
deleteFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<void>>;
|
|
15128
|
-
acceptFriendApplication(userId: string): Promise<IAsyncRes<void>>;
|
|
15129
|
-
refuseFriendApplication(userId: string, reason: string): Promise<IAsyncRes<void>>;
|
|
15130
|
-
setFriendInfo(userId: string, remark: string, extProfile: {
|
|
15131
|
-
[key: string]: string;
|
|
15132
|
-
}): Promise<IAsyncRes<IErrorKeys>>;
|
|
15133
|
-
checkFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<IFriendRelationInfo[]>>;
|
|
15134
|
-
getFriends(directionType: QueryFriendsDirectionType, option: IPagingQueryOption | undefined): Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>;
|
|
15135
|
-
getFriendApplications(option: IPagingQueryOption, type?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
15136
|
-
getFriendsInfo(userIds: string[]): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15137
|
-
searchFriendsInfo(nickname: string): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15138
|
-
setFriendAddPermission(permission: FriendAddPermission): Promise<IAsyncRes<void>>;
|
|
15139
|
-
getFriendAddPermission(): Promise<IAsyncRes<FriendAddPermission>>;
|
|
15367
|
+
testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
15140
15368
|
/**
|
|
15141
15369
|
* 查询实时会话列表
|
|
15142
15370
|
*/
|
|
@@ -15218,7 +15446,7 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
15218
15446
|
* rtc 房间保活
|
|
15219
15447
|
* 新版本 rtc ping 返回值增加 version 信息
|
|
15220
15448
|
*/
|
|
15221
|
-
rtcPingResVersion(roomId: string, mode: number, broadcastType?: number): Promise<
|
|
15449
|
+
rtcPingResVersion(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
15222
15450
|
/**
|
|
15223
15451
|
* @deprecated 兼容 rtc v3 方法调用
|
|
15224
15452
|
*/
|
|
@@ -15397,7 +15625,7 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
15397
15625
|
*/
|
|
15398
15626
|
declare type IUserSettingsModule = Pick<IIPCMethods, 'setTranslationLanguage' | 'getTranslationLanguage' | 'setAutoTranslateEnabled' | 'getAutoTranslateEnabled'>;
|
|
15399
15627
|
|
|
15400
|
-
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'>;
|
|
15628
|
+
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'>;
|
|
15401
15629
|
declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContext {
|
|
15402
15630
|
protected readonly rtcCodec: Codec<InnerRTCKeyMaps>;
|
|
15403
15631
|
protected readonly _watcher: IEngineWatcher;
|
|
@@ -15414,6 +15642,9 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15414
15642
|
*/
|
|
15415
15643
|
abstract get chat(): IChatService;
|
|
15416
15644
|
abstract get chatroom(): IChatroomService;
|
|
15645
|
+
/**
|
|
15646
|
+
* 用户级配置模块
|
|
15647
|
+
*/
|
|
15417
15648
|
abstract get userSettings(): IUserSettingsModule;
|
|
15418
15649
|
abstract get naviInfo(): INaviInfo | null;
|
|
15419
15650
|
get appkey(): string;
|
|
@@ -15421,6 +15652,11 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15421
15652
|
abstract get connectionStatus(): RCConnectionStatus;
|
|
15422
15653
|
abstract get userId(): string;
|
|
15423
15654
|
get logger(): BasicLogger;
|
|
15655
|
+
abstract get usingCppEngine(): boolean;
|
|
15656
|
+
/**
|
|
15657
|
+
* 用户信息托管模块
|
|
15658
|
+
*/
|
|
15659
|
+
abstract get dataHosting(): IDataHostingService;
|
|
15424
15660
|
/**
|
|
15425
15661
|
* 引擎初始化
|
|
15426
15662
|
* @param _appkey
|
|
@@ -15447,7 +15683,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15447
15683
|
* @param openCallPlus
|
|
15448
15684
|
* @param traceId
|
|
15449
15685
|
*/
|
|
15450
|
-
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string):
|
|
15686
|
+
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): Promise<RCResult<string>>;
|
|
15451
15687
|
/**
|
|
15452
15688
|
* 发送 SDK 版本
|
|
15453
15689
|
* @param versionInfo
|
|
@@ -15469,33 +15705,14 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15469
15705
|
* 清除指定会话消息草稿
|
|
15470
15706
|
*/
|
|
15471
15707
|
abstract clearTextMessageDraft(conversation: IConversationOption): Promise<RCResult>;
|
|
15472
|
-
abstract sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, traceId: string,
|
|
15473
|
-
/**
|
|
15474
|
-
* c++ 消息写库后存在自增 Id,必要时需要向业务层暴露,JSEngine 无需实现
|
|
15475
|
-
*/
|
|
15476
|
-
onBefore?: (messageId: number) => void): IPromiseResult<IReceivedMessage>;
|
|
15477
|
-
/**
|
|
15478
|
-
* 获取群组消息已读列表
|
|
15479
|
-
* @param targetId
|
|
15480
|
-
* @param messageUIds
|
|
15481
|
-
*/
|
|
15482
|
-
abstract getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
|
|
15483
|
-
/**
|
|
15484
|
-
* 发送已读回执 (V4)
|
|
15485
|
-
*/
|
|
15486
|
-
abstract sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
15487
|
-
/**
|
|
15488
|
-
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
15489
|
-
*/
|
|
15490
|
-
abstract getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
15491
|
-
/**
|
|
15492
|
-
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
15493
|
-
*/
|
|
15494
|
-
abstract batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
|
|
15495
15708
|
/**
|
|
15496
|
-
*
|
|
15709
|
+
* 发送消息
|
|
15710
|
+
* @param identifier 会话标识
|
|
15711
|
+
* @param options 消息发送配置
|
|
15712
|
+
* @param traceId 追踪 ID
|
|
15713
|
+
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
15497
15714
|
*/
|
|
15498
|
-
abstract
|
|
15715
|
+
abstract sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
15499
15716
|
/**
|
|
15500
15717
|
* 断开连接
|
|
15501
15718
|
* @param closeDB 是否关闭数据库,默认为 true,仅 Electron 平台有效
|
|
@@ -15508,20 +15725,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15508
15725
|
* 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
15509
15726
|
*/
|
|
15510
15727
|
abstract registerMessageType(objectName: string, desc: MessageRegisterParams): void;
|
|
15511
|
-
|
|
15512
|
-
* 获取存储服务鉴权信息
|
|
15513
|
-
* @param fileType 文件类型
|
|
15514
|
-
* @param fileName 文件名称
|
|
15515
|
-
* @param httpMethod STC 分段上传时的必填参数,有效值为 PUT | POST
|
|
15516
|
-
* @param queryString STC 分段上传时的查询字符串
|
|
15517
|
-
* @description
|
|
15518
|
-
* `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
|
|
15519
|
-
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
|
|
15520
|
-
* 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
|
|
15521
|
-
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
15522
|
-
* @returns
|
|
15523
|
-
*/
|
|
15524
|
-
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryString?: string, url?: string, size?: number): Promise<IAsyncRes<IUploadAuth>>;
|
|
15728
|
+
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth>>;
|
|
15525
15729
|
/**
|
|
15526
15730
|
* 获取文件的下载地址
|
|
15527
15731
|
* @param fileType 文件类型
|
|
@@ -15570,7 +15774,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15570
15774
|
* @param targetId
|
|
15571
15775
|
* @param options
|
|
15572
15776
|
*/
|
|
15573
|
-
abstract sendUltraMessage(
|
|
15777
|
+
abstract sendUltraMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onSendBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
15574
15778
|
/**
|
|
15575
15779
|
* 设置用户在线状态监听器
|
|
15576
15780
|
*/
|
|
@@ -15588,25 +15792,25 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15588
15792
|
/**
|
|
15589
15793
|
* 获取用户状态
|
|
15590
15794
|
*/
|
|
15591
|
-
abstract getUserStatus(userId: string):
|
|
15795
|
+
abstract getUserStatus(userId: string): Promise<RCResult<{
|
|
15592
15796
|
status: string;
|
|
15593
|
-
}
|
|
15797
|
+
}>>;
|
|
15594
15798
|
/**
|
|
15595
15799
|
* 加入黑名单
|
|
15596
15800
|
*/
|
|
15597
|
-
abstract addToBlacklist(userId: string): Promise<
|
|
15801
|
+
abstract addToBlacklist(userId: string): Promise<RCResult>;
|
|
15598
15802
|
/**
|
|
15599
15803
|
* 将指定用户移除黑名单
|
|
15600
15804
|
*/
|
|
15601
|
-
abstract removeFromBlacklist(userId: string): Promise<
|
|
15805
|
+
abstract removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
15602
15806
|
/**
|
|
15603
15807
|
* 获取黑名单列表
|
|
15604
15808
|
*/
|
|
15605
|
-
abstract getBlacklist():
|
|
15809
|
+
abstract getBlacklist(): Promise<RCResult<string[]>>;
|
|
15606
15810
|
/**
|
|
15607
15811
|
* 获取指定人员在黑名单中的状态
|
|
15608
15812
|
*/
|
|
15609
|
-
abstract getBlacklistStatus(userId: string):
|
|
15813
|
+
abstract getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
15610
15814
|
/**
|
|
15611
15815
|
* 向本地插入一条消息,不发送到服务器
|
|
15612
15816
|
*/
|
|
@@ -15648,28 +15852,24 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15648
15852
|
/**
|
|
15649
15853
|
* 通过关键字搜索所有会话
|
|
15650
15854
|
*/
|
|
15651
|
-
abstract searchConversationByContentWithAllChannel(keyword: string, messageTypes: string[], conversationTypes: ConversationType[]):
|
|
15855
|
+
abstract searchConversationByContentWithAllChannel(keyword: string, messageTypes: string[], conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
15652
15856
|
abstract searchMessagesWithParams(params: ISearchMessageParams): Promise<RCResult<ISearchMessagesResult>>;
|
|
15653
15857
|
/**
|
|
15654
15858
|
* 设置消息发送状态
|
|
15655
15859
|
*/
|
|
15656
|
-
abstract setMessageSentStatus(messageId: number, sentStatus: number): Promise<
|
|
15860
|
+
abstract setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
15657
15861
|
/**
|
|
15658
15862
|
* 设置消息接收状态
|
|
15659
15863
|
*/
|
|
15660
|
-
abstract setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<
|
|
15864
|
+
abstract setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
15661
15865
|
/**
|
|
15662
15866
|
* 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
|
|
15663
15867
|
*/
|
|
15664
15868
|
abstract updateMessageReceiptStatus(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<RCResult<boolean>>;
|
|
15665
|
-
|
|
15666
|
-
* 删除时间戳前的未读数
|
|
15667
|
-
*/
|
|
15668
|
-
abstract clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
|
|
15669
|
-
abstract setCallInfo(targetId: string, key: string, value: string): IPromiseResult<{
|
|
15869
|
+
abstract setCallInfo(targetId: string, key: string, value: string): Promise<RCResult<{
|
|
15670
15870
|
key: string;
|
|
15671
15871
|
value: string;
|
|
15672
|
-
}
|
|
15872
|
+
}>>;
|
|
15673
15873
|
abstract clearLocalData(): Promise<RCResult<boolean>>;
|
|
15674
15874
|
/**
|
|
15675
15875
|
* 获取运行时的系统信息,仅限 Electron 平台可用
|
|
@@ -15686,7 +15886,7 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15686
15886
|
/**
|
|
15687
15887
|
* 设置融云消息重排开关
|
|
15688
15888
|
*/
|
|
15689
|
-
abstract setCheckDuplicateMessage(enableCheck: boolean):
|
|
15889
|
+
abstract setCheckDuplicateMessage(enableCheck: boolean): Promise<RCResult<boolean>>;
|
|
15690
15890
|
/**
|
|
15691
15891
|
* RTC 通用调用接口
|
|
15692
15892
|
* 在非 Comet 协议下,入参 sourceData 应为 ArrayBuffer 数据,返回结果为 Uint8Array 数据
|
|
@@ -15695,12 +15895,9 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15695
15895
|
* @param isQuery 使用 `qry` or `pub` 进行请求,按服务要求传递
|
|
15696
15896
|
* @param sourceData PB 数据
|
|
15697
15897
|
*/
|
|
15698
|
-
abstract rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: ArrayBuffer): Promise<
|
|
15699
|
-
|
|
15700
|
-
|
|
15701
|
-
}>;
|
|
15702
|
-
abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
|
|
15703
|
-
pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<IAsyncRes<number>>;
|
|
15898
|
+
abstract rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: ArrayBuffer): Promise<RCResult<Uint8Array>>;
|
|
15899
|
+
abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
15900
|
+
pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<RCResult<number>>;
|
|
15704
15901
|
/**
|
|
15705
15902
|
* 接收 rtc 资源变更
|
|
15706
15903
|
*/
|
|
@@ -15712,15 +15909,15 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15712
15909
|
/**
|
|
15713
15910
|
* 设置代理
|
|
15714
15911
|
*/
|
|
15715
|
-
abstract setProxy(proxy: IProxy | null):
|
|
15912
|
+
abstract setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
15716
15913
|
/**
|
|
15717
15914
|
* 获取代理
|
|
15718
15915
|
*/
|
|
15719
|
-
abstract getProxy():
|
|
15916
|
+
abstract getProxy(): Promise<RCResult<IProxy>>;
|
|
15720
15917
|
/**
|
|
15721
15918
|
* 测试代理
|
|
15722
15919
|
*/
|
|
15723
|
-
abstract testProxy(proxy: IProxy, testHost: string): Promise<
|
|
15920
|
+
abstract testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
15724
15921
|
/**
|
|
15725
15922
|
* 设置当前网络
|
|
15726
15923
|
*/
|
|
@@ -15728,73 +15925,22 @@ declare abstract class BasicEngine implements IIPCMethodsInEngine, IModuleContex
|
|
|
15728
15925
|
/**
|
|
15729
15926
|
* 订阅用户状态事件
|
|
15730
15927
|
*/
|
|
15731
|
-
abstract subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
15928
|
+
abstract subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
15732
15929
|
/**
|
|
15733
15930
|
* 取消订阅用户状态事件
|
|
15734
15931
|
*/
|
|
15735
|
-
abstract unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
15932
|
+
abstract unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
15736
15933
|
/**
|
|
15737
15934
|
* 获取已订阅列表
|
|
15738
15935
|
*/
|
|
15739
|
-
abstract getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<
|
|
15936
|
+
abstract getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
15740
15937
|
/**
|
|
15741
15938
|
* 获取指定用户的在线状态
|
|
15742
15939
|
*/
|
|
15743
15940
|
abstract getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
15744
|
-
abstract updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
15745
|
-
abstract getUserProfiles(userIds: string[]): Promise<
|
|
15746
|
-
abstract getMyUserProfile(): Promise<
|
|
15747
|
-
abstract updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes>;
|
|
15748
|
-
abstract getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
|
|
15749
|
-
abstract searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
|
|
15750
|
-
abstract createGroup(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15751
|
-
[key: string]: string;
|
|
15752
|
-
} | undefined, inviteeUserIds: string[]): Promise<IAsyncRes<ICreateGroupFail>>;
|
|
15753
|
-
abstract updateGroupInfo(groupId: string, baseInfo: IServerGroupBaseInfo, extProfile: {
|
|
15754
|
-
[key: string]: string;
|
|
15755
|
-
} | undefined): Promise<IAsyncRes<IErrorKeys>>;
|
|
15756
|
-
abstract getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15757
|
-
abstract kickGroupMembers(groupId: string, userIds: string[], config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15758
|
-
abstract quitGroup(groupId: string, config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15759
|
-
abstract dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
|
|
15760
|
-
abstract transferGroupOwner(groupId: string, newOwnerId: string, quitGroupAfterTransfer: boolean, config: IQuitGroupConfig): Promise<IAsyncRes<void>>;
|
|
15761
|
-
abstract setGroupManagers(type: GroupOperationType, groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15762
|
-
abstract getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15763
|
-
abstract getGroupMembers(groupId: string, userIds: string[]): Promise<IAsyncRes<IGroupMemberInfo[]>>;
|
|
15764
|
-
abstract setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<IAsyncRes<IErrorKeys>>;
|
|
15765
|
-
abstract searchGroupMembers(groupId: string, nickName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
15766
|
-
abstract joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15767
|
-
abstract inviteUsersToGroup(groupId: string, userIds: string[]): Promise<IAsyncRes<IProcessCode>>;
|
|
15768
|
-
abstract memberInviteResponse(params: {
|
|
15769
|
-
groupId: string;
|
|
15770
|
-
inviterId: string;
|
|
15771
|
-
optType: GroupOperationRole;
|
|
15772
|
-
optResult: GroupOperationStatus;
|
|
15773
|
-
joinUserId?: string;
|
|
15774
|
-
reason?: string;
|
|
15775
|
-
}): Promise<IAsyncRes<IProcessCode>>;
|
|
15776
|
-
abstract getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
15777
|
-
abstract getJoinedGroupsByRole(role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15778
|
-
abstract searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
|
|
15779
|
-
abstract getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
|
|
15780
|
-
abstract setGroupRemark(groupId: string, remark: string | null): Promise<IAsyncRes<void>>;
|
|
15781
|
-
abstract setGroupFollows(optType: GroupOperationType, groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
|
|
15782
|
-
abstract getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInfo[]>>;
|
|
15783
|
-
abstract addFriend(userId: string, directionType: DirectionType, extra: string): Promise<IAsyncRes<IProcessCode>>;
|
|
15784
|
-
abstract deleteFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<void>>;
|
|
15785
|
-
abstract acceptFriendApplication(userId: string): Promise<IAsyncRes<void>>;
|
|
15786
|
-
abstract refuseFriendApplication(userId: string, reason: string): Promise<IAsyncRes<void>>;
|
|
15787
|
-
abstract setFriendInfo(userId: string, remark: string, extProfile: {
|
|
15788
|
-
[key: string]: string;
|
|
15789
|
-
}): Promise<IAsyncRes<IErrorKeys>>;
|
|
15790
|
-
abstract checkFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<IFriendRelationInfo[]>>;
|
|
15791
|
-
abstract getFriends(directionType: QueryFriendsDirectionType, option: IPagingQueryOption | undefined): Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>;
|
|
15792
|
-
abstract getFriendApplications(option: IPagingQueryOption, type?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
15793
|
-
abstract deleteFriendApplication(userId: string, type: FriendApplicationType): Promise<IAsyncRes<void>>;
|
|
15794
|
-
abstract getFriendsInfo(userIds: string[]): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15795
|
-
abstract searchFriendsInfo(nickname: string): Promise<IAsyncRes<IFriendInfo[]>>;
|
|
15796
|
-
abstract setFriendAddPermission(permission: FriendAddPermission): Promise<IAsyncRes<void>>;
|
|
15797
|
-
abstract getFriendAddPermission(): Promise<IAsyncRes<FriendAddPermission>>;
|
|
15941
|
+
abstract updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
15942
|
+
abstract getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
15943
|
+
abstract getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
15798
15944
|
abstract setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
15799
15945
|
abstract removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
15800
15946
|
abstract getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
@@ -15867,107 +16013,6 @@ declare class SSEModule extends EventDispatcher<{
|
|
|
15867
16013
|
requestStreamMessageContent(messageUId: string): Promise<RCResult>;
|
|
15868
16014
|
}
|
|
15869
16015
|
|
|
15870
|
-
interface IDataHostingModule {
|
|
15871
|
-
}
|
|
15872
|
-
|
|
15873
|
-
/**
|
|
15874
|
-
* 错误码映射表,单个标签且对应唯一错误码
|
|
15875
|
-
*/
|
|
15876
|
-
interface IErrorCodeKey {
|
|
15877
|
-
'set.proxy': number;
|
|
15878
|
-
'test.proxy': number;
|
|
15879
|
-
'test.proxy.socksHost': number;
|
|
15880
|
-
'test.proxy.socksPort': number;
|
|
15881
|
-
channelId: number;
|
|
15882
|
-
count: number;
|
|
15883
|
-
startTime: number;
|
|
15884
|
-
keyword: number;
|
|
15885
|
-
messageTypes: number;
|
|
15886
|
-
conversation: number;
|
|
15887
|
-
conversationType: number;
|
|
15888
|
-
targetId: number;
|
|
15889
|
-
endTime: number;
|
|
15890
|
-
offset: number;
|
|
15891
|
-
limit: number;
|
|
15892
|
-
userId: number;
|
|
15893
|
-
timestamp: number;
|
|
15894
|
-
sentTime: number;
|
|
15895
|
-
order: number;
|
|
15896
|
-
messageId: number;
|
|
15897
|
-
receivedStatus: number;
|
|
15898
|
-
receivedStatusInfo: number;
|
|
15899
|
-
sentStatus: number;
|
|
15900
|
-
content: number;
|
|
15901
|
-
messageType: number;
|
|
15902
|
-
messageIds: number;
|
|
15903
|
-
typingContentType: number;
|
|
15904
|
-
messageDirection: number;
|
|
15905
|
-
canIncludeExpansion: number;
|
|
15906
|
-
expansion: number;
|
|
15907
|
-
disableNotification: number;
|
|
15908
|
-
messages: number;
|
|
15909
|
-
checkDuplicate: number;
|
|
15910
|
-
messageUId: number;
|
|
15911
|
-
key: number;
|
|
15912
|
-
value: number;
|
|
15913
|
-
isAutoDelete: number;
|
|
15914
|
-
isSendNotification: number;
|
|
15915
|
-
notificationExtra: number;
|
|
15916
|
-
entries: number;
|
|
15917
|
-
isForce: number;
|
|
15918
|
-
rtcRoomId: number;
|
|
15919
|
-
token: number;
|
|
15920
|
-
conversations: number;
|
|
15921
|
-
conversationTypes: number;
|
|
15922
|
-
levels: number;
|
|
15923
|
-
notificationLevel: number;
|
|
15924
|
-
notificationLevels: number;
|
|
15925
|
-
notificationStatus: number;
|
|
15926
|
-
isTop: number;
|
|
15927
|
-
isUpdateTime: number;
|
|
15928
|
-
message: number;
|
|
15929
|
-
isStatusMessage: number;
|
|
15930
|
-
pushContent: number;
|
|
15931
|
-
pushData: number;
|
|
15932
|
-
isMentioned: number;
|
|
15933
|
-
mentionedType: number;
|
|
15934
|
-
mentionedUserIdList: number;
|
|
15935
|
-
directionalUserIdList: number;
|
|
15936
|
-
directedUserIds: number;
|
|
15937
|
-
isVoipPush: number;
|
|
15938
|
-
pushConfig: number;
|
|
15939
|
-
startMsgUId: number;
|
|
15940
|
-
endMsgUId: number;
|
|
15941
|
-
clearMessageOption: number;
|
|
15942
|
-
keys: number;
|
|
15943
|
-
searchContent: number;
|
|
15944
|
-
senderUserId: number;
|
|
15945
|
-
tagId: number;
|
|
15946
|
-
tagName: number;
|
|
15947
|
-
tagIds: number;
|
|
15948
|
-
containMuted: number;
|
|
15949
|
-
channelType: number;
|
|
15950
|
-
targetIds: number;
|
|
15951
|
-
file: number;
|
|
15952
|
-
fileType: number;
|
|
15953
|
-
contentDisposition: number;
|
|
15954
|
-
mediaUrl: number;
|
|
15955
|
-
filename: number;
|
|
15956
|
-
saveName: number;
|
|
15957
|
-
serverType: number;
|
|
15958
|
-
subscribeType: number;
|
|
15959
|
-
expiry: number;
|
|
15960
|
-
subscribeUserIds: number;
|
|
15961
|
-
subscribePageSize: number;
|
|
15962
|
-
conversationList: number;
|
|
15963
|
-
conversationTypeNotSupport: number;
|
|
15964
|
-
profile: number;
|
|
15965
|
-
userProfileVisibility: number;
|
|
15966
|
-
uniqueId: number;
|
|
15967
|
-
extra: number;
|
|
15968
|
-
disableUpdateLastMessage: number;
|
|
15969
|
-
}
|
|
15970
|
-
|
|
15971
16016
|
/**
|
|
15972
16017
|
* 预定义的验证规则,只包含 `值类型` 数据验证
|
|
15973
16018
|
* 引用类型数据需使用自定义 validator 校验函数进行校验
|
|
@@ -16004,15 +16049,7 @@ declare enum AssertRules {
|
|
|
16004
16049
|
/**
|
|
16005
16050
|
* ChannelId 验证,必须为 String 且不超过 20 位 且不能包含下划线
|
|
16006
16051
|
*/
|
|
16007
|
-
CHANNEL_ID = 7
|
|
16008
|
-
/**
|
|
16009
|
-
* 类型为会话
|
|
16010
|
-
*/
|
|
16011
|
-
CONVERSATION = 8,
|
|
16012
|
-
/**
|
|
16013
|
-
* 会话类型验证,必须为 ConversationType
|
|
16014
|
-
*/
|
|
16015
|
-
CONVERSATION_TYPE = 9
|
|
16052
|
+
CHANNEL_ID = 7
|
|
16016
16053
|
}
|
|
16017
16054
|
/**
|
|
16018
16055
|
* 参数校验,该方法用于对业务层入参数据检查,及时抛出异常通知业务层进行修改
|
|
@@ -16038,91 +16075,6 @@ declare const assert: (key: string, value: any, validator: AssertRules | ((value
|
|
|
16038
16075
|
*/
|
|
16039
16076
|
declare const validate: (key: string, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean) => boolean;
|
|
16040
16077
|
|
|
16041
|
-
/**
|
|
16042
|
-
* @deprecated
|
|
16043
|
-
*/
|
|
16044
|
-
declare class ValidatorManage<T> {
|
|
16045
|
-
private _logTagT;
|
|
16046
|
-
private _logTagR;
|
|
16047
|
-
private verificationFaileList;
|
|
16048
|
-
private context?;
|
|
16049
|
-
private logger?;
|
|
16050
|
-
private option?;
|
|
16051
|
-
constructor(_logTagT: string, _logTagR: string);
|
|
16052
|
-
/**
|
|
16053
|
-
* 添加效验参数
|
|
16054
|
-
* @param key 错误码标签
|
|
16055
|
-
* @param value 需要校验的值
|
|
16056
|
-
* @param validator 效验规则
|
|
16057
|
-
* @param required 是否必填
|
|
16058
|
-
* @param message 自定义错误信息
|
|
16059
|
-
*/
|
|
16060
|
-
validate(key: keyof IErrorCodeKey, value: any, validator: AssertRules | ((value?: any) => {
|
|
16061
|
-
errorKey?: keyof IErrorCodeKey;
|
|
16062
|
-
valid: boolean;
|
|
16063
|
-
}) | ((value?: any) => boolean), required?: boolean, message?: string): this;
|
|
16064
|
-
/**
|
|
16065
|
-
* 验证参数
|
|
16066
|
-
* @param key 错误码标签
|
|
16067
|
-
* @param value 需要校验的值
|
|
16068
|
-
* @param validator 效验规则
|
|
16069
|
-
* @param errorCode 错误码
|
|
16070
|
-
* @param required 是否必填
|
|
16071
|
-
* @param message 自定义错误信息
|
|
16072
|
-
* @description 代替 validate 方法,支持传入错误码,无需定义 Key
|
|
16073
|
-
*/
|
|
16074
|
-
validateParameters(key: string, value: any, validator: AssertRules | ((value?: any) => {
|
|
16075
|
-
errorKey?: string;
|
|
16076
|
-
valid: boolean;
|
|
16077
|
-
errorCode?: ErrorCode;
|
|
16078
|
-
}) | ((value?: any) => boolean), errorCode: ErrorCode, required?: boolean, message?: string): this;
|
|
16079
|
-
private _getValidationResult;
|
|
16080
|
-
/**
|
|
16081
|
-
* 内部验证接口是否完成初始化,若未完成初始化,返回状态码 `ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT`
|
|
16082
|
-
* @param handler 验证初始化完成的回调,其接收 APIContext, BasicLogger 与 IAPIContextOption 两个类型参数
|
|
16083
|
-
* @param errorTag 验证失败时,需要留存的日志信息
|
|
16084
|
-
* @description 对外接口定义中,使用此函数验证 SDK 初始化是否完成。
|
|
16085
|
-
*/
|
|
16086
|
-
ifReady(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption, traceId: string) => Promise<IAsyncRes<T>>): Promise<IAsyncRes<T>>;
|
|
16087
|
-
/**
|
|
16088
|
-
* 尝试调用需要初始化完成的函数,若未完成初始化,抛出异常 `Not initialized yet!`
|
|
16089
|
-
* @param handler
|
|
16090
|
-
* @returns
|
|
16091
|
-
* @throw `Not initialized yet!`
|
|
16092
|
-
* @description 对外接口定义中,若无明确 code 码返回的情况下,使用该函数验证 SDK 初始化是否完成。
|
|
16093
|
-
* 新增接口不可使用。
|
|
16094
|
-
*/
|
|
16095
|
-
try2do(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => T): T;
|
|
16096
|
-
/**
|
|
16097
|
-
* `_ifReady` 同步版本,若未完成初始化,返回状态码 `ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT`
|
|
16098
|
-
* @param handler 验证初始化完成的回调,其接收 APIContext, BasicLogger 与 IAPIContextOption 两个类型参数
|
|
16099
|
-
* @description 对外接口定义中,使用此函数验证 SDK 初始化是否完成。
|
|
16100
|
-
*/
|
|
16101
|
-
ifReadySync<T>(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => IAsyncRes<T>): IAsyncRes<T>;
|
|
16102
|
-
}
|
|
16103
|
-
|
|
16104
|
-
/**
|
|
16105
|
-
* 检查参数是否为数组
|
|
16106
|
-
* 做长度检查、每一项的类型检查
|
|
16107
|
-
*/
|
|
16108
|
-
declare const isLimitedArray: (option: {
|
|
16109
|
-
minLength?: number | undefined;
|
|
16110
|
-
maxLength?: number | undefined;
|
|
16111
|
-
itemValidator?: ((val: unknown) => boolean) | ((val: unknown) => {
|
|
16112
|
-
errorKey?: keyof IErrorCodeKey;
|
|
16113
|
-
valid: boolean;
|
|
16114
|
-
}) | undefined;
|
|
16115
|
-
}) => (arr: any[]) => boolean;
|
|
16116
|
-
/**
|
|
16117
|
-
* @param conversation 会话信息
|
|
16118
|
-
* @param conversationTypeList 接口支持的会话类型列表,不传则不校验
|
|
16119
|
-
* @returns
|
|
16120
|
-
*/
|
|
16121
|
-
declare const isValidConversation: (conversation: any, conversationTypeList?: ConversationType[] | undefined) => {
|
|
16122
|
-
errorKey?: keyof IErrorCodeKey | undefined;
|
|
16123
|
-
valid: boolean;
|
|
16124
|
-
};
|
|
16125
|
-
|
|
16126
16078
|
/**
|
|
16127
16079
|
* @deprecated 使用 UUId.gen() 替代
|
|
16128
16080
|
*/
|
|
@@ -16155,4 +16107,4 @@ declare class AppStorage {
|
|
|
16155
16107
|
}): void;
|
|
16156
16108
|
}
|
|
16157
16109
|
|
|
16158
|
-
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,
|
|
16110
|
+
export { APIContext, AbsCodec, AppSettings, AppStorage, AreaCode, AssertRules, BasicEngine, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationBatchDeletionParams, ConversationType, DataHosting, DirectionType, EnableLogL, ErrorCode, EventEmitter, FileType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupOperationRole, GroupOperationStatus, GroupOperationType, GroupReadReceiptVersion, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAppPushConfig, IAsyncRes, IAuditInfoKeyInMessage, IAuditInfoValueInMessage, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatService, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomErrorKeys, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomService, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineMessageContent, ICombineV2MessageContent, ICombinedMessage, ICommandMessageContent, IConnectionStatusListener, IConversationFilter, IConversationIdentifier, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IConversationUnreadCount, IConvertHQVoiceMessageToTextOption, IConvertSpeechToTextOption, IConvertVoiceMessageToTextOption, ICreateGroupFail, IDataHostingService, IDeletedExpansion, IDownloadAuth, IEditedMessageDraft, IEnginRefreshReferenceMessageResult, IEngineWatcher, IErrorKeys, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraDataKeyInMessage, IFileMessageContent, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGIFMessageContent, IGetConversationListByTimestampParams, IGetGroupMembersOption, IGetHistoryMessageOption, IGetHistoryMessageResult, IGetHistoryMessagesByTypesOption, IGetUltraGroupListOption, IGetUnreadMentionMeConversationListParams, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupNotificationMessageContent, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHQVoiceMessageContent, IHarmonyOSPushConfig, IIPCMethods, IImageMessageContent, IInformationNotificationMessageContent, IInsertMessage, ILocalTagStatus, ILocationMessageContent, ILogData, ILogger, IMemberInviteResponse, IMentionedInfoKeyInMessage, IMessageAttrsForUpdateExpansion, IMessageDesc, IMessageFilter, IMessageIdentifier, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMessageSendOptions, IModifyMessageParams, INaviInfo, INetwork, INotificationQuietHoursSetting, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPlatformOnlineStatus, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessCode, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallCommandMessageContent, IRecallMsgOptions, IRecallNotificationMessageContent, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRefreshReferenceMessageParams, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRichContentMessageContent, IRuntime, ISearchMessageParams, ISearchMessagesResult, ISendMsgOptions, IServerGroupBaseInfo, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStorage, IStreamMessageContent, IStreamMessageResponseChunkData, IStreamMessageResponseEventData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IUserSettingsModule, IVoiceMessageContent, IWatcher, IiOSPushConfig, InnerInsertMessageParams, InnerRTCKeyMaps, 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 };
|