@rongcloud/engine 5.20.0-c-esm-alpha.1 → 5.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -17,11 +17,11 @@ declare enum UploadMethod {
17
17
  */
18
18
  AWS = 3,
19
19
  /**
20
- * stc上传
20
+ * stc 上传
21
21
  */
22
22
  STC = 4,
23
23
  /**
24
- * minio上传
24
+ * minio 上传
25
25
  */
26
26
  MINIO = 5
27
27
  }
@@ -29,212 +29,229 @@ declare enum UploadMethod {
29
29
  /**
30
30
  * IMLib 埋点日志 Id 枚举
31
31
  */
32
- declare enum LogTagId {
33
- L_IMSDK_VER_O = "L-imsdk_ver-O",
34
- A_INIT_REPEAT_O = "A_INIT_REPEAT_O",
35
- L_INIT_O = "L-init-O",
36
- A_DESTROY_O = "A_DESTROY_O",
37
- L_DESTROY_O = "L_DESTROY_O",
38
- A_CONNECT_T = "A-connect-T",
39
- A_CONNECT_R = "A-connect-R",
40
- A_CONNECT_S = "A-connect-S",
41
- A_DISCONNECT_O = "A-disconnect-O",
42
- A_RECONNECT_T = "A-reconnect-T",
43
- A_RECONNECT_R = "A_RECONNECT_R",
44
- L_CONNECT_T = "L-connect-T",
45
- L_CONNECT_R = "L-connect-R",
46
- L_CONNECT_S = "L-connect-S",
47
- L_DB_UPGRATE_START_S = "L-db_upgrate_start-S",
48
- L_DB_UPGRATING_S = "L-db_upgrating-S",
49
- L_DB_UPGRATE_COMPLETE_S = "L-db_upgrate_complete-S",
50
- L_NOTIFY_ULTRA_ONLINE_S = "L-notify-ultra-online-S",
51
- L_ULTRA_SYNC_DONE_S = "L-ultra-sync-done-S",
52
- L_BATCH_MESSAGE_O = "L-BATCH_MESSAGE-O",
32
+ declare const LogTagId: {
33
+ readonly L_IMSDK_VER_O: "L-imsdk_ver-O";
34
+ readonly A_INIT_REPEAT_O: "A_INIT_REPEAT_O";
35
+ readonly L_INIT_O: "L-init-O";
36
+ readonly A_DESTROY_O: "A_DESTROY_O";
37
+ readonly A_CONNECT_T: "A-connect-T";
38
+ readonly A_CONNECT_R: "A-connect-R";
39
+ readonly A_CONNECT_S: "A-connect-S";
40
+ readonly L_QUERY_CMP_T: "L-query_cmp-T";
41
+ readonly L_QUERY_CMP_R: "L-query_cmp-R";
42
+ readonly A_DISCONNECT_O: "A-disconnect-O";
43
+ readonly A_RECONNECT_T: "A-reconnect-T";
44
+ readonly A_RECONNECT_R: "A_RECONNECT_R";
45
+ readonly L_CONNECT_T: "L-connect-T";
46
+ readonly L_CONNECT_O: "L-connect-O";
47
+ readonly L_CONNECT_R: "L-connect-R";
48
+ readonly L_CONNECT_S: "L-connect-S";
49
+ readonly L_DB_UPGRATE_START_S: "L-db_upgrate_start-S";
50
+ readonly L_DB_UPGRATING_S: "L-db_upgrating-S";
51
+ readonly L_DB_UPGRATE_COMPLETE_S: "L-db_upgrate_complete-S";
52
+ readonly L_NOTIFY_ULTRA_ONLINE_S: "L-notify-ultra-online-S";
53
+ readonly L_ULTRA_SYNC_DONE_S: "L-ultra-sync-done-S";
54
+ readonly L_BATCH_MESSAGE_O: "L-BATCH_MESSAGE-O";
53
55
  /** 业务层 APIContext onmessage 回调报错 */
54
- A_MSG_LISTENER_E = "A-MSG_LISTENER-E",
56
+ readonly A_MSG_LISTENER_E: "A-MSG_LISTENER-E";
55
57
  /**
56
58
  * @deprecated
57
59
  * 用于保留迁移前的日志,后续删除
58
60
  */
59
- O = "L-original-O",
61
+ readonly O: "L-original-O";
60
62
  /**
61
63
  * 测试日志,不入库,因此不需要关注 TAG,避免调试 TAG 膨胀
62
64
  */
63
- T = "L-TEST-O",
65
+ readonly T: "L-TEST-O";
64
66
  /** 插件安装 */
65
- L_INSTALL_PLUGIN_T = "L-INSTALL_PLUGIN-T",
67
+ readonly L_INSTALL_PLUGIN_T: "L-INSTALL_PLUGIN-T";
66
68
  /** 插件安装结果 */
67
- L_INSTALL_PLUGIN_R = "L-INSTALL_PLUGIN-R",
69
+ readonly L_INSTALL_PLUGIN_R: "L-INSTALL_PLUGIN-R";
68
70
  /** navi 配置错误 */
69
- L_NAVI_CONF_E = "L-NAVI_CONF_ERROR-E",
71
+ readonly L_NAVI_CONF_E: "L-NAVI_CONF_ERROR-E";
70
72
  /** CMP 地址 */
71
- L_NAVI_CMP_R = "L-NAVI_CPM-R",
72
- A_SEND_MSG_T = "A-send_msg-T",
73
- A_SEND_MSG_R = "A-send_msg-R",
74
- L_SEND_MSG_T = "L-send_msg-T",
75
- L_SEND_MSG_R = "L-send_msg-R",
76
- L_PULL_MSG_T = "L-pull_msg-T",
77
- L_PULL_MSG_R = "L-pull_msg-R",
78
- L_PULL_MSG_E = "L-pull_msg-E",
79
- L_PULL_MSG_O = "L-pull_msg-O",
80
- L_PULL_ULTRA_MSG_T = "L-pull_ultra_msg-T",
81
- L_PULL_ULTRA_MSG_R = "L-pull_ultra_msg-R",
82
- L_PULL_CHATROOM_KV_T = "L-pull_chatroom_kv-T",
83
- L_PULL_CHATROOM_KV_R = "L-pull_chatroom_kv-R",
84
- L_PULL_CHATROOM_MSG_T = "L-pull_chatroom_msg-T",
85
- L_PULL_CHATROOM_MSG_R = "L-pull_chatroom_msg-R",
73
+ readonly L_NAVI_CMP_R: "L-NAVI_CPM-R";
74
+ readonly A_SEND_MSG_T: "A-send_msg-T";
75
+ readonly A_SEND_MSG_R: "A-send_msg-R";
76
+ readonly L_SEND_MSG_T: "L-send_msg-T";
77
+ readonly L_SEND_MSG_R: "L-send_msg-R";
78
+ readonly L_PULL_MSG_T: "L-pull_msg-T";
79
+ readonly L_PULL_MSG_R: "L-pull_msg-R";
80
+ readonly L_PULL_MSG_E: "L-pull_msg-E";
81
+ readonly L_PULL_MSG_O: "L-pull_msg-O";
82
+ readonly L_PULL_ULTRA_MSG_T: "L-pull_ultra_msg-T";
83
+ readonly L_PULL_ULTRA_MSG_R: "L-pull_ultra_msg-R";
84
+ readonly L_PULL_UG_RELATIONS_T: "L-pull_ug_relations-T";
85
+ readonly L_PULL_UG_RELATIONS_R: "L-pull_ug_relations-R";
86
+ readonly L_PULL_CHATROOM_KV_T: "L-pull_chatroom_kv-T";
87
+ readonly L_PULL_CHATROOM_KV_R: "L-pull_chatroom_kv-R";
88
+ readonly L_PULL_CHATROOM_MSG_T: "L-pull_chatroom_msg-T";
89
+ readonly L_PULL_CHATROOM_MSG_R: "L-pull_chatroom_msg-R";
86
90
  /**
87
91
  * 接收到多端同步消息
88
92
  */
89
- L_RECV_MULTI_SYNC_MSG_O = "L-recv_multi_sync_msg-O",
93
+ readonly L_RECV_MULTI_SYNC_MSG_O: "L-recv_multi_sync_msg-O";
90
94
  /**
91
95
  * 接收到直发消息
92
96
  */
93
- L_RECV_S_MSG_O = "L-recv_s_msg-O",
94
- A_DELETE_MESSAGES_S = "A-delete_messages-S",
95
- P_DELETE_MSG_S = "P-delete_msg-S",
96
- L_PULL_CONVERSATION_S = "L-pull_conversation-S",
97
- A_RECALL_MESSAGE_T = "A-recall_msg-T",
98
- A_RECALL_MESSAGE_R = "A-recall_msg-R",
99
- A_RECALL_MESSAGE_E = "A-recall_msg-E",
100
- A_REGTYP_O = "A-regtyp-O",
101
- P_REGTYP_E = "P-regtype-E",
102
- L_GET_NAVI_T = "L-get_navi-T",
103
- L_GET_NAVI_R = "L-get_navi-R",
104
- L_REQUEST_T = "L-request-T",
105
- L_REQUEST_R = "L-request-R",
106
- L_PARSE_NAVI_E = "L-parse_navi-E",
107
- L_ENV_S = "L-Env-S",
108
- L_GET_INDEX_NAVI_S = "L-get_index_navi-S",
109
- A_JOIN_CHATROOM_T = "A-join_chatroom-T",
110
- A_JOIN_CHATROOM_R = "A-join_chatroom-R",
111
- L_JOIN_CHATROOM_T = "L-join_chatroom-T",
112
- L_JOIN_CHATROOM_R = "L-join_chatroom-R",
113
- A_QUIT_CHATROOM_T = "A-quit_chatroom-T",
114
- A_QUIT_CHATROOM_R = "A-quit_chatroom-R",
115
- L_REJOIN_CHATROOM_T = "L-rejoin_chatroom-T",
116
- L_REJOIN_CHATROOM_R = "L-rejoin_chatroom-R",
117
- L_REJOIN_CHATROOM_S = "L-rejoin_chatroom-S",
118
- L_MEDIA_S = "L-media-S",
119
- L_MEDIA_UPLOAD_T = "L-media_upload-T",
120
- L_MEDIA_UPLOAD_R = "L-media_upload-R",
121
- G_UPLOAD_LOG_S = "G-upload_log-S",
122
- G_REPORT_LOG_S = "G-report_log-S",
123
- G_UPLOAD_LOG_E = "G-upload_log-E",
124
- G_GET_REAL_TIMELOG_COMMAND_S = "G-get_real_timelog_command-S",
125
- L_CHECK_ALIVE_IM_T = "L-check_alive_im-T",
126
- L_CHECK_ALIVE_IM_R = "L-check_alive_im-R",
127
- L_CHECK_ALIVE_IM_S = "L-check_alive_im-S",
128
- A_GET_LOCAL_MESSAGE_T = "A-get_local_message-T",
129
- A_GET_LOCAL_MESSAGE_R = "A-get_local_message-R",
130
- A_GET_HISTORY_MSG_T = "A-get_history_msg-T",
131
- A_GET_HISTORY_MSG_R = "A-get_history_msg-R",
132
- L_GET_HISTORY_MSG_T = "L-get_history_msg-T",
133
- L_GET_HISTORY_MSG_R = "L-get_history_msg-R",
134
- A_GET_PRIVATE_MESSAGE_DELIVER_TIME_E = "A-get_privage_message_deliver_time-E",
135
- A_GET_GROUP_MESSAGE_DELIVER_LIST_E = "A-get_group_message_deliver_list-E",
136
- A_CALLBACK_O = "A-callback-O",
137
- A_CALLBACK_E = "A-callback-E",
138
- L_CALLBACK_E = "L-callback-E",
139
- A_SEND_MESSAGE_READ_RECEIPT_V4_T = "A-send_message_read_receipt_V4-T",
140
- A_SEND_MESSAGE_READ_RECEIPT_V4_R = "A-send_message_read_receipt_V4-R",
141
- A_GET_MESSAGE_READ_RECEIPT_V4_T = "A-get_message_read_receipt_V4-T",
142
- A_GET_MESSAGE_READ_RECEIPT_V4_R = "A-get_message_read_receipt_V4-R",
143
- A_BATCH_GET_MESSAGE_READ_RECEIPT_INFO_V4_T = "A-batch_get_message_read_receipt_info_V4-T",
144
- A_BATCH_GET_MESSAGE_READ_RECEIPT_INFO_V4_R = "A-batch_get_message_read_receipt_info_V4-R",
145
- A_SYNC_READ_STATUS_T = "A-sync_read_status-T",
146
- A_SYNC_READ_STATUS_R = "A-sync_read_status-R",
147
- A_GET_TOP_CONVERSATION_LIST_E = "A-get_top_conversation_list-E",
97
+ readonly L_RECV_S_MSG_O: "L-recv_s_msg-O";
98
+ readonly A_DELETE_MESSAGES_S: "A-delete_messages-S";
99
+ readonly P_DELETE_MSG_S: "P-delete_msg-S";
100
+ readonly A_RECALL_MESSAGE_T: "A-recall_msg-T";
101
+ readonly A_RECALL_MESSAGE_R: "A-recall_msg-R";
102
+ readonly A_RECALL_MESSAGE_E: "A-recall_msg-E";
103
+ readonly A_REGTYP_O: "A-regtyp-O";
104
+ readonly P_REGTYP_E: "P-regtype-E";
105
+ readonly L_GET_NAVI_T: "L-get_navi-T";
106
+ readonly L_GET_NAVI_R: "L-get_navi-R";
107
+ readonly L_REQUEST_T: "L-request-T";
108
+ readonly L_REQUEST_R: "L-request-R";
109
+ readonly L_PARSE_NAVI_E: "L-parse_navi-E";
110
+ readonly L_ENV_S: "L-Env-S";
111
+ readonly L_GET_INDEX_NAVI_S: "L-get_index_navi-S";
112
+ readonly A_JOIN_CHATROOM_T: "A-join_chatroom-T";
113
+ readonly A_JOIN_CHATROOM_R: "A-join_chatroom-R";
114
+ readonly L_JOIN_CHATROOM_T: "L-join_chatroom-T";
115
+ readonly L_JOIN_CHATROOM_R: "L-join_chatroom-R";
116
+ readonly A_QUIT_CHATROOM_T: "A-quit_chatroom-T";
117
+ readonly A_QUIT_CHATROOM_R: "A-quit_chatroom-R";
118
+ readonly L_REJOIN_CHATROOM_T: "L-rejoin_chatroom-T";
119
+ readonly L_REJOIN_CHATROOM_R: "L-rejoin_chatroom-R";
120
+ readonly L_REJOIN_CHATROOM_S: "L-rejoin_chatroom-S";
121
+ readonly L_MEDIA_S: "L-media-S";
122
+ readonly L_MEDIA_UPLOAD_T: "L-media_upload-T";
123
+ readonly L_MEDIA_UPLOAD_R: "L-media_upload-R";
124
+ readonly G_UPLOAD_LOG_S: "G-upload_log-S";
125
+ readonly G_REPORT_LOG_S: "G-report_log-S";
126
+ readonly G_UPLOAD_LOG_E: "G-upload_log-E";
127
+ readonly G_GET_REAL_TIMELOG_COMMAND_S: "G-get_real_timelog_command-S";
128
+ readonly L_CHECK_ALIVE_IM_T: "L-check_alive_im-T";
129
+ readonly L_CHECK_ALIVE_IM_R: "L-check_alive_im-R";
130
+ readonly L_CHECK_ALIVE_IM_S: "L-check_alive_im-S";
131
+ readonly A_GET_LOCAL_MESSAGE_T: "A-get_local_message-T";
132
+ readonly A_GET_LOCAL_MESSAGE_R: "A-get_local_message-R";
133
+ readonly A_GET_HISTORY_MSG_T: "A-get_history_msg-T";
134
+ readonly A_GET_HISTORY_MSG_R: "A-get_history_msg-R";
135
+ readonly L_GET_HISTORY_MSG_T: "L-get_history_msg-T";
136
+ readonly L_GET_HISTORY_MSG_R: "L-get_history_msg-R";
137
+ readonly A_GET_PRIVATE_MESSAGE_DELIVER_TIME_E: "A-get_privage_message_deliver_time-E";
138
+ readonly A_GET_GROUP_MESSAGE_DELIVER_LIST_E: "A-get_group_message_deliver_list-E";
139
+ readonly L_CALLBACK_E: "L-callback-E";
140
+ readonly A_SEND_MESSAGE_READ_RECEIPT_V4_T: "A-send_message_read_receipt_V4-T";
141
+ readonly A_SEND_MESSAGE_READ_RECEIPT_V4_R: "A-send_message_read_receipt_V4-R";
142
+ readonly A_GET_MESSAGE_READ_RECEIPT_V4_T: "A-get_message_read_receipt_V4-T";
143
+ readonly A_GET_MESSAGE_READ_RECEIPT_V4_R: "A-get_message_read_receipt_V4-R";
144
+ readonly A_BATCH_GET_MESSAGE_READ_RECEIPT_INFO_V4_T: "A-batch_get_message_read_receipt_info_V4-T";
145
+ readonly A_BATCH_GET_MESSAGE_READ_RECEIPT_INFO_V4_R: "A-batch_get_message_read_receipt_info_V4-R";
146
+ readonly A_SYNC_READ_STATUS_T: "A-sync_read_status-T";
147
+ readonly A_SYNC_READ_STATUS_R: "A-sync_read_status-R";
148
148
  /**
149
149
  * PB 数据编码错误
150
150
  */
151
- L_PB_ENCODE_E = "L-pb-encode-E",
152
- L_PB_DECODE_E = "L-pb-decode-E",
153
- L_NOTIFY_NAVI_CHANGE_E = "L-notify_navi_change-E",
154
- L_REPORT_FULL_LOG_O = "L-report_full_log-O",
155
- L_REPORT_FULL_LOG_T = "L-report_full_log-T",
156
- L_REPORT_FULL_LOG_R = "L-report_full_log-R",
151
+ readonly L_PB_ENCODE_E: "L-pb-encode-E";
152
+ readonly L_PB_DECODE_E: "L-pb-decode-E";
153
+ readonly L_NOTIFY_NAVI_CHANGE_E: "L-notify_navi_change-E";
154
+ readonly L_REPORT_FULL_LOG_O: "L-report_full_log-O";
155
+ readonly L_REPORT_FULL_LOG_T: "L-report_full_log-T";
156
+ readonly L_REPORT_FULL_LOG_R: "L-report_full_log-R";
157
157
  /** 解析 navi logPolicy 报错 */
158
- L_REPORT_LOG_POLICY_E = "L-parse_navi_logpolicy-E",
158
+ readonly L_REPORT_LOG_POLICY_E: "L-parse_navi_logpolicy-E";
159
159
  /** 运行时环境不支持 IndexDB */
160
- L_UNSUPPORT_INDEXDB_O = "L-unsupport_IndexDB-O",
161
- L_LOGDB_OPEN_FAILED_E = "L-logDB_open_failed-E",
162
- L_LOGDB_CLOSED_S = "L-logDB_closed-S",
163
- L_LOGDB_ERROR_E = "L-logDB_error-S",
164
- L_LOGDB_ABORT_S = "L-logDB_abort-S",
165
- /** 实时日志上报 */
166
- L_REALTIME_LOG_R = "L_REALTIME_LOG_R",
167
- L_REALTIME_LOG_O = "L_REALTIME_LOG_O",
160
+ readonly L_UNSUPPORT_INDEXDB_O: "L-unsupport_IndexDB-O";
161
+ readonly L_LOGDB_OPEN_FAILED_E: "L-logDB_open_failed-E";
162
+ readonly L_LOGDB_CLOSED_S: "L-logDB_closed-S";
163
+ readonly L_LOGDB_ERROR_E: "L-logDB_error-S";
164
+ readonly L_LOGDB_ABORT_S: "L-logDB_abort-S";
168
165
  /** 实时日志上报结果 */
169
- L_REALTIME_LOG_T = "L_REALTIME_LOG_T",
170
- /** 埋点日志上报 */
171
- L_STATISTIC_LOG_R = "L_STATISTIC_LOG_R",
172
- L_STATISTIC_LOG_O = "L_STATISTIC_LOG_O",
173
- /** 埋点日志上报结果 */
174
- L_STATISTIC_LOG_T = "L_STATISTIC_LOG_T",
175
- L_UNKNOWN_TOPIC_E = "L_UNKNOWN_TOPIC_E",
176
- L_RECV_RMTP_O = "L_RECV_RMTP_O",
177
- L_RECV_RMTP_E = "L_RECV_RMTP_E",
178
- L_RECV_S_NTF_O = "L-recv_s_ntf_O",
166
+ readonly L_REALTIME_LOG_T: "L_REALTIME_LOG_T";
167
+ /** 实时日志上报 */
168
+ readonly L_REALTIME_LOG_R: "L_REALTIME_LOG_R";
169
+ readonly L_REALTIME_LOG_O: "L_REALTIME_LOG_O";
170
+ readonly L_RECV_RMTP_O: "L_RECV_RMTP_O";
171
+ readonly L_RECV_RMTP_E: "L_RECV_RMTP_E";
172
+ readonly L_RECV_S_NTF_O: "L-recv_s_ntf_O";
173
+ readonly L_RECV_S_CMD_O: "L-recv_s_cmd_O";
179
174
  /** 版本号上报 */
180
- L_VER_REPORT_T = "L-VER_REPORT-T",
175
+ readonly L_VER_REPORT_T: "L-VER_REPORT-T";
181
176
  /** 版本号上报结果 */
182
- L_VER_REPORT_R = "L-VER_REPORT-R",
177
+ readonly L_VER_REPORT_R: "L-VER_REPORT-R";
183
178
  /** 跨进程阻塞调用 */
184
- L_CALL_MAIN_SYNC_O = "L_CALL_MAIN_SYNC_O",
179
+ readonly L_CALL_MAIN_SYNC_O: "L_CALL_MAIN_SYNC_O";
185
180
  /** 未知的通知 */
186
- L_UNSUPPORT_NTF_FROM_MAIN_E = "L_UNSUPPORT_NTF_FROM_MAIN_E",
187
- A_SET_MSG_CONTENT_O = "A_SET_MSG_CONTENT_O",
188
- A_REMOVE_PROXY_O = "A-remove_proxy-O",
189
- A_SET_PROXY_O = "A-set_proxy-O",
190
- A_TEST_PROXY_O = "A-test_proxy-O",
191
- L_WEBSOCKET_DISACCORD_E = "L-websocket_disaccord-e",
192
- /** electronExtension 相关 */
193
- A_SEARCH_MESSAGE_BY_USER_T = "A-search_messages_by_user-T",
194
- A_SEARCH_MESSAGE_BY_USER_R = "A-search_messages_by_user-R",
181
+ readonly L_UNSUPPORT_NTF_FROM_MAIN_E: "L_UNSUPPORT_NTF_FROM_MAIN_E";
182
+ readonly A_SET_MSG_CONTENT_O: "A_SET_MSG_CONTENT_O";
183
+ readonly A_REMOVE_PROXY_O: "A-remove_proxy-O";
184
+ readonly A_SET_PROXY_O: "A-set_proxy-O";
185
+ readonly A_TEST_PROXY_O: "A-test_proxy-O";
186
+ /** WebSocket 连接与接收数据链路不一致 */
187
+ readonly L_WS_DISACCORD_E: "L-ws_disaccord-E";
195
188
  /** 获取静态配置 */
196
- L_GET_STATIC_CONF_T = "L-get_static_conf-T",
197
- L_GET_STATIC_CONF_R = "L-get_static_conf-R",
198
- L_GET_STATIC_CONF_E = "L-get_static_conf-E",
189
+ readonly L_GET_STATIC_CONF_T: "L-get_static_conf-T";
190
+ readonly L_GET_STATIC_CONF_R: "L-get_static_conf-R";
191
+ readonly L_GET_STATIC_CONF_E: "L-get_static_conf-E";
199
192
  /** 云控日志 */
200
- L_CLOUD_DISABLED = "L-cloud_disabled",
201
- L_CLOUD_EXPIRE = "L-cloud_expire",
202
- L_CLOUD_OVERCLOCK = "L-cloud_overclock",
203
- L_CLOUD_APPKEY_REGION_E = "L-cloud_appkey_region_error",
204
- L_CLOUD_CONFIG_DATA_E = "L-cloud_config_data_error",
205
- L_CLOUD_SET_CACHE_O = "L-cloud_set_cache-O",
206
- L_CLOUD_GET_CACHE_O = "L-cloud_get_cache-O",
207
- L_CLOUD_MSG_NTF_O = "L-cloud_msg_ntf-O",
208
- L_CLOUD_SET_AREA_CODE_O = "L-cloud_set_area_code-O",
209
- L_CLOUD_SET_MRTR_O = "L-cloud_set_mrtr-O",
193
+ readonly L_CLOUD_DISABLED: "L-cloud_disabled";
194
+ readonly L_CLOUD_OVERCLOCK: "L-cloud_overclock";
195
+ readonly L_CLOUD_APPKEY_REGION_E: "L-cloud_appkey_region_error";
196
+ readonly L_CLOUD_CONFIG_DATA_E: "L-cloud_config_data_error";
197
+ readonly L_CLOUD_SET_CACHE_O: "L-cloud_set_cache-O";
198
+ readonly L_CLOUD_GET_CACHE_O: "L-cloud_get_cache-O";
199
+ readonly L_CLOUD_SET_AREA_CODE_O: "L-cloud_set_area_code-O";
200
+ readonly L_CLOUD_SET_MRTR_O: "L-cloud_set_mrtr-O";
210
201
  /** 用户状态订阅 */
211
- L_SYNC_SUBSCRIBED_USER_STATUS_FINISHED_S = "L-sync_subscribed_user_status_finished-S",
212
- L_PULL_SUBSCRIBED_USER_RELATION_T = "L-pull_subscribed_user_relation-T",
213
- L_PULL_SUBSCRIBED_USER_RELATION_R = "L-pull_subscribed_user_relation-R",
214
- L_PULL_SUBSCRIBED_USER_STATUS_T = "L-pull_subscribed_user_status-T",
215
- L_PULL_SUBSCRIBED_USER_STATUS_R = "L-pull_subscribed_user_status-R",
216
- L_OWN_USER_PROFILE_CHANGED_S = "L-own_user_profile_changed-S",
217
- L_QUERY_SUBSCRIBE_DATA_T = "L-query_subscribe_data-T",
218
- L_QUERY_SUBSCRIBE_DATA_R = "L-query_subscribe_data-R",
219
- L_PULL_USER_PROFILE_T = "L-pull_user_profile-T",
220
- L_PULL_USER_PROFILE_R = "L-pull_user_profile-R",
221
- L_PULL_OWN_PROFILE_T = "L-pull_own_profile-T",
222
- L_PULL_OWN_PROFILE_R = "L-pull_own_profile-R",
202
+ readonly L_SYNC_SUBSCRIBED_USER_STATUS_FINISHED_S: "L-sync_subscribed_user_status_finished-S";
203
+ readonly L_PULL_SUBSCRIBED_USER_RELATION_T: "L-pull_subscribed_user_relation-T";
204
+ readonly L_PULL_SUBSCRIBED_USER_RELATION_R: "L-pull_subscribed_user_relation-R";
205
+ readonly L_PULL_SUBSCRIBED_USER_STATUS_T: "L-pull_subscribed_user_status-T";
206
+ readonly L_PULL_SUBSCRIBED_USER_STATUS_R: "L-pull_subscribed_user_status-R";
207
+ readonly L_OWN_USER_PROFILE_CHANGED_S: "L-own_user_profile_changed-S";
208
+ readonly L_QUERY_SUBSCRIBE_DATA_T: "L-query_subscribe_data-T";
209
+ readonly L_QUERY_SUBSCRIBE_DATA_R: "L-query_subscribe_data-R";
210
+ readonly L_PULL_USER_PROFILE_T: "L-pull_user_profile-T";
211
+ readonly L_PULL_USER_PROFILE_R: "L-pull_user_profile-R";
212
+ readonly L_PULL_OWN_PROFILE_T: "L-pull_own_profile-T";
213
+ readonly L_PULL_OWN_PROFILE_R: "L-pull_own_profile-R";
223
214
  /** 用户托管 - 好友 */
224
- L_QUERY_FRIEND_LIST_T = "L-query_friend_list-T",
225
- L_QUERY_FRIEND_LIST_R = "L-query_friend_list-R",
215
+ readonly L_QUERY_FRIEND_LIST_T: "L-query_friend_list-T";
216
+ readonly L_QUERY_FRIEND_LIST_R: "L-query_friend_list-R";
226
217
  /** 用户托管 - 群组 */
227
- L_PULL_USER_PROFILE_REQ_T = "L-pull_user_profile_req-T",
228
- L_PULL_USER_PROFILE_REQ_R = "L-pull_user_profile_req-R",
229
- L_PULL_EVENT_CHANGE_NOTIFY_ULTRA_ONLINE_S = "L-pull_event_change_notify_ultra_online-S",
230
- L_PULL_EVENT_CHANGE_T = "L-pull_event_change-T",
231
- L_PULL_EVENT_CHANGE_R = "L-pull_event_change-R",
232
- L_PARSE_JSON_E = "L-parse_json-E",
233
- L_REQ_STREAM_MSG_CONTENT_T = "L-req_stream_msg_content-T",
234
- L_REQ_STREAM_MSG_CONTENT_R = "L-req_stream_msg_content-R",
235
- L_REQ_STREAM_MSG_CONTENT_O = "L-req_stream_msg_content-O",
236
- L_REQ_STREAM_MSG_CONTENT_E = "L-req_stream_msg_content-E"
237
- }
218
+ readonly L_PULL_USER_PROFILE_REQ_T: "L-pull_user_profile_req-T";
219
+ readonly L_PULL_USER_PROFILE_REQ_R: "L-pull_user_profile_req-R";
220
+ readonly L_SERVER_EVENT_NOTIFY_ONLINE_T: "L-server_event_notify_online-T";
221
+ readonly L_SERVER_EVENT_NOTIFY_ONLINE_R: "L-server_event_notify_online-R";
222
+ readonly L_PULL_EVENT_CHANGE_T: "L-pull_event_change-T";
223
+ readonly L_PULL_EVENT_CHANGE_R: "L-pull_event_change-R";
224
+ readonly L_PARSE_JSON_E: "L-parse_json-E";
225
+ readonly L_REQ_STREAM_MSG_CONTENT_T: "L-req_stream_msg_content-T";
226
+ readonly L_REQ_STREAM_MSG_CONTENT_R: "L-req_stream_msg_content-R";
227
+ readonly L_REQ_STREAM_MSG_CONTENT_O: "L-req_stream_msg_content-O";
228
+ readonly L_REQ_STREAM_MSG_CONTENT_E: "L-req_stream_msg_content-E";
229
+ readonly L_PULL_CONVERSATION_SETTINGS_T: "L-pull_conversation_settings-T";
230
+ readonly L_PULL_CONVERSATION_SETTINGS_R: "L-pull_conversation_settings-R";
231
+ readonly L_PULL_SG_RELATIONS_T: "L-pull_sg_relations-T";
232
+ readonly L_PULL_SG_RELATIONS_R: "L-pull_sg_relations-R";
233
+ readonly A_REMOVE_CONVERSATION_T: "A-remove_conversation-T";
234
+ readonly A_REMOVE_CONVERSATION_R: "A-remove_conversation-R";
235
+ readonly A_GET_CONVERSATION_LIST_BY_FILTER_T: "A-get_conversation_list_by_filter-T";
236
+ readonly A_GET_CONVERSATION_LIST_BY_FILTER_R: "A-get_conversation_list_by_filter-R";
237
+ readonly A_GET_CONVERSATION_T: "A-get_conversation-T";
238
+ readonly A_GET_CONVERSATION_R: "A-get_conversation-R";
239
+ readonly A_BATCH_SET_CONVERSATION_TO_TOP_T: "A-batch_set_conversation_to_top-T";
240
+ readonly A_BATCH_SET_CONVERSATION_TO_TOP_R: "A-batch_set_conversation_to_top-R";
241
+ readonly A_BATCH_SET_CONVERSATION_NOTIFICATION_LEVEL_T: "A-batch_set_conversation_notification_level-T";
242
+ readonly A_BATCH_SET_CONVERSATION_NOTIFICATION_LEVEL_R: "A-batch_set_conversation_notification_level-R";
243
+ readonly A_CLEAR_ALL_UNREAD_COUNT_O: "A-clear_all_unread_count-O";
244
+ readonly A_DELETE_REMOTE_MESSAGE_BY_TIMESTAMP_T: "A-delete_remote_message_by_timestamp-T";
245
+ readonly A_DELETE_REMOTE_MESSAGE_BY_TIMESTAMP_R: "A-delete_remote_message_by_timestamp-R";
246
+ readonly A_DELETE_REMOTE_MESSAGE_T: "A-delete_remote_message-T";
247
+ readonly A_DELETE_REMOTE_MESSAGE_R: "A-delete_remote_message-R";
248
+ readonly A_BATCH_CLEAR_REMOTE_MSG_T: "A-batch_clear_remote_msg-T";
249
+ readonly A_BATCH_CLEAR_REMOTE_MSG_R: "A-batch_clear_remote_msg-R";
250
+ /** 事件循环阻塞告警 */
251
+ readonly L_EVENT_LOOP_BLOCKING_S: "L-event_loop_blocking-S";
252
+ readonly A_E_SEARCH_CONVERSATION_BY_CONTENT_T: "A-e_search_conversation_by_content-T";
253
+ readonly A_E_SEARCH_CONVERSATION_BY_CONTENT_R: "A-e_search_conversation_by_content-R";
254
+ };
238
255
 
239
256
  /**
240
257
  * 好友类型
@@ -248,7 +265,7 @@ declare enum DirectionType {
248
265
  BOTH = 2
249
266
  }
250
267
  /**
251
- * 查询接口-好友类型
268
+ * 查询接口 - 好友类型
252
269
  * @category Enum
253
270
  * @since 5.12.0
254
271
  */
@@ -362,7 +379,7 @@ declare enum GroupJoinPermission {
362
379
  declare enum GroupOperationPermission {
363
380
  /** 群主(默认) */
364
381
  OWNER = 0,
365
- /** 群主+群管理员 */
382
+ /** 群主 + 群管理员 */
366
383
  OWNER_OR_MANAGER = 1,
367
384
  /** 所有人 */
368
385
  EVERYONE = 2
@@ -373,9 +390,9 @@ declare enum GroupOperationPermission {
373
390
  * @since 5.12.0
374
391
  */
375
392
  declare enum GroupMemberInfoEditPermission {
376
- /** 群主+群管理员+自已(默认) */
393
+ /** 群主 + 群管理员 + 自已 (默认) */
377
394
  OWNER_OR_MANAGER_OR_SELF = 0,
378
- /** 群主+自已 */
395
+ /** 群主 + 自已 */
379
396
  OWNER_OR_SELF = 1,
380
397
  /** 仅自已 */
381
398
  SELF = 2
@@ -499,7 +516,7 @@ declare enum GroupApplicationDirection {
499
516
  }
500
517
 
501
518
  /**
502
- * 聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
519
+ * 聊天室 kv 存储操作类型。对方操作,己方收到消息 (RC:chrmKVNotiMsg) 中会带入此值。根据此值判断是删除还是更新
503
520
  * @category Enum
504
521
  */
505
522
  declare enum ChatroomEntryType {
@@ -644,7 +661,7 @@ declare enum ErrorCode {
644
661
  SYS_CONVERSATION_NOT_SUPPORT_MESSAGE = 20109,
645
662
  /**
646
663
  * 20512
647
- * appkey的数据中心与请求云控的数据中心不匹配
664
+ * appkey 的数据中心与请求云控的数据中心不匹配
648
665
  * @since 5.8.5
649
666
  */
650
667
  CLOUD_DATA_CENTER_INVALID = 20512,
@@ -675,12 +692,12 @@ declare enum ErrorCode {
675
692
  NOT_IN_DISCUSSION = 21406,
676
693
  /**
677
694
  * 21501
678
- * 发送的消息中包含敏感词 (发送方发送失败,接收方不会收到消息)
695
+ * 发送的消息中包含敏感词(发送方发送失败,接收方不会收到消息)
679
696
  */
680
697
  SENSITIVE_SHIELD = 21501,
681
698
  /**
682
699
  * 21502
683
- * 消息中敏感词已经被替换 (接收方可以收到被替换之后的消息)
700
+ * 消息中敏感词已经被替换(接收方可以收到被替换之后的消息)
684
701
  */
685
702
  SENSITIVE_REPLACE = 21502,
686
703
  /**
@@ -720,8 +737,8 @@ declare enum ErrorCode {
720
737
  NOT_IN_CHATROOM = 23406,
721
738
  /**
722
739
  * 23407
723
- * 聊天室禁言白名单人数超限(最多5个)
724
- * 创建聊天室时,禁言白名单用户列表,支持批量设置,最多不超过 20 个
740
+ * 聊天室禁言白名单人数超限 (最多 5 个)
741
+ * 创建聊天室时,禁言白名单用户列表,支持批量设置,最多不超过 20 个
725
742
  */
726
743
  GET_USERINFO_ERROR = 23407,
727
744
  /**
@@ -786,23 +803,23 @@ declare enum ErrorCode {
786
803
  CHATROOM_KEY_NOT_EXIST = 23427,
787
804
  /**
788
805
  * 23428
789
- * 聊天室批量设置或删除KV部分不成功
806
+ * 聊天室批量设置或删除 KV 部分不成功
790
807
  */
791
808
  CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
792
809
  /**
793
810
  * 23429
794
- * 聊天室批量设置或删除KV数量超限(最多一次10条)
811
+ * 聊天室批量设置或删除 KV 数量超限(最多一次 10 条)
795
812
  */
796
813
  CHATROOM_KV_STORE_OUT_LIMIT = 23429,
797
814
  /**
798
815
  * 23431
799
- * 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
816
+ * 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
800
817
  * @since 5.3.0
801
818
  */
802
819
  CHATROOM_KV_SET_ERROR = 23431,
803
820
  /**
804
821
  * 24001
805
- * 没有注册DeviveId 也就是用户没有登陆
822
+ * 没有注册 DeviveId 也就是用户没有登陆
806
823
  * @deprecated
807
824
  */
808
825
  HAVNODEVICEID = 24001,
@@ -832,7 +849,7 @@ declare enum ErrorCode {
832
849
  RC_USER_PROFILE_KEY_NOT_ALLOW_SDK_SET = 24360,
833
850
  /**
834
851
  * 24361
835
- * 用户托管基本属性的key列表中没有此key
852
+ * 用户托管基本属性的 key 列表中没有此 key
836
853
  * @since 5.9.10
837
854
  */
838
855
  RC_USER_PROFILE_KEY_NOT_EXIST = 24361,
@@ -850,7 +867,7 @@ declare enum ErrorCode {
850
867
  RC_USER_PROFILE_EXT_KV_COUNT_EXCEED_LIMIT = 24363,
851
868
  /**
852
869
  * 24364
853
- * 用户托管基本属性或扩展属性的Value,字符超过最大上限
870
+ * 用户托管基本属性或扩展属性的 Value,字符超过最大上限
854
871
  * @since 5.9.10
855
872
  */
856
873
  RC_USER_PROFILE_VALUE_LENGTH_EXCEED_LIMIT = 24364,
@@ -985,7 +1002,7 @@ declare enum ErrorCode {
985
1002
  RC_ENTRUST_SERVER_PARAMETER_ERROR = 25403,
986
1003
  /**
987
1004
  * 25404
988
- * 非法操作,非群主修改群权限相关,msg中返回传的对应的key
1005
+ * 非法操作,非群主修改群权限相关,msg 中返回传的对应的 key
989
1006
  * @since 5.12.0
990
1007
  */
991
1008
  RC_GROUP_ILLEGAL_ERROR = 25404,
@@ -1069,7 +1086,7 @@ declare enum ErrorCode {
1069
1086
  RC_GROUP_OWNER_NOT_ALLOW_QUIT_OR_KICK = 25417,
1070
1087
  /**
1071
1088
  * 25418
1072
- * 用户ID不在群组中
1089
+ * 用户 ID 不在群组中
1073
1090
  * @since 5.12.0
1074
1091
  */
1075
1092
  RC_GROUP_USER_NOT_IN_GROUP = 25418,
@@ -1141,13 +1158,13 @@ declare enum ErrorCode {
1141
1158
  RC_GROUP_OLD_GROUP_NOT_ENTRUST = 25429,
1142
1159
  /**
1143
1160
  * 25430
1144
- * 群ID不合法,包含特殊字符
1161
+ * 群 ID 不合法,包含特殊字符
1145
1162
  * @since 5.12.0
1146
1163
  */
1147
1164
  RC_GROUP_ID_INVALID = 25430,
1148
1165
  /**
1149
1166
  * 25432
1150
- * pagetoken解析失败
1167
+ * pagetoken 解析失败
1151
1168
  * @since 5.12.0
1152
1169
  */
1153
1170
  RC_PAGE_TOKEN_PARSING_FAILED = 25432,
@@ -1258,7 +1275,7 @@ declare enum ErrorCode {
1258
1275
  CONVERSATION_TAG_OVERSIZE = 26004,
1259
1276
  /**
1260
1277
  * 26005
1261
- * 未开通v4已读回执
1278
+ * 未开通 v4 已读回执
1262
1279
  */
1263
1280
  RC_READ_RECEIPT_V4_INVALID = 26005,
1264
1281
  /**
@@ -1273,12 +1290,12 @@ declare enum ErrorCode {
1273
1290
  RC_SERVER_PARAMETER_MESSAGEUIDS_CONFUSED = 26007,
1274
1291
  /**
1275
1292
  * 26009
1276
- * 消息id不合法
1293
+ * 消息 id 不合法
1277
1294
  */
1278
1295
  RC_SERVER_PARAMETER_MESSAGEUID_INVALID = 26009,
1279
1296
  /**
1280
1297
  * 26010
1281
- * 参数有���
1298
+ * 参数有误
1282
1299
  */
1283
1300
  RC_SERVER_PARAMETER_INVALID = 26010,
1284
1301
  /**
@@ -1288,12 +1305,12 @@ declare enum ErrorCode {
1288
1305
  RC_SUBSCRIBE_ONLINE_SERVICE_UNAVAILABLE = 26020,
1289
1306
  /**
1290
1307
  * 26021
1291
- * 用户被订阅量达到上限, 详细查看开发文档。
1308
+ * 用户被订阅量达到上限,详细查看开发文档。
1292
1309
  */
1293
1310
  RC_BESUBSCRIBED_USERIDS_COUNT_EXCEED_LIMIT = 26021,
1294
1311
  /**
1295
1312
  * 26022
1296
- * 订阅用户数达到上限, 详细查看开发文档。
1313
+ * 订阅用户数达到上限,详细查看开发文档。
1297
1314
  */
1298
1315
  RC_SUBSCRIBED_USERIDS_EXCEED_LIMIT = 26022,
1299
1316
  /**
@@ -1380,7 +1397,7 @@ declare enum ErrorCode {
1380
1397
  /**
1381
1398
  * 30012
1382
1399
  * PING 失败
1383
- * @solution 本地网络问题导致ping失败,SDK 会进入重连逻辑
1400
+ * @solution 本地网络问题导致 ping 失败,SDK 会进入重连逻辑
1384
1401
  * @since 5.2.0
1385
1402
  */
1386
1403
  RC_PING_EXCEED_LIMIT = 30012,
@@ -1429,7 +1446,7 @@ declare enum ErrorCode {
1429
1446
  RC_TCP_DISCONNECTED_NO_RMTP = 30021,
1430
1447
  /**
1431
1448
  * 31000
1432
- * 连接ACK超时
1449
+ * 连接 ACK 超时
1433
1450
  * @solution 网络问题,SDK 会进行重连
1434
1451
  * @since 5.2.0
1435
1452
  */
@@ -1442,14 +1459,14 @@ declare enum ErrorCode {
1442
1459
  RC_CONN_PROTO_VERSION_ERROR = 31001,
1443
1460
  /**
1444
1461
  * 31002
1445
- * 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk版本}。 其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识, 移动/电信/联通}
1462
+ * 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk 版本}。其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识,移动/电信/联通}
1446
1463
  * @solution 一般是 appkey 错误导致,建议在融云的开发者后台中确认一下当前应用的 appkey 标识是否正确
1447
1464
  * @since 5.2.0
1448
1465
  */
1449
1466
  RC_CONN_IDENTIFIER_REJECTED = 31002,
1450
1467
  /**
1451
1468
  * 31003
1452
- * 连接服务未开通���需要排查后台小程序(或桌面端)服务是否已开通
1469
+ * 连接服务未开通,需要排查后台小程序(或桌面端)服务是否已开通
1453
1470
  * @solution 建议到开发者后台 - 服务管理开通对应业务服务
1454
1471
  * @since 5.2.0
1455
1472
  */
@@ -1517,7 +1534,7 @@ declare enum ErrorCode {
1517
1534
  RC_CONN_TOKEN_EXPIRED = 31020,
1518
1535
  /**
1519
1536
  * 31021
1520
- * Token 中携带 deviceId 时,检测 Token 中deviceId 与链接设备 deviceId 不一致
1537
+ * Token 中携带 deviceId 时,检测 Token 中 deviceId 与链接设备 deviceId 不一致
1521
1538
  * @since 5.7.0
1522
1539
  */
1523
1540
  RC_CONN_DEVICE_ERROR = 31021,
@@ -1547,13 +1564,13 @@ declare enum ErrorCode {
1547
1564
  RC_CONN_WRONG_CLUSTER = 31025,
1548
1565
  /**
1549
1566
  * 31026
1550
- * 开启AppServer联合鉴权功能后,到AppServer认证失败
1567
+ * 开启 AppServer 联合鉴权功能后,到 AppServer 认证失败
1551
1568
  * @since 5.2.0
1552
1569
  */
1553
1570
  RC_APP_AUTH_NOT_PASS = 31026,
1554
1571
  /**
1555
1572
  * 31027
1556
- * 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
1573
+ * 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
1557
1574
  * @since 5.2.0
1558
1575
  */
1559
1576
  RC_OTP_USED = 31027,
@@ -1606,13 +1623,13 @@ declare enum ErrorCode {
1606
1623
  CONNECTION_REFUSED = 32061,
1607
1624
  /**
1608
1625
  * 33000
1609
- * 将消息存储到本地数据时失败。 发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
1626
+ * 将消息存储到本地数据时失败。发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
1610
1627
  * @since 5.2.0
1611
1628
  */
1612
1629
  PROTOCOL_MESSAGE_SAVED_ERROR = 33000,
1613
1630
  /**
1614
1631
  * 33001
1615
- * 协议栈未初始化(可能原因:1,没有调用SDK初始化接口;2,SDK的so未正常加载)
1632
+ * 协议栈未初始化(可能原因:1,没有调用 SDK 初始化接口;2,SDK so 未正常加载)
1616
1633
  * @since 5.2.0
1617
1634
  */
1618
1635
  BIZ_ERROR_CLIENT_NOT_INIT = 33001,
@@ -1712,7 +1729,7 @@ declare enum ErrorCode {
1712
1729
  MESSAGE_EXPANDED_ERROR = 34009,
1713
1730
  /**
1714
1731
  * 34010
1715
- * 消息扩展大小超出限制, 默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
1732
+ * 消息扩展大小超出限制,默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
1716
1733
  * @since 5.2.0
1717
1734
  */
1718
1735
  EXPANSION_LIMIT_EXCEET = 34010,
@@ -1787,7 +1804,7 @@ declare enum ErrorCode {
1787
1804
  INVALID_PARAMETER_TIMESTAMP = 34202,
1788
1805
  /**
1789
1806
  * 34203
1790
- * 开发者接口调用时传入的 uid (服务器消息唯一 id)非法
1807
+ * 开发者接口调用时传入的 uid (服务器消息唯一 id) 非法
1791
1808
  */
1792
1809
  INVALID_PARAMETER_MESSAGE_UID = 34203,
1793
1810
  /**
@@ -1862,7 +1879,7 @@ declare enum ErrorCode {
1862
1879
  INVALID_PARAMETER_TIMESTRING = 34224,
1863
1880
  /**
1864
1881
  * 34225
1865
- * RCConversationIdentifier 参数非法。 可能原因:开发者调用接口传入的 RCConversationIdentifier 参数类型不对或者参数为空
1882
+ * RCConversationIdentifier 参数非法。可能原因:开发者调用接口传入的 RCConversationIdentifier 参数类型不对或者参数为空
1866
1883
  * @solution conversation is not valid
1867
1884
  * @since 5.9.9
1868
1885
  */
@@ -1950,7 +1967,7 @@ declare enum ErrorCode {
1950
1967
  INVALID_PARAMETER_KEY = 34260,
1951
1968
  /**
1952
1969
  * 34261
1953
- * 参数keys 非法
1970
+ * 参数 keys 非法
1954
1971
  */
1955
1972
  INVALID_PARAMETER_KEYS = 34261,
1956
1973
  /**
@@ -1976,14 +1993,14 @@ declare enum ErrorCode {
1976
1993
  /**
1977
1994
  * 34272
1978
1995
  * 参数 before 非法
1979
- * @solution beforeCount 无效,需要输入大于0 的正整数
1996
+ * @solution beforeCount 无效,需要输入大于 0 的正整数
1980
1997
  * @since 5.9.8
1981
1998
  */
1982
1999
  INVALID_PARAMETER_BEFORE = 34272,
1983
2000
  /**
1984
2001
  * 34273
1985
2002
  * 参数 after 非法
1986
- * @solution afterCount 输入无效,需要输入大于0 的正整数
2003
+ * @solution afterCount 输入无效,需要输入大于 0 的正整数
1987
2004
  * @since 5.9.8
1988
2005
  */
1989
2006
  INVALID_PARAMETER_AFTER = 34273,
@@ -2019,12 +2036,12 @@ declare enum ErrorCode {
2019
2036
  INVALID_PARAMETER_LIMIT = 34279,
2020
2037
  /**
2021
2038
  * 34280
2022
- * MessageDirection错误
2039
+ * MessageDirection 错误
2023
2040
  */
2024
2041
  INVALID_MESSAGE_DIRECTION = 34280,
2025
2042
  /**
2026
2043
  * 34281
2027
- * SentStatus错误
2044
+ * SentStatus 错误
2028
2045
  */
2029
2046
  INVALID_MESSAGE_SENT_STATUS = 34281,
2030
2047
  /**
@@ -2045,14 +2062,14 @@ declare enum ErrorCode {
2045
2062
  INVALID_PARAMETER_CONVERSATION_TYPE_LIST = 34284,
2046
2063
  /**
2047
2064
  * 34287
2048
- * 开发者调用接口传入的 ConversationIdentifier 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
2049
- * @solution 传入的 ConversationList 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
2065
+ * 开发者调用接口传入的 ConversationIdentifier 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
2066
+ * @solution 传入的 ConversationList 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
2050
2067
  * @since 5.9.9
2051
2068
  */
2052
2069
  INVALID_PARAMETER_CONVERSATION_LIST = 34287,
2053
2070
  /**
2054
2071
  * 34288
2055
- * 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
2072
+ * 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
2056
2073
  */
2057
2074
  INVALID_PARAMETER_CLEAR_MESSAGE_OPTION_LIST = 34288,
2058
2075
  /**
@@ -2069,12 +2086,12 @@ declare enum ErrorCode {
2069
2086
  INVALID_PARAMETER_END_MESSAGE_UID = 34290,
2070
2087
  /**
2071
2088
  * 34291
2072
- * 不支持V4已读回执功能
2089
+ * 不支持 V4 已读回执功能
2073
2090
  */
2074
2091
  READ_RECEIPT_V4_NOT_SUPPORT = 34291,
2075
2092
  /**
2076
2093
  * 34292
2077
- * 不支持更新v4已读回执信息
2094
+ * 不支持更新 v4 已读回执信息
2078
2095
  */
2079
2096
  READ_RECEIPT_V4_UPDATE_NOT_SUPPORT = 34292,
2080
2097
  /**
@@ -2116,7 +2133,7 @@ declare enum ErrorCode {
2116
2133
  INVALID_PARAMETER_SUBSCRIBE_TYPE = 34306,
2117
2134
  /**
2118
2135
  * 34307
2119
- * 订阅事件传入的订阅时长非法[60s ~ 30天]
2136
+ * 订阅事件传入的订阅时长非法 [60s ~ 30 天]
2120
2137
  */
2121
2138
  INVALID_PARAMETER_SUBSCRIBE_EXPIRY = 34307,
2122
2139
  /**
@@ -2127,7 +2144,7 @@ declare enum ErrorCode {
2127
2144
  /**
2128
2145
  * 34309
2129
2146
  * 订阅事件传入的分页大小非法
2130
- * @solution 订阅相关接口传入的分页大小非法[1~200]
2147
+ * @solution 订阅相关接口传入的分页大小非法 [1~200]
2131
2148
  */
2132
2149
  INVALID_PARAMETER_SUBSCRIBE_PAGESIZE = 34309,
2133
2150
  /**
@@ -2321,7 +2338,7 @@ declare enum ErrorCode {
2321
2338
  HOSTNAME_ERROR = 35009,
2322
2339
  /**
2323
2340
  * 35010
2324
- * 开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
2341
+ * 开启 `禁止把已在线客户端踢下线` 开关后,该错误码标识已有同类型端在线,禁止链接
2325
2342
  * @deprecated
2326
2343
  */
2327
2344
  HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
@@ -2378,7 +2395,7 @@ declare enum ErrorCode {
2378
2395
  INVALID_PARAMETER_DRAFT = 35028,
2379
2396
  /**
2380
2397
  * 35029
2381
- * 开发者调用时传入的 message 无效, message 应是对象或者 BaseMessage 的子类
2398
+ * 开发者调用时传入的 message 无效,message 应是对象或者 BaseMessage 的子类
2382
2399
  */
2383
2400
  INVALID_PARAMETER_MESSAGE = 35029,
2384
2401
  /**
@@ -2510,9 +2527,21 @@ declare enum ErrorCode {
2510
2527
  * @since 5.12.2
2511
2528
  */
2512
2529
  INVALID_DISABLE_UPDATE_LAST_MESSAGE = 35054,
2530
+ /**
2531
+ * 35055
2532
+ * 超级群类型会话仅允许置顶默认频道
2533
+ * @since 5.20.0
2534
+ */
2535
+ ONLY_DEFAULT_CHANNEL_SUPPORTS_PINNING = 35055,
2536
+ /**
2537
+ * 35056
2538
+ * 发送消息时配置 needReceipt 错误,相关参数仅限单群聊会话内非状态消息、非群定向消息可配置,且需要开启已读回执 v5 功能
2539
+ * @since 5.20.0
2540
+ */
2541
+ SEND_READ_RECEIPT_CONF_ERROR = 35056,
2513
2542
  /**
2514
2543
  * 36001
2515
- * 加入聊天室Id为空
2544
+ * 加入聊天室 Id 为空
2516
2545
  * @deprecated
2517
2546
  */
2518
2547
  CHATROOM_ID_ISNULL = 36001,
@@ -2596,7 +2625,7 @@ declare enum ErrorCode {
2596
2625
  STREAM_MESSAGE_SYNCED = 39007,
2597
2626
  /**
2598
2627
  * 41002
2599
- * 获取七牛token失败
2628
+ * 获取七牛 token 失败
2600
2629
  * @deprecated
2601
2630
  */
2602
2631
  QNTKN_GET_ERROR = 41002,
@@ -2661,7 +2690,7 @@ declare enum ConversationType {
2661
2690
  /**
2662
2691
  * 连接协议
2663
2692
  * 截止 5.7.4 版本,暂不支持 rpp 和 quic
2664
- * v2 版本文档: https://a5bq662kv5.feishu.cn/wiki/wikcnfo3lEo2CPbonDxuXFvU0Kb#K7nbeN
2693
+ * v2 版本文档:https://a5bq662kv5.feishu.cn/wiki/wikcnfo3lEo2CPbonDxuXFvU0Kb#K7nbeN
2665
2694
  */
2666
2695
  declare enum EConnectProtocol {
2667
2696
  RMTP = 1,
@@ -2813,11 +2842,11 @@ declare enum MessageType {
2813
2842
  */
2814
2843
  SYNC_READ_STATUS = "RC:SRSMsg",
2815
2844
  /**
2816
- * 接受群已读回执更新消息(导航开关grpRRVer = 1时使用)
2845
+ * 接受群已读回执更新消息 (导航开关 grpRRVer = 1 时使用)
2817
2846
  */
2818
2847
  GROUP_READ_RECEIPT_REQUEST = "RC:RRMsg",
2819
2848
  /**
2820
- * 已读回执消息(V4)(导航开关grpRRVer = 3 时使用),支持单群聊
2849
+ * 已读回执消息(V4)(导航开关 grpRRVer = 3 时使用),支持单群聊
2821
2850
  */
2822
2851
  READ_STATE = "RC:RSMsg",
2823
2852
  /**
@@ -2849,7 +2878,7 @@ declare enum MessageType {
2849
2878
  */
2850
2879
  TYPING_STATUS = "RC:TypSts",
2851
2880
  /**
2852
- * 拦截消息,(当发送的消息的敏感词时,服务会下发一个拦截消息,内容包含被拦截消息信息)
2881
+ * 拦截消息,(当发送的消息的敏感词时,服务会下发一个拦截消息,内容包含被拦截消息信息)
2853
2882
  */
2854
2883
  INTERCEPT = "RC:InterceptMsg",
2855
2884
  /**
@@ -3034,7 +3063,7 @@ declare enum SubscribeOperationType {
3034
3063
  * @since 5.10.1
3035
3064
  * */
3036
3065
  declare enum UserProfileVisibility {
3037
- /** 未设置: AppKey 权限设置为准,默认是此状态 */
3066
+ /** 未设置:以 AppKey 权限设置为准,默认是此状态 */
3038
3067
  NOT_SET = 0,
3039
3068
  /** 都不可见:任何人都不能搜索到我的用户信息,名称、头像除外。 */
3040
3069
  INVISIBLE = 1,
@@ -3132,7 +3161,6 @@ declare enum PushImportanceHonor {
3132
3161
 
3133
3162
  /**
3134
3163
  * 免打扰级别
3135
- * @desc 原:NotificationStatus 已废弃
3136
3164
  * @category Enum
3137
3165
  */
3138
3166
  declare enum NotificationLevel {
@@ -3141,7 +3169,7 @@ declare enum NotificationLevel {
3141
3169
  */
3142
3170
  ALL_MESSAGE = -1,
3143
3171
  /**
3144
- * 未设置(向上查询群或者APP级别设置)// 存量数据中 0 表示未设置
3172
+ * 未设置(向上查询群或者 APP 级别设置)// 存量数据中 0 表示未设置
3145
3173
  */
3146
3174
  NOT_SET = 0,
3147
3175
  /**
@@ -3183,13 +3211,13 @@ declare enum NotificationStatus {
3183
3211
  * @param status
3184
3212
  * @returns
3185
3213
  */
3186
- declare const transformNotificationStatus: (status: NotificationStatus) => NotificationLevel;
3214
+ declare const trans2NotificationLevel: (status: NotificationStatus) => NotificationLevel;
3187
3215
  /**
3188
3216
  * 转换 NotificationLevel 为 NotificationStatus
3189
3217
  * @param level
3190
3218
  * @returns
3191
3219
  */
3192
- declare const transformNotificationLevel: (level: NotificationLevel) => NotificationStatus;
3220
+ declare const trans2NotificationStatus: (level: NotificationLevel) => NotificationStatus;
3193
3221
 
3194
3222
  /**
3195
3223
  * 消息接受状态
@@ -3235,7 +3263,7 @@ declare enum InterruptionLevel {
3235
3263
  */
3236
3264
  declare enum PushNotificationQuietHoursLevel {
3237
3265
  /**
3238
- * 未设置(向上查询群或者APP级别设置),存量数据中 0 表示未设置
3266
+ * 未设置(向上查询群或者 APP 级别设置),存量数据中 0 表示未设置
3239
3267
  */
3240
3268
  PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_DEFAULT = 0,
3241
3269
  /**
@@ -3270,13 +3298,6 @@ declare enum HttpMethod {
3270
3298
  * 消息 content 内容尺寸限制:128 KB
3271
3299
  */
3272
3300
  declare const MAX_MESSAGE_CONTENT_BYTES: number;
3273
- declare const SEND_MESSAGE_TYPE_OPTION: {
3274
- [key: string]: {
3275
- isCounted: boolean;
3276
- isPersited: boolean;
3277
- searchProps?: string[];
3278
- };
3279
- };
3280
3301
  declare const MAX_UPLOAD_FILE_SIZE: number;
3281
3302
  declare const UPLOAD_FILE_CHUNK_SIZE: number;
3282
3303
 
@@ -3301,6 +3322,15 @@ declare const UUId: {
3301
3322
  genWithLen(strLen?: number): string;
3302
3323
  };
3303
3324
 
3325
+ declare class EventTransmitter {
3326
+ #private;
3327
+ /**
3328
+ * 停止事件传播
3329
+ */
3330
+ stopPropagation(): void;
3331
+ get isStopPropagation(): boolean;
3332
+ }
3333
+ declare type ICallback<T extends (...args: any[]) => any> = (...args: [EventTransmitter, ...Parameters<T>]) => void;
3304
3334
  declare type LSR<T> = {
3305
3335
  [P in keyof T]: T[P] extends (...args: any) => any ? T[P] : never;
3306
3336
  };
@@ -3323,7 +3353,7 @@ declare class EventDispatcher<T> {
3323
3353
  * @param priority 监听器调用优先级,默认为 0,值越大调用优先级越高,最大值 100
3324
3354
  * @returns 返回 symbol,移除监听时使用
3325
3355
  */
3326
- on<K extends keyof T>(event: K, listener: LSR<T>[K], target?: any, priority?: number): symbol;
3356
+ on<K extends keyof T>(event: K, listener: ICallback<LSR<T>[K]>, target?: any, priority?: number): symbol;
3327
3357
  /**
3328
3358
  * @hidden
3329
3359
  * 添加事件监听器,并在一次通知过后移除该监听器
@@ -3333,7 +3363,7 @@ declare class EventDispatcher<T> {
3333
3363
  * @param priority 监听器调用优先级,默认为 0,值越大调用优先级越高,最大值 100
3334
3364
  * @returns 返回 symbol,移除监听时使用
3335
3365
  */
3336
- once<K extends keyof T>(event: K, listener: LSR<T>[K], target?: any, priority?: number): symbol;
3366
+ once<K extends keyof T>(event: K, listener: ICallback<LSR<T>[K]>, target?: any, priority?: number): symbol;
3337
3367
  /**
3338
3368
  * @hidden
3339
3369
  * 移除事件监听
@@ -3366,25 +3396,15 @@ declare class EventDispatcher<T> {
3366
3396
  pipe<K extends T>(emitter: EventDispatcher<K>): void;
3367
3397
  }
3368
3398
 
3369
- declare class SuspendablePromise<T> {
3370
- private readonly _promise;
3371
- private _resolve;
3372
- private _onCancel;
3373
- constructor(handle: (resolve: (val: T) => void) => void, onCancel: (resolve: (val: T) => void) => void);
3374
- private _onResolve;
3375
- result(): Promise<T>;
3376
- abort(): void;
3377
- }
3378
-
3379
3399
  declare class RCResult<T = void> {
3380
3400
  readonly code: number;
3381
3401
  readonly msg: string;
3382
- readonly data?: T;
3402
+ readonly data?: T | undefined;
3383
3403
  readonly isOk: boolean;
3384
3404
  /**
3385
3405
  * @hidden
3386
3406
  */
3387
- constructor(code: number, msg: string, data?: T);
3407
+ constructor(code: number, msg: string, data?: T | undefined);
3388
3408
  /**
3389
3409
  * 结果为 ok 时,进行后续异步操作
3390
3410
  * @hidden
@@ -3413,13 +3433,23 @@ declare class RCResult<T = void> {
3413
3433
  */
3414
3434
  errmsg(): string;
3415
3435
  /**
3416
- * 抹除 data 数据,返回新的 RCResult 对象,不改变原数据
3436
+ * 抹除 data 数据,返回新的 RCResult 对象,不改变当前数据
3417
3437
  * @hidden
3418
3438
  */
3419
3439
  wipe(): RCResult<any>;
3420
3440
  }
3421
- declare const ok: <T>(data?: T, desc?: string) => RCResult<T>;
3422
- declare const fail: <T>(code: number, desc?: string, data?: T) => RCResult<T>;
3441
+ declare const ok: <T>(data?: T | undefined, desc?: string | undefined) => RCResult<T>;
3442
+ declare const fail: <T>(code: number, desc?: string | undefined, data?: T | undefined) => RCResult<T>;
3443
+
3444
+ declare class SuspendablePromise<T> {
3445
+ private readonly _promise;
3446
+ private _resolve;
3447
+ private _onCancel;
3448
+ constructor(handle: (resolve: (val: T) => void) => void, onCancel: (resolve: (val: T) => void) => void);
3449
+ private _onResolve;
3450
+ result(): Promise<T>;
3451
+ abort(): void;
3452
+ }
3423
3453
 
3424
3454
  declare class Validator {
3425
3455
  protected readonly _apiName: string;
@@ -3449,6 +3479,14 @@ declare class Validator {
3449
3479
  * @param required
3450
3480
  */
3451
3481
  validate(key: string, value: any, handler: (value: any) => boolean, required?: boolean): Validator;
3482
+ /**
3483
+ * 验证参数是否合规
3484
+ * @param key
3485
+ * @param value
3486
+ * @param handler 验证方法,返回一个 RCResult
3487
+ * @param required 是否必填
3488
+ */
3489
+ validate2(key: string, value: any, handler: (value: any) => RCResult, required?: boolean): Validator;
3452
3490
  /**
3453
3491
  * 验证参数是否合规,不合规时抛出 CMSYError
3454
3492
  * @param key - 参数名,当抛出异常时用于提供详细错误信息
@@ -3605,19 +3643,19 @@ interface IChatroomUserChangeInfo {
3605
3643
  */
3606
3644
  interface IChatroomNotifyMultiLoginSync {
3607
3645
  /**
3608
- * 聊天室ID
3646
+ * 聊天室 ID
3609
3647
  */
3610
3648
  chatroomId: string;
3611
3649
  /**
3612
- * 变更的状态,0:离开, 1:加入
3650
+ * 变更的状态,0:离开,1:加入
3613
3651
  */
3614
3652
  status: ChrmSyncStatus;
3615
3653
  /**
3616
- * 如果status是0的情况,区分离开类型,0:主动离开, 1:多端加入被踢
3654
+ * 如果 status 0 的情况,区分离开类型,0:主动离开,1:多端加入被踢
3617
3655
  */
3618
3656
  reason: ChatroomSyncStatusReason;
3619
3657
  /**
3620
- * 用户加入/退出/被踢的时间(毫秒时间戳)
3658
+ * 用户加入/退出/被踢的时间 (毫秒时间戳)
3621
3659
  */
3622
3660
  time: number;
3623
3661
  /**
@@ -3631,19 +3669,19 @@ interface IChatroomNotifyMultiLoginSync {
3631
3669
  */
3632
3670
  interface IChatroomNotifyBlock {
3633
3671
  /**
3634
- * 聊天室ID
3672
+ * 聊天室 ID
3635
3673
  */
3636
3674
  chatroomId: string;
3637
3675
  /**
3638
- * 封禁类型,0是解封,1是封禁
3676
+ * 封禁类型,0 是解封,1 是封禁
3639
3677
  */
3640
3678
  operateType: ChrmMemOperateType;
3641
3679
  /**
3642
- * 封禁时长(毫秒),封禁时有此字段,封禁时长最大值为43200分钟(1个月), 最小值1分钟
3680
+ * 封禁时长 (毫秒),封禁时有此字段,封禁时长最大值为 43200 分钟(1 个月), 最小值 1 分钟
3643
3681
  */
3644
3682
  durationTime: number;
3645
3683
  /**
3646
- * 操作时间(毫秒时间戳)
3684
+ * 操作时间 (毫秒时间戳)
3647
3685
  */
3648
3686
  operateTime: number;
3649
3687
  /**
@@ -3661,7 +3699,7 @@ interface IChatroomNotifyBlock {
3661
3699
  */
3662
3700
  interface IChatroomNotifyBan {
3663
3701
  /**
3664
- * 聊天室ID
3702
+ * 聊天室 ID
3665
3703
  */
3666
3704
  chatroomId: string;
3667
3705
  /**
@@ -3669,11 +3707,11 @@ interface IChatroomNotifyBan {
3669
3707
  */
3670
3708
  banType: ChrmMemBanType;
3671
3709
  /**
3672
- * 禁言时长(毫秒),禁言时有此字段,禁言时长最大值为43200分钟(1个月), 最小值1分钟
3710
+ * 禁言时长 (毫秒),禁言时有此字段,禁言时长最大值为 43200 分钟(1 个月), 最小值 1 分钟
3673
3711
  */
3674
3712
  durationTime: number;
3675
3713
  /**
3676
- * 操作时间(毫秒时间戳)
3714
+ * 操作时间 (毫秒时间戳)
3677
3715
  */
3678
3716
  operateTime: number;
3679
3717
  /**
@@ -3729,11 +3767,11 @@ interface IChatroomListenerData {
3729
3767
  */
3730
3768
  interface IChatroomEntry {
3731
3769
  /**
3732
- * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
3770
+ * 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
3733
3771
  */
3734
3772
  key: string;
3735
3773
  /**
3736
- * 属性对应的值, 最大长度 4096 字符
3774
+ * 属性对应的值,最大长度 4096 字符
3737
3775
  */
3738
3776
  value: string;
3739
3777
  /**
@@ -3781,7 +3819,7 @@ interface IChatroomInfo {
3781
3819
  */
3782
3820
  interface IRemoveChatroomEntry {
3783
3821
  /**
3784
- * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
3822
+ * 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
3785
3823
  */
3786
3824
  key: string;
3787
3825
  /**
@@ -3798,7 +3836,7 @@ interface IRemoveChatroomEntry {
3798
3836
  */
3799
3837
  interface IRemoveChatroomEntries {
3800
3838
  /**
3801
- * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
3839
+ * key 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
3802
3840
  */
3803
3841
  entries: {
3804
3842
  key: string;
@@ -3817,8 +3855,8 @@ interface IRemoveChatroomEntries {
3817
3855
  interface IChatroomEntries {
3818
3856
  /**
3819
3857
  * entries ,要设置的属性列表
3820
- * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
3821
- * value 属性对应的值, 最大长度 4096 字符
3858
+ * key 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
3859
+ * value 属性对应的值,最大长度 4096 字符
3822
3860
  */
3823
3861
  entries: {
3824
3862
  key: string;
@@ -3950,23 +3988,23 @@ interface IUploadAuth {
3950
3988
  */
3951
3989
  ossBucketName: string;
3952
3990
  /**
3953
- * s3 认证凭证,对应 post上传 x-amz-credential 字段
3991
+ * s3 认证凭证,对应 post 上传 x-amz-credential 字段
3954
3992
  */
3955
3993
  s3Credential: string;
3956
3994
  /**
3957
- * 加密算法,对应 post上传 x-amz-algorithm 字段
3995
+ * 加密算法,对应 post 上传 x-amz-algorithm 字段
3958
3996
  */
3959
3997
  s3Algorithm: string;
3960
3998
  /**
3961
- * s3 日期,对应 post上传 x-amz-date 字段
3999
+ * s3 日期,对应 post 上传 x-amz-date 字段
3962
4000
  */
3963
4001
  s3Date: string;
3964
4002
  /**
3965
- * s3 policy,对应 post上传 policy 字段
4003
+ * s3 policy,对应 post 上传 policy 字段
3966
4004
  */
3967
4005
  s3Policy: string;
3968
4006
  /**
3969
- * s3 签名信息,对应 post上传 x-amz-signature 字段
4007
+ * s3 签名信息,对应 post 上传 x-amz-signature 字段
3970
4008
  */
3971
4009
  s3Signature: string;
3972
4010
  /**
@@ -4174,7 +4212,7 @@ interface IRTCRoomBindOption {
4174
4212
  */
4175
4213
  chatRoomId: string;
4176
4214
  /**
4177
- * RTC房间 ID
4215
+ * RTC 房间 ID
4178
4216
  */
4179
4217
  rtcRoomId: string;
4180
4218
  }
@@ -4251,11 +4289,11 @@ interface IResRoomPKOptions {
4251
4289
  */
4252
4290
  content: string;
4253
4291
  /**
4254
- * 同意邀请时要设置的 key, 放在room级别的k和v,新加入房间的能拉取到
4292
+ * 同意邀请时要设置的 key, 放在 room 级别的 k v,新加入房间的能拉取到
4255
4293
  */
4256
4294
  key: string;
4257
4295
  /**
4258
- * 同意邀请时要设置的 value, 放在room级别的k和v,新加入房间的能拉取到
4296
+ * 同意邀请时要设置的 value, 放在 room 级别的 k v,新加入房间的能拉取到
4259
4297
  */
4260
4298
  value: string;
4261
4299
  /**
@@ -4292,7 +4330,7 @@ interface IEndRoomPKOptions {
4292
4330
  */
4293
4331
  interface IGooglePushConfig {
4294
4332
  /**
4295
- * 分组ID
4333
+ * 分组 ID
4296
4334
  */
4297
4335
  collapseKey?: string;
4298
4336
  /**
@@ -4317,7 +4355,7 @@ interface IiOSPushConfig {
4317
4355
  */
4318
4356
  apnsCollapseId?: string;
4319
4357
  /**
4320
- * iOS 分类,如果不设置后台默认取消息类型字符串,如RC:TxtMsg
4358
+ * iOS 分类,如果不设置后台默认取消息类型字符串,如 RC:TxtMsg
4321
4359
  */
4322
4360
  category?: string;
4323
4361
  /**
@@ -4357,7 +4395,7 @@ interface IAndroidPushConfig {
4357
4395
  channelIdHW?: string;
4358
4396
  /**
4359
4397
  * 华为推送消息分类
4360
- * 更多信息请参考华为消息分类标准文档: https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835
4398
+ * 更多信息请参考华为消息分类标准文档:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835
4361
4399
  * @since 5.7.3 版本开始支持
4362
4400
  */
4363
4401
  categoryHW?: string;
@@ -4383,9 +4421,9 @@ interface IAndroidPushConfig {
4383
4421
  typeVivo?: string;
4384
4422
  /**
4385
4423
  * Vivo 分类
4386
- * 即时消息[IM],账号与资产[ACCOUNT],日程待办[TODO],设备信息[DEVICE_REMINDER],订单与物流[ORDER],订阅提醒[SUBSCRIPTION]
4424
+ * 即时消息 [IM],账号与资产 [ACCOUNT],日程待办 [TODO],设备信息 [DEVICE_REMINDER],订单与物流 [ORDER],订阅提醒 [SUBSCRIPTION]
4387
4425
  * 运营消息分类
4388
- * 新闻[NEWS],内容推荐[CONTENT],运营活动[MARKETING],社交动态[SOCIAL]
4426
+ * 新闻 [NEWS],内容推荐 [CONTENT],运营活动 [MARKETING],社交动态 [SOCIAL]
4389
4427
  *
4390
4428
  * @since 5.7.5
4391
4429
  */
@@ -4413,13 +4451,13 @@ interface IAndroidPushConfig {
4413
4451
  */
4414
4452
  interface IHarmonyOSPushConfig {
4415
4453
  /**
4416
- * HarmonyOS通知栏消息右侧大图标 URL,必须 https 协议
4417
- * 通知栏右侧图片,格式支持 png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000像素
4454
+ * HarmonyOS 通知栏消息右侧大图标 URL,必须 https 协议
4455
+ * 通知栏右侧图片,格式支持 png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000 像素
4418
4456
  * 图片不满足要求的情况下,终端不能显示通知消息。
4419
4457
  */
4420
4458
  image?: string;
4421
4459
  /**
4422
- * HarmonyOS推送消息分类:
4460
+ * HarmonyOS 推送消息分类:
4423
4461
  * 社交通讯:消息自分类标识,默认为空。category 取值必须为大写字母
4424
4462
  * 默认值为 null,如果为 null,则以服务配置为准
4425
4463
  */
@@ -4462,7 +4500,7 @@ interface IPushConfig {
4462
4500
  */
4463
4501
  harmonyOSConfig?: IHarmonyOSPushConfig;
4464
4502
  /**
4465
- * 是否显示推送标题. 仅针对 iOS 平台有效
4503
+ * 是否显示推送标题。仅针对 iOS 平台有效
4466
4504
  */
4467
4505
  disablePushTitle?: boolean;
4468
4506
  /**
@@ -4470,10 +4508,23 @@ interface IPushConfig {
4470
4508
  */
4471
4509
  forceShowDetailContent?: boolean;
4472
4510
  /**
4473
- * 推送模板id
4511
+ * 推送模板 id
4474
4512
  */
4475
4513
  templateId?: string;
4476
4514
  }
4515
+ /**
4516
+ * 应用推送配置
4517
+ */
4518
+ interface IAppPushConfig {
4519
+ /**
4520
+ * 设备 Id
4521
+ */
4522
+ deviceId: string;
4523
+ /**
4524
+ * 包名
4525
+ */
4526
+ packageName: string;
4527
+ }
4477
4528
 
4478
4529
  /**
4479
4530
  * 标签相关接口
@@ -4496,7 +4547,7 @@ interface IConversationTag {
4496
4547
  */
4497
4548
  createdTime?: number;
4498
4549
  /**
4499
- * 是否置顶
4550
+ * 是否在标签内置顶
4500
4551
  */
4501
4552
  isTop?: boolean;
4502
4553
  }
@@ -4640,11 +4691,15 @@ interface IProcessInfo {
4640
4691
  };
4641
4692
  }
4642
4693
 
4643
- declare type IConnectionListener = {
4694
+ /**
4695
+ * 连接事件监听器
4696
+ * @typeParam T - onConnected 是否包含 fromSuspend 参数
4697
+ */
4698
+ declare type IConnectionListener<T extends boolean = false> = {
4644
4699
  /**
4645
4700
  * 连接成功
4646
4701
  */
4647
- onConnected(): void;
4702
+ onConnected: T extends true ? (fromSuspend: boolean) => void : () => void;
4648
4703
  /**
4649
4704
  * 连接中止,SDK 内部会进行重连
4650
4705
  * @param code 中止原因
@@ -4699,7 +4754,7 @@ interface IUpdateItem {
4699
4754
  */
4700
4755
  mentionedInfo?: {
4701
4756
  time: number;
4702
- val: MentionedInfoBody;
4757
+ val: MentionedInfo | undefined;
4703
4758
  };
4704
4759
  /**
4705
4760
  * 未读数变更
@@ -4713,7 +4768,7 @@ interface IUpdateItem {
4713
4768
  */
4714
4769
  tags?: {
4715
4770
  time: number;
4716
- val: IConversationTag;
4771
+ val: IConversationTag[];
4717
4772
  };
4718
4773
  /**
4719
4774
  * 会话最后一条消息变更
@@ -4728,10 +4783,6 @@ interface IUpdateItem {
4728
4783
  * @category Interface
4729
4784
  */
4730
4785
  interface IReceivedConversation {
4731
- /**
4732
- * 会话的业务标识
4733
- */
4734
- channelId?: string;
4735
4786
  /**
4736
4787
  * 会话类型
4737
4788
  */
@@ -4739,33 +4790,50 @@ interface IReceivedConversation {
4739
4790
  /**
4740
4791
  * 会话 Id
4741
4792
  * @description
4742
- * 1. 当 `conversationType` 为 `ConversationType.GROUP` 时,该值为群组 Id
4743
- * 1. 当 `conversationType` 为 `ConversationType.PRIVATE` 时,该值为对方用户 Id
4793
+ * * 当 `conversationType` 为 `ConversationType.GROUP` 或 `ConversationType.ULTRA_GROUP` 时,该值为群组 Id
4794
+ * * 当 `conversationType` 为 `ConversationType.PRIVATE` 时,该值为对方用户 Id
4744
4795
  */
4745
4796
  targetId: string;
4746
4797
  /**
4747
- * 当前会话的未读消息数
4798
+ * 会话的业务标识
4799
+ * @description
4800
+ * * 当会话类型为超级群时,该值为频道 ID
4801
+ * * 当会话类型为单、群聊时,该值为组织 ID,用于区分多组织场景
4802
+ * * 其他会话类型该值为空
4748
4803
  */
4749
- unreadMessageCount: number;
4804
+ channelId?: string;
4750
4805
  /**
4751
4806
  * 会话中的最后一条消息
4752
4807
  */
4753
4808
  latestMessage: IReceivedMessage | null;
4754
4809
  /**
4755
- * 是否包含 @ 自己的消息,此数据仅在 `conversationType` 为 `ConversationType.GROUP` 时有效
4810
+ * 当前会话的未读消息数
4811
+ */
4812
+ unreadMessageCount?: number;
4813
+ /**
4814
+ * 未读消息中是否包含 @ 自己、@ 所有人的消息
4756
4815
  */
4757
4816
  hasMentioned?: boolean;
4758
4817
  /**
4759
- * 消息中的 @ 数据,仅在 `conversationType` 为 `ConversationType.GROUP` 时有效
4818
+ * 消息中的 @ 数据
4819
+ * @description
4820
+ * * 仅支持 Web 端;该数据基于本地接收到的消息计算得出,服务器不记录
4821
+ * * 仅支持群聊会话,自 5.20.0 版本开始,支持超级群会话类型
4822
+ */
4823
+ mentionedInfo?: MentionedInfo;
4824
+ /**
4825
+ * @deprecated 废弃,该字段为内部记录,用于接收消息时避免本地计数重复
4826
+ * * 本地收消息时,避免重新收消息导致技术重复
4827
+ * * 本地撤回消息时,计算是否需要本地计数 -1
4760
4828
  */
4761
- mentionedInfo?: MentionedInfoBody | null;
4829
+ lastUnreadTime: number;
4762
4830
  /**
4763
4831
  * 会话免打扰状态
4764
4832
  * @description
4765
4833
  * 1. 已开启免打扰
4766
4834
  * 2. 未开启免打扰
4767
4835
  */
4768
- notificationStatus: NotificationStatus;
4836
+ notificationStatus?: NotificationStatus;
4769
4837
  /**
4770
4838
  * 会话免打扰状态
4771
4839
  */
@@ -4773,34 +4841,58 @@ interface IReceivedConversation {
4773
4841
  /**
4774
4842
  * 会话是否已置顶
4775
4843
  */
4776
- isTop: boolean;
4844
+ isTop?: boolean;
4777
4845
  /**
4778
- * 会话中消息的最后未读时间
4846
+ * 会话项变更时间戳
4847
+ * @deprecated 字段已废弃即将删除,请勿使用
4779
4848
  */
4780
- lastUnreadTime: number;
4849
+ versionTime?: number;
4781
4850
  /**
4782
- * 搜索到的会话数量
4851
+ * 按消息搜索会话时,匹配到的消息数量(仅 Electron 平台相关搜索接口返回值有效)
4783
4852
  */
4784
4853
  matchCount?: number;
4785
4854
  /**
4786
- * 会话项变更时间戳
4855
+ * 会话的 @ 消息未读数
4856
+ * @since 5.7.9
4857
+ * @description
4858
+ * * 该属性仅 Web 端有效;Electron 平台可通过 `getUnreadMentionedMessages` 接口获取未读 @ 消息列表计算
4859
+ * * 该属性仅超级群会话有效,数据基于服务器记录,并依据接收到的消息进行本地维护
4860
+ * * 自 5.20.0 版本开始,新增支持单群聊会话,数据基于本地接收到的消息计算得出,服务器不记录
4787
4861
  */
4788
- versionTime?: number;
4789
4862
  unreadMentionedCount?: number;
4790
4863
  /**
4791
4864
  * @ 我的未读消息数
4792
- * 仅超级群支持
4793
4865
  * @since 5.7.9
4866
+ * @description
4867
+ * * 该属性仅 Web 端有效;Electron 平台可通过 `getUnreadMentionedMessages` 接口获取未读 @ 消息列表计算
4868
+ * * 该属性仅超级群会话有效,数据基于服务器记录,并依据接收到的消息进行本地维护
4869
+ * * 自 5.20.0 版本开始,新增支持单群聊会话,数据基于本地接收到的消息计算得出,服务器不记录
4794
4870
  */
4795
4871
  unreadMentionedMeCount?: number;
4796
4872
  /**
4797
- * 会话操作时间,暂不支持超级群会话
4873
+ * 会话操作时间
4874
+ * - 5.8.4 版本开始,Electron 平台支持此参数,收发消息、设置置顶等操作将更新会话操作时间以用于会话排序。
4875
+ * - 5.14.0 版本开始 Web 端支持此参数,仅收发消息时会更新。
4876
+ * - 5.20.0 版本开始,Web 端增加内存状态维护,不再只有从服务器获取列表时返回。
4877
+ * @since 5.8.4
4798
4878
  */
4799
4879
  operationTime?: number;
4800
4880
  /**
4801
4881
  * 会话草稿
4802
4882
  */
4803
4883
  draft?: string;
4884
+ /**
4885
+ * 超级群频道类型
4886
+ * @description 仅超级群会话支持
4887
+ */
4888
+ channelType?: UltraGroupChannelType;
4889
+ /**
4890
+ * 第一条未读消息
4891
+ * @description
4892
+ * * 该属性仅超级群会话支持,数据基于服务器记录,并依据接收到的消息进行本地维护
4893
+ * * 自 5.20.0 版本开始,新增支持单群聊会话,数据基于本地接收到的消息计算得出,并在本地缓存和维护,服务器不记录
4894
+ */
4895
+ firstUnreadMessage?: IUltraUnreadMsg | null;
4804
4896
  }
4805
4897
  /**
4806
4898
  * @category Interface
@@ -4811,143 +4903,29 @@ interface IReceivedConversationByTag extends IReceivedConversation {
4811
4903
  /**
4812
4904
  * 超级群会话数据结构
4813
4905
  * @category Interface
4906
+ * @deprecated
4814
4907
  */
4815
- interface IUltraGroupConversation extends IReceivedConversation {
4816
- /**
4817
- * 超级群频道类型,只有 ConversationType 为超级群时该字段有效
4818
- */
4819
- channelType?: UltraGroupChannelType;
4820
- /**
4821
- * 第一条未读消息
4822
- */
4823
- firstUnreadMessage?: IUltraUnreadMsg | null;
4824
- }
4825
- /**
4826
- * 设置会话状态 参数 信息
4827
- */
4828
- interface ISetConversationStatusOptions {
4829
- conversationType: ConversationType;
4830
- targetId: string;
4831
- isTop?: boolean;
4832
- notificationLevel?: number;
4833
- channelId?: string;
4834
- isUpdateTime?: boolean;
4835
- }
4908
+ declare type IUltraGroupConversation = IReceivedConversation;
4836
4909
  /**
4837
4910
  * 会话更新信息
4838
4911
  * @category Interface
4839
4912
  */
4840
- interface IUpdatedConversation {
4913
+ interface IUpdatedConversation extends IReceivedConversation {
4841
4914
  /**
4842
4915
  * 更新项
4843
4916
  */
4844
- updatedItems: {
4845
- [key: string]: {
4846
- time: number;
4847
- val: any;
4848
- };
4849
- };
4850
- /**
4851
- * 会话类型
4852
- */
4853
- conversationType: number;
4854
- /**
4855
- * 目标 ID
4856
- */
4857
- targetId: string;
4858
- /**
4859
- * 会话最后一条消息
4860
- */
4861
- latestMessage?: IReceivedMessage;
4862
- /**
4863
- * 会话未读数
4864
- */
4865
- unreadMessageCount?: number;
4866
- /**
4867
- * 是否有 @ 消息
4868
- */
4869
- hasMentioned?: boolean;
4870
- /**
4871
- * @ 信息详情
4872
- */
4873
- mentionedInfo?: {
4874
- /**
4875
- * `@ 类型,其中 1 为 @ 所有人,2 为 @ 部分人`
4876
- */
4877
- type: 1 | 2;
4878
- /**
4879
- * 被 @ 的用户 Id 列表,仅在 `type` 为 `2` 时有效
4880
- */
4881
- userIdList: string[];
4882
- };
4883
- /**
4884
- * 未读消息时间
4885
- */
4886
- lastUnreadTime?: number;
4887
- /**
4888
- * 免打扰状态
4889
- */
4890
- notificationStatus?: number;
4891
- /**
4892
- * 免打扰状态
4893
- */
4894
- notificationLevel?: number;
4895
- /**
4896
- * 是否置顶
4897
- */
4898
- isTop?: boolean;
4899
- /**
4900
- * 频道 ID
4901
- */
4902
- channelId?: string;
4903
- /**
4904
- * 会话标签
4905
- */
4906
- tags?: IUpdatedConversation[];
4907
- versionTime?: number;
4908
- /**
4909
- * @ 消息未读数
4910
- */
4911
- unreadMentionedCount?: number;
4912
- /**
4913
- * @ 我的未读消息数
4914
- * 仅超级群支持
4915
- * @since 5.7.9
4916
- */
4917
- unreadMentionedMeCount?: number;
4917
+ updatedItems?: IUpdateItem;
4918
4918
  }
4919
4919
  /**
4920
4920
  * 会话基础信息
4921
4921
  * @category Interface
4922
4922
  */
4923
- interface IBaseConversationInfo {
4924
- /**
4925
- * 会话类型
4926
- */
4927
- conversationType: ConversationType;
4928
- /**
4929
- * 目标 ID
4930
- */
4931
- targetId: string;
4923
+ interface IBaseConversationInfo extends IConversationIdentifier {
4932
4924
  /**
4933
4925
  * 频道 ID
4934
4926
  */
4935
4927
  channelId: string;
4936
4928
  }
4937
- /**
4938
- * 会话标签变更通知内容
4939
- * @category Interface
4940
- */
4941
- interface IConversationState extends IBaseConversationInfo {
4942
- /**
4943
- * 消息未读数
4944
- */
4945
- unreadCount: number;
4946
- /**
4947
- * @ 消息未读数
4948
- */
4949
- unreadMentionedCount: number;
4950
- }
4951
4929
  /**
4952
4930
  * 指定超级群会话传参
4953
4931
  * @category Interface
@@ -5049,8 +5027,13 @@ interface IUltraChannelDeleteInfo {
5049
5027
  interface IUltraGroupUnreadInfo {
5050
5028
  /**
5051
5029
  * 会话类型
5030
+ * @deprecated 请使用 `conversationType` 替代
5052
5031
  */
5053
5032
  type: ConversationType;
5033
+ /**
5034
+ * 会话类型
5035
+ */
5036
+ conversationType: ConversationType;
5054
5037
  /**
5055
5038
  * 目标 ID
5056
5039
  */
@@ -5097,19 +5080,13 @@ interface IConversationIdentifier {
5097
5080
  interface IConversationOption extends IConversationIdentifier {
5098
5081
  /**
5099
5082
  * 频道 Id 字符串类型,不能包含 _ , 长度不能超过 20
5083
+ * @description
5084
+ * * 当会话类型为超级群时,该值为频道 ID
5085
+ * * 当会话类型为单、群聊时,该值为组织 ID,用于区分多组织场景
5086
+ * * 其他会话类型该值为空
5100
5087
  */
5101
5088
  channelId?: string;
5102
5089
  }
5103
- interface IServerConversationStatus {
5104
- conversationType: number;
5105
- targetId: string;
5106
- updatedTime?: number;
5107
- notificationStatus?: number;
5108
- notificationLevel?: number;
5109
- isTop?: boolean;
5110
- tags?: IConversationTag[];
5111
- channelId?: string;
5112
- }
5113
5090
  interface IConversationUnreadCount extends IConversationOption {
5114
5091
  unreadCount: number;
5115
5092
  }
@@ -5124,7 +5101,7 @@ interface IReadReceiptResponseInfo {
5124
5101
  */
5125
5102
  isReceiptRequestMessage?: boolean;
5126
5103
  /**
5127
- * 是否已发送响应, Electron 平台有效
5104
+ * 是否已发送响应,仅 Electron 平台有效
5128
5105
  */
5129
5106
  hasRespond?: boolean;
5130
5107
  /**
@@ -5147,7 +5124,7 @@ interface IMessageReader {
5147
5124
  userId: string;
5148
5125
  }
5149
5126
  /**
5150
- * 已读回执响应数据结构V4
5127
+ * 已读回执响应数据结构 V4
5151
5128
  * @category Interface
5152
5129
  * @hidden
5153
5130
  */
@@ -5168,7 +5145,7 @@ interface IMessageReaderResponse {
5168
5145
  */
5169
5146
  interface IReadReceiptInfo {
5170
5147
  /**
5171
- * 是否已经发送已读回执, V2 支持
5148
+ * 是否已经发送已读回执,仅 V2 支持
5172
5149
  * @hidden
5173
5150
  * @deprecated
5174
5151
  */
@@ -5299,7 +5276,6 @@ interface IReceivedMessage {
5299
5276
  content: any;
5300
5277
  /**
5301
5278
  * 消息结构名称,即消息类型
5302
- * @example RC:TxtMsg
5303
5279
  */
5304
5280
  messageType: string;
5305
5281
  /**
@@ -5307,11 +5283,13 @@ interface IReceivedMessage {
5307
5283
  */
5308
5284
  messageUId: string;
5309
5285
  /**
5310
- * 消息方向是发出 or 收取
5286
+ * 消息方向
5287
+ * * 1: 发送
5288
+ * * 2: 接收
5311
5289
  */
5312
5290
  messageDirection: MessageDirection;
5313
5291
  /**
5314
- * 是否为离线消息, 在超级群中不适用
5292
+ * 是否为离线消息,不适用于超级群消息
5315
5293
  */
5316
5294
  isOffLineMessage: boolean;
5317
5295
  /**
@@ -5361,23 +5339,24 @@ interface IReceivedMessage {
5361
5339
  * 只能表示单一状态,推荐使用 receivedStatusInfo 来判断接收消息状态
5362
5340
  * @deprecated
5363
5341
  */
5364
- receivedStatus: number;
5342
+ receivedStatus: ReceivedStatus;
5365
5343
  /**
5366
5344
  * 消息接收状态详情
5367
- * 推荐使用, receivedStatusInfo 值更详细,能同时表示多个接收状态
5345
+ * 推荐使用,receivedStatusInfo 值更详细,能同时表示多个接收状态
5368
5346
  */
5369
5347
  receivedStatusInfo?: IReceivedStatusInfo;
5370
5348
  /**
5371
- * 消息本地 ID, web 端由 lib 内生成, PC 端由协议栈数据库生成自增ID
5349
+ * 消息本地 ID, web 端由 lib 内生成,PC 端由协议栈数据库生成自增 ID
5372
5350
  */
5373
5351
  messageId?: number;
5374
5352
  /**
5375
- * 消息发送状态, web 端由 lib 内根据消息状态设置值为 发送中、已发送和发送失败 ,PC 端由协议栈自动维护或用户自己设置
5353
+ * 消息发送状态,web 端由 lib 内根据消息状态设置值为 发送中、已发送和发送失败,PC 端由协议栈自动维护或用户自己设置
5376
5354
  */
5377
5355
  sentStatus?: SentStatus;
5378
5356
  /**
5379
- * 群已读回执信息(导航配置 grpRRVer = 0 时为 IReadReceiptResponseInfo,
5380
- * grpRRVer >= 1时为 IReadReceiptInfo)
5357
+ * 群已读回执信息
5358
+ * * 导航配置 grpRRVer = 0 时为 IReadReceiptResponseInfo,
5359
+ * * 导航配置 grpRRVer >= 1 时为 IReadReceiptInfo
5381
5360
  */
5382
5361
  readReceiptInfo?: IReadReceiptInfo | IReadReceiptResponseInfo;
5383
5362
  /**
@@ -5401,13 +5380,23 @@ interface IReceivedMessage {
5401
5380
  */
5402
5381
  hasMore?: boolean;
5403
5382
  /**
5404
- * 定向用户列表(仅支持群聊, 超级群)
5383
+ * 定向用户列表 (仅支持群聊,超级群)
5405
5384
  */
5406
5385
  directedUserIds?: string[];
5407
5386
  /**
5408
5387
  * 禁止更新到会话最新一条消息,默认 false: 更新,true: 不更新
5409
5388
  */
5410
5389
  disableUpdateLastMessage?: boolean;
5390
+ /**
5391
+ * 是否需要回执,仅支持单群聊会话类型内有效
5392
+ * @since 5.20.0
5393
+ */
5394
+ needReceipt?: boolean;
5395
+ /**
5396
+ * 是否已发送回执,仅获取历史消息列表时有效;仅单群聊会话类型内有效
5397
+ * @since 5.20.0
5398
+ */
5399
+ sendReceipt?: boolean;
5411
5400
  }
5412
5401
  /**
5413
5402
  * 第一条未读消息信息
@@ -5525,7 +5514,7 @@ interface IOperateStatusNotify {
5525
5514
  }
5526
5515
  declare type IRecallMsgOptions = {
5527
5516
  /**
5528
- * 消息的唯一id,客户端依赖此属性查找要撤回的消息
5517
+ * 消息的唯一 id,客户端依赖此属性查找要撤回的消息
5529
5518
  */
5530
5519
  messageUId: string;
5531
5520
  /**
@@ -5687,6 +5676,11 @@ interface ISendMsgOptions {
5687
5676
  * 禁止更新到会话最新一条消息,默认 false: 更新,true: 不更新
5688
5677
  */
5689
5678
  disableUpdateLastMessage?: boolean;
5679
+ /**
5680
+ * 是否需要回执,仅支持单群聊会话类型内有效,需要开启已读 v5 功能开关
5681
+ * @since 5.20.0
5682
+ */
5683
+ needReceipt?: boolean;
5690
5684
  }
5691
5685
  interface IInsertMsgOptions {
5692
5686
  senderUserId: string;
@@ -5779,7 +5773,7 @@ interface IInsertMessage {
5779
5773
  */
5780
5774
  directedUserIds?: string[];
5781
5775
  /**
5782
- * 插入消息是否计入未读数: true 计数 false 不计数, 默认不计数
5776
+ * 插入消息是否计入未读数:true 计数 false 不计数,默认不计数
5783
5777
  */
5784
5778
  isUnread?: boolean;
5785
5779
  /**
@@ -5945,11 +5939,11 @@ interface IUltraGroupUnreadMentionedOption {
5945
5939
  */
5946
5940
  channelId?: string;
5947
5941
  /**
5948
- * 消息的时间戳,首次获取传 0 后续查询传未读 @ 列表中的消息时间戳
5942
+ * 消息的时间戳,首次获取传 0,后续查询传未读 @ 列表中的消息时间戳
5949
5943
  */
5950
5944
  sentTime: number;
5951
5945
  /**
5952
- * 数据个数,最大50
5946
+ * 数据个数,最大 50
5953
5947
  */
5954
5948
  count: number;
5955
5949
  }
@@ -5967,7 +5961,7 @@ interface IUltraUnreadMsg {
5967
5961
  */
5968
5962
  sentTime: number;
5969
5963
  /**
5970
- * @ 类型: 1 所有人;2: 部分人
5964
+ * @ 类型:1 所有人;2: 部分人
5971
5965
  */
5972
5966
  mentionedType?: number;
5973
5967
  /**
@@ -5979,7 +5973,7 @@ interface IUltraUnreadMsg {
5979
5973
  * 被 @ 的用户信息
5980
5974
  * @category Interface
5981
5975
  */
5982
- interface MentionedInfoBody {
5976
+ interface MentionedInfo {
5983
5977
  /**
5984
5978
  * @ 类型
5985
5979
  */
@@ -5989,7 +5983,7 @@ interface MentionedInfoBody {
5989
5983
  */
5990
5984
  userIdList?: string[];
5991
5985
  /**
5992
- * 携带扩展信息,例如 `有人@你`
5986
+ * 携带扩展信息,例如 `有人 @ 你`
5993
5987
  */
5994
5988
  mentionedContent?: string;
5995
5989
  }
@@ -6057,21 +6051,9 @@ interface ICombineV2MessageContent {
6057
6051
  /**
6058
6052
  * @category Interface
6059
6053
  */
6060
- interface IClearMessageOption {
6061
- /**
6062
- * 目标 ID
6063
- */
6064
- targetId: string;
6065
- /**
6066
- * 会话类型
6067
- */
6068
- conversationType: ConversationType;
6069
- /**
6070
- * 频道 ID
6071
- */
6072
- channelId?: string;
6054
+ interface IClearMessageOption extends IConversationOption {
6073
6055
  /**
6074
- * 时间
6056
+ * 时间戳
6075
6057
  */
6076
6058
  timestamp?: number;
6077
6059
  }
@@ -6127,6 +6109,7 @@ interface IGroupMessageDeliverStatus {
6127
6109
 
6128
6110
  /**
6129
6111
  * 异步任务结果结构
6112
+ * @description 该结构即将废弃,请使用 {@link RCResult} 替代
6130
6113
  * @category Interface
6131
6114
  */
6132
6115
  declare type IAsyncRes<T = void> = Pick<RCResult<T>, 'code' | 'data'> & {
@@ -6144,7 +6127,6 @@ declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
6144
6127
  * 拓展方法定义,便于 electron-solution 实现时保持接口类型推导可用
6145
6128
  */
6146
6129
  interface IExtraMethod {
6147
- getConversationsByPage(conversationTypes: ConversationType[], sentTime: number, count: number, channelId?: string, topPriority?: boolean): Promise<IAsyncRes<IReceivedConversation[]>>;
6148
6130
  getHistoryMessagesByObjectNames(conversationType: ConversationType, targetId: string, sentTime: number, count: number, objectNames: string[], desc: 0 | 1, tag: string): Promise<IAsyncRes<{
6149
6131
  list: IReceivedMessage[];
6150
6132
  hasMore: boolean;
@@ -6279,22 +6261,18 @@ interface INaviInfo {
6279
6261
  /**
6280
6262
  * 是否开启用户级配置,若开启,需连接成功后立即拉取实时配置,0 | 1
6281
6263
  * @description
6282
- * 配置来源:
6264
+ * 配置来源:
6283
6265
  * 1. 导航
6284
6266
  * 2. 服务端实时下发
6285
- * 已有配置字段:
6286
- * 1. Lan. 推送使用的语言设置,用户端可自定义修改. Web 端未做设置, 只做接收
6287
- * 2. ShPushSwit. 推送是否显示详情设置,用户端可自定义修改. Web 端未做设置, 只做接收
6288
- * 3. MobPushSwit: Web/PC 在线,移动端不在线是否发送推送开关,用户端可自定义修改. Web 端未做设置, 只做接收
6289
- * 4. OffMsgDur: 离线消息保存天数,设置天数不可大于App级对应配置,用户端可自定义修改. Web 端未做设置, 只做接收
6290
- * 5. VoipInfo: 音视频相关配置,用户端不可自定义修改. 由服务端决定,与导航下发格式一致
6267
+ * 已有配置字段:
6268
+ * 1. Lan. 推送使用的语言设置,用户端可自定义修改。Web 端未做设置,只做接收
6269
+ * 2. ShPushSwit. 推送是否显示详情设置,用户端可自定义修改。Web 端未做设置,只做接收
6270
+ * 3. MobPushSwit: Web/PC 在线,移动端不在线是否发送推送开关,用户端可自定义修改。Web 端未做设置,只做接收
6271
+ * 4. OffMsgDur: 离线消息保存天数,设置天数不可大于 App 级对应配置,用户端可自定义修改。Web 端未做设置,只做接收
6272
+ * 5. VoipInfo: 音视频相关配置,用户端不可自定义修改。由服务端决定,与导航下发格式一致
6291
6273
  * @todo 需确认公有云与私有云区别
6292
6274
  */
6293
6275
  openUS: 0 | 1;
6294
- /**
6295
- * 超级群功能开关,1表示开
6296
- */
6297
- ugMsg?: 0 | 1;
6298
6276
  /**
6299
6277
  * 群离线消息最大下发条数,`0` 为关闭
6300
6278
  * @description 公有云独有配合
@@ -6401,21 +6379,22 @@ interface INaviInfo {
6401
6379
  */
6402
6380
  crypto?: string;
6403
6381
  /**
6404
- * 群组回执开关,
6405
- * 0(或者没有): 关闭 v1 版本
6406
- * 1: 打开, v2 版本
6407
- * 2: 废弃
6408
- * 3: V4 版本,单群聊已读回执
6382
+ * 群组回执开关,
6383
+ * * 0(或者没有): 关闭 v1 版本
6384
+ * * 1: v2 版本,目前仅 Beem 与部分私有云用户使用
6385
+ * * 2: 废弃
6386
+ * * 3: V4 版本,目前仅 Global-UI-Kit 使用,未公开
6387
+ * * 4: V5 版本,5.20.0 版本新增
6409
6388
  */
6410
6389
  grpRRVer?: number;
6411
6390
  /**
6412
6391
  * 会话驱动类型
6413
- * 0: 默认,客户端离线消息驱动计算未读数(客户端通过pullMsg结果计算)
6414
- * 1: 服务端会话驱动计算未读数(调用pullSes进行初始化),暂只影响更新会话已读时间接口
6392
+ * 0: 默认,客户端离线消息驱动计算未读数 (客户端通过 pullMsg 结果计算)
6393
+ * 1: 服务端会话驱动计算未读数 (调用 pullSes 进行初始化),暂只影响更新会话已读时间接口
6415
6394
  */
6416
6395
  sesDriven?: number;
6417
6396
  /**
6418
- * 防黑产开关, 1: 打开,0:关闭
6397
+ * 防黑产开关,1: 打开,0:关闭
6419
6398
  */
6420
6399
  openAnti?: number;
6421
6400
  /**
@@ -6437,7 +6416,7 @@ interface INaviInfo {
6437
6416
  serverAddr?: IServerAddressData[];
6438
6417
  /**
6439
6418
  * V2 版本中新增字段
6440
- * 新版本控制tag
6419
+ * 新版本控制 tag
6441
6420
  */
6442
6421
  excludeLogTag?: string;
6443
6422
  /**
@@ -6449,12 +6428,6 @@ interface INaviInfo {
6449
6428
  * 消息断档开关
6450
6429
  */
6451
6430
  repairHisMsg?: number;
6452
- /**
6453
- * 超级群驱动配置
6454
- * 第一位:是否开启消息变更SDK主动拉取模式(关闭全量离线消息变更功能)
6455
- * 第二位:是否开启默认群频道功能(关闭空频道(""))
6456
- */
6457
- ugDriven?: number;
6458
6431
  /**
6459
6432
  * #用户订阅驱动配置,位标记!!:
6460
6433
  * 第一位:是否开启在线状态订阅功能
@@ -6468,14 +6441,14 @@ interface INaviInfo {
6468
6441
  */
6469
6442
  userProfile?: number;
6470
6443
  /**
6471
- * 用户信息托管 - 回调功能开关
6472
- * 第一位:是否开启群托管 事件同步功能
6473
- # 第二位:是否开启好友关系 事件同步功能
6444
+ * 事件驱动开关
6445
+ * * 第一位:是否开启群托管 事件同步功能
6446
+ * * 第二位:是否开启好友关系 事件同步功能
6474
6447
  */
6475
6448
  eventDriven?: number;
6476
6449
  /**
6477
- * 服务开启实时会话
6478
- * 第一位:0:未开通实时会话,1: 开通实时会话
6450
+ * 服务开启实时会话,按位运算
6451
+ * * 第一位:0:未开通实时会话,1: 开通实时会话
6479
6452
  */
6480
6453
  sessionMode?: number;
6481
6454
  /**
@@ -6493,6 +6466,30 @@ interface INaviInfo {
6493
6466
  * 是否开启 baggage 功能
6494
6467
  */
6495
6468
  baggageEnabled?: number;
6469
+ /**
6470
+ * 超级群功能开关,按位运算
6471
+ * * 第一位 0 表示关闭,1 表示开启
6472
+ */
6473
+ ugMsg?: 0 | 1;
6474
+ /**
6475
+ * 超级群驱动配置
6476
+ * * 第一位:是否开启消息变更 SDK 主动拉取模式 (关闭全量离线消息变更功能)
6477
+ * * 第二位:是否开启默认群频道功能 (关闭空频道 ("")),开关为内部开关,不可修改;早期 App 默认关闭,新增 App 均为默认开启;
6478
+ */
6479
+ ugDriven?: number;
6480
+ /**
6481
+ * 会话列表配置
6482
+ * * 第一位:会话列表是否包含超级群会话,0 为关闭,1 表示开启;
6483
+ * * 第二位:协议栈是否拉服务端会话列表,0 为关闭,1 表示开启;
6484
+ * * 第三位:协议栈自动拉取服务端会话列表,0 为关闭,1 表示开启;仅当第二位为 1 时有效
6485
+ */
6486
+ sessionCfg?: number;
6487
+ /**
6488
+ * 推送服务器地址
6489
+ */
6490
+ active?: {
6491
+ addrs: IStreamServerAddress[];
6492
+ };
6496
6493
  }
6497
6494
 
6498
6495
  /**
@@ -6501,7 +6498,7 @@ interface INaviInfo {
6501
6498
  * */
6502
6499
  interface IUserProfileInfo {
6503
6500
  /**
6504
- * 用户Id
6501
+ * 用户 Id
6505
6502
  * @description 不可修改
6506
6503
  */
6507
6504
  userId?: string;
@@ -6909,7 +6906,7 @@ interface IGroupInfoOption extends IGroupBaseInfo {
6909
6906
  interface IGroupBaseInfo {
6910
6907
  /**
6911
6908
  * 群组 ID
6912
- * @description 1 ~ 64 个字符,仅支持字母,数字 和 -_+=|: 字符
6909
+ * @description 1 ~ 64 个字符,仅支持字母,数字 和 -_+=|:字符
6913
6910
  */
6914
6911
  groupId: string;
6915
6912
  /**
@@ -6959,15 +6956,15 @@ interface IGroupInfo extends IGroupInfoOption {
6959
6956
  */
6960
6957
  interface IQuitGroupConfig {
6961
6958
  /**
6962
- * 是否移除群成员禁言状态,true代表移除,false代表不移除。默认为true
6959
+ * 是否移除群成员禁言状态,true 代表移除,false 代表不移除。默认为 true
6963
6960
  */
6964
6961
  removeMuteStatus: boolean;
6965
6962
  /**
6966
- * 是否移除群成员白名单,true代表移除,false代表不移除。默认为true
6963
+ * 是否移除群成员白名单,true 代表移除,false 代表不移除。默认为 true
6967
6964
  */
6968
6965
  removeWhiteList: boolean;
6969
6966
  /**
6970
- * 是否移除特别关注群成员,true代表移除,false代表不移除。默认为true
6967
+ * 是否移除特别关注群成员,true 代表移除,false 代表不移除。默认为 true
6971
6968
  */
6972
6969
  removeFollow: boolean;
6973
6970
  }
@@ -6978,7 +6975,7 @@ interface IQuitGroupConfig {
6978
6975
  */
6979
6976
  interface IGroupMemberInfo {
6980
6977
  /**
6981
- * 群成员用户Id。
6978
+ * 群成员用户 Id。
6982
6979
  */
6983
6980
  userId: string;
6984
6981
  /**
@@ -7013,7 +7010,7 @@ interface IGroupMemberInfo {
7013
7010
  */
7014
7011
  interface IFollowsInfo {
7015
7012
  /**
7016
- * 用户Id。
7013
+ * 用户 Id。
7017
7014
  */
7018
7015
  userId: string;
7019
7016
  /**
@@ -7028,7 +7025,7 @@ interface IFollowsInfo {
7028
7025
  */
7029
7026
  interface IGroupApplicationInfo {
7030
7027
  /**
7031
- * 群Id。
7028
+ * 群 Id。
7032
7029
  */
7033
7030
  groupId: string;
7034
7031
  /**
@@ -7154,7 +7151,7 @@ interface IGroupOperationInfo {
7154
7151
  operation: GroupOperation;
7155
7152
  /**
7156
7153
  * 本次操作行为,涉及到的群成员列表
7157
- * 注意:创建群组,解散群组时为空
7154
+ * 注意:创建群组,解散群组时为空
7158
7155
  */
7159
7156
  memberInfos?: IGroupMemberInfo[];
7160
7157
  /**
@@ -7169,7 +7166,7 @@ interface IGroupOperationInfo {
7169
7166
  */
7170
7167
  interface IGroupMemberInfoChanged {
7171
7168
  /**
7172
- * 群组ID
7169
+ * 群组 ID
7173
7170
  */
7174
7171
  groupId: string;
7175
7172
  /**
@@ -7221,7 +7218,7 @@ interface IGroupInfoChanged {
7221
7218
  */
7222
7219
  interface IGroupRemarkChangedSync {
7223
7220
  /**
7224
- * 群组ID
7221
+ * 群组 ID
7225
7222
  */
7226
7223
  groupId: string;
7227
7224
  /**
@@ -7244,7 +7241,7 @@ interface IGroupRemarkChangedSync {
7244
7241
  */
7245
7242
  interface IGroupFollowsChangedSync {
7246
7243
  /**
7247
- * 群组ID
7244
+ * 群组 ID
7248
7245
  */
7249
7246
  groupId: string;
7250
7247
  /**
@@ -7297,38 +7294,283 @@ interface INotificationQuietHoursSetting {
7297
7294
  }
7298
7295
 
7299
7296
  /**
7300
- * 进程内缓存数据
7297
+ * 消息类型描述
7301
7298
  */
7302
- interface IProcessCache {
7303
- crtUserId: string;
7304
- connectedTime: number;
7305
- naviInfo: INaviInfo | null;
7306
- connectionStatus: RCConnectionStatus;
7307
- deviceId: string;
7308
- deltaTime: number;
7309
- }
7299
+ declare type MessageTypeDescription = {
7300
+ /** 是否存储 */
7301
+ isPersited: boolean;
7302
+ /** 是否计数 */
7303
+ isCounted: boolean;
7304
+ /** 是否为状态消息 */
7305
+ isStatusMessage?: boolean;
7306
+ /** 搜索属性 */
7307
+ searchProps?: string[];
7308
+ /** 是否为自定义消息 */
7309
+ isCustom?: boolean;
7310
+ };
7311
+ declare type MessageRegisterParams = Omit<MessageTypeDescription, 'isCustom'>;
7310
7312
  /**
7311
- * 约束主进程 CppEngine 与 CppService 间的方法定义,以便于代码检查
7313
+ * 获取消息类型描述
7314
+ * @param type 消息类型
7315
+ * @param ignoreDefault 是否在获取不到描述时构建默认描述
7316
+ * @returns 消息类型描述
7317
+ */
7318
+ declare function getMessageTypeDescription(type: string): MessageTypeDescription;
7319
+ /**
7320
+ * 判断消息类型是否已注册
7321
+ * @param type 消息类型
7322
+ * @returns 是否已注册
7323
+ */
7324
+ declare function hasMessageTypeDescription(type: string): boolean;
7325
+
7326
+ /**
7327
+ * 会话列表查询条件枚举
7312
7328
  */
7313
- interface IEngine {
7329
+ declare const ConversationListFilterType: {
7314
7330
  /**
7315
- * 注册本渲染进程至主进程,以接收主进程的消息通知,同时同步主进程的当前缓存数据
7331
+ * 按时间戳查询会话列表
7316
7332
  */
7317
- getMainProcessCache(): Promise<IProcessCache>;
7333
+ readonly TIMESTAMP: 0;
7318
7334
  /**
7319
- * 建立连接
7320
- * @param token
7321
- * @param reconnectKickEnable
7335
+ * 获取置顶会话列表
7322
7336
  */
7323
- connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
7324
- getNaviInfoFromCache(): INaviInfo | null;
7337
+ readonly TOP: 1;
7325
7338
  /**
7326
- * 上报版本信息
7327
- * @param version
7339
+ * 获取免打扰会话列表,暂不支持 Electron 平台
7328
7340
  */
7329
- reportSDKInfo(version: {
7330
- [name: string]: string;
7331
- }): void;
7341
+ readonly BLOCKED: 2;
7342
+ /**
7343
+ * 获取未读会话列表
7344
+ */
7345
+ readonly UNREAD: 3;
7346
+ /**
7347
+ * 获取全部会话列表,仅 Electron 平台支持
7348
+ */
7349
+ readonly ALL: 4;
7350
+ /**
7351
+ * 按分页索引获取会话列表,仅 Electron 平台支持;目前仅 v2-adapter 中有调用
7352
+ */
7353
+ readonly PAGE_INDEX: 5;
7354
+ };
7355
+ /**
7356
+ * 按时间戳查询参数
7357
+ */
7358
+ declare type GetConversationListByTimestampParams = {
7359
+ /**
7360
+ * 获取会话起始时间,需要精确到毫秒,0 表示当前时间
7361
+ */
7362
+ startTime: number;
7363
+ /**
7364
+ * 分页数量,默认值
7365
+ */
7366
+ count: number;
7367
+ /**
7368
+ * 该参数在 Electron 平台下无效,Electron 平台下始终为 0;
7369
+ * * 0 - 从 startTime 开始向前查询,数据按时间降序排序
7370
+ * * 1 - 从 startTime 开始向后查询,数据按时间升序排序
7371
+ */
7372
+ order?: 0 | 1;
7373
+ /**
7374
+ * 单群聊的组织 ID,非超级群的频道 ID
7375
+ * * 该参数对 Web 平台无效
7376
+ * * Electron 平台下,当值为 undefined 时,将获取全部会话,其他查询条件失效
7377
+ */
7378
+ channelId?: string;
7379
+ /**
7380
+ * 是否置顶优先
7381
+ * * 当前仅支持 Electron 平台
7382
+ * * 当 channelId 非 undefined 时,该参数无效
7383
+ */
7384
+ topPriority?: boolean;
7385
+ /**
7386
+ * 会话类型,值为空或长度为 0 时,获取全部会话类型;仅 Electron 平台有效
7387
+ */
7388
+ conversationTypes?: ConversationType[];
7389
+ };
7390
+ /**
7391
+ * 置顶列表查询参数
7392
+ */
7393
+ declare type GetTopConversationListParams = {
7394
+ /**
7395
+ * 会话类型,值为空或长度为 0 时,获取全部会话类型
7396
+ */
7397
+ conversationTypes?: ConversationType[];
7398
+ /**
7399
+ * 频道 ID,当值为 undefined 时,获取全部频道会话;
7400
+ * * 参数对超级群无效,超级群始终只返回默认频道数据
7401
+ */
7402
+ channelId?: string;
7403
+ };
7404
+ /**
7405
+ * 未读列表查询参数
7406
+ */
7407
+ declare type GetUnreadConversationListParams = Pick<GetTopConversationListParams, 'conversationTypes'>;
7408
+ /**
7409
+ * 全部列表查询参数
7410
+ */
7411
+ declare type GetAllConversationListFilterParams = {
7412
+ /**
7413
+ * 频道 ID,当值为 undefined 时,获取全部频道会话
7414
+ * * 参数对超级群无效,超级群始终只返回默认频道数据
7415
+ */
7416
+ channelId?: string;
7417
+ };
7418
+ /**
7419
+ * 按分页索引获取会话列表查询参数
7420
+ */
7421
+ declare type GetConversationListByPageIndexParams = {
7422
+ /**
7423
+ * 分页索引
7424
+ */
7425
+ index: number;
7426
+ /**
7427
+ * 分页数量
7428
+ */
7429
+ limit: number;
7430
+ /**
7431
+ * 会话类型,值为空或长度为 0 时,获取全部会话类型
7432
+ */
7433
+ conversationTypes?: ConversationType[];
7434
+ };
7435
+ /**
7436
+ * 会话列表查询参数
7437
+ * * type 为 ConversationListFilterType 的枚举值
7438
+ * * params 为对应的查询参数
7439
+ */
7440
+ declare type ConversationListFilter = {
7441
+ type: typeof ConversationListFilterType.ALL;
7442
+ params?: GetAllConversationListFilterParams;
7443
+ } | {
7444
+ type: typeof ConversationListFilterType.TIMESTAMP;
7445
+ params: GetConversationListByTimestampParams;
7446
+ } | {
7447
+ type: typeof ConversationListFilterType.TOP;
7448
+ params?: GetTopConversationListParams;
7449
+ } | {
7450
+ type: typeof ConversationListFilterType.UNREAD;
7451
+ params?: GetUnreadConversationListParams;
7452
+ } | {
7453
+ type: typeof ConversationListFilterType.BLOCKED;
7454
+ params?: never;
7455
+ } | {
7456
+ type: typeof ConversationListFilterType.PAGE_INDEX;
7457
+ params: GetConversationListByPageIndexParams;
7458
+ };
7459
+ /**
7460
+ * 会话列表查询结果
7461
+ */
7462
+ declare type GetConversationListResponse = {
7463
+ /**
7464
+ * 会话列表
7465
+ */
7466
+ list: IReceivedConversation[];
7467
+ /**
7468
+ * 是否还有更多数据,当值为 undefined 时,需要业务自行判断
7469
+ */
7470
+ hasNext?: boolean;
7471
+ };
7472
+
7473
+ /** 已读回执用户信息 */
7474
+ declare type ReadReceiptUser = {
7475
+ /** 用户 ID */
7476
+ userId: string;
7477
+ /** 该用户的阅读时间。0 表示用户没有发送已读回执 */
7478
+ timestamp: number;
7479
+ /** 该用户是否为被 @ 提醒的用户 */
7480
+ isMentioned: boolean;
7481
+ };
7482
+ /** 已读回执用户列表请求参数 */
7483
+ declare type ReadReceiptUsersOption = {
7484
+ /**
7485
+ * 分页游标,首页请求时可不传
7486
+ */
7487
+ pageToken?: string;
7488
+ /**
7489
+ * 分页条数,最大值为 100
7490
+ */
7491
+ pageCount: number;
7492
+ /**
7493
+ * 状态,若值非法则视为 0
7494
+ * * 0:获取已读列表
7495
+ * * 1:获取未读列表
7496
+ */
7497
+ readStatus: 0 | 1;
7498
+ /**
7499
+ * 排序,若值非法则视为 0
7500
+ * * 0: 按读取时间降序查询
7501
+ * * 1: 按读取时间升序查询
7502
+ */
7503
+ order: 0 | 1;
7504
+ };
7505
+ /** 消息已读回执列表请求结果 */
7506
+ declare type ReadReceiptUsersResult = {
7507
+ /** 分页游标 */
7508
+ pageToken: string;
7509
+ /** 总人数 */
7510
+ totalCount: number;
7511
+ /** 回执用户列表 */
7512
+ users: ReadReceiptUser[];
7513
+ };
7514
+ /** 消息已读回执响应数据 */
7515
+ declare type ReadReceiptResponseV5 = {
7516
+ /** 会话信息 */
7517
+ identifier: IConversationOption;
7518
+ /** 消息唯一 ID */
7519
+ messageUId: string;
7520
+ /** 已读回执的用户变更列表 */
7521
+ users: ReadReceiptUser[];
7522
+ /** 已读人数 */
7523
+ readCount: number;
7524
+ /** 未读人数 */
7525
+ unreadCount: number;
7526
+ /** 总人数 */
7527
+ totalCount: number;
7528
+ };
7529
+ /** 消息已读回执信息 */
7530
+ declare type ReadReceiptInfoV5 = {
7531
+ /** 消息 ID */
7532
+ messageUId: string;
7533
+ /** 未读人数 */
7534
+ unreadCount: number;
7535
+ /** 已读人数 */
7536
+ readCount: number;
7537
+ /** 总人数 */
7538
+ totalCount: number;
7539
+ };
7540
+
7541
+ /**
7542
+ * 进程内缓存数据
7543
+ */
7544
+ interface IProcessCache {
7545
+ crtUserId: string;
7546
+ connectedTime: number;
7547
+ naviInfo: INaviInfo | null;
7548
+ connectionStatus: RCConnectionStatus;
7549
+ deviceId: string;
7550
+ deltaTime: number;
7551
+ }
7552
+ /**
7553
+ * 约束主进程 CppEngine 与 CppService 间的方法定义,以便于代码检查
7554
+ */
7555
+ interface IIPCMethods {
7556
+ /**
7557
+ * 注册本渲染进程至主进程,以接收主进程的消息通知,同时同步主进程的当前缓存数据
7558
+ */
7559
+ getMainProcessCache(): Promise<IProcessCache>;
7560
+ /**
7561
+ * 建立连接
7562
+ * @param token
7563
+ * @param reconnectKickEnable
7564
+ */
7565
+ connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
7566
+ getNaviInfoFromCache(): INaviInfo | null;
7567
+ /**
7568
+ * 上报版本信息
7569
+ * @param version
7570
+ */
7571
+ reportSDKInfo(version: {
7572
+ [name: string]: string;
7573
+ }): void;
7332
7574
  /**
7333
7575
  * 连接时间
7334
7576
  */
@@ -7354,7 +7596,7 @@ interface IEngine {
7354
7596
  */
7355
7597
  timestamp: number,
7356
7598
  /**
7357
- * 获取条数, 有效值 `1` - `20`
7599
+ * 获取条数,有效值 `1` - `20`
7358
7600
  */
7359
7601
  count: number,
7360
7602
  /**
@@ -7384,7 +7626,7 @@ interface IEngine {
7384
7626
  /**
7385
7627
  * 删除历史消息 通过 messageUId
7386
7628
  */
7387
- deleteRemoteMessage(conversationType: ConversationType, targetId: string,
7629
+ deleteRemoteMessage(conversation: IConversationOption,
7388
7630
  /**
7389
7631
  * @description
7390
7632
  * message 中 messageUId、setTime、messageDirection 为必须参数
@@ -7393,74 +7635,64 @@ interface IEngine {
7393
7635
  messageUId: string;
7394
7636
  sentTime: number;
7395
7637
  messageDirection: MessageDirection;
7396
- }[],
7397
- /**
7398
- * 会话的业务标识
7399
- */
7400
- channelId: string): Promise<ErrorCode>;
7638
+ }[]): Promise<RCResult>;
7401
7639
  recallMsg(conversation: IConversationOption, recallMsgOptions: IRecallMsgOptions): Promise<RCResult<IReceivedMessage>>;
7640
+ deleteRemoteMessageByTimestamp(conversation: IConversationOption, timestamp: number): Promise<RCResult>;
7402
7641
  /**
7403
- * 删除历史消息 通过 时间戳
7404
- * @param timestamp 小于等于传入时间戳的消息均删除
7405
- */
7406
- deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number,
7407
- /**
7408
- * 会话的业务标识
7409
- */
7410
- channelId: string): Promise<ErrorCode>;
7411
- /**
7412
- * 获取会话列表
7413
- * @param count 指定获取数量, 不传则获取全部会话列表,默认 `300`
7414
- */
7415
- getConversationList(
7416
- /**
7417
- * 拉取数量, 有效值 0 - 1000, 默认 300
7418
- */
7419
- count: number,
7420
- /**
7421
- * 会话类型
7422
- * @todo 待确认是否生效
7423
- */
7424
- conversationType?: ConversationType,
7425
- /**
7426
- * 起始时间
7642
+ * 根据过滤条件获取会话列表
7643
+ * * 开启'会话列表支持超级群'功能后,结果数据中将包含超级群默认频道会话数据;
7644
+ *
7645
+ * @param filter 过滤条件
7646
+ * @returns 会话列表,始终保持时间升序返回
7427
7647
  */
7428
- startTime?: number,
7648
+ getConversationListByFilter(filter: ConversationListFilter): Promise<RCResult<GetConversationListResponse>>;
7429
7649
  /**
7430
- * 获取顺序
7650
+ * 获取单一会话数据
7651
+ * @param conversationType
7652
+ * @param targetId
7653
+ * @param channelId
7431
7654
  */
7432
- order?: 0 | 1,
7655
+ getConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<RCResult<IReceivedConversation>>;
7433
7656
  /**
7434
- * 会话的业务标识
7657
+ * 批量设置会话置顶
7658
+ * @param conversations 会话列表
7659
+ * @param isTop 是否置顶
7660
+ * @param isUpdateTime 是否更新置顶时间
7661
+ * @param isCreateConversation 是否创建会话
7435
7662
  */
7436
- channelId?: string): IPromiseResult<IReceivedConversation[]>;
7663
+ batchSetConversationToTop(conversations: IConversationOption[], isTop?: boolean, isUpdateTime?: boolean, isCreateConversation?: boolean): Promise<RCResult>;
7437
7664
  /**
7438
- * 分页获取会话列表,仅 electron中使用
7665
+ * 批量设置会话免打扰
7666
+ * @param conversations 会话列表
7667
+ * @param notificationLevel 免打扰级别
7439
7668
  */
7440
- getConversationsByPage(conversationTypes: ConversationType[], startTime: number, count: number, channelId: string, topPriority: boolean): IPromiseResult<IReceivedConversation[]>;
7669
+ batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<RCResult>;
7441
7670
  /**
7442
- * 获取指定会话
7671
+ * 设置指定会话类型默认免打扰级别
7672
+ * @param conversationType 会话类型
7673
+ * @param notificationLevel 免打扰级别
7443
7674
  */
7444
- getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
7675
+ setConversationTypeNotificationLevel(conversationType: ConversationType, notificationLevel: NotificationLevel): Promise<RCResult>;
7445
7676
  /**
7446
- * 获取未读会话列表
7677
+ * 获取指定会话类型默认免打扰级别
7678
+ * @param conversationType 会话类型
7447
7679
  */
7448
- getUnreadConversationList(conversationTypes: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
7680
+ getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<RCResult<NotificationLevel>>;
7449
7681
  /**
7450
7682
  * 删除会话
7451
7683
  * @description 该删除操作会删除服务器端存储的会话数据
7452
7684
  * @param conversationType
7453
7685
  * @param targetId
7454
7686
  */
7455
- removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
7687
+ removeConversation(conversation: IConversationOption): Promise<RCResult>;
7456
7688
  batchRemoveConversation(conversations: IConversationOption[]): Promise<ErrorCode>;
7457
7689
  /**
7458
7690
  * 获取所有会话未读数
7459
- * @param channelId 多组织 Id
7691
+ * @param channelId 多组织 Id,仅限于获取单群聊,超级群会话仅查询默认频道未读数
7460
7692
  * @param conversationTypes
7461
7693
  * @param includeMuted 包含已设置免打扰的会话
7462
7694
  */
7463
- getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
7695
+ getTotalUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): Promise<RCResult<number>>;
7464
7696
  /**
7465
7697
  * 获取指定会话未读数
7466
7698
  */
@@ -7469,6 +7701,10 @@ interface IEngine {
7469
7701
  * 清除指定会话未读数
7470
7702
  */
7471
7703
  clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
7704
+ /**
7705
+ * 清除全部会话未读数
7706
+ */
7707
+ clearAllUnreadCount(): Promise<RCResult>;
7472
7708
  /**
7473
7709
  * 获取第一个未读消息
7474
7710
  */
@@ -7487,36 +7723,19 @@ interface IEngine {
7487
7723
  * 清除指定会话消息草稿
7488
7724
  */
7489
7725
  clearConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
7490
- /**
7491
- * 从服务端拉取会话状态
7492
- */
7493
- pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
7494
- /**
7495
- * 批量设置会话 置顶、免打扰
7496
- */
7497
- batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
7498
- batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<ErrorCode>;
7499
- setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel: NotificationLevel, channelId?: string): Promise<number>;
7500
- batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<ErrorCode>;
7501
- getConversationNotificationLevel(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
7726
+ getConversationNotificationLevel(conversation: IConversationOption): Promise<RCResult<NotificationLevel>>;
7502
7727
  getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<IAsyncRes<number>>;
7503
7728
  sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void, traceId?: string): IPromiseResult<IReceivedMessage>;
7504
7729
  /**
7505
7730
  * 断开连接
7506
7731
  */
7507
- disconnect(closeDB?: boolean): void;
7732
+ disconnect(closeDB?: boolean, disablePush?: boolean): Promise<void>;
7508
7733
  /**
7509
7734
  * 消息注册
7510
7735
  * @description
7511
- * 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,
7512
- * 本端发出的消息将不默认作为未知消息处理,不存储、不计数
7513
- * @param objectName 消息类型,如:RC:TxtMsg
7514
- * @param isPersited 是否存储
7515
- * @param isCounted 是否技术
7516
- * @param searchProps 搜索字段,只在搭配协议栈使用时有效
7517
- * @param isStatusMessage 是否是状态消息
7736
+ * 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
7518
7737
  */
7519
- registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[], isStatusMessage: boolean): void;
7738
+ registerMessageType(objectName: string, params: MessageTypeDescription): void;
7520
7739
  /**
7521
7740
  * 加入聊天室
7522
7741
  * @param count 拉取消息数量
@@ -7533,8 +7752,8 @@ interface IEngine {
7533
7752
  quitChatroom(chatroomId: string): Promise<ErrorCode>;
7534
7753
  /**
7535
7754
  * 获取聊天室信息
7536
- * @param count 获取人数, 范围 0 - 20
7537
- * @param order 排序方式, 1 正序, 2 倒序
7755
+ * @param count 获取人数,范围 0 - 20
7756
+ * @param order 排序方式,1 正序,2 倒序
7538
7757
  */
7539
7758
  getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
7540
7759
  /**
@@ -7603,7 +7822,7 @@ interface IEngine {
7603
7822
  createTag(tag: ITagParam): IPromiseResult;
7604
7823
  /**
7605
7824
  * 删除标签
7606
- * @param tagId 标签id
7825
+ * @param tagId 标签 id
7607
7826
  */
7608
7827
  removeTag(tagId: string): IPromiseResult;
7609
7828
  /**
@@ -7617,31 +7836,31 @@ interface IEngine {
7617
7836
  getTagList(): IPromiseResult<Array<ITagInfo>>;
7618
7837
  /**
7619
7838
  * 添加会话到标签(给多个会话增加标签)
7620
- * @param tagId 标签id
7839
+ * @param tagId 标签 id
7621
7840
  * @param conversations 要添加的会话列表
7622
7841
  */
7623
7842
  addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
7624
7843
  /**
7625
- * 删除标签中的会话(从多个会话中批量删除指定标签)
7626
- * @param tagId 标签id
7844
+ * 删除标签中的会话 (从多个会话中批量删除指定标签)
7845
+ * @param tagId 标签 id
7627
7846
  * @param conversations 要删除的会话列表
7628
7847
  */
7629
7848
  removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
7630
7849
  /**
7631
- * 删除会话中的标签(从单一会话中批量删除标签)
7850
+ * 删除会话中的标签 (从单一会话中批量删除标签)
7632
7851
  * @param conversationType 会话类型
7633
- * @param targetId 会话id
7852
+ * @param targetId 会话 id
7634
7853
  * @param tagIds 要删除的标签列表
7635
7854
  */
7636
7855
  removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult;
7637
7856
  /**
7638
7857
  * 获取标签下的会话列表
7639
- * @param tagId 标签id
7858
+ * @param tagId 标签 id
7640
7859
  */
7641
7860
  getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
7642
7861
  /**
7643
7862
  * 获取标签下的未读消息数
7644
- * @param tagId 标签id
7863
+ * @param tagId 标签 id
7645
7864
  * @param containMuted 是否包含免打扰会话
7646
7865
  */
7647
7866
  getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
@@ -7665,15 +7884,15 @@ interface IEngine {
7665
7884
  */
7666
7885
  getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
7667
7886
  /**
7668
- * 发送已读回执(V4)
7887
+ * 发送已读回执 (V4)
7669
7888
  */
7670
7889
  sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
7671
7890
  /**
7672
- * 获取消息已读回执列表, 暂仅支持群聊(V4)
7891
+ * 获取消息已读回执列表,暂仅支持群聊 (V4)
7673
7892
  */
7674
7893
  getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
7675
7894
  /**
7676
- * 多端同步会话的已读时间(V4)
7895
+ * 多端同步会话的已读时间 (V4)
7677
7896
  */
7678
7897
  updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
7679
7898
  /**
@@ -7681,15 +7900,13 @@ interface IEngine {
7681
7900
  */
7682
7901
  getServerTime(): number;
7683
7902
  /**
7684
- * 获取设备ID
7903
+ * 获取设备 ID
7685
7904
  */
7686
7905
  getDeviceId(): string;
7687
7906
  /**
7688
7907
  * 获取当前 userId
7689
7908
  */
7690
7909
  getCurrentUserId(): string;
7691
- getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
7692
- getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
7693
7910
  /**
7694
7911
  * 设置用户在线状态监听器
7695
7912
  */
@@ -7744,7 +7961,7 @@ interface IEngine {
7744
7961
  deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
7745
7962
  batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
7746
7963
  batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
7747
- batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<ErrorCode>;
7964
+ batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<RCResult>;
7748
7965
  /**
7749
7966
  * 清空会话下历史消息
7750
7967
  */
@@ -7764,7 +7981,7 @@ interface IEngine {
7764
7981
  /**
7765
7982
  * 通过关键字与 channelId 搜索所有会话
7766
7983
  */
7767
- searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
7984
+ searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
7768
7985
  searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
7769
7986
  /**
7770
7987
  * 按内容搜索会话内的消息
@@ -7806,10 +8023,6 @@ interface IEngine {
7806
8023
  * 删除时间戳前的未读数
7807
8024
  */
7808
8025
  clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
7809
- /**
7810
- * 获取会话免打扰状态
7811
- */
7812
- getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
7813
8026
  /**
7814
8027
  * 协议栈获取远端历史消息
7815
8028
  */
@@ -7817,18 +8030,6 @@ interface IEngine {
7817
8030
  list: IReceivedMessage[];
7818
8031
  hasMore: boolean;
7819
8032
  }>;
7820
- /**
7821
- * 无差别获取本地免打扰列表
7822
- */
7823
- getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
7824
- /**
7825
- * 无差别获取本地置顶列表
7826
- */
7827
- getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
7828
- /**
7829
- * 获取单个群聊会话 @ 消息未读数
7830
- */
7831
- getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
7832
8033
  /**
7833
8034
  * 获取所有群聊会话 @ 消息未读数
7834
8035
  */
@@ -7927,6 +8128,23 @@ interface IEngine {
7927
8128
  setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
7928
8129
  removeNotificationQuietHoursSetting(): Promise<RCResult>;
7929
8130
  getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
8131
+ getStatsUrlList(): Promise<RCResult<string[]>>;
8132
+ /**
8133
+ * 发送消息已读回执(V5 版本)
8134
+ */
8135
+ sendReadReceiptResponseV5(conId: IConversationOption, messageUIdArray: string[]): Promise<RCResult>;
8136
+ /**
8137
+ * 获取消息已读人数信息(V5 版本)
8138
+ */
8139
+ getMessageReadReceiptInfoV5(conId: IConversationOption, messageUIdArray: Array<string>): Promise<RCResult<ReadReceiptInfoV5[]>>;
8140
+ /**
8141
+ * 分页获取消息已读、未读人员列表(V5 版本)
8142
+ */
8143
+ getMessagesReadReceiptUsersByPageV5(conId: IConversationOption, messageUId: string, opt: ReadReceiptUsersOption): Promise<RCResult<ReadReceiptUsersResult>>;
8144
+ /**
8145
+ * 按人查询消息是否已读(V5 版本)
8146
+ */
8147
+ getMessagesReadReceiptByUsersV5(conId: IConversationOption, messageUId: string, userList: Array<string>): Promise<RCResult<ReadReceiptUsersResult>>;
7930
8148
  rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
7931
8149
  rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
7932
8150
  code: ErrorCode;
@@ -7990,7 +8208,7 @@ interface IExpansionListenerData {
7990
8208
  }
7991
8209
 
7992
8210
  /**
7993
- * typing信息
8211
+ * typing 信息
7994
8212
  * @category Interface
7995
8213
  */
7996
8214
  interface ITypingUser {
@@ -8008,7 +8226,7 @@ interface ITypingUser {
8008
8226
  messageType: string;
8009
8227
  }
8010
8228
  /**
8011
- * typing通知消息接口
8229
+ * typing 通知消息接口
8012
8230
  * @category Interface
8013
8231
  */
8014
8232
  interface ITypingMessage {
@@ -8025,7 +8243,7 @@ interface ITypingMessage {
8025
8243
  */
8026
8244
  channelId?: string;
8027
8245
  /**
8028
- * typing信息列表
8246
+ * typing 信息列表
8029
8247
  */
8030
8248
  list: Array<ITypingUser>;
8031
8249
  }
@@ -8089,35 +8307,23 @@ interface IUserGroupStatusInfo {
8089
8307
  userGroupUnBindChannel?: IChannelAndUserGroupChangeData[];
8090
8308
  }
8091
8309
 
8092
- interface IUserSettingItem {
8093
- targetId: number;
8094
- type: number;
8095
- key: string;
8096
- value: any;
8097
- version: number;
8098
- status: number;
8099
- tags: IConversationTag[];
8100
- }
8101
- interface IServerUserSetting {
8102
- settings: {
8103
- [key: string]: IUserSettingItem;
8104
- };
8105
- version: number;
8106
- }
8107
-
8108
8310
  interface IEngineWatcher extends IConnectionListener {
8109
8311
  /**
8110
8312
  * @param message 消息
8111
8313
  * @param leftCount 参数废弃,值始终为 undefined
8112
- * @param hasMore 消息是否收取结束,需与协议栈配合使用
8314
+ * @param hasMore 消息是否收取结束,仅 Electron 平台有效
8113
8315
  */
8114
8316
  batchMessage: (messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean) => void;
8115
8317
  chatroom: (event: IChatroomListenerData) => void;
8116
- conversation: (event: any) => void;
8318
+ conversation: (event: IUpdatedConversation[]) => void;
8117
8319
  expansion: (event: IExpansionListenerData) => void;
8118
8320
  tag: () => void;
8321
+ /**
8322
+ * C++ 协议栈对外通知会话 tag 变更时,不携带任何数据; 为保持 Web 与 C++ 协议栈通知一致,不抛数据
8323
+ */
8119
8324
  conversationTag: () => void;
8120
- ultraGroupEnable: (conversations: IReceivedConversation[]) => void;
8325
+ ultraGroupEnable: () => void;
8326
+ sgRelationsSynced: () => void;
8121
8327
  operateStatus: (status: IOperateStatusNotify) => void;
8122
8328
  ultraGroupMessageExpansionUpdated: (list: IReceivedMessage[]) => void;
8123
8329
  ultraGroupMessageModified: (list: IReceivedMessage[]) => void;
@@ -8161,6 +8367,7 @@ interface IEngineWatcher extends IConnectionListener {
8161
8367
  databaseUpgradeWillStart: () => void;
8162
8368
  databaseUpgrading: (progress: number) => void;
8163
8369
  databaseUpgradeDidComplete: (code: ErrorCode) => void;
8370
+ readReceiptResponseV5?: (data: ReadReceiptResponseV5[]) => void;
8164
8371
  }
8165
8372
 
8166
8373
  declare type IErrorKeys = {
@@ -8195,7 +8402,7 @@ declare const isBoolean: (value: unknown) => boolean;
8195
8402
  */
8196
8403
  declare const isNumber: (value: unknown) => boolean;
8197
8404
  /**
8198
- * 检查参数是否为整数, 可以指定最小值和最大值,区间包含最小值和最大值,
8405
+ * 检查参数是否为整数,可以指定最小值和最大值,区间包含最小值和最大值,
8199
8406
  */
8200
8407
  declare const isInteger: (option: {
8201
8408
  min?: number;
@@ -8240,14 +8447,10 @@ declare const isObject: (val: any) => boolean;
8240
8447
  */
8241
8448
  declare const isFunction: (val: any) => boolean;
8242
8449
  /**
8243
- * 检查参数是否为undefined
8450
+ * 检查参数是否为 undefined
8244
8451
  * @param val
8245
8452
  */
8246
8453
  declare const isUndefined: (val: any) => boolean;
8247
- /**
8248
- * 检查参数是否为 null
8249
- */
8250
- declare const isNull: (val: any) => boolean;
8251
8454
  /**
8252
8455
  * 检查参数是否为有效 http(s) 协议 url
8253
8456
  * @param value
@@ -8277,20 +8480,6 @@ declare const isValidGroupId: (value: any) => boolean;
8277
8480
  */
8278
8481
  declare const isValidFileType: (fileType: number) => boolean;
8279
8482
 
8280
- /**
8281
- * @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
8282
- * @deprecated
8283
- * @param source
8284
- * @param event
8285
- * @param options
8286
- */
8287
- declare const forEach: (source: any, event: Function, options?: any) => void;
8288
- /**
8289
- * @deprecated
8290
- * @param source
8291
- * @param event
8292
- */
8293
- declare const map: (source: any[], event: Function) => any[];
8294
8483
  /**
8295
8484
  * 判断当前是否运行在 electron 环境且搭配 c++ 协议栈使用
8296
8485
  */
@@ -8299,13 +8488,57 @@ declare const usingCppEngine: () => boolean;
8299
8488
  * 将接收状态枚举值转换为接收转态详情
8300
8489
  * @param status 状态枚举值
8301
8490
  */
8302
- declare const transformReceivedStatusInfo: (status: ReceivedStatus) => IReceivedStatusInfo;
8491
+ declare const trans2IReceivedStatusInfo: (status: ReceivedStatus) => IReceivedStatusInfo;
8303
8492
  /**
8304
8493
  * 将接收状态详情转换为接收转态枚举值
8305
8494
  * @param status 状态枚举值
8306
8495
  */
8307
8496
  declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusInfo) => number;
8308
8497
 
8498
+ declare type PBModule = {
8499
+ toArrayBuffer: () => ArrayBuffer;
8500
+ getArrayData: never;
8501
+ [key: string]: Function;
8502
+ };
8503
+ declare class Codec$1<T> {
8504
+ #private;
8505
+ /**
8506
+ * 嵌套结构声明
8507
+ * key: pbname
8508
+ * value: [key: pbname + _ + 属性名,type: 值的 pbname ]
8509
+ */
8510
+ private nestedMap;
8511
+ private readonly pbModules;
8512
+ constructor(
8513
+ /**
8514
+ * proto 协议描述
8515
+ */
8516
+ desc: string,
8517
+ /**
8518
+ * 嵌套结构声明
8519
+ * key: pbname
8520
+ * value: [key: pbname + _ + 属性名,type: 值的 pbname ]
8521
+ */
8522
+ nestedMap: Map<string, keyof T>);
8523
+ private _encode;
8524
+ /**
8525
+ * PB 数据序列化
8526
+ * @param pbname - PB 名称
8527
+ * @param params - 待序列化数据
8528
+ */
8529
+ encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
8530
+ /**
8531
+ * 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
8532
+ * @param pbname 待解码数据的 PB 名
8533
+ * @param data 待解码数据
8534
+ */
8535
+ decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
8536
+ /**
8537
+ * @deprecated
8538
+ */
8539
+ getModule(pbname: string): PBModule;
8540
+ }
8541
+
8309
8542
  /**
8310
8543
  * 日志打印等级定义
8311
8544
  * @category Enum
@@ -8369,7 +8602,6 @@ interface ILogData {
8369
8602
  * @description
8370
8603
  * Electron 环境下,以主进程 sessionId 入库,渲染进程 sessionId 存储于 content 内。
8371
8604
  * 日志上报时,通过 `${mainSessionId}:${renderSessionId}` 形式作为 sessionId 上报
8372
- * @TODO 需确认服务是否允许 `${mainSessionId}:${renderSessionId}` 的方式,以及 sessionId 是否超出长度。
8373
8605
  */
8374
8606
  sessionId: string;
8375
8607
  /**
@@ -8431,15 +8663,13 @@ declare abstract class BasicLogger {
8431
8663
  /**
8432
8664
  * 汇总 result 结果记录并记录日志
8433
8665
  * @param tag
8434
- * @param isSuccess
8666
+ * @param res
8435
8667
  * @param traceId
8436
8668
  * @param summaryInfo - 日志摘要数据
8437
- * @param successMsg - 自定义成功日志信息,优先级高于 summaryInfo
8438
- * @param failMsg - 自定义失败日志信息,优先级高于 summaryInfo
8669
+ * @param success - 请求成功时追加的日志信息
8670
+ * @param fail - 请求失败时追加的日志信息
8439
8671
  */
8440
- summary(tag: string, res: RCResult<any>, traceId?: string, summaryInfo?: {
8441
- [key: string]: string | number | boolean | undefined;
8442
- }, successMsg?: () => string, failMsg?: () => string): void;
8672
+ summary<T = void>(tag: string, res: RCResult<T>, traceId?: string, summaryInfo?: Record<string, any>, success?: (data: T) => Record<string, any>, fail?: (data: T) => Record<string, any>): void;
8443
8673
  /**
8444
8674
  * 内部质量数据统计接口,仅限 IMLib 与 RTCLib 内部使用
8445
8675
  */
@@ -8628,54 +8858,23 @@ interface IRuntime {
8628
8858
  * 创建 EventSource 客户端建立 SSE 链路,用于拉取 AI 流式消息数据
8629
8859
  */
8630
8860
  createSSEClient(initOpts: ISSEClientInitOpts): RCResult<SSEClient>;
8631
- }
8632
-
8633
- declare const runtime: IRuntime;
8634
-
8635
- declare type PBModule = {
8636
- toArrayBuffer: () => ArrayBuffer;
8637
- getArrayData: never;
8638
- [key: string]: Function;
8639
- };
8640
- declare class Codec$1<T> {
8641
- #private;
8642
- /**
8643
- * 嵌套结构声明
8644
- * key: pbname
8645
- * value: [key: pbname + _ + 属性名, type: 值的 pbname ]
8646
- */
8647
- private nestedMap;
8648
- private readonly pbModules;
8649
- constructor(
8650
8861
  /**
8651
- * proto 协议描述
8862
+ * 获取 apiVer
8652
8863
  */
8653
- desc: string,
8864
+ getApiVer?: () => string;
8654
8865
  /**
8655
- * 嵌套结构声明
8656
- * key: pbname
8657
- * value: [key: pbname + _ + 属性名, type: 值的 pbname ]
8866
+ * 获取 runtime 信息
8658
8867
  */
8659
- nestedMap: Map<string, keyof T>);
8660
- private _encode;
8661
- /**
8662
- * PB 数据序列化
8663
- * @param pbname - PB 名称
8664
- * @param params - 待序列化数据
8665
- */
8666
- encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
8667
- /**
8668
- * 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
8669
- * @param pbname 待解码数据的 PB 名
8670
- * @param data 待解码数据
8671
- */
8672
- decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
8673
- /**
8674
- * @deprecated
8675
- */
8676
- getModule(pbname: string): PBModule;
8868
+ get runtimeInfo(): {
8869
+ /** 小程序平台为 runtime tag 数据,浏览器为浏览器品牌信息 */
8870
+ type: string;
8871
+ /** 浏览器版本,小程序平台始终为 Unknown */
8872
+ version: string;
8873
+ };
8677
8874
  }
8678
8875
 
8876
+ declare const runtime: IRuntime;
8877
+
8679
8878
  /**
8680
8879
  * @deprecated
8681
8880
  * 日志级别,已废弃
@@ -8786,7 +8985,7 @@ declare enum ConnectionStatus {
8786
8985
  */
8787
8986
  RESPONSE_NAVI_TIMEOUT = 204,
8788
8987
  /**
8789
- * 证书过期,SDK不会重连
8988
+ * 证书过期,SDK 不会重连
8790
8989
  */
8791
8990
  RC_LICENSE_EXPIRED = 31030,
8792
8991
  /**
@@ -8809,11 +9008,11 @@ declare enum RTCMode {
8809
9008
  */
8810
9009
  LIVE = 2,
8811
9010
  /**
8812
- *sip呼叫
9011
+ *sip 呼叫
8813
9012
  */
8814
9013
  SIP = 4,
8815
9014
  /**
8816
- * 呼叫模式.包括单呼和群呼
9015
+ * 呼叫模式。包括单呼和群呼
8817
9016
  */
8818
9017
  CALL = 5,
8819
9018
  /**
@@ -8938,6 +9137,26 @@ declare type IChatRoomEntries = IChatroomEntries;
8938
9137
  */
8939
9138
  declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
8940
9139
 
9140
+ /**
9141
+ * @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
9142
+ * @deprecated
9143
+ * @param source
9144
+ * @param event
9145
+ * @param options
9146
+ */
9147
+ declare const forEach: (source: any, event: Function, options?: any) => void;
9148
+ /**
9149
+ * @deprecated
9150
+ * @param source
9151
+ * @param event
9152
+ */
9153
+ declare const map: (source: any[], event: Function) => any[];
9154
+ /**
9155
+ * 检查参数是否为 null
9156
+ * @deprecated
9157
+ */
9158
+ declare const isNull: (val: any) => boolean;
9159
+
8941
9160
  /** @deprecated */
8942
9161
  declare type CodecPBMaps = {
8943
9162
  readonly [pbname: string]: readonly string[];
@@ -9072,11 +9291,20 @@ declare class PluginContext {
9072
9291
  * 用户连接建立之前及 disconnect 之后,该方法返回 '' 值
9073
9292
  */
9074
9293
  getCurrentId(): string;
9294
+ /**
9295
+ * 获取当前已连接用户的 token
9296
+ */
9297
+ getUserToken(): string;
9075
9298
  /**
9076
9299
  * 获取当前连接状态
9077
9300
  */
9078
9301
  getConnectionStatus(): RCConnectionStatus;
9079
9302
  getDeviceId(): string;
9303
+ /**
9304
+ * 设置推送配置 (uni app 平台使用)
9305
+ * @param config 推送配置
9306
+ */
9307
+ setPushConfig(config: IAppPushConfig): void;
9080
9308
  /**
9081
9309
  * 发送消息
9082
9310
  */
@@ -9116,6 +9344,10 @@ declare class PluginContext {
9116
9344
  * @param type 目前仅支持 `IM` 与 `RTC` 两个值
9117
9345
  */
9118
9346
  createLogger(id: string, type: LogType): BasicLogger;
9347
+ /**
9348
+ * 获取统计地址
9349
+ */
9350
+ getStatsUrlList(): Promise<RCResult<string[]>>;
9119
9351
  }
9120
9352
 
9121
9353
  interface IPluginGenerator<API, InitOption> {
@@ -9200,7 +9432,8 @@ interface IWatcher {
9200
9432
  * 敏感词被拦截监听
9201
9433
  */
9202
9434
  messageBlocked?: IMessageBlockedListener;
9203
- ultraGroupEnable?: (conversations: IReceivedConversation[]) => void;
9435
+ ultraGroupEnable?: () => void;
9436
+ sgRelationsSynced?: () => void;
9204
9437
  operateStatus?: (status: IOperateStatusNotify) => void;
9205
9438
  ultraGroupMessageExpansionUpdated?: (list: IReceivedMessage[]) => void;
9206
9439
  ultraGroupMessageModified?: (list: IReceivedMessage[]) => void;
@@ -9235,6 +9468,7 @@ interface IWatcher {
9235
9468
  databaseUpgradeWillStart?: () => void;
9236
9469
  databaseUpgrading?: (progress: number) => void;
9237
9470
  databaseUpgradeDidComplete?: (code: ErrorCode) => void;
9471
+ readReceiptResponseV5?: (data: ReadReceiptResponseV5[]) => void;
9238
9472
  }
9239
9473
  interface IAPIContextOption {
9240
9474
  /**
@@ -9242,7 +9476,7 @@ interface IAPIContextOption {
9242
9476
  */
9243
9477
  appkey: string;
9244
9478
  /**
9245
- * 自定义导航地址:
9479
+ * 自定义导航地址:
9246
9480
  * 1. 私有云环境下该值为必填项
9247
9481
  * 2. 当存在自定义导航地址时,SDK 内部默认地址将无效
9248
9482
  * 3. 当存在自定义导航地址时,地址 url 中需包含 http/https 协议头,否则视为无效值
@@ -9257,7 +9491,7 @@ interface IAPIContextOption {
9257
9491
  */
9258
9492
  miniCMPProxy: string[];
9259
9493
  /**
9260
- * typing状态过期时间
9494
+ * typing 状态过期时间
9261
9495
  */
9262
9496
  typingExpireTime?: number;
9263
9497
  /**
@@ -9295,6 +9529,10 @@ interface IAPIContextOption {
9295
9529
  * 私有云环境配置
9296
9530
  */
9297
9531
  environment?: string;
9532
+ /**
9533
+ * 启动线程阻塞检查
9534
+ */
9535
+ eventLoopBlockingCheck?: boolean;
9298
9536
  }
9299
9537
  interface IConnectResult {
9300
9538
  /**
@@ -9307,22 +9545,8 @@ interface IConnectResult {
9307
9545
  userId?: string;
9308
9546
  }
9309
9547
 
9310
- /**
9311
- * 会话聊天模块
9312
- */
9313
- interface IChatModule {
9314
- }
9315
-
9316
- /**
9317
- * 聊天室模块
9318
- */
9319
- interface IChatroomModule {
9320
- }
9321
-
9322
- interface IDataHostingModule {
9323
- }
9324
-
9325
9548
  declare class APIContext {
9549
+ #private;
9326
9550
  private static _context?;
9327
9551
  static init(options: IAPIContextOption): APIContext;
9328
9552
  /**
@@ -9340,7 +9564,7 @@ declare class APIContext {
9340
9564
  */
9341
9565
  private _pluginContextQueue;
9342
9566
  /**
9343
- * 插件实例Map,用于重复初始化时返回实例
9567
+ * 插件实例 Map,用于重复初始化时返回实例
9344
9568
  */
9345
9569
  private _pluginInstanseMap;
9346
9570
  private readonly _engine;
@@ -9360,12 +9584,6 @@ declare class APIContext {
9360
9584
  * engine 内部日志工具
9361
9585
  */
9362
9586
  readonly logger: BasicLogger;
9363
- /**
9364
- * 聊天室业务模块
9365
- */
9366
- get chatroom(): IChatroomModule;
9367
- get chat(): IChatModule;
9368
- get dataHosting(): IDataHostingModule;
9369
9587
  constructor(options: IAPIContextOption);
9370
9588
  /**
9371
9589
  * 安装使用插件,并初始化插件实例
@@ -9381,25 +9599,25 @@ declare class APIContext {
9381
9599
  * 聊天室用户加入退出多端同步消息
9382
9600
  * @since 5.7.9
9383
9601
  * 多端登录相关事件通知回调,包含三种通知 case
9384
- * 1. 多端登录情况, 一端加入聊天室, 需要通知另一终端, 指定聊天室中所有成员,包括当前加入用户
9385
- * 2. 多端登录情况, 一端退出聊天室, 需要通知另一终端, 指定聊天室中所有成员,包括当前退出用户
9386
- * 3. 用户多端加入聊天室场景: 用户在 Android 端加入聊天室, Web 端登录后又加入一个新的聊天室,
9387
- * 自动将用户从上一个聊天室踢出, 被踢出聊天室中的所有成员,包括被踢出用户
9602
+ * 1. 多端登录情况,一端加入聊天室,需要通知另一终端,指定聊天室中所有成员,包括当前加入用户
9603
+ * 2. 多端登录情况,一端退出聊天室,需要通知另一终端,指定聊天室中所有成员,包括当前退出用户
9604
+ * 3. 用户多端加入聊天室场景:用户在 Android 端加入聊天室,在 Web 端登录后又加入一个新的聊天室,
9605
+ * 自动将用户从上一个聊天室踢出,被踢出聊天室中的所有成员,包括被踢出用户
9388
9606
  * 注:case 3 如果开通了一个用户可加入多个聊天室的情况不会进行通知
9389
9607
  */
9390
9608
  private _processChrmSyncMessage;
9391
9609
  /**
9392
9610
  * @since 5.7.9
9393
- * 封禁用户相关事件通知回调, 包含两种通知 case
9611
+ * 封禁用户相关事件通知回调,包含两种通知 case
9394
9612
  * 1. 封禁用户,聊天室中所有成员,包括被封禁用户
9395
- * 注:
9613
+ * 注:
9396
9614
  * 封禁后用户被自动踢出聊天室
9397
9615
  * 封禁后用户不会再收到被踢出的通知
9398
9616
  *
9399
9617
  * 2. 解除封禁,被解除封禁的成员
9400
- * 注:
9618
+ * 注:
9401
9619
  * 用户未在线时,再登录时不会收到通知
9402
- * 服务端仅对主动解除封禁做通知,封禁时间到了,自动解除的不通知, 此刻调用加入聊天室接口可成功
9620
+ * 服务端仅对主动解除封禁做通知,封禁时间到了,自动解除的不通知,此刻调用加入聊天室接口可成功
9403
9621
  */
9404
9622
  private _processChrmMemBlockMessage;
9405
9623
  /**
@@ -9424,7 +9642,7 @@ declare class APIContext {
9424
9642
  */
9425
9643
  private _processChrmMemBanMessage;
9426
9644
  /**
9427
- * 消息处理器(v2/v4/next 版本中兼容)
9645
+ * 消息处理器(v2/v4/next 版本中兼容)
9428
9646
  * 返回 false | undefined:消息继续向上抛出,true:内部处理或转为事件回调,无需向上抛出
9429
9647
  */
9430
9648
  private _compatibleMessageProccessor;
@@ -9432,7 +9650,7 @@ declare class APIContext {
9432
9650
  private _processReadReceiptRequestMessage;
9433
9651
  private _processReadReceiptResponseMessage;
9434
9652
  /**
9435
- * 消息处理器(imlib-next 中转为事件回调, 无需抛出)
9653
+ * 消息处理器(imlib-next 中转为事件回调,无需抛出)
9436
9654
  */
9437
9655
  private _messageProccessor;
9438
9656
  private _messageReceiver;
@@ -9464,6 +9682,7 @@ declare class APIContext {
9464
9682
  private _groupMessageDeliveredStatusListerer;
9465
9683
  private _callInfoListener;
9466
9684
  private _ultraGroupEnableListener;
9685
+ private _sgRelationsSyncedListener;
9467
9686
  private _operateStatusListener;
9468
9687
  private _ultraGroupMessageExpansionUpdatedListener;
9469
9688
  private _ultraGroupMessageModifiedListener;
@@ -9509,6 +9728,7 @@ declare class APIContext {
9509
9728
  * 数据库升级完成
9510
9729
  */
9511
9730
  private _databaseUpgradeDidComplete;
9731
+ private _readReceiptResponseV5;
9512
9732
  /**
9513
9733
  * 业务层事件监听器挂载点
9514
9734
  */
@@ -9528,17 +9748,27 @@ declare class APIContext {
9528
9748
  private _typingExpireTime;
9529
9749
  private _typingChangedList;
9530
9750
  /**
9531
- * 启动定时移除typing
9751
+ * 启动定时移除 typing 信息
9532
9752
  */
9533
9753
  private _startCheckTypingInfo;
9534
9754
  private _notifyTypingChanged;
9535
9755
  getConnectedTime(): number;
9536
9756
  getServerTime(): number;
9537
9757
  getDeviceId(): string;
9758
+ /**
9759
+ * 设置推送配置 (仅 Web 端支持)
9760
+ * @param config 推送配置
9761
+ */
9762
+ setPushConfig(config: IAppPushConfig): void;
9538
9763
  getCurrentUserId(): string;
9539
9764
  getConnectionStatus(): RCConnectionStatus;
9540
9765
  /** 高阶函数,生成一个验证方法,验证是否处于连接中状态,并在连接状态可用时返回导航数据 */
9541
- get validatorConnected(): () => RCResult<INaviInfo>;
9766
+ get validateConnected(): () => RCResult<INaviInfo>;
9767
+ /**
9768
+ * 高阶函数,生成一个验证方法,验证是否处于登录状态
9769
+ * * 本地数据查询时,只需要验证用户已经登录过且未主动断开,无需校验当前连接状态
9770
+ */
9771
+ get validateLogin(): () => RCResult<INaviInfo>;
9542
9772
  get token(): string;
9543
9773
  refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
9544
9774
  /**
@@ -9555,9 +9785,8 @@ declare class APIContext {
9555
9785
  设置 reconnectKickEnable 为 true 时,SDK 重连的时候发现此时已有别的设备连接成功,不再强行踢出已有设备,而是踢出重连设备。
9556
9786
  */
9557
9787
  connect(token: string, reconnectKickEnable: boolean, traceId: string): Promise<IConnectResult>;
9558
- disconnect(closeDB?: boolean): Promise<void>;
9788
+ disconnect(closeDB?: boolean, disablePush?: boolean): Promise<void>;
9559
9789
  reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
9560
- private _getTokenWithoutNavi;
9561
9790
  /**
9562
9791
  * 超级群 channelId 转换
9563
9792
  * @param type 会话类型
@@ -9568,7 +9797,6 @@ declare class APIContext {
9568
9797
  * 获取当前缓存的导航数据
9569
9798
  */
9570
9799
  getNaviInfoFromCache(): INaviInfo | null;
9571
- private _registerMessageSearchPropsMapping;
9572
9800
  /**
9573
9801
  * 消息注册
9574
9802
  * @description 消息注册需在应用初始化完成前进行
@@ -9584,7 +9812,6 @@ declare class APIContext {
9584
9812
  * @param listener
9585
9813
  */
9586
9814
  registerRTCSignalingListener(listener?: (buffer: Uint8Array) => void): void;
9587
- checkSearchPropsMsg(messageType: string, msgContent: any): IAsyncRes;
9588
9815
  /**
9589
9816
  * 降低圈复杂度 - 将扩展验证的结果抽离
9590
9817
  * @param expansion
@@ -9606,13 +9833,13 @@ declare class APIContext {
9606
9833
  /**
9607
9834
  * 发送群组消息已读回执
9608
9835
  * 导航下发已读回执开关为 true 时调用
9609
- * @param targetId 群组会话id
9610
- * @param messageUIds 消息id
9836
+ * @param targetId 群组会话 Id
9837
+ * @param messageUIds 消息 UId
9611
9838
  */
9612
9839
  sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
9613
9840
  /**
9614
9841
  * 获取群组消息已读列表
9615
- * 已读回执目前 3 个版本 有 naviInfo.grpRRVer字段区分。
9842
+ * 已读回执目前 3 个版本 有 naviInfo.grpRRVer 字段区分。
9616
9843
  * 0:为目前有公有先支持版本,调用 sendReadReceiptResponseV2
9617
9844
  * 1. 为 v2 版本,仅供 beem 使用目前公有云已废弃
9618
9845
  * 3. 为 v4 版本,目前仅海外 IMkit 使用
@@ -9621,16 +9848,16 @@ declare class APIContext {
9621
9848
  */
9622
9849
  getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
9623
9850
  /**
9624
- * 发送已读回执(V4)
9851
+ * 发送已读回执 (V4)
9625
9852
  */
9626
9853
  sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
9627
9854
  /**
9628
- * 获取消息已读回执列表, 暂仅支持群聊(V4)
9855
+ * 获取消息已读回执列表,暂仅支持群聊 (V4)
9629
9856
  */
9630
9857
  getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
9631
9858
  batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
9632
9859
  /**
9633
- * 多端同步会话的已读时间(V4)
9860
+ * 多端同步会话的已读时间(V4
9634
9861
  */
9635
9862
  updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
9636
9863
  /**
@@ -9682,25 +9909,20 @@ declare class APIContext {
9682
9909
  hasMore: boolean;
9683
9910
  }>>;
9684
9911
  /**
9685
- * 获取会话列表
9686
- * @param count 指定获取数量, 不传则获取全部会话列表,默认 `300`
9912
+ * 查询会话列表
9687
9913
  */
9688
- getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
9914
+ getConversationListByFilter(filter: ConversationListFilter): Promise<RCResult<IReceivedConversation[]>>;
9689
9915
  /**
9690
- * 分页获取会话列表,仅 electron中使用
9691
- */
9692
- getConversationsByPage(conversationTypes: ConversationType[], startTime: number, count: number, channelId: string, topPriority: boolean): Promise<IAsyncRes<IReceivedConversation[]>>;
9693
- /**
9694
- * 获取单一会话数据
9916
+ * 从本地缓存获取单一会话数据
9695
9917
  * @param conversationType
9696
9918
  * @param targetId
9697
9919
  * @param channelId
9698
9920
  */
9699
- getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
9921
+ getConversation(conversation: IConversationOption): Promise<RCResult<IReceivedConversation>>;
9700
9922
  /**
9701
9923
  * 删除会话
9702
9924
  */
9703
- removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
9925
+ removeConversation(conversation: IConversationOption): Promise<RCResult>;
9704
9926
  batchRemoveConversation(conversations: IConversationOption[]): Promise<ErrorCode>;
9705
9927
  /**
9706
9928
  * 获取超级群会话列表
@@ -9710,10 +9932,6 @@ declare class APIContext {
9710
9932
  * 获取超级群免打扰列表
9711
9933
  */
9712
9934
  getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
9713
- /**
9714
- * 获取超级群置顶列表
9715
- */
9716
- getTopUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
9717
9935
  /**
9718
9936
  * 清除会话消息未读数
9719
9937
  */
@@ -9721,18 +9939,19 @@ declare class APIContext {
9721
9939
  /**
9722
9940
  * 清除全部会话消息未读数
9723
9941
  */
9724
- clearAllUnreadCount(): Promise<ErrorCode>;
9942
+ clearAllUnreadCount(): Promise<RCResult>;
9725
9943
  /**
9726
9944
  * 获取指定会话消息未读数
9727
9945
  */
9728
9946
  getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
9729
9947
  /**
9730
9948
  * 获取所有会话未读数
9949
+ * * 自 5.20.0 版本开始,在开启了会话列表支持超级群功能后,该接口返回的未读数包含超级群未读数
9731
9950
  * @param channelId 多组织 Id
9732
9951
  * @param conversationTypes
9733
9952
  * @param includeMuted 包含已设置免打扰的会话
9734
9953
  */
9735
- getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<IAsyncRes<number>>;
9954
+ getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<RCResult<number>>;
9736
9955
  /**
9737
9956
  * 获取会话指定免打扰级别未读消息总数
9738
9957
  * @param conversationTypes 会话类型
@@ -9745,26 +9964,9 @@ declare class APIContext {
9745
9964
  */
9746
9965
  getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<IReceivedMessage | null>>;
9747
9966
  getFirstUnreadMessageInfo(conversationType: ConversationType, targetId: string, channelId: string): Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>;
9748
- /**
9749
- * 设置会话免打扰
9750
- * 原: setConversationStatus 已废弃
9751
- * 是否免打扰
9752
- * * -1: 全部消息通知(接收全部消息通知 -- 显示指定关闭免打扰功能)
9753
- * * 0: 未设置(向上查询群或者APP级别设置)//存量数据中0表示未设置
9754
- * * 1: 群聊超级群仅@消息通知(现在通知)单聊代表全部消息通知
9755
- * * 2: @ 指定用户通知
9756
- * * 4: @ 群全员通知
9757
- * * 5: 消息通知被屏蔽,即不接收消息通知
9758
- */
9759
- setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel?: NotificationLevel, channelId?: string): Promise<ErrorCode>;
9760
- batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<ErrorCode>;
9761
- /**
9762
- * @deprecated 同时设置置顶、免打扰状态,为兼容 v2/v4 使用,v5 后不再支持
9763
- * @returns
9764
- */
9765
- setConversationStatus(conversationType: ConversationType, targetId: string, isTop?: boolean, notificationStatus?: 1 | 2, channelId?: string, isUpdateTime?: boolean): Promise<ErrorCode>;
9766
- setConversationToTop(conversationType: ConversationType, targetId: string, isTop: boolean, channelId: string, isUpdateTime: boolean): Promise<ErrorCode>;
9767
- batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<ErrorCode>;
9967
+ batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<RCResult>;
9968
+ /** 批量设置会话置顶 */
9969
+ batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isUpdateTime?: boolean, isCreateConversation?: boolean): Promise<RCResult>;
9768
9970
  saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string, channelId?: string): Promise<ErrorCode>;
9769
9971
  getConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<string>>;
9770
9972
  clearConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
@@ -9783,18 +9985,17 @@ declare class APIContext {
9783
9985
  * @param targetId
9784
9986
  * @param list
9785
9987
  */
9786
- deleteRemoteMessage(conversationType: ConversationType, targetId: string, list: {
9988
+ deleteRemoteMessage(conversation: IConversationOption, messages: {
9787
9989
  messageUId: string;
9788
9990
  sentTime: number;
9789
9991
  messageDirection: MessageDirection;
9790
- }[], channelId?: string): Promise<ErrorCode>;
9992
+ }[]): Promise<RCResult>;
9791
9993
  /**
9792
9994
  * 根据时间戳删除指定时间之前的
9793
- * @param conversationType
9794
- * @param targetId
9795
- * @param timestamp
9995
+ * @param identifier 会话信息
9996
+ * @param timestamp 时间戳
9796
9997
  */
9797
- deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<ErrorCode>;
9998
+ deleteRemoteMessageByTimestamp(identifier: IConversationOption, timestamp: number): Promise<RCResult>;
9798
9999
  /**
9799
10000
  * 加入聊天室,若聊天室不存在则创建聊天室
9800
10001
  * @param roomId 聊天室房间 Id
@@ -9878,7 +10079,7 @@ declare class APIContext {
9878
10079
  /**
9879
10080
  * 拉取聊天室内的历史消息
9880
10081
  * @param roomId
9881
- * @param count 拉取消息条数, 有效值范围 `1 - 20`
10082
+ * @param count 拉取消息条数,有效值范围 `1 - 20`
9882
10083
  * @param order 获取顺序,默认值为 0。
9883
10084
  * * 0:降序,用于获取早于指定时间戳发送的消息
9884
10085
  * * 1:升序,用于获取晚于指定时间戳发送的消息
@@ -9904,7 +10105,7 @@ declare class APIContext {
9904
10105
  * @param queryString STC 分段上传时的查询字符串
9905
10106
  * @description
9906
10107
  * `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
9907
- * 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`, `queryString` 值为 `uploads`
10108
+ * 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
9908
10109
  * 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
9909
10110
  * 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
9910
10111
  * @returns
@@ -9930,7 +10131,7 @@ declare class APIContext {
9930
10131
  createTag(tag: ITagParam): Promise<IAsyncRes>;
9931
10132
  /**
9932
10133
  * 删除标签
9933
- * @param tagId 标签id
10134
+ * @param tagId 标签 Id
9934
10135
  */
9935
10136
  removeTag(tagId: string): Promise<IAsyncRes>;
9936
10137
  /**
@@ -9944,31 +10145,31 @@ declare class APIContext {
9944
10145
  getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
9945
10146
  /**
9946
10147
  * 添加会话到标签(给多个会话增加标签)
9947
- * @param tagId 标签id
10148
+ * @param tagId 标签 Id
9948
10149
  * @param conversations 要添加的会话列表
9949
10150
  */
9950
10151
  addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes>;
9951
10152
  /**
9952
- * 删除标签中的会话(从多个会话中批量删除指定标签)
9953
- * @param tagId 标签id
10153
+ * 删除标签中的会话(从多个会话中批量删除指定标签)
10154
+ * @param tagId 标签 Id
9954
10155
  * @param conversations 要删除的会话列表
9955
10156
  */
9956
10157
  removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes>;
9957
10158
  /**
9958
- * 删除会话中的标签(从单一会话中批量删除标签)
10159
+ * 删除会话中的标签(从单一会话中批量删除标签)
9959
10160
  * @param conversationType 会话类型
9960
- * @param targetId 会话id
10161
+ * @param targetId 会话 Id
9961
10162
  * @param tagIds 要删除的标签列表
9962
10163
  */
9963
10164
  removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes>;
9964
10165
  /**
9965
10166
  * 获取标签下的会话列表
9966
- * @param tagId 标签id
10167
+ * @param tagId 标签 Id
9967
10168
  */
9968
10169
  getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
9969
10170
  /**
9970
10171
  * 获取标签下的未读消息数
9971
- * @param tagId 标签id
10172
+ * @param tagId 标签 Id
9972
10173
  * @param containMuted 是否包含免打扰会话
9973
10174
  */
9974
10175
  getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
@@ -9984,19 +10185,7 @@ declare class APIContext {
9984
10185
  * @param conversation
9985
10186
  */
9986
10187
  getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
9987
- /**
9988
- * 获取所有本地免打扰列表
9989
- */
9990
- getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
9991
- /**
9992
- * 获取所有本地置顶列表
9993
- */
9994
- getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
9995
- /**
9996
- * 获取未读会话列表
9997
- */
9998
- getUnreadConversationList(conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
9999
- getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
10188
+ getUnreadMentionedCount(conversation: IConversationOption): Promise<RCResult<number>>;
10000
10189
  /**
10001
10190
  * 获取所有群聊会话 @ 消息未读数
10002
10191
  */
@@ -10041,7 +10230,6 @@ declare class APIContext {
10041
10230
  * @returns 未读数
10042
10231
  */
10043
10232
  getAllUltraGroupUnreadCount(isMentioned?: boolean): Promise<IAsyncRes<number>>;
10044
- getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
10045
10233
  /**
10046
10234
  * 超级群类型获取未读 @ 消息列表
10047
10235
  * @param options
@@ -10159,7 +10347,7 @@ declare class APIContext {
10159
10347
  * 通过时间戳批量清除本地消息
10160
10348
  */
10161
10349
  batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
10162
- batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<ErrorCode>;
10350
+ batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<RCResult>;
10163
10351
  /**
10164
10352
  * 清空会话下历史消息
10165
10353
  */
@@ -10205,7 +10393,7 @@ declare class APIContext {
10205
10393
  getUserStatus(userId: string): Promise<IAsyncRes<{
10206
10394
  status: string;
10207
10395
  }>>;
10208
- searchConversationByContent(keyword: string, customMessageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
10396
+ searchConversationByContent(keyword: string, messageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
10209
10397
  searchConversationByContentWithAllChannel(keyword: string, customMessageTypes?: string[], conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
10210
10398
  searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId?: string): Promise<IAsyncRes<{
10211
10399
  messages: IReceivedMessage[];
@@ -10242,20 +10430,14 @@ declare class APIContext {
10242
10430
  setUltraGroupDefaultNotificationLevel(targetId: string, notificationLevel: NotificationLevel, channelId?: string): Promise<IAsyncRes<void>>;
10243
10431
  /**
10244
10432
  * 获取会话免打扰状态
10245
- */
10246
- getConversationNotificationLevel(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<NotificationLevel>>;
10247
- setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<IAsyncRes<void>>;
10248
- getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<IAsyncRes<NotificationLevel>>;
10249
- /**
10250
- * 获取会话免打扰状态
10251
- */
10252
- getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<NotificationStatus>>;
10433
+ */
10434
+ getConversationNotificationLevel(conversation: IConversationOption): Promise<RCResult<NotificationLevel>>;
10435
+ setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<RCResult>;
10436
+ getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<RCResult<NotificationLevel>>;
10253
10437
  getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): Promise<IAsyncRes<{
10254
10438
  list: IReceivedMessage[];
10255
10439
  hasMore: boolean;
10256
10440
  }>>;
10257
- getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
10258
- getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
10259
10441
  clearData(): Promise<IAsyncRes<boolean>>;
10260
10442
  createLogger(id: string, type: LogType): BasicLogger;
10261
10443
  getConversations(conversationList: IConversationOption[]): Promise<IAsyncRes<IReceivedConversation[]>>;
@@ -10273,7 +10455,7 @@ declare class APIContext {
10273
10455
  }>;
10274
10456
  rtcPing(roomId: string, mode: number, mediaType?: number): Promise<IAsyncRes<any>>;
10275
10457
  /**
10276
- * SDK设置聊天室关联的rtc房间
10458
+ * SDK 设置聊天室关联的 RTC 房间
10277
10459
  */
10278
10460
  bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<ErrorCode>;
10279
10461
  /**
@@ -10355,6 +10537,14 @@ declare class APIContext {
10355
10537
  setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
10356
10538
  removeNotificationQuietHoursSetting(): Promise<RCResult>;
10357
10539
  getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
10540
+ /**
10541
+ * 获取统计地址
10542
+ */
10543
+ getStatsUrlList(): Promise<RCResult<string[]>>;
10544
+ sendReadReceiptResponseV5(conId: IConversationOption, messageUIdArray: string[]): Promise<RCResult>;
10545
+ getMessageReadReceiptInfoV5(conId: IConversationOption, messageUIdArray: Array<string>): Promise<RCResult<ReadReceiptInfoV5[]>>;
10546
+ getMessagesReadReceiptUsersByPageV5(conId: IConversationOption, messageUId: string, option: ReadReceiptUsersOption): Promise<RCResult<ReadReceiptUsersResult>>;
10547
+ getMessagesReadReceiptByUsersV5(conId: IConversationOption, messageUId: string, userList: Array<string>): Promise<RCResult<ReadReceiptUsersResult>>;
10358
10548
  }
10359
10549
 
10360
10550
  declare class RTCPluginContext extends PluginContext {
@@ -10556,6 +10746,11 @@ declare class RTCPluginContext extends PluginContext {
10556
10746
  getRTCJoinedUserInfo(userId: string): IPromiseResult<IRTCJoinedInfo[]>;
10557
10747
  }
10558
10748
 
10749
+ /**
10750
+ * 会话聊天模块
10751
+ */
10752
+ declare type IChatModule = Pick<IIPCMethods, 'getConversationListByFilter' | 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent'>;
10753
+
10559
10754
  declare abstract class BasicEngine {
10560
10755
  protected readonly rtcCodec: Codec<InnerRTCKeyMaps>;
10561
10756
  protected readonly _watcher: IEngineWatcher;
@@ -10567,18 +10762,10 @@ declare abstract class BasicEngine {
10567
10762
  abstract getConnectedTime(): number;
10568
10763
  protected readonly _appkey: string;
10569
10764
  private _rtcKVManager;
10570
- /**
10571
- * 聊天室业务模块
10572
- */
10573
- abstract get chatroom(): IChatroomModule;
10574
10765
  /**
10575
10766
  * 会话聊天模块
10576
10767
  */
10577
10768
  abstract get chat(): IChatModule;
10578
- /**
10579
- * 数据托管模块
10580
- */
10581
- abstract get dataHosting(): IDataHostingModule;
10582
10769
  /**
10583
10770
  * 引擎初始化
10584
10771
  * @param _appkey
@@ -10622,7 +10809,7 @@ declare abstract class BasicEngine {
10622
10809
  */
10623
10810
  abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
10624
10811
  /**
10625
- * 发送SDK版本
10812
+ * 发送 SDK 版本
10626
10813
  * @param versionInfo
10627
10814
  */
10628
10815
  abstract reportSDKInfo(versionInfo: {
@@ -10659,7 +10846,7 @@ declare abstract class BasicEngine {
10659
10846
  hasMore: boolean;
10660
10847
  }>;
10661
10848
  /**
10662
- * 获取历史消息(pc 端支持断档补偿, web 端同 getHistoryMessage)
10849
+ * 获取历史消息 (pc 端支持断档补偿,web 端同 getHistoryMessage)
10663
10850
  * @param conversationType
10664
10851
  * @param targetId
10665
10852
  * @param timestamp
@@ -10696,86 +10883,15 @@ declare abstract class BasicEngine {
10696
10883
  list: IReceivedMessage[];
10697
10884
  hasMore: boolean;
10698
10885
  }>>;
10699
- /**
10700
- * 删除历史消息 通过 messageUId
10701
- */
10702
- abstract deleteRemoteMessage(conversationType: ConversationType, targetId: string,
10703
- /**
10704
- * @description
10705
- * message 中 messageUId、setTime、messageDirection 为必须参数
10706
- */
10707
- messages: {
10708
- messageUId: string;
10709
- sentTime: number;
10710
- messageDirection: MessageDirection;
10711
- }[],
10712
- /**
10713
- * 会话的业务标识
10714
- */
10715
- channelId: string): Promise<ErrorCode>;
10716
10886
  abstract recallMsg(conversation: IConversationOption, recallMsgOptions: IRecallMsgOptions): Promise<RCResult<IReceivedMessage>>;
10717
- /**
10718
- * 删除历史消息 通过 时间戳
10719
- * @param timestamp 小于等于传入时间戳的消息均删除
10720
- */
10721
- abstract deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number,
10722
- /**
10723
- * 会话的业务标识
10724
- */
10725
- channelId: string): Promise<ErrorCode>;
10726
- /**
10727
- * 获取会话列表
10728
- * @param count 指定获取数量, 不传则获取全部会话列表,默认 `300`
10729
- */
10730
- abstract getConversationList(
10731
- /**
10732
- * 拉取数量, 有效值 0 - 1000, 默认 300
10733
- */
10734
- count: number,
10735
- /**
10736
- * 会话类型
10737
- * @todo 待确认是否生效
10738
- */
10739
- conversationType?: ConversationType,
10740
- /**
10741
- * 起始时间
10742
- */
10743
- startTime?: number,
10744
- /**
10745
- * 获取顺序
10746
- */
10747
- order?: 0 | 1,
10748
- /**
10749
- * 会话的业务标识
10750
- */
10751
- channelId?: string): IPromiseResult<IReceivedConversation[]>;
10752
- /**
10753
- * 分页获取会话列表,仅 electron中使用
10754
- */
10755
- abstract getConversationsByPage(conversationTypes: ConversationType[], startTime: number, count: number, channelId: string, topPriority: boolean): IPromiseResult<IReceivedConversation[]>;
10756
- /**
10757
- * 获取指定会话
10758
- */
10759
- abstract getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
10760
- /**
10761
- * 获取未读会话列表
10762
- */
10763
- abstract getUnreadConversationList(conversationTypes: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
10764
10887
  /**
10765
10888
  * 删除会话
10766
10889
  * @description 该删除操作会删除服务器端存储的会话数据
10767
10890
  * @param conversationType
10768
10891
  * @param targetId
10769
10892
  */
10770
- abstract removeConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
10893
+ abstract removeConversation(conversation: IConversationOption): Promise<RCResult>;
10771
10894
  abstract batchRemoveConversation(conversations: IConversationOption[]): Promise<ErrorCode>;
10772
- /**
10773
- * 获取所有会话未读数
10774
- * @param channelId 多组织 Id
10775
- * @param conversationTypes
10776
- * @param includeMuted 包含已设置免打扰的会话
10777
- */
10778
- abstract getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
10779
10895
  /**
10780
10896
  * 获取会话指定免打扰级别的未读总数
10781
10897
  */
@@ -10788,10 +10904,6 @@ declare abstract class BasicEngine {
10788
10904
  * 清除指定会话未读数
10789
10905
  */
10790
10906
  abstract clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
10791
- /**
10792
- * 清除全部会话未读数
10793
- */
10794
- abstract clearAllUnreadCount(): Promise<ErrorCode>;
10795
10907
  /**
10796
10908
  * 获取第一个未读消息
10797
10909
  */
@@ -10810,16 +10922,6 @@ declare abstract class BasicEngine {
10810
10922
  * 清除指定会话消息草稿
10811
10923
  */
10812
10924
  abstract clearConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
10813
- /**
10814
- * 从服务端拉取会话状态
10815
- */
10816
- abstract pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
10817
- /**
10818
- * 批量设置会话 置顶、免打扰
10819
- */
10820
- abstract batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
10821
- abstract setConversationToTop(conversationType: ConversationType, targetId: string, isTop: boolean, channelId: string, isUpdateTime: boolean): Promise<ErrorCode>;
10822
- abstract batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<ErrorCode>;
10823
10925
  abstract sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions,
10824
10926
  /**
10825
10927
  * c++ 消息写库后存在自增 Id,必要时需要向业务层暴露,JSEngine 无需实现
@@ -10839,26 +10941,27 @@ declare abstract class BasicEngine {
10839
10941
  */
10840
10942
  abstract getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
10841
10943
  /**
10842
- * 发送已读回执(V4)
10944
+ * 发送已读回执 (V4)
10843
10945
  */
10844
10946
  abstract sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
10845
10947
  /**
10846
- * 获取消息已读回执列表, 暂仅支持群聊(V4)
10948
+ * 获取消息已读回执列表,暂仅支持群聊 (V4)
10847
10949
  */
10848
10950
  abstract getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
10849
10951
  /**
10850
- * 批量获取消息已读回执信息, 暂仅支持群聊(V4)
10952
+ * 批量获取消息已读回执信息,暂仅支持群聊 (V4)
10851
10953
  */
10852
10954
  abstract batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
10853
10955
  /**
10854
- * 多端同步会话的已读时间(V4)
10956
+ * 多端同步会话的已读时间 (V4)
10855
10957
  */
10856
10958
  abstract updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
10857
10959
  /**
10858
10960
  * 断开连接
10859
10961
  * @param closeDB 是否关闭数据库,默认为 true,仅 Electron 平台有效
10962
+ * @param disablePush 是否禁用推送,默认为 false(≥ 5.20.0)
10860
10963
  */
10861
- abstract disconnect(closeDB?: boolean): Promise<void>;
10964
+ abstract disconnect(closeDB?: boolean, disablePush?: boolean): Promise<void>;
10862
10965
  /**
10863
10966
  * 获取当前连接状态
10864
10967
  */
@@ -10866,15 +10969,9 @@ declare abstract class BasicEngine {
10866
10969
  /**
10867
10970
  * 消息注册
10868
10971
  * @description
10869
- * 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,
10870
- * 本端发出的消息将不默认作为未知消息处理,不存储、不计数
10871
- * @param objectName 消息类型,如:RC:TxtMsg
10872
- * @param isPersited 是否存储
10873
- * @param isCounted 是否技术
10874
- * @param searchProps 搜索字段,只在搭配协议栈使用时有效
10875
- * @param isStatusMessage 是否是状态消息
10972
+ * 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
10876
10973
  */
10877
- abstract registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[], isStatusMessage: boolean): void;
10974
+ abstract registerMessageType(objectName: string, desc: MessageRegisterParams): void;
10878
10975
  /**
10879
10976
  * 加入聊天室
10880
10977
  * @param count 拉取消息数量
@@ -10891,8 +10988,8 @@ declare abstract class BasicEngine {
10891
10988
  abstract quitChatroom(chatroomId: string): Promise<ErrorCode>;
10892
10989
  /**
10893
10990
  * 获取聊天室信息
10894
- * @param count 获取人数, 范围 0 - 20
10895
- * @param order 排序方式, 1 正序, 2 倒序
10991
+ * @param count 获取人数,范围 0 - 20
10992
+ * @param order 排序方式,1 正序,2 倒序
10896
10993
  */
10897
10994
  abstract getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
10898
10995
  /**
@@ -10950,7 +11047,7 @@ declare abstract class BasicEngine {
10950
11047
  * @param queryString STC 分段上传时的查询字符串
10951
11048
  * @description
10952
11049
  * `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
10953
- * 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`, `queryString` 值为 `uploads`
11050
+ * 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
10954
11051
  * 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
10955
11052
  * 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
10956
11053
  * @returns
@@ -10974,7 +11071,7 @@ declare abstract class BasicEngine {
10974
11071
  abstract createTag(tag: ITagParam): IPromiseResult;
10975
11072
  /**
10976
11073
  * 删除标签
10977
- * @param tagId 标签id
11074
+ * @param tagId 标签 id
10978
11075
  */
10979
11076
  abstract removeTag(tagId: string): IPromiseResult;
10980
11077
  /**
@@ -10988,31 +11085,31 @@ declare abstract class BasicEngine {
10988
11085
  abstract getTagList(): IPromiseResult<Array<ITagInfo>>;
10989
11086
  /**
10990
11087
  * 添加会话到标签(给多个会话增加标签)
10991
- * @param tagId 标签id
11088
+ * @param tagId 标签 id
10992
11089
  * @param conversations 要添加的会话列表
10993
11090
  */
10994
11091
  abstract addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
10995
11092
  /**
10996
- * 删除标签中的会话(从多个会话中批量删除指定标签)
10997
- * @param tagId 标签id
11093
+ * 删除标签中的会话 (从多个会话中批量删除指定标签)
11094
+ * @param tagId 标签 id
10998
11095
  * @param conversations 要删除的会话列表
10999
11096
  */
11000
11097
  abstract removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
11001
11098
  /**
11002
- * 删除会话中的标签(从单一会话中批量删除标签)
11099
+ * 删除会话中的标签 (从单一会话中批量删除标签)
11003
11100
  * @param conversationType 会话类型
11004
- * @param targetId 会话id
11101
+ * @param targetId 会话 id
11005
11102
  * @param tagIds 要删除的标签列表
11006
11103
  */
11007
11104
  abstract removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult;
11008
11105
  /**
11009
11106
  * 获取标签下的会话列表
11010
- * @param tagId 标签id
11107
+ * @param tagId 标签 id
11011
11108
  */
11012
11109
  abstract getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
11013
11110
  /**
11014
11111
  * 获取标签下的未读消息数
11015
- * @param tagId 标签id
11112
+ * @param tagId 标签 id
11016
11113
  * @param containMuted 是否包含免打扰会话
11017
11114
  */
11018
11115
  abstract getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
@@ -11031,9 +11128,14 @@ declare abstract class BasicEngine {
11031
11128
  */
11032
11129
  abstract getServerTime(): number;
11033
11130
  /**
11034
- * 获取设备ID
11131
+ * 获取设备 ID
11035
11132
  */
11036
11133
  abstract getDeviceId(): string;
11134
+ /**
11135
+ * 设置推送配置
11136
+ * @param config 推送配置
11137
+ */
11138
+ abstract setPushConfig(config: IAppPushConfig): void;
11037
11139
  /**
11038
11140
  * 获取当前 userId
11039
11141
  */
@@ -11046,10 +11148,6 @@ declare abstract class BasicEngine {
11046
11148
  * 获取超级群免打扰列表
11047
11149
  */
11048
11150
  abstract getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
11049
- /**
11050
- * 获取超级群置顶列表
11051
- */
11052
- abstract getTopUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
11053
11151
  /**
11054
11152
  * 上报超级群会话已读时间
11055
11153
  * @param targetId
@@ -11117,8 +11215,6 @@ declare abstract class BasicEngine {
11117
11215
  * @param targetIds
11118
11216
  */
11119
11217
  abstract getUltraGroupUnreadInfoList(targetIds: string[]): Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>;
11120
- abstract getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
11121
- abstract getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
11122
11218
  /**
11123
11219
  * 设置用户在线状态监听器
11124
11220
  */
@@ -11185,7 +11281,6 @@ declare abstract class BasicEngine {
11185
11281
  * 通过时间戳批量清除本地消息
11186
11282
  */
11187
11283
  abstract batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
11188
- abstract batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<ErrorCode>;
11189
11284
  /**
11190
11285
  * 清空会话下历史消息
11191
11286
  */
@@ -11202,10 +11297,6 @@ declare abstract class BasicEngine {
11202
11297
  * 设置消息搜索字段
11203
11298
  */
11204
11299
  abstract setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
11205
- /**
11206
- * 通过关键字搜索会话
11207
- */
11208
- abstract searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
11209
11300
  /**
11210
11301
  * 通过关键字搜索所有会话
11211
11302
  */
@@ -11222,7 +11313,7 @@ declare abstract class BasicEngine {
11222
11313
  count: number;
11223
11314
  }>;
11224
11315
  /**
11225
- * 按用户ID搜索会话内的消息
11316
+ * 按用户 ID 搜索会话内的消息
11226
11317
  */
11227
11318
  abstract searchMessagesByUser(conversationType: ConversationType, targetId: string, userId: string, timestamp: number, count: number, channelId: string): IPromiseResult<{
11228
11319
  messages: IReceivedMessage[];
@@ -11272,20 +11363,6 @@ declare abstract class BasicEngine {
11272
11363
  * 查询指定超级群默认通知配置
11273
11364
  */
11274
11365
  abstract getUltraGroupDefaultNotificationLevel(targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
11275
- /**
11276
- * 获取会话免打扰状态
11277
- * @deprecated 已废弃,请使用 getConversationNotificationLevel
11278
- */
11279
- abstract getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
11280
- abstract setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel?: NotificationLevel, channelId?: string): Promise<ErrorCode>;
11281
- abstract batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<ErrorCode>;
11282
- /**
11283
- * 获取会话免打扰状态
11284
- * 旧:getConversationNotificationStatus
11285
- */
11286
- abstract getConversationNotificationLevel(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
11287
- abstract setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<IAsyncRes<void>>;
11288
- abstract getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<IAsyncRes<NotificationLevel>>;
11289
11366
  /**
11290
11367
  * 协议栈获取远端历史消息
11291
11368
  */
@@ -11305,26 +11382,14 @@ declare abstract class BasicEngine {
11305
11382
  key: string;
11306
11383
  value: string;
11307
11384
  }>;
11308
- /**
11309
- * 无差别获取本地免打扰列表
11310
- */
11311
- abstract getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
11312
- /**
11313
- * 无差别获取本地置顶列表
11314
- */
11315
- abstract getTopConversationList(conversationTypes: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
11316
11385
  /**
11317
11386
  * 获取单个群聊会话 @ 消息未读数
11318
11387
  */
11319
- abstract getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
11388
+ abstract getUnreadMentionedCount(conversation: IConversationOption): Promise<RCResult<number>>;
11320
11389
  /**
11321
11390
  * 获取所有群聊会话 @ 消息未读数
11322
11391
  */
11323
11392
  abstract getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
11324
- /**
11325
- * 获取本地全部会话的状态
11326
- */
11327
- abstract getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
11328
11393
  abstract clearData(): Promise<IAsyncRes<boolean>>;
11329
11394
  /**
11330
11395
  * 超级群获取指定会话未读 @ 消息列表
@@ -11369,7 +11434,7 @@ declare abstract class BasicEngine {
11369
11434
  abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
11370
11435
  pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<IAsyncRes<number>>;
11371
11436
  /**
11372
- * 设置聊天室关联的rtc房间
11437
+ * 设置聊天室关联的 rtc 房间
11373
11438
  */
11374
11439
  abstract bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<ErrorCode>;
11375
11440
  /**
@@ -11484,6 +11549,10 @@ declare abstract class BasicEngine {
11484
11549
  abstract setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
11485
11550
  abstract removeNotificationQuietHoursSetting(): Promise<RCResult>;
11486
11551
  abstract getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
11552
+ /**
11553
+ * 获取统计地址
11554
+ */
11555
+ abstract getStatsUrlList(): Promise<RCResult<string[]>>;
11487
11556
  }
11488
11557
 
11489
11558
  /**
@@ -11546,6 +11615,15 @@ declare class SSEModule extends EventDispatcher<{
11546
11615
  requestStreamMessageContent(messageUId: string): Promise<RCResult>;
11547
11616
  }
11548
11617
 
11618
+ /**
11619
+ * 聊天室模块
11620
+ */
11621
+ interface IChatroomModule {
11622
+ }
11623
+
11624
+ interface IDataHostingModule {
11625
+ }
11626
+
11549
11627
  /**
11550
11628
  * 错误码映射表,单个标签且对应唯一错误码
11551
11629
  */
@@ -11649,7 +11727,7 @@ interface IErrorCodeKey {
11649
11727
  }
11650
11728
 
11651
11729
  /**
11652
- * 预定义的验证规则,只包含`值类型`数据验证
11730
+ * 预定义的验证规则,只包含 `值类型` 数据验证
11653
11731
  * 引用类型数据需使用自定义 validator 校验函数进行校验
11654
11732
  */
11655
11733
  declare enum AssertRules {
@@ -11690,7 +11768,7 @@ declare enum AssertRules {
11690
11768
  */
11691
11769
  CONVERSATION = 8,
11692
11770
  /**
11693
- * 会话类型验证, 必须为 ConversationType
11771
+ * 会话类型验证,必须为 ConversationType
11694
11772
  */
11695
11773
  CONVERSATION_TYPE = 9
11696
11774
  }
@@ -11835,4 +11913,4 @@ declare class AppStorage {
11835
11913
  }): void;
11836
11914
  }
11837
11915
 
11838
- export { APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BasicEngine, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationType, DirectionType, EnableLogL, ErrorCode, EventEmitter, FileType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupOperationRole, GroupOperationStatus, GroupOperationType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatModule, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomModule, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IConversationUnreadCount, ICreateGroupFail, IDataHostingModule, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEngine, IEngineWatcher, IErrorKeys, IEventListener, IExpansionListener, IExpansionListenerData, IExtraMethod, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHarmonyOSPushConfig, IInsertMessage, IInsertMsgOptions, ILocalTagStatus, ILogData, ILogger, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, INaviInfo, INetwork, INotificationQuietHoursSetting, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessCode, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRuntime, ISendMsgOptions, IServerConversationStatus, IServerGroupBaseInfo, IServerUserSetting, ISetConversationStatusOptions, IStorage, IStreamMessageResponseChunkData, IStreamMessageResponseEventData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IWatcher, IiOSPushConfig, InnerRTCKeyMaps, InterruptionLevel, ItypingStateListener, KVString, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Codec$1 as PBCodec, PlatformInfo, PluginContext, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, RTCApiType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, SSEModule, SentStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, SuspendablePromise, UPLOAD_FILE_CHUNK_SIZE, UUId, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, Validator, ValidatorManage, VersionManage, assert, fail, fixUrlProtocol, forEach, getUUID, getUUID22, httpRequest, isArray, isBoolean, isFunction, isHttpUrl, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isString, isUndefined, isValidConversation, isValidConversationType, isValidEnum, isValidFileType, isValidGroupId, isValidNotificationLevel, isValidTargetId, logger, map, notEmptyArray, notEmptyObject, notEmptyString, ok, runtime, transformNotificationLevel, transformNotificationStatus, transformReceivedStatusFlag, transformReceivedStatusInfo, usingCppEngine, validate };
11916
+ export { APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BasicEngine, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationListFilter, ConversationListFilterType, ConversationType, DirectionType, EnableLogL, ErrorCode, EventEmitter, FileType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GetAllConversationListFilterParams, GetConversationListByPageIndexParams, GetConversationListByTimestampParams, GetConversationListResponse, GetTopConversationListParams, GetUnreadConversationListParams, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupOperationRole, GroupOperationStatus, GroupOperationType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAppPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatModule, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomModule, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IConversationUnreadCount, ICreateGroupFail, IDataHostingModule, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEngineWatcher, IErrorKeys, IEventListener, IExpansionListener, IExpansionListenerData, IExtraMethod, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHarmonyOSPushConfig, IIPCMethods, IInsertMessage, IInsertMsgOptions, ILocalTagStatus, ILogData, ILogger, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, INaviInfo, INetwork, INotificationQuietHoursSetting, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessCode, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRuntime, ISendMsgOptions, IServerGroupBaseInfo, IStorage, IStreamMessageResponseChunkData, IStreamMessageResponseEventData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IWatcher, IiOSPushConfig, InnerRTCKeyMaps, InterruptionLevel, ItypingStateListener, KVString, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_UPLOAD_FILE_SIZE, MentionedInfo, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageRegisterParams, MessageType, MessageTypeDescription, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Codec$1 as PBCodec, PlatformInfo, PluginContext, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, RTCApiType, RTCJoinType, RTCMode, RTCPluginContext, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, SSEModule, SentStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, SuspendablePromise, UPLOAD_FILE_CHUNK_SIZE, UUId, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, Validator, ValidatorManage, VersionManage, assert, fail, fixUrlProtocol, forEach, getMessageTypeDescription, getUUID, getUUID22, hasMessageTypeDescription, httpRequest, isArray, isBoolean, isFunction, isHttpUrl, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isString, isUndefined, isValidConversation, isValidConversationType, isValidEnum, isValidFileType, isValidGroupId, isValidNotificationLevel, isValidTargetId, logger, map, notEmptyArray, notEmptyObject, notEmptyString, ok, runtime, trans2IReceivedStatusInfo, trans2NotificationLevel, trans2NotificationStatus, transformReceivedStatusFlag, usingCppEngine, validate };