@rongcloud/engine 5.20.0-c-unikit.1 → 5.20.0-enterprise-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs +1 -1
- package/index.cjs.js +1 -1
- package/index.d.ts +1071 -1047
- package/index.esm.js +1 -1
- package/index.mjs +1 -1
- package/package.json +1 -4
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,230 @@ declare enum UploadMethod {
|
|
|
29
29
|
/**
|
|
30
30
|
* IMLib 埋点日志 Id 枚举
|
|
31
31
|
*/
|
|
32
|
-
declare
|
|
33
|
-
L_IMSDK_VER_O
|
|
34
|
-
A_INIT_REPEAT_O
|
|
35
|
-
L_INIT_O
|
|
36
|
-
A_DESTROY_O
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
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
|
|
56
|
+
readonly A_MSG_LISTENER_E: "A-MSG_LISTENER-E";
|
|
55
57
|
/**
|
|
56
58
|
* @deprecated
|
|
57
59
|
* 用于保留迁移前的日志,后续删除
|
|
58
60
|
*/
|
|
59
|
-
O
|
|
61
|
+
readonly O: "L-original-O";
|
|
60
62
|
/**
|
|
61
63
|
* 测试日志,不入库,因此不需要关注 TAG,避免调试 TAG 膨胀
|
|
62
64
|
*/
|
|
63
|
-
T
|
|
65
|
+
readonly T: "L-TEST-O";
|
|
64
66
|
/** 插件安装 */
|
|
65
|
-
L_INSTALL_PLUGIN_T
|
|
67
|
+
readonly L_INSTALL_PLUGIN_T: "L-INSTALL_PLUGIN-T";
|
|
66
68
|
/** 插件安装结果 */
|
|
67
|
-
L_INSTALL_PLUGIN_R
|
|
69
|
+
readonly L_INSTALL_PLUGIN_R: "L-INSTALL_PLUGIN-R";
|
|
68
70
|
/** navi 配置错误 */
|
|
69
|
-
L_NAVI_CONF_E
|
|
71
|
+
readonly L_NAVI_CONF_E: "L-NAVI_CONF_ERROR-E";
|
|
70
72
|
/** CMP 地址 */
|
|
71
|
-
L_NAVI_CMP_R
|
|
72
|
-
A_SEND_MSG_T
|
|
73
|
-
A_SEND_MSG_R
|
|
74
|
-
L_SEND_MSG_T
|
|
75
|
-
L_SEND_MSG_R
|
|
76
|
-
L_PULL_MSG_T
|
|
77
|
-
L_PULL_MSG_R
|
|
78
|
-
L_PULL_MSG_E
|
|
79
|
-
L_PULL_MSG_O
|
|
80
|
-
L_PULL_ULTRA_MSG_T
|
|
81
|
-
L_PULL_ULTRA_MSG_R
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
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
|
|
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
|
|
94
|
-
A_DELETE_MESSAGES_S
|
|
95
|
-
P_DELETE_MSG_S
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
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
|
|
152
|
-
L_PB_DECODE_E
|
|
153
|
-
L_NOTIFY_NAVI_CHANGE_E
|
|
154
|
-
L_REPORT_FULL_LOG_O
|
|
155
|
-
L_REPORT_FULL_LOG_T
|
|
156
|
-
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
|
|
158
|
+
readonly L_REPORT_LOG_POLICY_E: "L-parse_navi_logpolicy-E";
|
|
159
159
|
/** 运行时环境不支持 IndexDB */
|
|
160
|
-
L_UNSUPPORT_INDEXDB_O
|
|
161
|
-
L_LOGDB_OPEN_FAILED_E
|
|
162
|
-
L_LOGDB_CLOSED_S
|
|
163
|
-
L_LOGDB_ERROR_E
|
|
164
|
-
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
|
|
170
|
-
/**
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
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
|
|
175
|
+
readonly L_VER_REPORT_T: "L-VER_REPORT-T";
|
|
181
176
|
/** 版本号上报结果 */
|
|
182
|
-
L_VER_REPORT_R
|
|
177
|
+
readonly L_VER_REPORT_R: "L-VER_REPORT-R";
|
|
183
178
|
/** 跨进程阻塞调用 */
|
|
184
|
-
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
|
|
187
|
-
A_SET_MSG_CONTENT_O
|
|
188
|
-
A_REMOVE_PROXY_O
|
|
189
|
-
A_SET_PROXY_O
|
|
190
|
-
A_TEST_PROXY_O
|
|
191
|
-
|
|
192
|
-
|
|
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
|
|
197
|
-
L_GET_STATIC_CONF_R
|
|
198
|
-
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
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
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
|
|
212
|
-
L_PULL_SUBSCRIBED_USER_RELATION_T
|
|
213
|
-
L_PULL_SUBSCRIBED_USER_RELATION_R
|
|
214
|
-
L_PULL_SUBSCRIBED_USER_STATUS_T
|
|
215
|
-
L_PULL_SUBSCRIBED_USER_STATUS_R
|
|
216
|
-
L_OWN_USER_PROFILE_CHANGED_S
|
|
217
|
-
L_QUERY_SUBSCRIBE_DATA_T
|
|
218
|
-
L_QUERY_SUBSCRIBE_DATA_R
|
|
219
|
-
L_PULL_USER_PROFILE_T
|
|
220
|
-
L_PULL_USER_PROFILE_R
|
|
221
|
-
L_PULL_OWN_PROFILE_T
|
|
222
|
-
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
|
|
225
|
-
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
|
|
228
|
-
L_PULL_USER_PROFILE_REQ_R
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
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
|
+
readonly P_GET_SYS_VERSION_E: "P-get_sys_version-E";
|
|
255
|
+
};
|
|
238
256
|
|
|
239
257
|
/**
|
|
240
258
|
* 好友类型
|
|
@@ -248,7 +266,7 @@ declare enum DirectionType {
|
|
|
248
266
|
BOTH = 2
|
|
249
267
|
}
|
|
250
268
|
/**
|
|
251
|
-
*
|
|
269
|
+
* 查询接口 - 好友类型
|
|
252
270
|
* @category Enum
|
|
253
271
|
* @since 5.12.0
|
|
254
272
|
*/
|
|
@@ -362,7 +380,7 @@ declare enum GroupJoinPermission {
|
|
|
362
380
|
declare enum GroupOperationPermission {
|
|
363
381
|
/** 群主(默认) */
|
|
364
382
|
OWNER = 0,
|
|
365
|
-
/**
|
|
383
|
+
/** 群主 + 群管理员 */
|
|
366
384
|
OWNER_OR_MANAGER = 1,
|
|
367
385
|
/** 所有人 */
|
|
368
386
|
EVERYONE = 2
|
|
@@ -373,9 +391,9 @@ declare enum GroupOperationPermission {
|
|
|
373
391
|
* @since 5.12.0
|
|
374
392
|
*/
|
|
375
393
|
declare enum GroupMemberInfoEditPermission {
|
|
376
|
-
/**
|
|
394
|
+
/** 群主 + 群管理员 + 自已 (默认) */
|
|
377
395
|
OWNER_OR_MANAGER_OR_SELF = 0,
|
|
378
|
-
/**
|
|
396
|
+
/** 群主 + 自已 */
|
|
379
397
|
OWNER_OR_SELF = 1,
|
|
380
398
|
/** 仅自已 */
|
|
381
399
|
SELF = 2
|
|
@@ -499,7 +517,7 @@ declare enum GroupApplicationDirection {
|
|
|
499
517
|
}
|
|
500
518
|
|
|
501
519
|
/**
|
|
502
|
-
* 聊天室 kv
|
|
520
|
+
* 聊天室 kv 存储操作类型。对方操作,己方收到消息 (RC:chrmKVNotiMsg) 中会带入此值。根据此值判断是删除还是更新
|
|
503
521
|
* @category Enum
|
|
504
522
|
*/
|
|
505
523
|
declare enum ChatroomEntryType {
|
|
@@ -644,7 +662,7 @@ declare enum ErrorCode {
|
|
|
644
662
|
SYS_CONVERSATION_NOT_SUPPORT_MESSAGE = 20109,
|
|
645
663
|
/**
|
|
646
664
|
* 20512
|
|
647
|
-
* appkey的数据中心与请求云控的数据中心不匹配
|
|
665
|
+
* appkey 的数据中心与请求云控的数据中心不匹配
|
|
648
666
|
* @since 5.8.5
|
|
649
667
|
*/
|
|
650
668
|
CLOUD_DATA_CENTER_INVALID = 20512,
|
|
@@ -675,12 +693,12 @@ declare enum ErrorCode {
|
|
|
675
693
|
NOT_IN_DISCUSSION = 21406,
|
|
676
694
|
/**
|
|
677
695
|
* 21501
|
|
678
|
-
*
|
|
696
|
+
* 发送的消息中包含敏感词(发送方发送失败,接收方不会收到消息)
|
|
679
697
|
*/
|
|
680
698
|
SENSITIVE_SHIELD = 21501,
|
|
681
699
|
/**
|
|
682
700
|
* 21502
|
|
683
|
-
*
|
|
701
|
+
* 消息中敏感词已经被替换(接收方可以收到被替换之后的消息)
|
|
684
702
|
*/
|
|
685
703
|
SENSITIVE_REPLACE = 21502,
|
|
686
704
|
/**
|
|
@@ -720,8 +738,8 @@ declare enum ErrorCode {
|
|
|
720
738
|
NOT_IN_CHATROOM = 23406,
|
|
721
739
|
/**
|
|
722
740
|
* 23407
|
|
723
|
-
* 聊天室禁言白名单人数超限(最多5个)
|
|
724
|
-
*
|
|
741
|
+
* 聊天室禁言白名单人数超限 (最多 5 个)
|
|
742
|
+
* 创建聊天室时,禁言白名单用户列表,支持批量设置,最多不超过 20 个
|
|
725
743
|
*/
|
|
726
744
|
GET_USERINFO_ERROR = 23407,
|
|
727
745
|
/**
|
|
@@ -786,23 +804,23 @@ declare enum ErrorCode {
|
|
|
786
804
|
CHATROOM_KEY_NOT_EXIST = 23427,
|
|
787
805
|
/**
|
|
788
806
|
* 23428
|
|
789
|
-
* 聊天室批量设置或删除KV部分不成功
|
|
807
|
+
* 聊天室批量设置或删除 KV 部分不成功
|
|
790
808
|
*/
|
|
791
809
|
CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
|
|
792
810
|
/**
|
|
793
811
|
* 23429
|
|
794
|
-
* 聊天室批量设置或删除KV数量超限(最多一次10条)
|
|
812
|
+
* 聊天室批量设置或删除 KV 数量超限(最多一次 10 条)
|
|
795
813
|
*/
|
|
796
814
|
CHATROOM_KV_STORE_OUT_LIMIT = 23429,
|
|
797
815
|
/**
|
|
798
816
|
* 23431
|
|
799
|
-
* 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV
|
|
817
|
+
* 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
|
|
800
818
|
* @since 5.3.0
|
|
801
819
|
*/
|
|
802
820
|
CHATROOM_KV_SET_ERROR = 23431,
|
|
803
821
|
/**
|
|
804
822
|
* 24001
|
|
805
|
-
* 没有注册DeviveId 也就是用户没有登陆
|
|
823
|
+
* 没有注册 DeviveId 也就是用户没有登陆
|
|
806
824
|
* @deprecated
|
|
807
825
|
*/
|
|
808
826
|
HAVNODEVICEID = 24001,
|
|
@@ -832,7 +850,7 @@ declare enum ErrorCode {
|
|
|
832
850
|
RC_USER_PROFILE_KEY_NOT_ALLOW_SDK_SET = 24360,
|
|
833
851
|
/**
|
|
834
852
|
* 24361
|
|
835
|
-
* 用户托管基本属性的key列表中没有此key
|
|
853
|
+
* 用户托管基本属性的 key 列表中没有此 key
|
|
836
854
|
* @since 5.9.10
|
|
837
855
|
*/
|
|
838
856
|
RC_USER_PROFILE_KEY_NOT_EXIST = 24361,
|
|
@@ -850,7 +868,7 @@ declare enum ErrorCode {
|
|
|
850
868
|
RC_USER_PROFILE_EXT_KV_COUNT_EXCEED_LIMIT = 24363,
|
|
851
869
|
/**
|
|
852
870
|
* 24364
|
|
853
|
-
* 用户托管基本属性或扩展属性的Value,字符超过最大上限
|
|
871
|
+
* 用户托管基本属性或扩展属性的 Value,字符超过最大上限
|
|
854
872
|
* @since 5.9.10
|
|
855
873
|
*/
|
|
856
874
|
RC_USER_PROFILE_VALUE_LENGTH_EXCEED_LIMIT = 24364,
|
|
@@ -985,7 +1003,7 @@ declare enum ErrorCode {
|
|
|
985
1003
|
RC_ENTRUST_SERVER_PARAMETER_ERROR = 25403,
|
|
986
1004
|
/**
|
|
987
1005
|
* 25404
|
|
988
|
-
* 非法操作,非群主修改群权限相关,msg中返回传的对应的key
|
|
1006
|
+
* 非法操作,非群主修改群权限相关,msg 中返回传的对应的 key
|
|
989
1007
|
* @since 5.12.0
|
|
990
1008
|
*/
|
|
991
1009
|
RC_GROUP_ILLEGAL_ERROR = 25404,
|
|
@@ -1069,7 +1087,7 @@ declare enum ErrorCode {
|
|
|
1069
1087
|
RC_GROUP_OWNER_NOT_ALLOW_QUIT_OR_KICK = 25417,
|
|
1070
1088
|
/**
|
|
1071
1089
|
* 25418
|
|
1072
|
-
* 用户ID不在群组中
|
|
1090
|
+
* 用户 ID 不在群组中
|
|
1073
1091
|
* @since 5.12.0
|
|
1074
1092
|
*/
|
|
1075
1093
|
RC_GROUP_USER_NOT_IN_GROUP = 25418,
|
|
@@ -1141,13 +1159,13 @@ declare enum ErrorCode {
|
|
|
1141
1159
|
RC_GROUP_OLD_GROUP_NOT_ENTRUST = 25429,
|
|
1142
1160
|
/**
|
|
1143
1161
|
* 25430
|
|
1144
|
-
* 群ID不合法,包含特殊字符
|
|
1162
|
+
* 群 ID 不合法,包含特殊字符
|
|
1145
1163
|
* @since 5.12.0
|
|
1146
1164
|
*/
|
|
1147
1165
|
RC_GROUP_ID_INVALID = 25430,
|
|
1148
1166
|
/**
|
|
1149
1167
|
* 25432
|
|
1150
|
-
* pagetoken解析失败
|
|
1168
|
+
* pagetoken 解析失败
|
|
1151
1169
|
* @since 5.12.0
|
|
1152
1170
|
*/
|
|
1153
1171
|
RC_PAGE_TOKEN_PARSING_FAILED = 25432,
|
|
@@ -1258,7 +1276,7 @@ declare enum ErrorCode {
|
|
|
1258
1276
|
CONVERSATION_TAG_OVERSIZE = 26004,
|
|
1259
1277
|
/**
|
|
1260
1278
|
* 26005
|
|
1261
|
-
* 未开通v4已读回执
|
|
1279
|
+
* 未开通 v4 已读回执
|
|
1262
1280
|
*/
|
|
1263
1281
|
RC_READ_RECEIPT_V4_INVALID = 26005,
|
|
1264
1282
|
/**
|
|
@@ -1273,12 +1291,12 @@ declare enum ErrorCode {
|
|
|
1273
1291
|
RC_SERVER_PARAMETER_MESSAGEUIDS_CONFUSED = 26007,
|
|
1274
1292
|
/**
|
|
1275
1293
|
* 26009
|
|
1276
|
-
* 消息id不合法
|
|
1294
|
+
* 消息 id 不合法
|
|
1277
1295
|
*/
|
|
1278
1296
|
RC_SERVER_PARAMETER_MESSAGEUID_INVALID = 26009,
|
|
1279
1297
|
/**
|
|
1280
1298
|
* 26010
|
|
1281
|
-
*
|
|
1299
|
+
* 参数有误
|
|
1282
1300
|
*/
|
|
1283
1301
|
RC_SERVER_PARAMETER_INVALID = 26010,
|
|
1284
1302
|
/**
|
|
@@ -1288,12 +1306,12 @@ declare enum ErrorCode {
|
|
|
1288
1306
|
RC_SUBSCRIBE_ONLINE_SERVICE_UNAVAILABLE = 26020,
|
|
1289
1307
|
/**
|
|
1290
1308
|
* 26021
|
|
1291
|
-
*
|
|
1309
|
+
* 用户被订阅量达到上限,详细查看开发文档。
|
|
1292
1310
|
*/
|
|
1293
1311
|
RC_BESUBSCRIBED_USERIDS_COUNT_EXCEED_LIMIT = 26021,
|
|
1294
1312
|
/**
|
|
1295
1313
|
* 26022
|
|
1296
|
-
*
|
|
1314
|
+
* 订阅用户数达到上限,详细查看开发文档。
|
|
1297
1315
|
*/
|
|
1298
1316
|
RC_SUBSCRIBED_USERIDS_EXCEED_LIMIT = 26022,
|
|
1299
1317
|
/**
|
|
@@ -1380,7 +1398,7 @@ declare enum ErrorCode {
|
|
|
1380
1398
|
/**
|
|
1381
1399
|
* 30012
|
|
1382
1400
|
* PING 失败
|
|
1383
|
-
* @solution 本地网络问题导致ping失败,SDK 会进入重连逻辑
|
|
1401
|
+
* @solution 本地网络问题导致 ping 失败,SDK 会进入重连逻辑
|
|
1384
1402
|
* @since 5.2.0
|
|
1385
1403
|
*/
|
|
1386
1404
|
RC_PING_EXCEED_LIMIT = 30012,
|
|
@@ -1429,7 +1447,7 @@ declare enum ErrorCode {
|
|
|
1429
1447
|
RC_TCP_DISCONNECTED_NO_RMTP = 30021,
|
|
1430
1448
|
/**
|
|
1431
1449
|
* 31000
|
|
1432
|
-
* 连接ACK超时
|
|
1450
|
+
* 连接 ACK 超时
|
|
1433
1451
|
* @solution 网络问题,SDK 会进行重连
|
|
1434
1452
|
* @since 5.2.0
|
|
1435
1453
|
*/
|
|
@@ -1442,14 +1460,14 @@ declare enum ErrorCode {
|
|
|
1442
1460
|
RC_CONN_PROTO_VERSION_ERROR = 31001,
|
|
1443
1461
|
/**
|
|
1444
1462
|
* 31002
|
|
1445
|
-
* 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk版本}
|
|
1463
|
+
* 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk 版本}。其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识,移动/电信/联通}
|
|
1446
1464
|
* @solution 一般是 appkey 错误导致,建议在融云的开发者后台中确认一下当前应用的 appkey 标识是否正确
|
|
1447
1465
|
* @since 5.2.0
|
|
1448
1466
|
*/
|
|
1449
1467
|
RC_CONN_IDENTIFIER_REJECTED = 31002,
|
|
1450
1468
|
/**
|
|
1451
1469
|
* 31003
|
|
1452
|
-
*
|
|
1470
|
+
* 连接服务未开通,需要排查后台小程序(或桌面端)服务是否已开通
|
|
1453
1471
|
* @solution 建议到开发者后台 - 服务管理开通对应业务服务
|
|
1454
1472
|
* @since 5.2.0
|
|
1455
1473
|
*/
|
|
@@ -1517,7 +1535,7 @@ declare enum ErrorCode {
|
|
|
1517
1535
|
RC_CONN_TOKEN_EXPIRED = 31020,
|
|
1518
1536
|
/**
|
|
1519
1537
|
* 31021
|
|
1520
|
-
* Token 中携带 deviceId 时,检测 Token 中deviceId 与链接设备 deviceId 不一致
|
|
1538
|
+
* Token 中携带 deviceId 时,检测 Token 中 deviceId 与链接设备 deviceId 不一致
|
|
1521
1539
|
* @since 5.7.0
|
|
1522
1540
|
*/
|
|
1523
1541
|
RC_CONN_DEVICE_ERROR = 31021,
|
|
@@ -1547,13 +1565,13 @@ declare enum ErrorCode {
|
|
|
1547
1565
|
RC_CONN_WRONG_CLUSTER = 31025,
|
|
1548
1566
|
/**
|
|
1549
1567
|
* 31026
|
|
1550
|
-
* 开启AppServer联合鉴权功能后,到AppServer认证失败
|
|
1568
|
+
* 开启 AppServer 联合鉴权功能后,到 AppServer 认证失败
|
|
1551
1569
|
* @since 5.2.0
|
|
1552
1570
|
*/
|
|
1553
1571
|
RC_APP_AUTH_NOT_PASS = 31026,
|
|
1554
1572
|
/**
|
|
1555
1573
|
* 31027
|
|
1556
|
-
* 该 token
|
|
1574
|
+
* 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
|
|
1557
1575
|
* @since 5.2.0
|
|
1558
1576
|
*/
|
|
1559
1577
|
RC_OTP_USED = 31027,
|
|
@@ -1606,13 +1624,13 @@ declare enum ErrorCode {
|
|
|
1606
1624
|
CONNECTION_REFUSED = 32061,
|
|
1607
1625
|
/**
|
|
1608
1626
|
* 33000
|
|
1609
|
-
*
|
|
1627
|
+
* 将消息存储到本地数据时失败。发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
|
|
1610
1628
|
* @since 5.2.0
|
|
1611
1629
|
*/
|
|
1612
1630
|
PROTOCOL_MESSAGE_SAVED_ERROR = 33000,
|
|
1613
1631
|
/**
|
|
1614
1632
|
* 33001
|
|
1615
|
-
* 协议栈未初始化(可能原因:1
|
|
1633
|
+
* 协议栈未初始化(可能原因:1,没有调用 SDK 初始化接口;2,SDK 的 so 未正常加载)
|
|
1616
1634
|
* @since 5.2.0
|
|
1617
1635
|
*/
|
|
1618
1636
|
BIZ_ERROR_CLIENT_NOT_INIT = 33001,
|
|
@@ -1712,7 +1730,7 @@ declare enum ErrorCode {
|
|
|
1712
1730
|
MESSAGE_EXPANDED_ERROR = 34009,
|
|
1713
1731
|
/**
|
|
1714
1732
|
* 34010
|
|
1715
|
-
*
|
|
1733
|
+
* 消息扩展大小超出限制,默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
|
|
1716
1734
|
* @since 5.2.0
|
|
1717
1735
|
*/
|
|
1718
1736
|
EXPANSION_LIMIT_EXCEET = 34010,
|
|
@@ -1787,7 +1805,7 @@ declare enum ErrorCode {
|
|
|
1787
1805
|
INVALID_PARAMETER_TIMESTAMP = 34202,
|
|
1788
1806
|
/**
|
|
1789
1807
|
* 34203
|
|
1790
|
-
* 开发者接口调用时传入的 uid (服务器消息唯一 id)非法
|
|
1808
|
+
* 开发者接口调用时传入的 uid (服务器消息唯一 id) 非法
|
|
1791
1809
|
*/
|
|
1792
1810
|
INVALID_PARAMETER_MESSAGE_UID = 34203,
|
|
1793
1811
|
/**
|
|
@@ -1862,7 +1880,7 @@ declare enum ErrorCode {
|
|
|
1862
1880
|
INVALID_PARAMETER_TIMESTRING = 34224,
|
|
1863
1881
|
/**
|
|
1864
1882
|
* 34225
|
|
1865
|
-
* RCConversationIdentifier
|
|
1883
|
+
* RCConversationIdentifier 参数非法。可能原因:开发者调用接口传入的 RCConversationIdentifier 参数类型不对或者参数为空
|
|
1866
1884
|
* @solution conversation is not valid
|
|
1867
1885
|
* @since 5.9.9
|
|
1868
1886
|
*/
|
|
@@ -1950,7 +1968,7 @@ declare enum ErrorCode {
|
|
|
1950
1968
|
INVALID_PARAMETER_KEY = 34260,
|
|
1951
1969
|
/**
|
|
1952
1970
|
* 34261
|
|
1953
|
-
* 参数keys 非法
|
|
1971
|
+
* 参数 keys 非法
|
|
1954
1972
|
*/
|
|
1955
1973
|
INVALID_PARAMETER_KEYS = 34261,
|
|
1956
1974
|
/**
|
|
@@ -1976,14 +1994,14 @@ declare enum ErrorCode {
|
|
|
1976
1994
|
/**
|
|
1977
1995
|
* 34272
|
|
1978
1996
|
* 参数 before 非法
|
|
1979
|
-
* @solution beforeCount 无效,需要输入大于0 的正整数
|
|
1997
|
+
* @solution beforeCount 无效,需要输入大于 0 的正整数
|
|
1980
1998
|
* @since 5.9.8
|
|
1981
1999
|
*/
|
|
1982
2000
|
INVALID_PARAMETER_BEFORE = 34272,
|
|
1983
2001
|
/**
|
|
1984
2002
|
* 34273
|
|
1985
2003
|
* 参数 after 非法
|
|
1986
|
-
* @solution afterCount 输入无效,需要输入大于0 的正整数
|
|
2004
|
+
* @solution afterCount 输入无效,需要输入大于 0 的正整数
|
|
1987
2005
|
* @since 5.9.8
|
|
1988
2006
|
*/
|
|
1989
2007
|
INVALID_PARAMETER_AFTER = 34273,
|
|
@@ -2019,12 +2037,12 @@ declare enum ErrorCode {
|
|
|
2019
2037
|
INVALID_PARAMETER_LIMIT = 34279,
|
|
2020
2038
|
/**
|
|
2021
2039
|
* 34280
|
|
2022
|
-
* MessageDirection错误
|
|
2040
|
+
* MessageDirection 错误
|
|
2023
2041
|
*/
|
|
2024
2042
|
INVALID_MESSAGE_DIRECTION = 34280,
|
|
2025
2043
|
/**
|
|
2026
2044
|
* 34281
|
|
2027
|
-
* SentStatus错误
|
|
2045
|
+
* SentStatus 错误
|
|
2028
2046
|
*/
|
|
2029
2047
|
INVALID_MESSAGE_SENT_STATUS = 34281,
|
|
2030
2048
|
/**
|
|
@@ -2045,14 +2063,14 @@ declare enum ErrorCode {
|
|
|
2045
2063
|
INVALID_PARAMETER_CONVERSATION_TYPE_LIST = 34284,
|
|
2046
2064
|
/**
|
|
2047
2065
|
* 34287
|
|
2048
|
-
* 开发者调用接口传入的 ConversationIdentifier 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
|
|
2049
|
-
* @solution 传入的 ConversationList 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
|
|
2066
|
+
* 开发者调用接口传入的 ConversationIdentifier 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
|
|
2067
|
+
* @solution 传入的 ConversationList 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
|
|
2050
2068
|
* @since 5.9.9
|
|
2051
2069
|
*/
|
|
2052
2070
|
INVALID_PARAMETER_CONVERSATION_LIST = 34287,
|
|
2053
2071
|
/**
|
|
2054
2072
|
* 34288
|
|
2055
|
-
* 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
|
|
2073
|
+
* 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
|
|
2056
2074
|
*/
|
|
2057
2075
|
INVALID_PARAMETER_CLEAR_MESSAGE_OPTION_LIST = 34288,
|
|
2058
2076
|
/**
|
|
@@ -2069,12 +2087,12 @@ declare enum ErrorCode {
|
|
|
2069
2087
|
INVALID_PARAMETER_END_MESSAGE_UID = 34290,
|
|
2070
2088
|
/**
|
|
2071
2089
|
* 34291
|
|
2072
|
-
* 不支持V4已读回执功能
|
|
2090
|
+
* 不支持 V4 已读回执功能
|
|
2073
2091
|
*/
|
|
2074
2092
|
READ_RECEIPT_V4_NOT_SUPPORT = 34291,
|
|
2075
2093
|
/**
|
|
2076
2094
|
* 34292
|
|
2077
|
-
* 不支持更新v4已读回执信息
|
|
2095
|
+
* 不支持更新 v4 已读回执信息
|
|
2078
2096
|
*/
|
|
2079
2097
|
READ_RECEIPT_V4_UPDATE_NOT_SUPPORT = 34292,
|
|
2080
2098
|
/**
|
|
@@ -2116,7 +2134,7 @@ declare enum ErrorCode {
|
|
|
2116
2134
|
INVALID_PARAMETER_SUBSCRIBE_TYPE = 34306,
|
|
2117
2135
|
/**
|
|
2118
2136
|
* 34307
|
|
2119
|
-
* 订阅事件传入的订阅时长非法[60s ~ 30天]
|
|
2137
|
+
* 订阅事件传入的订阅时长非法 [60s ~ 30 天]
|
|
2120
2138
|
*/
|
|
2121
2139
|
INVALID_PARAMETER_SUBSCRIBE_EXPIRY = 34307,
|
|
2122
2140
|
/**
|
|
@@ -2127,7 +2145,7 @@ declare enum ErrorCode {
|
|
|
2127
2145
|
/**
|
|
2128
2146
|
* 34309
|
|
2129
2147
|
* 订阅事件传入的分页大小非法
|
|
2130
|
-
* @solution 订阅相关接口传入的分页大小非法[1~200]
|
|
2148
|
+
* @solution 订阅相关接口传入的分页大小非法 [1~200]
|
|
2131
2149
|
*/
|
|
2132
2150
|
INVALID_PARAMETER_SUBSCRIBE_PAGESIZE = 34309,
|
|
2133
2151
|
/**
|
|
@@ -2321,7 +2339,7 @@ declare enum ErrorCode {
|
|
|
2321
2339
|
HOSTNAME_ERROR = 35009,
|
|
2322
2340
|
/**
|
|
2323
2341
|
* 35010
|
|
2324
|
-
*
|
|
2342
|
+
* 开启 `禁止把已在线客户端踢下线` 开关后,该错误码标识已有同类型端在线,禁止链接
|
|
2325
2343
|
* @deprecated
|
|
2326
2344
|
*/
|
|
2327
2345
|
HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
|
|
@@ -2378,7 +2396,7 @@ declare enum ErrorCode {
|
|
|
2378
2396
|
INVALID_PARAMETER_DRAFT = 35028,
|
|
2379
2397
|
/**
|
|
2380
2398
|
* 35029
|
|
2381
|
-
* 开发者调用时传入的 message
|
|
2399
|
+
* 开发者调用时传入的 message 无效,message 应是对象或者 BaseMessage 的子类
|
|
2382
2400
|
*/
|
|
2383
2401
|
INVALID_PARAMETER_MESSAGE = 35029,
|
|
2384
2402
|
/**
|
|
@@ -2510,9 +2528,21 @@ declare enum ErrorCode {
|
|
|
2510
2528
|
* @since 5.12.2
|
|
2511
2529
|
*/
|
|
2512
2530
|
INVALID_DISABLE_UPDATE_LAST_MESSAGE = 35054,
|
|
2531
|
+
/**
|
|
2532
|
+
* 35055
|
|
2533
|
+
* 超级群类型会话仅允许置顶默认频道
|
|
2534
|
+
* @since 5.20.0
|
|
2535
|
+
*/
|
|
2536
|
+
ONLY_DEFAULT_CHANNEL_SUPPORTS_PINNING = 35055,
|
|
2537
|
+
/**
|
|
2538
|
+
* 35056
|
|
2539
|
+
* 发送消息时配置 needReceipt 错误,相关参数仅限单群聊会话内非状态消息、非群定向消息可配置,且需要开启已读回执 v5 功能
|
|
2540
|
+
* @since 5.20.0
|
|
2541
|
+
*/
|
|
2542
|
+
SEND_READ_RECEIPT_CONF_ERROR = 35056,
|
|
2513
2543
|
/**
|
|
2514
2544
|
* 36001
|
|
2515
|
-
* 加入聊天室Id为空
|
|
2545
|
+
* 加入聊天室 Id 为空
|
|
2516
2546
|
* @deprecated
|
|
2517
2547
|
*/
|
|
2518
2548
|
CHATROOM_ID_ISNULL = 36001,
|
|
@@ -2596,7 +2626,7 @@ declare enum ErrorCode {
|
|
|
2596
2626
|
STREAM_MESSAGE_SYNCED = 39007,
|
|
2597
2627
|
/**
|
|
2598
2628
|
* 41002
|
|
2599
|
-
* 获取七牛token失败
|
|
2629
|
+
* 获取七牛 token 失败
|
|
2600
2630
|
* @deprecated
|
|
2601
2631
|
*/
|
|
2602
2632
|
QNTKN_GET_ERROR = 41002,
|
|
@@ -2661,7 +2691,7 @@ declare enum ConversationType {
|
|
|
2661
2691
|
/**
|
|
2662
2692
|
* 连接协议
|
|
2663
2693
|
* 截止 5.7.4 版本,暂不支持 rpp 和 quic
|
|
2664
|
-
* v2 版本文档:
|
|
2694
|
+
* v2 版本文档:https://a5bq662kv5.feishu.cn/wiki/wikcnfo3lEo2CPbonDxuXFvU0Kb#K7nbeN
|
|
2665
2695
|
*/
|
|
2666
2696
|
declare enum EConnectProtocol {
|
|
2667
2697
|
RMTP = 1,
|
|
@@ -2813,11 +2843,11 @@ declare enum MessageType {
|
|
|
2813
2843
|
*/
|
|
2814
2844
|
SYNC_READ_STATUS = "RC:SRSMsg",
|
|
2815
2845
|
/**
|
|
2816
|
-
* 接受群已读回执更新消息(导航开关grpRRVer = 1时使用)
|
|
2846
|
+
* 接受群已读回执更新消息 (导航开关 grpRRVer = 1 时使用)
|
|
2817
2847
|
*/
|
|
2818
2848
|
GROUP_READ_RECEIPT_REQUEST = "RC:RRMsg",
|
|
2819
2849
|
/**
|
|
2820
|
-
* 已读回执消息(V4)(导航开关grpRRVer = 3 时使用),支持单群聊
|
|
2850
|
+
* 已读回执消息(V4)(导航开关 grpRRVer = 3 时使用),支持单群聊
|
|
2821
2851
|
*/
|
|
2822
2852
|
READ_STATE = "RC:RSMsg",
|
|
2823
2853
|
/**
|
|
@@ -2849,7 +2879,7 @@ declare enum MessageType {
|
|
|
2849
2879
|
*/
|
|
2850
2880
|
TYPING_STATUS = "RC:TypSts",
|
|
2851
2881
|
/**
|
|
2852
|
-
*
|
|
2882
|
+
* 拦截消息,(当发送的消息的敏感词时,服务会下发一个拦截消息,内容包含被拦截消息信息)
|
|
2853
2883
|
*/
|
|
2854
2884
|
INTERCEPT = "RC:InterceptMsg",
|
|
2855
2885
|
/**
|
|
@@ -3034,7 +3064,7 @@ declare enum SubscribeOperationType {
|
|
|
3034
3064
|
* @since 5.10.1
|
|
3035
3065
|
* */
|
|
3036
3066
|
declare enum UserProfileVisibility {
|
|
3037
|
-
/**
|
|
3067
|
+
/** 未设置:以 AppKey 权限设置为准,默认是此状态 */
|
|
3038
3068
|
NOT_SET = 0,
|
|
3039
3069
|
/** 都不可见:任何人都不能搜索到我的用户信息,名称、头像除外。 */
|
|
3040
3070
|
INVISIBLE = 1,
|
|
@@ -3132,7 +3162,6 @@ declare enum PushImportanceHonor {
|
|
|
3132
3162
|
|
|
3133
3163
|
/**
|
|
3134
3164
|
* 免打扰级别
|
|
3135
|
-
* @desc 原:NotificationStatus 已废弃
|
|
3136
3165
|
* @category Enum
|
|
3137
3166
|
*/
|
|
3138
3167
|
declare enum NotificationLevel {
|
|
@@ -3141,7 +3170,7 @@ declare enum NotificationLevel {
|
|
|
3141
3170
|
*/
|
|
3142
3171
|
ALL_MESSAGE = -1,
|
|
3143
3172
|
/**
|
|
3144
|
-
* 未设置(向上查询群或者APP级别设置)// 存量数据中 0 表示未设置
|
|
3173
|
+
* 未设置(向上查询群或者 APP 级别设置)// 存量数据中 0 表示未设置
|
|
3145
3174
|
*/
|
|
3146
3175
|
NOT_SET = 0,
|
|
3147
3176
|
/**
|
|
@@ -3183,13 +3212,13 @@ declare enum NotificationStatus {
|
|
|
3183
3212
|
* @param status
|
|
3184
3213
|
* @returns
|
|
3185
3214
|
*/
|
|
3186
|
-
declare const
|
|
3215
|
+
declare const trans2NotificationLevel: (status: NotificationStatus) => NotificationLevel;
|
|
3187
3216
|
/**
|
|
3188
3217
|
* 转换 NotificationLevel 为 NotificationStatus
|
|
3189
3218
|
* @param level
|
|
3190
3219
|
* @returns
|
|
3191
3220
|
*/
|
|
3192
|
-
declare const
|
|
3221
|
+
declare const trans2NotificationStatus: (level: NotificationLevel) => NotificationStatus;
|
|
3193
3222
|
|
|
3194
3223
|
/**
|
|
3195
3224
|
* 消息接受状态
|
|
@@ -3235,7 +3264,7 @@ declare enum InterruptionLevel {
|
|
|
3235
3264
|
*/
|
|
3236
3265
|
declare enum PushNotificationQuietHoursLevel {
|
|
3237
3266
|
/**
|
|
3238
|
-
* 未设置(向上查询群或者APP级别设置),存量数据中 0 表示未设置
|
|
3267
|
+
* 未设置(向上查询群或者 APP 级别设置),存量数据中 0 表示未设置
|
|
3239
3268
|
*/
|
|
3240
3269
|
PUSH_NOTIFICATION_QUIET_HOURS_LEVEL_DEFAULT = 0,
|
|
3241
3270
|
/**
|
|
@@ -3270,13 +3299,6 @@ declare enum HttpMethod {
|
|
|
3270
3299
|
* 消息 content 内容尺寸限制:128 KB
|
|
3271
3300
|
*/
|
|
3272
3301
|
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
3302
|
declare const MAX_UPLOAD_FILE_SIZE: number;
|
|
3281
3303
|
declare const UPLOAD_FILE_CHUNK_SIZE: number;
|
|
3282
3304
|
|
|
@@ -3301,6 +3323,15 @@ declare const UUId: {
|
|
|
3301
3323
|
genWithLen(strLen?: number): string;
|
|
3302
3324
|
};
|
|
3303
3325
|
|
|
3326
|
+
declare class EventTransmitter {
|
|
3327
|
+
#private;
|
|
3328
|
+
/**
|
|
3329
|
+
* 停止事件传播
|
|
3330
|
+
*/
|
|
3331
|
+
stopPropagation(): void;
|
|
3332
|
+
get isStopPropagation(): boolean;
|
|
3333
|
+
}
|
|
3334
|
+
declare type ICallback<T extends (...args: any[]) => any> = (...args: [EventTransmitter, ...Parameters<T>]) => void;
|
|
3304
3335
|
declare type LSR<T> = {
|
|
3305
3336
|
[P in keyof T]: T[P] extends (...args: any) => any ? T[P] : never;
|
|
3306
3337
|
};
|
|
@@ -3323,7 +3354,7 @@ declare class EventDispatcher<T> {
|
|
|
3323
3354
|
* @param priority 监听器调用优先级,默认为 0,值越大调用优先级越高,最大值 100
|
|
3324
3355
|
* @returns 返回 symbol,移除监听时使用
|
|
3325
3356
|
*/
|
|
3326
|
-
on<K extends keyof T>(event: K, listener: LSR<T>[K]
|
|
3357
|
+
on<K extends keyof T>(event: K, listener: ICallback<LSR<T>[K]>, target?: any, priority?: number): symbol;
|
|
3327
3358
|
/**
|
|
3328
3359
|
* @hidden
|
|
3329
3360
|
* 添加事件监听器,并在一次通知过后移除该监听器
|
|
@@ -3333,7 +3364,7 @@ declare class EventDispatcher<T> {
|
|
|
3333
3364
|
* @param priority 监听器调用优先级,默认为 0,值越大调用优先级越高,最大值 100
|
|
3334
3365
|
* @returns 返回 symbol,移除监听时使用
|
|
3335
3366
|
*/
|
|
3336
|
-
once<K extends keyof T>(event: K, listener: LSR<T>[K]
|
|
3367
|
+
once<K extends keyof T>(event: K, listener: ICallback<LSR<T>[K]>, target?: any, priority?: number): symbol;
|
|
3337
3368
|
/**
|
|
3338
3369
|
* @hidden
|
|
3339
3370
|
* 移除事件监听
|
|
@@ -3366,25 +3397,15 @@ declare class EventDispatcher<T> {
|
|
|
3366
3397
|
pipe<K extends T>(emitter: EventDispatcher<K>): void;
|
|
3367
3398
|
}
|
|
3368
3399
|
|
|
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
3400
|
declare class RCResult<T = void> {
|
|
3380
3401
|
readonly code: number;
|
|
3381
3402
|
readonly msg: string;
|
|
3382
|
-
readonly data?: T;
|
|
3403
|
+
readonly data?: T | undefined;
|
|
3383
3404
|
readonly isOk: boolean;
|
|
3384
3405
|
/**
|
|
3385
3406
|
* @hidden
|
|
3386
3407
|
*/
|
|
3387
|
-
constructor(code: number, msg: string, data?: T);
|
|
3408
|
+
constructor(code: number, msg: string, data?: T | undefined);
|
|
3388
3409
|
/**
|
|
3389
3410
|
* 结果为 ok 时,进行后续异步操作
|
|
3390
3411
|
* @hidden
|
|
@@ -3413,13 +3434,23 @@ declare class RCResult<T = void> {
|
|
|
3413
3434
|
*/
|
|
3414
3435
|
errmsg(): string;
|
|
3415
3436
|
/**
|
|
3416
|
-
* 抹除 data 数据,返回新的 RCResult
|
|
3437
|
+
* 抹除 data 数据,返回新的 RCResult 对象,不改变当前数据
|
|
3417
3438
|
* @hidden
|
|
3418
3439
|
*/
|
|
3419
3440
|
wipe(): RCResult<any>;
|
|
3420
3441
|
}
|
|
3421
|
-
declare const ok: <T>(data?: T, desc?: string) => RCResult<T>;
|
|
3422
|
-
declare const fail: <T>(code: number, desc?: string, data?: T) => RCResult<T>;
|
|
3442
|
+
declare const ok: <T>(data?: T | undefined, desc?: string | undefined) => RCResult<T>;
|
|
3443
|
+
declare const fail: <T>(code: number, desc?: string | undefined, data?: T | undefined) => RCResult<T>;
|
|
3444
|
+
|
|
3445
|
+
declare class SuspendablePromise<T> {
|
|
3446
|
+
private readonly _promise;
|
|
3447
|
+
private _resolve;
|
|
3448
|
+
private _onCancel;
|
|
3449
|
+
constructor(handle: (resolve: (val: T) => void) => void, onCancel: (resolve: (val: T) => void) => void);
|
|
3450
|
+
private _onResolve;
|
|
3451
|
+
result(): Promise<T>;
|
|
3452
|
+
abort(): void;
|
|
3453
|
+
}
|
|
3423
3454
|
|
|
3424
3455
|
declare class Validator {
|
|
3425
3456
|
protected readonly _apiName: string;
|
|
@@ -3449,6 +3480,14 @@ declare class Validator {
|
|
|
3449
3480
|
* @param required
|
|
3450
3481
|
*/
|
|
3451
3482
|
validate(key: string, value: any, handler: (value: any) => boolean, required?: boolean): Validator;
|
|
3483
|
+
/**
|
|
3484
|
+
* 验证参数是否合规
|
|
3485
|
+
* @param key
|
|
3486
|
+
* @param value
|
|
3487
|
+
* @param handler 验证方法,返回一个 RCResult
|
|
3488
|
+
* @param required 是否必填
|
|
3489
|
+
*/
|
|
3490
|
+
validate2(key: string, value: any, handler: (value: any) => RCResult, required?: boolean): Validator;
|
|
3452
3491
|
/**
|
|
3453
3492
|
* 验证参数是否合规,不合规时抛出 CMSYError
|
|
3454
3493
|
* @param key - 参数名,当抛出异常时用于提供详细错误信息
|
|
@@ -3605,19 +3644,19 @@ interface IChatroomUserChangeInfo {
|
|
|
3605
3644
|
*/
|
|
3606
3645
|
interface IChatroomNotifyMultiLoginSync {
|
|
3607
3646
|
/**
|
|
3608
|
-
* 聊天室ID
|
|
3647
|
+
* 聊天室 ID
|
|
3609
3648
|
*/
|
|
3610
3649
|
chatroomId: string;
|
|
3611
3650
|
/**
|
|
3612
|
-
* 变更的状态,0:离开,
|
|
3651
|
+
* 变更的状态,0:离开,1:加入
|
|
3613
3652
|
*/
|
|
3614
3653
|
status: ChrmSyncStatus;
|
|
3615
3654
|
/**
|
|
3616
|
-
* 如果status是0的情况,区分离开类型,0:主动离开,
|
|
3655
|
+
* 如果 status 是 0 的情况,区分离开类型,0:主动离开,1:多端加入被踢
|
|
3617
3656
|
*/
|
|
3618
3657
|
reason: ChatroomSyncStatusReason;
|
|
3619
3658
|
/**
|
|
3620
|
-
* 用户加入/退出/被踢的时间(毫秒时间戳)
|
|
3659
|
+
* 用户加入/退出/被踢的时间 (毫秒时间戳)
|
|
3621
3660
|
*/
|
|
3622
3661
|
time: number;
|
|
3623
3662
|
/**
|
|
@@ -3631,19 +3670,19 @@ interface IChatroomNotifyMultiLoginSync {
|
|
|
3631
3670
|
*/
|
|
3632
3671
|
interface IChatroomNotifyBlock {
|
|
3633
3672
|
/**
|
|
3634
|
-
* 聊天室ID
|
|
3673
|
+
* 聊天室 ID
|
|
3635
3674
|
*/
|
|
3636
3675
|
chatroomId: string;
|
|
3637
3676
|
/**
|
|
3638
|
-
* 封禁类型,0是解封,1是封禁
|
|
3677
|
+
* 封禁类型,0 是解封,1 是封禁
|
|
3639
3678
|
*/
|
|
3640
3679
|
operateType: ChrmMemOperateType;
|
|
3641
3680
|
/**
|
|
3642
|
-
* 封禁时长(毫秒),封禁时有此字段,封禁时长最大值为43200分钟(1个月), 最小值1分钟
|
|
3681
|
+
* 封禁时长 (毫秒),封禁时有此字段,封禁时长最大值为 43200 分钟(1 个月), 最小值 1 分钟
|
|
3643
3682
|
*/
|
|
3644
3683
|
durationTime: number;
|
|
3645
3684
|
/**
|
|
3646
|
-
* 操作时间(毫秒时间戳)
|
|
3685
|
+
* 操作时间 (毫秒时间戳)
|
|
3647
3686
|
*/
|
|
3648
3687
|
operateTime: number;
|
|
3649
3688
|
/**
|
|
@@ -3661,7 +3700,7 @@ interface IChatroomNotifyBlock {
|
|
|
3661
3700
|
*/
|
|
3662
3701
|
interface IChatroomNotifyBan {
|
|
3663
3702
|
/**
|
|
3664
|
-
* 聊天室ID
|
|
3703
|
+
* 聊天室 ID
|
|
3665
3704
|
*/
|
|
3666
3705
|
chatroomId: string;
|
|
3667
3706
|
/**
|
|
@@ -3669,11 +3708,11 @@ interface IChatroomNotifyBan {
|
|
|
3669
3708
|
*/
|
|
3670
3709
|
banType: ChrmMemBanType;
|
|
3671
3710
|
/**
|
|
3672
|
-
* 禁言时长(毫秒),禁言时有此字段,禁言时长最大值为43200分钟(1个月), 最小值1分钟
|
|
3711
|
+
* 禁言时长 (毫秒),禁言时有此字段,禁言时长最大值为 43200 分钟(1 个月), 最小值 1 分钟
|
|
3673
3712
|
*/
|
|
3674
3713
|
durationTime: number;
|
|
3675
3714
|
/**
|
|
3676
|
-
* 操作时间(毫秒时间戳)
|
|
3715
|
+
* 操作时间 (毫秒时间戳)
|
|
3677
3716
|
*/
|
|
3678
3717
|
operateTime: number;
|
|
3679
3718
|
/**
|
|
@@ -3729,11 +3768,11 @@ interface IChatroomListenerData {
|
|
|
3729
3768
|
*/
|
|
3730
3769
|
interface IChatroomEntry {
|
|
3731
3770
|
/**
|
|
3732
|
-
*
|
|
3771
|
+
* 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
|
|
3733
3772
|
*/
|
|
3734
3773
|
key: string;
|
|
3735
3774
|
/**
|
|
3736
|
-
*
|
|
3775
|
+
* 属性对应的值,最大长度 4096 字符
|
|
3737
3776
|
*/
|
|
3738
3777
|
value: string;
|
|
3739
3778
|
/**
|
|
@@ -3781,7 +3820,7 @@ interface IChatroomInfo {
|
|
|
3781
3820
|
*/
|
|
3782
3821
|
interface IRemoveChatroomEntry {
|
|
3783
3822
|
/**
|
|
3784
|
-
*
|
|
3823
|
+
* 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
|
|
3785
3824
|
*/
|
|
3786
3825
|
key: string;
|
|
3787
3826
|
/**
|
|
@@ -3798,7 +3837,7 @@ interface IRemoveChatroomEntry {
|
|
|
3798
3837
|
*/
|
|
3799
3838
|
interface IRemoveChatroomEntries {
|
|
3800
3839
|
/**
|
|
3801
|
-
* key
|
|
3840
|
+
* key 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
|
|
3802
3841
|
*/
|
|
3803
3842
|
entries: {
|
|
3804
3843
|
key: string;
|
|
@@ -3817,8 +3856,8 @@ interface IRemoveChatroomEntries {
|
|
|
3817
3856
|
interface IChatroomEntries {
|
|
3818
3857
|
/**
|
|
3819
3858
|
* entries ,要设置的属性列表
|
|
3820
|
-
* key
|
|
3821
|
-
* value
|
|
3859
|
+
* key 属性名称,支持英文字母、数字、+、=、-、_ 的组合方式,最大长度 128 字符
|
|
3860
|
+
* value 属性对应的值,最大长度 4096 字符
|
|
3822
3861
|
*/
|
|
3823
3862
|
entries: {
|
|
3824
3863
|
key: string;
|
|
@@ -3950,23 +3989,23 @@ interface IUploadAuth {
|
|
|
3950
3989
|
*/
|
|
3951
3990
|
ossBucketName: string;
|
|
3952
3991
|
/**
|
|
3953
|
-
* s3 认证凭证,对应 post上传 x-amz-credential 字段
|
|
3992
|
+
* s3 认证凭证,对应 post 上传 x-amz-credential 字段
|
|
3954
3993
|
*/
|
|
3955
3994
|
s3Credential: string;
|
|
3956
3995
|
/**
|
|
3957
|
-
* 加密算法,对应 post上传 x-amz-algorithm 字段
|
|
3996
|
+
* 加密算法,对应 post 上传 x-amz-algorithm 字段
|
|
3958
3997
|
*/
|
|
3959
3998
|
s3Algorithm: string;
|
|
3960
3999
|
/**
|
|
3961
|
-
* s3 日期,对应 post上传 x-amz-date 字段
|
|
4000
|
+
* s3 日期,对应 post 上传 x-amz-date 字段
|
|
3962
4001
|
*/
|
|
3963
4002
|
s3Date: string;
|
|
3964
4003
|
/**
|
|
3965
|
-
* s3 policy,对应 post上传 policy 字段
|
|
4004
|
+
* s3 policy,对应 post 上传 policy 字段
|
|
3966
4005
|
*/
|
|
3967
4006
|
s3Policy: string;
|
|
3968
4007
|
/**
|
|
3969
|
-
* s3 签名信息,对应 post上传 x-amz-signature 字段
|
|
4008
|
+
* s3 签名信息,对应 post 上传 x-amz-signature 字段
|
|
3970
4009
|
*/
|
|
3971
4010
|
s3Signature: string;
|
|
3972
4011
|
/**
|
|
@@ -4174,7 +4213,7 @@ interface IRTCRoomBindOption {
|
|
|
4174
4213
|
*/
|
|
4175
4214
|
chatRoomId: string;
|
|
4176
4215
|
/**
|
|
4177
|
-
* RTC房间 ID
|
|
4216
|
+
* RTC 房间 ID
|
|
4178
4217
|
*/
|
|
4179
4218
|
rtcRoomId: string;
|
|
4180
4219
|
}
|
|
@@ -4251,11 +4290,11 @@ interface IResRoomPKOptions {
|
|
|
4251
4290
|
*/
|
|
4252
4291
|
content: string;
|
|
4253
4292
|
/**
|
|
4254
|
-
* 同意邀请时要设置的 key, 放在room级别的k和v
|
|
4293
|
+
* 同意邀请时要设置的 key, 放在 room 级别的 k 和 v,新加入房间的能拉取到
|
|
4255
4294
|
*/
|
|
4256
4295
|
key: string;
|
|
4257
4296
|
/**
|
|
4258
|
-
* 同意邀请时要设置的 value, 放在room级别的k和v
|
|
4297
|
+
* 同意邀请时要设置的 value, 放在 room 级别的 k 和 v,新加入房间的能拉取到
|
|
4259
4298
|
*/
|
|
4260
4299
|
value: string;
|
|
4261
4300
|
/**
|
|
@@ -4292,7 +4331,7 @@ interface IEndRoomPKOptions {
|
|
|
4292
4331
|
*/
|
|
4293
4332
|
interface IGooglePushConfig {
|
|
4294
4333
|
/**
|
|
4295
|
-
* 分组ID
|
|
4334
|
+
* 分组 ID
|
|
4296
4335
|
*/
|
|
4297
4336
|
collapseKey?: string;
|
|
4298
4337
|
/**
|
|
@@ -4317,7 +4356,7 @@ interface IiOSPushConfig {
|
|
|
4317
4356
|
*/
|
|
4318
4357
|
apnsCollapseId?: string;
|
|
4319
4358
|
/**
|
|
4320
|
-
* iOS 分类,如果不设置后台默认取消息类型字符串,如RC:TxtMsg
|
|
4359
|
+
* iOS 分类,如果不设置后台默认取消息类型字符串,如 RC:TxtMsg
|
|
4321
4360
|
*/
|
|
4322
4361
|
category?: string;
|
|
4323
4362
|
/**
|
|
@@ -4357,7 +4396,7 @@ interface IAndroidPushConfig {
|
|
|
4357
4396
|
channelIdHW?: string;
|
|
4358
4397
|
/**
|
|
4359
4398
|
* 华为推送消息分类
|
|
4360
|
-
*
|
|
4399
|
+
* 更多信息请参考华为消息分类标准文档:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835
|
|
4361
4400
|
* @since 5.7.3 版本开始支持
|
|
4362
4401
|
*/
|
|
4363
4402
|
categoryHW?: string;
|
|
@@ -4383,9 +4422,9 @@ interface IAndroidPushConfig {
|
|
|
4383
4422
|
typeVivo?: string;
|
|
4384
4423
|
/**
|
|
4385
4424
|
* Vivo 分类
|
|
4386
|
-
* 即时消息[IM],账号与资产[ACCOUNT],日程待办[TODO],设备信息[DEVICE_REMINDER],订单与物流[ORDER],订阅提醒[SUBSCRIPTION]
|
|
4425
|
+
* 即时消息 [IM],账号与资产 [ACCOUNT],日程待办 [TODO],设备信息 [DEVICE_REMINDER],订单与物流 [ORDER],订阅提醒 [SUBSCRIPTION]
|
|
4387
4426
|
* 运营消息分类
|
|
4388
|
-
* 新闻[NEWS],内容推荐[CONTENT],运营活动[MARKETING],社交动态[SOCIAL]
|
|
4427
|
+
* 新闻 [NEWS],内容推荐 [CONTENT],运营活动 [MARKETING],社交动态 [SOCIAL]
|
|
4389
4428
|
*
|
|
4390
4429
|
* @since 5.7.5
|
|
4391
4430
|
*/
|
|
@@ -4413,13 +4452,13 @@ interface IAndroidPushConfig {
|
|
|
4413
4452
|
*/
|
|
4414
4453
|
interface IHarmonyOSPushConfig {
|
|
4415
4454
|
/**
|
|
4416
|
-
* HarmonyOS通知栏消息右侧大图标 URL,必须 https 协议
|
|
4417
|
-
* 通知栏右侧图片,格式支持 png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000像素
|
|
4455
|
+
* HarmonyOS 通知栏消息右侧大图标 URL,必须 https 协议
|
|
4456
|
+
* 通知栏右侧图片,格式支持 png、jpg、jpeg、heif、gif、bmp,图片长*宽<25000 像素
|
|
4418
4457
|
* 图片不满足要求的情况下,终端不能显示通知消息。
|
|
4419
4458
|
*/
|
|
4420
4459
|
image?: string;
|
|
4421
4460
|
/**
|
|
4422
|
-
* HarmonyOS推送消息分类:
|
|
4461
|
+
* HarmonyOS 推送消息分类:
|
|
4423
4462
|
* 社交通讯:消息自分类标识,默认为空。category 取值必须为大写字母
|
|
4424
4463
|
* 默认值为 null,如果为 null,则以服务配置为准
|
|
4425
4464
|
*/
|
|
@@ -4462,7 +4501,7 @@ interface IPushConfig {
|
|
|
4462
4501
|
*/
|
|
4463
4502
|
harmonyOSConfig?: IHarmonyOSPushConfig;
|
|
4464
4503
|
/**
|
|
4465
|
-
*
|
|
4504
|
+
* 是否显示推送标题。仅针对 iOS 平台有效
|
|
4466
4505
|
*/
|
|
4467
4506
|
disablePushTitle?: boolean;
|
|
4468
4507
|
/**
|
|
@@ -4470,7 +4509,7 @@ interface IPushConfig {
|
|
|
4470
4509
|
*/
|
|
4471
4510
|
forceShowDetailContent?: boolean;
|
|
4472
4511
|
/**
|
|
4473
|
-
* 推送模板id
|
|
4512
|
+
* 推送模板 id
|
|
4474
4513
|
*/
|
|
4475
4514
|
templateId?: string;
|
|
4476
4515
|
}
|
|
@@ -4479,7 +4518,7 @@ interface IPushConfig {
|
|
|
4479
4518
|
*/
|
|
4480
4519
|
interface IAppPushConfig {
|
|
4481
4520
|
/**
|
|
4482
|
-
* 设备Id
|
|
4521
|
+
* 设备 Id
|
|
4483
4522
|
*/
|
|
4484
4523
|
deviceId: string;
|
|
4485
4524
|
/**
|
|
@@ -4509,7 +4548,7 @@ interface IConversationTag {
|
|
|
4509
4548
|
*/
|
|
4510
4549
|
createdTime?: number;
|
|
4511
4550
|
/**
|
|
4512
|
-
*
|
|
4551
|
+
* 是否在标签内置顶
|
|
4513
4552
|
*/
|
|
4514
4553
|
isTop?: boolean;
|
|
4515
4554
|
}
|
|
@@ -4653,11 +4692,15 @@ interface IProcessInfo {
|
|
|
4653
4692
|
};
|
|
4654
4693
|
}
|
|
4655
4694
|
|
|
4656
|
-
|
|
4695
|
+
/**
|
|
4696
|
+
* 连接事件监听器
|
|
4697
|
+
* @typeParam T - onConnected 是否包含 fromSuspend 参数
|
|
4698
|
+
*/
|
|
4699
|
+
declare type IConnectionListener<T extends boolean = false> = {
|
|
4657
4700
|
/**
|
|
4658
4701
|
* 连接成功
|
|
4659
4702
|
*/
|
|
4660
|
-
onConnected(): void;
|
|
4703
|
+
onConnected: T extends true ? (fromSuspend: boolean) => void : () => void;
|
|
4661
4704
|
/**
|
|
4662
4705
|
* 连接中止,SDK 内部会进行重连
|
|
4663
4706
|
* @param code 中止原因
|
|
@@ -4712,7 +4755,7 @@ interface IUpdateItem {
|
|
|
4712
4755
|
*/
|
|
4713
4756
|
mentionedInfo?: {
|
|
4714
4757
|
time: number;
|
|
4715
|
-
val:
|
|
4758
|
+
val: MentionedInfo | undefined;
|
|
4716
4759
|
};
|
|
4717
4760
|
/**
|
|
4718
4761
|
* 未读数变更
|
|
@@ -4726,7 +4769,7 @@ interface IUpdateItem {
|
|
|
4726
4769
|
*/
|
|
4727
4770
|
tags?: {
|
|
4728
4771
|
time: number;
|
|
4729
|
-
val: IConversationTag;
|
|
4772
|
+
val: IConversationTag[];
|
|
4730
4773
|
};
|
|
4731
4774
|
/**
|
|
4732
4775
|
* 会话最后一条消息变更
|
|
@@ -4741,10 +4784,6 @@ interface IUpdateItem {
|
|
|
4741
4784
|
* @category Interface
|
|
4742
4785
|
*/
|
|
4743
4786
|
interface IReceivedConversation {
|
|
4744
|
-
/**
|
|
4745
|
-
* 会话的业务标识
|
|
4746
|
-
*/
|
|
4747
|
-
channelId?: string;
|
|
4748
4787
|
/**
|
|
4749
4788
|
* 会话类型
|
|
4750
4789
|
*/
|
|
@@ -4752,33 +4791,50 @@ interface IReceivedConversation {
|
|
|
4752
4791
|
/**
|
|
4753
4792
|
* 会话 Id
|
|
4754
4793
|
* @description
|
|
4755
|
-
*
|
|
4756
|
-
*
|
|
4794
|
+
* * 当 `conversationType` 为 `ConversationType.GROUP` 或 `ConversationType.ULTRA_GROUP` 时,该值为群组 Id
|
|
4795
|
+
* * 当 `conversationType` 为 `ConversationType.PRIVATE` 时,该值为对方用户 Id
|
|
4757
4796
|
*/
|
|
4758
4797
|
targetId: string;
|
|
4759
4798
|
/**
|
|
4760
|
-
*
|
|
4799
|
+
* 会话的业务标识
|
|
4800
|
+
* @description
|
|
4801
|
+
* * 当会话类型为超级群时,该值为频道 ID
|
|
4802
|
+
* * 当会话类型为单、群聊时,该值为组织 ID,用于区分多组织场景
|
|
4803
|
+
* * 其他会话类型该值为空
|
|
4761
4804
|
*/
|
|
4762
|
-
|
|
4805
|
+
channelId?: string;
|
|
4763
4806
|
/**
|
|
4764
4807
|
* 会话中的最后一条消息
|
|
4765
4808
|
*/
|
|
4766
4809
|
latestMessage: IReceivedMessage | null;
|
|
4767
4810
|
/**
|
|
4768
|
-
*
|
|
4811
|
+
* 当前会话的未读消息数
|
|
4812
|
+
*/
|
|
4813
|
+
unreadMessageCount?: number;
|
|
4814
|
+
/**
|
|
4815
|
+
* 未读消息中是否包含 @ 自己、@ 所有人的消息
|
|
4769
4816
|
*/
|
|
4770
4817
|
hasMentioned?: boolean;
|
|
4771
4818
|
/**
|
|
4772
|
-
* 消息中的 @
|
|
4819
|
+
* 消息中的 @ 数据
|
|
4820
|
+
* @description
|
|
4821
|
+
* * 仅支持 Web 端;该数据基于本地接收到的消息计算得出,服务器不记录
|
|
4822
|
+
* * 仅支持群聊会话,自 5.20.0 版本开始,支持超级群会话类型
|
|
4823
|
+
*/
|
|
4824
|
+
mentionedInfo?: MentionedInfo;
|
|
4825
|
+
/**
|
|
4826
|
+
* @deprecated 废弃,该字段为内部记录,用于接收消息时避免本地计数重复
|
|
4827
|
+
* * 本地收消息时,避免重新收消息导致技术重复
|
|
4828
|
+
* * 本地撤回消息时,计算是否需要本地计数 -1
|
|
4773
4829
|
*/
|
|
4774
|
-
|
|
4830
|
+
lastUnreadTime: number;
|
|
4775
4831
|
/**
|
|
4776
4832
|
* 会话免打扰状态
|
|
4777
4833
|
* @description
|
|
4778
4834
|
* 1. 已开启免打扰
|
|
4779
4835
|
* 2. 未开启免打扰
|
|
4780
4836
|
*/
|
|
4781
|
-
notificationStatus
|
|
4837
|
+
notificationStatus?: NotificationStatus;
|
|
4782
4838
|
/**
|
|
4783
4839
|
* 会话免打扰状态
|
|
4784
4840
|
*/
|
|
@@ -4786,34 +4842,58 @@ interface IReceivedConversation {
|
|
|
4786
4842
|
/**
|
|
4787
4843
|
* 会话是否已置顶
|
|
4788
4844
|
*/
|
|
4789
|
-
isTop
|
|
4845
|
+
isTop?: boolean;
|
|
4790
4846
|
/**
|
|
4791
|
-
*
|
|
4847
|
+
* 会话项变更时间戳
|
|
4848
|
+
* @deprecated 字段已废弃即将删除,请勿使用
|
|
4792
4849
|
*/
|
|
4793
|
-
|
|
4850
|
+
versionTime?: number;
|
|
4794
4851
|
/**
|
|
4795
|
-
*
|
|
4852
|
+
* 按消息搜索会话时,匹配到的消息数量(仅 Electron 平台相关搜索接口返回值有效)
|
|
4796
4853
|
*/
|
|
4797
4854
|
matchCount?: number;
|
|
4798
4855
|
/**
|
|
4799
|
-
*
|
|
4856
|
+
* 会话的 @ 消息未读数
|
|
4857
|
+
* @since 5.7.9
|
|
4858
|
+
* @description
|
|
4859
|
+
* * 该属性仅 Web 端有效;Electron 平台可通过 `getUnreadMentionedMessages` 接口获取未读 @ 消息列表计算
|
|
4860
|
+
* * 该属性仅超级群会话有效,数据基于服务器记录,并依据接收到的消息进行本地维护
|
|
4861
|
+
* * 自 5.20.0 版本开始,新增支持单群聊会话,数据基于本地接收到的消息计算得出,服务器不记录
|
|
4800
4862
|
*/
|
|
4801
|
-
versionTime?: number;
|
|
4802
4863
|
unreadMentionedCount?: number;
|
|
4803
4864
|
/**
|
|
4804
4865
|
* @ 我的未读消息数
|
|
4805
|
-
* 仅超级群支持
|
|
4806
4866
|
* @since 5.7.9
|
|
4867
|
+
* @description
|
|
4868
|
+
* * 该属性仅 Web 端有效;Electron 平台可通过 `getUnreadMentionedMessages` 接口获取未读 @ 消息列表计算
|
|
4869
|
+
* * 该属性仅超级群会话有效,数据基于服务器记录,并依据接收到的消息进行本地维护
|
|
4870
|
+
* * 自 5.20.0 版本开始,新增支持单群聊会话,数据基于本地接收到的消息计算得出,服务器不记录
|
|
4807
4871
|
*/
|
|
4808
4872
|
unreadMentionedMeCount?: number;
|
|
4809
4873
|
/**
|
|
4810
|
-
*
|
|
4874
|
+
* 会话操作时间
|
|
4875
|
+
* - 5.8.4 版本开始,Electron 平台支持此参数,收发消息、设置置顶等操作将更新会话操作时间以用于会话排序。
|
|
4876
|
+
* - 5.14.0 版本开始 Web 端支持此参数,仅收发消息时会更新。
|
|
4877
|
+
* - 5.20.0 版本开始,Web 端增加内存状态维护,不再只有从服务器获取列表时返回。
|
|
4878
|
+
* @since 5.8.4
|
|
4811
4879
|
*/
|
|
4812
4880
|
operationTime?: number;
|
|
4813
4881
|
/**
|
|
4814
4882
|
* 会话草稿
|
|
4815
4883
|
*/
|
|
4816
4884
|
draft?: string;
|
|
4885
|
+
/**
|
|
4886
|
+
* 超级群频道类型
|
|
4887
|
+
* @description 仅超级群会话支持
|
|
4888
|
+
*/
|
|
4889
|
+
channelType?: UltraGroupChannelType;
|
|
4890
|
+
/**
|
|
4891
|
+
* 第一条未读消息
|
|
4892
|
+
* @description
|
|
4893
|
+
* * 该属性仅超级群会话支持,数据基于服务器记录,并依据接收到的消息进行本地维护
|
|
4894
|
+
* * 自 5.20.0 版本开始,新增支持单群聊会话,数据基于本地接收到的消息计算得出,并在本地缓存和维护,服务器不记录
|
|
4895
|
+
*/
|
|
4896
|
+
firstUnreadMessage?: IUltraUnreadMsg | null;
|
|
4817
4897
|
}
|
|
4818
4898
|
/**
|
|
4819
4899
|
* @category Interface
|
|
@@ -4824,143 +4904,29 @@ interface IReceivedConversationByTag extends IReceivedConversation {
|
|
|
4824
4904
|
/**
|
|
4825
4905
|
* 超级群会话数据结构
|
|
4826
4906
|
* @category Interface
|
|
4907
|
+
* @deprecated
|
|
4827
4908
|
*/
|
|
4828
|
-
|
|
4829
|
-
/**
|
|
4830
|
-
* 超级群频道类型,只有 ConversationType 为超级群时该字段有效
|
|
4831
|
-
*/
|
|
4832
|
-
channelType?: UltraGroupChannelType;
|
|
4833
|
-
/**
|
|
4834
|
-
* 第一条未读消息
|
|
4835
|
-
*/
|
|
4836
|
-
firstUnreadMessage?: IUltraUnreadMsg | null;
|
|
4837
|
-
}
|
|
4838
|
-
/**
|
|
4839
|
-
* 设置会话状态 参数 信息
|
|
4840
|
-
*/
|
|
4841
|
-
interface ISetConversationStatusOptions {
|
|
4842
|
-
conversationType: ConversationType;
|
|
4843
|
-
targetId: string;
|
|
4844
|
-
isTop?: boolean;
|
|
4845
|
-
notificationLevel?: number;
|
|
4846
|
-
channelId?: string;
|
|
4847
|
-
isUpdateTime?: boolean;
|
|
4848
|
-
}
|
|
4909
|
+
declare type IUltraGroupConversation = IReceivedConversation;
|
|
4849
4910
|
/**
|
|
4850
4911
|
* 会话更新信息
|
|
4851
4912
|
* @category Interface
|
|
4852
4913
|
*/
|
|
4853
|
-
interface IUpdatedConversation {
|
|
4914
|
+
interface IUpdatedConversation extends IReceivedConversation {
|
|
4854
4915
|
/**
|
|
4855
4916
|
* 更新项
|
|
4856
4917
|
*/
|
|
4857
|
-
updatedItems
|
|
4858
|
-
[key: string]: {
|
|
4859
|
-
time: number;
|
|
4860
|
-
val: any;
|
|
4861
|
-
};
|
|
4862
|
-
};
|
|
4863
|
-
/**
|
|
4864
|
-
* 会话类型
|
|
4865
|
-
*/
|
|
4866
|
-
conversationType: number;
|
|
4867
|
-
/**
|
|
4868
|
-
* 目标 ID
|
|
4869
|
-
*/
|
|
4870
|
-
targetId: string;
|
|
4871
|
-
/**
|
|
4872
|
-
* 会话最后一条消息
|
|
4873
|
-
*/
|
|
4874
|
-
latestMessage?: IReceivedMessage;
|
|
4875
|
-
/**
|
|
4876
|
-
* 会话未读数
|
|
4877
|
-
*/
|
|
4878
|
-
unreadMessageCount?: number;
|
|
4879
|
-
/**
|
|
4880
|
-
* 是否有 @ 消息
|
|
4881
|
-
*/
|
|
4882
|
-
hasMentioned?: boolean;
|
|
4883
|
-
/**
|
|
4884
|
-
* @ 信息详情
|
|
4885
|
-
*/
|
|
4886
|
-
mentionedInfo?: {
|
|
4887
|
-
/**
|
|
4888
|
-
* `@ 类型,其中 1 为 @ 所有人,2 为 @ 部分人`
|
|
4889
|
-
*/
|
|
4890
|
-
type: 1 | 2;
|
|
4891
|
-
/**
|
|
4892
|
-
* 被 @ 的用户 Id 列表,仅在 `type` 为 `2` 时有效
|
|
4893
|
-
*/
|
|
4894
|
-
userIdList: string[];
|
|
4895
|
-
};
|
|
4896
|
-
/**
|
|
4897
|
-
* 未读消息时间
|
|
4898
|
-
*/
|
|
4899
|
-
lastUnreadTime?: number;
|
|
4900
|
-
/**
|
|
4901
|
-
* 免打扰状态
|
|
4902
|
-
*/
|
|
4903
|
-
notificationStatus?: number;
|
|
4904
|
-
/**
|
|
4905
|
-
* 免打扰状态
|
|
4906
|
-
*/
|
|
4907
|
-
notificationLevel?: number;
|
|
4908
|
-
/**
|
|
4909
|
-
* 是否置顶
|
|
4910
|
-
*/
|
|
4911
|
-
isTop?: boolean;
|
|
4912
|
-
/**
|
|
4913
|
-
* 频道 ID
|
|
4914
|
-
*/
|
|
4915
|
-
channelId?: string;
|
|
4916
|
-
/**
|
|
4917
|
-
* 会话标签
|
|
4918
|
-
*/
|
|
4919
|
-
tags?: IUpdatedConversation[];
|
|
4920
|
-
versionTime?: number;
|
|
4921
|
-
/**
|
|
4922
|
-
* @ 消息未读数
|
|
4923
|
-
*/
|
|
4924
|
-
unreadMentionedCount?: number;
|
|
4925
|
-
/**
|
|
4926
|
-
* @ 我的未读消息数
|
|
4927
|
-
* 仅超级群支持
|
|
4928
|
-
* @since 5.7.9
|
|
4929
|
-
*/
|
|
4930
|
-
unreadMentionedMeCount?: number;
|
|
4918
|
+
updatedItems?: IUpdateItem;
|
|
4931
4919
|
}
|
|
4932
4920
|
/**
|
|
4933
4921
|
* 会话基础信息
|
|
4934
4922
|
* @category Interface
|
|
4935
4923
|
*/
|
|
4936
|
-
interface IBaseConversationInfo {
|
|
4937
|
-
/**
|
|
4938
|
-
* 会话类型
|
|
4939
|
-
*/
|
|
4940
|
-
conversationType: ConversationType;
|
|
4941
|
-
/**
|
|
4942
|
-
* 目标 ID
|
|
4943
|
-
*/
|
|
4944
|
-
targetId: string;
|
|
4924
|
+
interface IBaseConversationInfo extends IConversationIdentifier {
|
|
4945
4925
|
/**
|
|
4946
4926
|
* 频道 ID
|
|
4947
4927
|
*/
|
|
4948
4928
|
channelId: string;
|
|
4949
4929
|
}
|
|
4950
|
-
/**
|
|
4951
|
-
* 会话标签变更通知内容
|
|
4952
|
-
* @category Interface
|
|
4953
|
-
*/
|
|
4954
|
-
interface IConversationState extends IBaseConversationInfo {
|
|
4955
|
-
/**
|
|
4956
|
-
* 消息未读数
|
|
4957
|
-
*/
|
|
4958
|
-
unreadCount: number;
|
|
4959
|
-
/**
|
|
4960
|
-
* @ 消息未读数
|
|
4961
|
-
*/
|
|
4962
|
-
unreadMentionedCount: number;
|
|
4963
|
-
}
|
|
4964
4930
|
/**
|
|
4965
4931
|
* 指定超级群会话传参
|
|
4966
4932
|
* @category Interface
|
|
@@ -5062,8 +5028,13 @@ interface IUltraChannelDeleteInfo {
|
|
|
5062
5028
|
interface IUltraGroupUnreadInfo {
|
|
5063
5029
|
/**
|
|
5064
5030
|
* 会话类型
|
|
5031
|
+
* @deprecated 请使用 `conversationType` 替代
|
|
5065
5032
|
*/
|
|
5066
5033
|
type: ConversationType;
|
|
5034
|
+
/**
|
|
5035
|
+
* 会话类型
|
|
5036
|
+
*/
|
|
5037
|
+
conversationType: ConversationType;
|
|
5067
5038
|
/**
|
|
5068
5039
|
* 目标 ID
|
|
5069
5040
|
*/
|
|
@@ -5110,19 +5081,13 @@ interface IConversationIdentifier {
|
|
|
5110
5081
|
interface IConversationOption extends IConversationIdentifier {
|
|
5111
5082
|
/**
|
|
5112
5083
|
* 频道 Id 字符串类型,不能包含 _ , 长度不能超过 20
|
|
5084
|
+
* @description
|
|
5085
|
+
* * 当会话类型为超级群时,该值为频道 ID
|
|
5086
|
+
* * 当会话类型为单、群聊时,该值为组织 ID,用于区分多组织场景
|
|
5087
|
+
* * 其他会话类型该值为空
|
|
5113
5088
|
*/
|
|
5114
5089
|
channelId?: string;
|
|
5115
5090
|
}
|
|
5116
|
-
interface IServerConversationStatus {
|
|
5117
|
-
conversationType: number;
|
|
5118
|
-
targetId: string;
|
|
5119
|
-
updatedTime?: number;
|
|
5120
|
-
notificationStatus?: number;
|
|
5121
|
-
notificationLevel?: number;
|
|
5122
|
-
isTop?: boolean;
|
|
5123
|
-
tags?: IConversationTag[];
|
|
5124
|
-
channelId?: string;
|
|
5125
|
-
}
|
|
5126
5091
|
interface IConversationUnreadCount extends IConversationOption {
|
|
5127
5092
|
unreadCount: number;
|
|
5128
5093
|
}
|
|
@@ -5137,7 +5102,7 @@ interface IReadReceiptResponseInfo {
|
|
|
5137
5102
|
*/
|
|
5138
5103
|
isReceiptRequestMessage?: boolean;
|
|
5139
5104
|
/**
|
|
5140
|
-
*
|
|
5105
|
+
* 是否已发送响应,仅 Electron 平台有效
|
|
5141
5106
|
*/
|
|
5142
5107
|
hasRespond?: boolean;
|
|
5143
5108
|
/**
|
|
@@ -5160,7 +5125,7 @@ interface IMessageReader {
|
|
|
5160
5125
|
userId: string;
|
|
5161
5126
|
}
|
|
5162
5127
|
/**
|
|
5163
|
-
* 已读回执响应数据结构V4
|
|
5128
|
+
* 已读回执响应数据结构 V4
|
|
5164
5129
|
* @category Interface
|
|
5165
5130
|
* @hidden
|
|
5166
5131
|
*/
|
|
@@ -5181,7 +5146,7 @@ interface IMessageReaderResponse {
|
|
|
5181
5146
|
*/
|
|
5182
5147
|
interface IReadReceiptInfo {
|
|
5183
5148
|
/**
|
|
5184
|
-
*
|
|
5149
|
+
* 是否已经发送已读回执,仅 V2 支持
|
|
5185
5150
|
* @hidden
|
|
5186
5151
|
* @deprecated
|
|
5187
5152
|
*/
|
|
@@ -5312,7 +5277,6 @@ interface IReceivedMessage {
|
|
|
5312
5277
|
content: any;
|
|
5313
5278
|
/**
|
|
5314
5279
|
* 消息结构名称,即消息类型
|
|
5315
|
-
* @example RC:TxtMsg
|
|
5316
5280
|
*/
|
|
5317
5281
|
messageType: string;
|
|
5318
5282
|
/**
|
|
@@ -5320,11 +5284,13 @@ interface IReceivedMessage {
|
|
|
5320
5284
|
*/
|
|
5321
5285
|
messageUId: string;
|
|
5322
5286
|
/**
|
|
5323
|
-
*
|
|
5287
|
+
* 消息方向
|
|
5288
|
+
* * 1: 发送
|
|
5289
|
+
* * 2: 接收
|
|
5324
5290
|
*/
|
|
5325
5291
|
messageDirection: MessageDirection;
|
|
5326
5292
|
/**
|
|
5327
|
-
*
|
|
5293
|
+
* 是否为离线消息,不适用于超级群消息
|
|
5328
5294
|
*/
|
|
5329
5295
|
isOffLineMessage: boolean;
|
|
5330
5296
|
/**
|
|
@@ -5374,23 +5340,24 @@ interface IReceivedMessage {
|
|
|
5374
5340
|
* 只能表示单一状态,推荐使用 receivedStatusInfo 来判断接收消息状态
|
|
5375
5341
|
* @deprecated
|
|
5376
5342
|
*/
|
|
5377
|
-
receivedStatus:
|
|
5343
|
+
receivedStatus: ReceivedStatus;
|
|
5378
5344
|
/**
|
|
5379
5345
|
* 消息接收状态详情
|
|
5380
|
-
*
|
|
5346
|
+
* 推荐使用,receivedStatusInfo 值更详细,能同时表示多个接收状态
|
|
5381
5347
|
*/
|
|
5382
5348
|
receivedStatusInfo?: IReceivedStatusInfo;
|
|
5383
5349
|
/**
|
|
5384
|
-
* 消息本地 ID, web 端由 lib 内生成,
|
|
5350
|
+
* 消息本地 ID, web 端由 lib 内生成,PC 端由协议栈数据库生成自增 ID
|
|
5385
5351
|
*/
|
|
5386
5352
|
messageId?: number;
|
|
5387
5353
|
/**
|
|
5388
|
-
* 消息发送状态,
|
|
5354
|
+
* 消息发送状态,web 端由 lib 内根据消息状态设置值为 发送中、已发送和发送失败,PC 端由协议栈自动维护或用户自己设置
|
|
5389
5355
|
*/
|
|
5390
5356
|
sentStatus?: SentStatus;
|
|
5391
5357
|
/**
|
|
5392
|
-
* 群已读回执信息
|
|
5393
|
-
* grpRRVer
|
|
5358
|
+
* 群已读回执信息
|
|
5359
|
+
* * 导航配置 grpRRVer = 0 时为 IReadReceiptResponseInfo,
|
|
5360
|
+
* * 导航配置 grpRRVer >= 1 时为 IReadReceiptInfo
|
|
5394
5361
|
*/
|
|
5395
5362
|
readReceiptInfo?: IReadReceiptInfo | IReadReceiptResponseInfo;
|
|
5396
5363
|
/**
|
|
@@ -5414,13 +5381,23 @@ interface IReceivedMessage {
|
|
|
5414
5381
|
*/
|
|
5415
5382
|
hasMore?: boolean;
|
|
5416
5383
|
/**
|
|
5417
|
-
* 定向用户列表(
|
|
5384
|
+
* 定向用户列表 (仅支持群聊,超级群)
|
|
5418
5385
|
*/
|
|
5419
5386
|
directedUserIds?: string[];
|
|
5420
5387
|
/**
|
|
5421
5388
|
* 禁止更新到会话最新一条消息,默认 false: 更新,true: 不更新
|
|
5422
5389
|
*/
|
|
5423
5390
|
disableUpdateLastMessage?: boolean;
|
|
5391
|
+
/**
|
|
5392
|
+
* 是否需要回执,仅支持单群聊会话类型内有效
|
|
5393
|
+
* @since 5.20.0
|
|
5394
|
+
*/
|
|
5395
|
+
needReceipt?: boolean;
|
|
5396
|
+
/**
|
|
5397
|
+
* 是否已发送回执,仅获取历史消息列表时有效;仅单群聊会话类型内有效
|
|
5398
|
+
* @since 5.20.0
|
|
5399
|
+
*/
|
|
5400
|
+
sendReceipt?: boolean;
|
|
5424
5401
|
}
|
|
5425
5402
|
/**
|
|
5426
5403
|
* 第一条未读消息信息
|
|
@@ -5538,7 +5515,7 @@ interface IOperateStatusNotify {
|
|
|
5538
5515
|
}
|
|
5539
5516
|
declare type IRecallMsgOptions = {
|
|
5540
5517
|
/**
|
|
5541
|
-
* 消息的唯一id,客户端依赖此属性查找要撤回的消息
|
|
5518
|
+
* 消息的唯一 id,客户端依赖此属性查找要撤回的消息
|
|
5542
5519
|
*/
|
|
5543
5520
|
messageUId: string;
|
|
5544
5521
|
/**
|
|
@@ -5700,6 +5677,11 @@ interface ISendMsgOptions {
|
|
|
5700
5677
|
* 禁止更新到会话最新一条消息,默认 false: 更新,true: 不更新
|
|
5701
5678
|
*/
|
|
5702
5679
|
disableUpdateLastMessage?: boolean;
|
|
5680
|
+
/**
|
|
5681
|
+
* 是否需要回执,仅支持单群聊会话类型内有效,需要开启已读 v5 功能开关
|
|
5682
|
+
* @since 5.20.0
|
|
5683
|
+
*/
|
|
5684
|
+
needReceipt?: boolean;
|
|
5703
5685
|
}
|
|
5704
5686
|
interface IInsertMsgOptions {
|
|
5705
5687
|
senderUserId: string;
|
|
@@ -5792,7 +5774,7 @@ interface IInsertMessage {
|
|
|
5792
5774
|
*/
|
|
5793
5775
|
directedUserIds?: string[];
|
|
5794
5776
|
/**
|
|
5795
|
-
*
|
|
5777
|
+
* 插入消息是否计入未读数:true 计数 false 不计数,默认不计数
|
|
5796
5778
|
*/
|
|
5797
5779
|
isUnread?: boolean;
|
|
5798
5780
|
/**
|
|
@@ -5958,11 +5940,11 @@ interface IUltraGroupUnreadMentionedOption {
|
|
|
5958
5940
|
*/
|
|
5959
5941
|
channelId?: string;
|
|
5960
5942
|
/**
|
|
5961
|
-
* 消息的时间戳,首次获取传 0
|
|
5943
|
+
* 消息的时间戳,首次获取传 0,后续查询传未读 @ 列表中的消息时间戳
|
|
5962
5944
|
*/
|
|
5963
5945
|
sentTime: number;
|
|
5964
5946
|
/**
|
|
5965
|
-
* 数据个数,最大50
|
|
5947
|
+
* 数据个数,最大 50
|
|
5966
5948
|
*/
|
|
5967
5949
|
count: number;
|
|
5968
5950
|
}
|
|
@@ -5980,7 +5962,7 @@ interface IUltraUnreadMsg {
|
|
|
5980
5962
|
*/
|
|
5981
5963
|
sentTime: number;
|
|
5982
5964
|
/**
|
|
5983
|
-
* @ 类型:
|
|
5965
|
+
* @ 类型:1 所有人;2: 部分人
|
|
5984
5966
|
*/
|
|
5985
5967
|
mentionedType?: number;
|
|
5986
5968
|
/**
|
|
@@ -5992,7 +5974,7 @@ interface IUltraUnreadMsg {
|
|
|
5992
5974
|
* 被 @ 的用户信息
|
|
5993
5975
|
* @category Interface
|
|
5994
5976
|
*/
|
|
5995
|
-
interface
|
|
5977
|
+
interface MentionedInfo {
|
|
5996
5978
|
/**
|
|
5997
5979
|
* @ 类型
|
|
5998
5980
|
*/
|
|
@@ -6002,7 +5984,7 @@ interface MentionedInfoBody {
|
|
|
6002
5984
|
*/
|
|
6003
5985
|
userIdList?: string[];
|
|
6004
5986
|
/**
|
|
6005
|
-
* 携带扩展信息,例如
|
|
5987
|
+
* 携带扩展信息,例如 `有人 @ 你`
|
|
6006
5988
|
*/
|
|
6007
5989
|
mentionedContent?: string;
|
|
6008
5990
|
}
|
|
@@ -6070,21 +6052,9 @@ interface ICombineV2MessageContent {
|
|
|
6070
6052
|
/**
|
|
6071
6053
|
* @category Interface
|
|
6072
6054
|
*/
|
|
6073
|
-
interface IClearMessageOption {
|
|
6074
|
-
/**
|
|
6075
|
-
* 目标 ID
|
|
6076
|
-
*/
|
|
6077
|
-
targetId: string;
|
|
6078
|
-
/**
|
|
6079
|
-
* 会话类型
|
|
6080
|
-
*/
|
|
6081
|
-
conversationType: ConversationType;
|
|
6082
|
-
/**
|
|
6083
|
-
* 频道 ID
|
|
6084
|
-
*/
|
|
6085
|
-
channelId?: string;
|
|
6055
|
+
interface IClearMessageOption extends IConversationOption {
|
|
6086
6056
|
/**
|
|
6087
|
-
*
|
|
6057
|
+
* 时间戳
|
|
6088
6058
|
*/
|
|
6089
6059
|
timestamp?: number;
|
|
6090
6060
|
}
|
|
@@ -6140,6 +6110,7 @@ interface IGroupMessageDeliverStatus {
|
|
|
6140
6110
|
|
|
6141
6111
|
/**
|
|
6142
6112
|
* 异步任务结果结构
|
|
6113
|
+
* @description 该结构即将废弃,请使用 {@link RCResult} 替代
|
|
6143
6114
|
* @category Interface
|
|
6144
6115
|
*/
|
|
6145
6116
|
declare type IAsyncRes<T = void> = Pick<RCResult<T>, 'code' | 'data'> & {
|
|
@@ -6157,7 +6128,6 @@ declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
|
|
|
6157
6128
|
* 拓展方法定义,便于 electron-solution 实现时保持接口类型推导可用
|
|
6158
6129
|
*/
|
|
6159
6130
|
interface IExtraMethod {
|
|
6160
|
-
getConversationsByPage(conversationTypes: ConversationType[], sentTime: number, count: number, channelId?: string, topPriority?: boolean): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
6161
6131
|
getHistoryMessagesByObjectNames(conversationType: ConversationType, targetId: string, sentTime: number, count: number, objectNames: string[], desc: 0 | 1, tag: string): Promise<IAsyncRes<{
|
|
6162
6132
|
list: IReceivedMessage[];
|
|
6163
6133
|
hasMore: boolean;
|
|
@@ -6292,22 +6262,18 @@ interface INaviInfo {
|
|
|
6292
6262
|
/**
|
|
6293
6263
|
* 是否开启用户级配置,若开启,需连接成功后立即拉取实时配置,0 | 1
|
|
6294
6264
|
* @description
|
|
6295
|
-
*
|
|
6265
|
+
* 配置来源:
|
|
6296
6266
|
* 1. 导航
|
|
6297
6267
|
* 2. 服务端实时下发
|
|
6298
|
-
*
|
|
6299
|
-
* 1. Lan.
|
|
6300
|
-
* 2. ShPushSwit.
|
|
6301
|
-
* 3. MobPushSwit: Web/PC
|
|
6302
|
-
* 4. OffMsgDur: 离线消息保存天数,设置天数不可大于App
|
|
6303
|
-
* 5. VoipInfo:
|
|
6268
|
+
* 已有配置字段:
|
|
6269
|
+
* 1. Lan. 推送使用的语言设置,用户端可自定义修改。Web 端未做设置,只做接收
|
|
6270
|
+
* 2. ShPushSwit. 推送是否显示详情设置,用户端可自定义修改。Web 端未做设置,只做接收
|
|
6271
|
+
* 3. MobPushSwit: Web/PC 在线,移动端不在线是否发送推送开关,用户端可自定义修改。Web 端未做设置,只做接收
|
|
6272
|
+
* 4. OffMsgDur: 离线消息保存天数,设置天数不可大于 App 级对应配置,用户端可自定义修改。Web 端未做设置,只做接收
|
|
6273
|
+
* 5. VoipInfo: 音视频相关配置,用户端不可自定义修改。由服务端决定,与导航下发格式一致
|
|
6304
6274
|
* @todo 需确认公有云与私有云区别
|
|
6305
6275
|
*/
|
|
6306
6276
|
openUS: 0 | 1;
|
|
6307
|
-
/**
|
|
6308
|
-
* 超级群功能开关,1表示开
|
|
6309
|
-
*/
|
|
6310
|
-
ugMsg?: 0 | 1;
|
|
6311
6277
|
/**
|
|
6312
6278
|
* 群离线消息最大下发条数,`0` 为关闭
|
|
6313
6279
|
* @description 公有云独有配合
|
|
@@ -6414,21 +6380,22 @@ interface INaviInfo {
|
|
|
6414
6380
|
*/
|
|
6415
6381
|
crypto?: string;
|
|
6416
6382
|
/**
|
|
6417
|
-
*
|
|
6418
|
-
*
|
|
6419
|
-
* 1:
|
|
6420
|
-
* 2: 废弃
|
|
6421
|
-
* 3: V4
|
|
6383
|
+
* 群组回执开关,
|
|
6384
|
+
* * 0(或者没有): 关闭 v1 版本
|
|
6385
|
+
* * 1: v2 版本,目前仅 Beem 与部分私有云用户使用
|
|
6386
|
+
* * 2: 废弃
|
|
6387
|
+
* * 3: V4 版本,目前仅 Global-UI-Kit 使用,未公开
|
|
6388
|
+
* * 4: V5 版本,5.20.0 版本新增
|
|
6422
6389
|
*/
|
|
6423
6390
|
grpRRVer?: number;
|
|
6424
6391
|
/**
|
|
6425
6392
|
* 会话驱动类型
|
|
6426
|
-
* 0: 默认,客户端离线消息驱动计算未读数(客户端通过pullMsg结果计算)
|
|
6427
|
-
* 1: 服务端会话驱动计算未读数(调用pullSes进行初始化),暂只影响更新会话已读时间接口
|
|
6393
|
+
* 0: 默认,客户端离线消息驱动计算未读数 (客户端通过 pullMsg 结果计算)
|
|
6394
|
+
* 1: 服务端会话驱动计算未读数 (调用 pullSes 进行初始化),暂只影响更新会话已读时间接口
|
|
6428
6395
|
*/
|
|
6429
6396
|
sesDriven?: number;
|
|
6430
6397
|
/**
|
|
6431
|
-
*
|
|
6398
|
+
* 防黑产开关,1: 打开,0:关闭
|
|
6432
6399
|
*/
|
|
6433
6400
|
openAnti?: number;
|
|
6434
6401
|
/**
|
|
@@ -6450,7 +6417,7 @@ interface INaviInfo {
|
|
|
6450
6417
|
serverAddr?: IServerAddressData[];
|
|
6451
6418
|
/**
|
|
6452
6419
|
* V2 版本中新增字段
|
|
6453
|
-
* 新版本控制tag
|
|
6420
|
+
* 新版本控制 tag
|
|
6454
6421
|
*/
|
|
6455
6422
|
excludeLogTag?: string;
|
|
6456
6423
|
/**
|
|
@@ -6462,12 +6429,6 @@ interface INaviInfo {
|
|
|
6462
6429
|
* 消息断档开关
|
|
6463
6430
|
*/
|
|
6464
6431
|
repairHisMsg?: number;
|
|
6465
|
-
/**
|
|
6466
|
-
* 超级群驱动配置
|
|
6467
|
-
* 第一位:是否开启消息变更SDK主动拉取模式(关闭全量离线消息变更功能)
|
|
6468
|
-
* 第二位:是否开启默认群频道功能(关闭空频道(""))
|
|
6469
|
-
*/
|
|
6470
|
-
ugDriven?: number;
|
|
6471
6432
|
/**
|
|
6472
6433
|
* #用户订阅驱动配置,位标记!!:
|
|
6473
6434
|
* 第一位:是否开启在线状态订阅功能
|
|
@@ -6481,14 +6442,14 @@ interface INaviInfo {
|
|
|
6481
6442
|
*/
|
|
6482
6443
|
userProfile?: number;
|
|
6483
6444
|
/**
|
|
6484
|
-
*
|
|
6485
|
-
* 第一位:是否开启群托管 事件同步功能
|
|
6486
|
-
|
|
6445
|
+
* 事件驱动开关
|
|
6446
|
+
* * 第一位:是否开启群托管 事件同步功能
|
|
6447
|
+
* * 第二位:是否开启好友关系 事件同步功能
|
|
6487
6448
|
*/
|
|
6488
6449
|
eventDriven?: number;
|
|
6489
6450
|
/**
|
|
6490
|
-
*
|
|
6491
|
-
* 第一位:0:未开通实时会话,1: 开通实时会话
|
|
6451
|
+
* 服务开启实时会话,按位运算
|
|
6452
|
+
* * 第一位:0:未开通实时会话,1: 开通实时会话
|
|
6492
6453
|
*/
|
|
6493
6454
|
sessionMode?: number;
|
|
6494
6455
|
/**
|
|
@@ -6506,6 +6467,24 @@ interface INaviInfo {
|
|
|
6506
6467
|
* 是否开启 baggage 功能
|
|
6507
6468
|
*/
|
|
6508
6469
|
baggageEnabled?: number;
|
|
6470
|
+
/**
|
|
6471
|
+
* 超级群功能开关,按位运算
|
|
6472
|
+
* * 第一位 0 表示关闭,1 表示开启
|
|
6473
|
+
*/
|
|
6474
|
+
ugMsg?: 0 | 1;
|
|
6475
|
+
/**
|
|
6476
|
+
* 超级群驱动配置
|
|
6477
|
+
* * 第一位:是否开启消息变更 SDK 主动拉取模式 (关闭全量离线消息变更功能)
|
|
6478
|
+
* * 第二位:是否开启默认群频道功能 (关闭空频道 ("")),开关为内部开关,不可修改;早期 App 默认关闭,新增 App 均为默认开启;
|
|
6479
|
+
*/
|
|
6480
|
+
ugDriven?: number;
|
|
6481
|
+
/**
|
|
6482
|
+
* 会话列表配置
|
|
6483
|
+
* * 第一位:会话列表是否包含超级群会话,0 为关闭,1 表示开启;
|
|
6484
|
+
* * 第二位:协议栈是否拉服务端会话列表,0 为关闭,1 表示开启;
|
|
6485
|
+
* * 第三位:协议栈自动拉取服务端会话列表,0 为关闭,1 表示开启;仅当第二位为 1 时有效
|
|
6486
|
+
*/
|
|
6487
|
+
sessionCfg?: number;
|
|
6509
6488
|
/**
|
|
6510
6489
|
* 推送服务器地址
|
|
6511
6490
|
*/
|
|
@@ -6520,7 +6499,7 @@ interface INaviInfo {
|
|
|
6520
6499
|
* */
|
|
6521
6500
|
interface IUserProfileInfo {
|
|
6522
6501
|
/**
|
|
6523
|
-
* 用户Id
|
|
6502
|
+
* 用户 Id
|
|
6524
6503
|
* @description 不可修改
|
|
6525
6504
|
*/
|
|
6526
6505
|
userId?: string;
|
|
@@ -6928,7 +6907,7 @@ interface IGroupInfoOption extends IGroupBaseInfo {
|
|
|
6928
6907
|
interface IGroupBaseInfo {
|
|
6929
6908
|
/**
|
|
6930
6909
|
* 群组 ID
|
|
6931
|
-
* @description 1 ~ 64 个字符,仅支持字母,数字 和 -_
|
|
6910
|
+
* @description 1 ~ 64 个字符,仅支持字母,数字 和 -_+=|:字符
|
|
6932
6911
|
*/
|
|
6933
6912
|
groupId: string;
|
|
6934
6913
|
/**
|
|
@@ -6978,15 +6957,15 @@ interface IGroupInfo extends IGroupInfoOption {
|
|
|
6978
6957
|
*/
|
|
6979
6958
|
interface IQuitGroupConfig {
|
|
6980
6959
|
/**
|
|
6981
|
-
* 是否移除群成员禁言状态,true代表移除,false代表不移除。默认为true
|
|
6960
|
+
* 是否移除群成员禁言状态,true 代表移除,false 代表不移除。默认为 true
|
|
6982
6961
|
*/
|
|
6983
6962
|
removeMuteStatus: boolean;
|
|
6984
6963
|
/**
|
|
6985
|
-
* 是否移除群成员白名单,true代表移除,false代表不移除。默认为true
|
|
6964
|
+
* 是否移除群成员白名单,true 代表移除,false 代表不移除。默认为 true
|
|
6986
6965
|
*/
|
|
6987
6966
|
removeWhiteList: boolean;
|
|
6988
6967
|
/**
|
|
6989
|
-
* 是否移除特别关注群成员,true代表移除,false代表不移除。默认为true
|
|
6968
|
+
* 是否移除特别关注群成员,true 代表移除,false 代表不移除。默认为 true
|
|
6990
6969
|
*/
|
|
6991
6970
|
removeFollow: boolean;
|
|
6992
6971
|
}
|
|
@@ -6997,7 +6976,7 @@ interface IQuitGroupConfig {
|
|
|
6997
6976
|
*/
|
|
6998
6977
|
interface IGroupMemberInfo {
|
|
6999
6978
|
/**
|
|
7000
|
-
* 群成员用户Id。
|
|
6979
|
+
* 群成员用户 Id。
|
|
7001
6980
|
*/
|
|
7002
6981
|
userId: string;
|
|
7003
6982
|
/**
|
|
@@ -7032,7 +7011,7 @@ interface IGroupMemberInfo {
|
|
|
7032
7011
|
*/
|
|
7033
7012
|
interface IFollowsInfo {
|
|
7034
7013
|
/**
|
|
7035
|
-
* 用户Id。
|
|
7014
|
+
* 用户 Id。
|
|
7036
7015
|
*/
|
|
7037
7016
|
userId: string;
|
|
7038
7017
|
/**
|
|
@@ -7047,7 +7026,7 @@ interface IFollowsInfo {
|
|
|
7047
7026
|
*/
|
|
7048
7027
|
interface IGroupApplicationInfo {
|
|
7049
7028
|
/**
|
|
7050
|
-
* 群Id。
|
|
7029
|
+
* 群 Id。
|
|
7051
7030
|
*/
|
|
7052
7031
|
groupId: string;
|
|
7053
7032
|
/**
|
|
@@ -7173,7 +7152,7 @@ interface IGroupOperationInfo {
|
|
|
7173
7152
|
operation: GroupOperation;
|
|
7174
7153
|
/**
|
|
7175
7154
|
* 本次操作行为,涉及到的群成员列表
|
|
7176
|
-
*
|
|
7155
|
+
* 注意:创建群组,解散群组时为空
|
|
7177
7156
|
*/
|
|
7178
7157
|
memberInfos?: IGroupMemberInfo[];
|
|
7179
7158
|
/**
|
|
@@ -7188,7 +7167,7 @@ interface IGroupOperationInfo {
|
|
|
7188
7167
|
*/
|
|
7189
7168
|
interface IGroupMemberInfoChanged {
|
|
7190
7169
|
/**
|
|
7191
|
-
* 群组ID
|
|
7170
|
+
* 群组 ID
|
|
7192
7171
|
*/
|
|
7193
7172
|
groupId: string;
|
|
7194
7173
|
/**
|
|
@@ -7240,7 +7219,7 @@ interface IGroupInfoChanged {
|
|
|
7240
7219
|
*/
|
|
7241
7220
|
interface IGroupRemarkChangedSync {
|
|
7242
7221
|
/**
|
|
7243
|
-
* 群组ID
|
|
7222
|
+
* 群组 ID
|
|
7244
7223
|
*/
|
|
7245
7224
|
groupId: string;
|
|
7246
7225
|
/**
|
|
@@ -7263,7 +7242,7 @@ interface IGroupRemarkChangedSync {
|
|
|
7263
7242
|
*/
|
|
7264
7243
|
interface IGroupFollowsChangedSync {
|
|
7265
7244
|
/**
|
|
7266
|
-
* 群组ID
|
|
7245
|
+
* 群组 ID
|
|
7267
7246
|
*/
|
|
7268
7247
|
groupId: string;
|
|
7269
7248
|
/**
|
|
@@ -7316,53 +7295,298 @@ interface INotificationQuietHoursSetting {
|
|
|
7316
7295
|
}
|
|
7317
7296
|
|
|
7318
7297
|
/**
|
|
7319
|
-
*
|
|
7298
|
+
* 消息类型描述
|
|
7320
7299
|
*/
|
|
7321
|
-
|
|
7322
|
-
|
|
7323
|
-
|
|
7324
|
-
|
|
7325
|
-
|
|
7326
|
-
|
|
7327
|
-
|
|
7328
|
-
|
|
7300
|
+
declare type MessageTypeDescription = {
|
|
7301
|
+
/** 是否存储 */
|
|
7302
|
+
isPersited: boolean;
|
|
7303
|
+
/** 是否计数 */
|
|
7304
|
+
isCounted: boolean;
|
|
7305
|
+
/** 是否为状态消息 */
|
|
7306
|
+
isStatusMessage?: boolean;
|
|
7307
|
+
/** 搜索属性 */
|
|
7308
|
+
searchProps?: string[];
|
|
7309
|
+
/** 是否为自定义消息 */
|
|
7310
|
+
isCustom?: boolean;
|
|
7311
|
+
};
|
|
7312
|
+
declare type MessageRegisterParams = Omit<MessageTypeDescription, 'isCustom'>;
|
|
7329
7313
|
/**
|
|
7330
|
-
*
|
|
7314
|
+
* 获取消息类型描述
|
|
7315
|
+
* @param type 消息类型
|
|
7316
|
+
* @param ignoreDefault 是否在获取不到描述时构建默认描述
|
|
7317
|
+
* @returns 消息类型描述
|
|
7318
|
+
*/
|
|
7319
|
+
declare function getMessageTypeDescription(type: string): MessageTypeDescription;
|
|
7320
|
+
/**
|
|
7321
|
+
* 判断消息类型是否已注册
|
|
7322
|
+
* @param type 消息类型
|
|
7323
|
+
* @returns 是否已注册
|
|
7324
|
+
*/
|
|
7325
|
+
declare function hasMessageTypeDescription(type: string): boolean;
|
|
7326
|
+
|
|
7327
|
+
/**
|
|
7328
|
+
* 会话列表查询条件枚举
|
|
7331
7329
|
*/
|
|
7332
|
-
|
|
7330
|
+
declare const ConversationListFilterType: {
|
|
7333
7331
|
/**
|
|
7334
|
-
*
|
|
7332
|
+
* 按时间戳查询会话列表
|
|
7335
7333
|
*/
|
|
7336
|
-
|
|
7334
|
+
readonly TIMESTAMP: 0;
|
|
7337
7335
|
/**
|
|
7338
|
-
*
|
|
7339
|
-
* @param token
|
|
7340
|
-
* @param reconnectKickEnable
|
|
7336
|
+
* 获取置顶会话列表
|
|
7341
7337
|
*/
|
|
7342
|
-
|
|
7343
|
-
getNaviInfoFromCache(): INaviInfo | null;
|
|
7338
|
+
readonly TOP: 1;
|
|
7344
7339
|
/**
|
|
7345
|
-
*
|
|
7346
|
-
* @param version
|
|
7340
|
+
* 获取免打扰会话列表,暂不支持 Electron 平台
|
|
7347
7341
|
*/
|
|
7348
|
-
|
|
7349
|
-
[name: string]: string;
|
|
7350
|
-
}): void;
|
|
7342
|
+
readonly BLOCKED: 2;
|
|
7351
7343
|
/**
|
|
7352
|
-
*
|
|
7344
|
+
* 获取未读会话列表
|
|
7353
7345
|
*/
|
|
7354
|
-
|
|
7346
|
+
readonly UNREAD: 3;
|
|
7355
7347
|
/**
|
|
7356
|
-
*
|
|
7357
|
-
* 对于未实现的方法,接口响应 Unsupport 错误码
|
|
7358
|
-
* @param method
|
|
7359
|
-
* @param args
|
|
7348
|
+
* 获取全部会话列表,仅 Electron 平台支持
|
|
7360
7349
|
*/
|
|
7361
|
-
|
|
7350
|
+
readonly ALL: 4;
|
|
7362
7351
|
/**
|
|
7363
|
-
*
|
|
7364
|
-
|
|
7365
|
-
|
|
7352
|
+
* 按分页索引获取会话列表,仅 Electron 平台支持;目前仅 v2-adapter 中有调用
|
|
7353
|
+
*/
|
|
7354
|
+
readonly PAGE_INDEX: 5;
|
|
7355
|
+
};
|
|
7356
|
+
/**
|
|
7357
|
+
* 按时间戳查询参数
|
|
7358
|
+
*/
|
|
7359
|
+
declare type GetConversationListByTimestampParams = {
|
|
7360
|
+
/**
|
|
7361
|
+
* 获取会话起始时间,需要精确到毫秒,0 表示当前时间
|
|
7362
|
+
*/
|
|
7363
|
+
startTime: number;
|
|
7364
|
+
/**
|
|
7365
|
+
* 分页数量,默认值
|
|
7366
|
+
*/
|
|
7367
|
+
count: number;
|
|
7368
|
+
/**
|
|
7369
|
+
* 该参数在 Electron 平台下无效,Electron 平台下始终为 0;
|
|
7370
|
+
* * 0 - 从 startTime 开始向前查询,数据按时间降序排序
|
|
7371
|
+
* * 1 - 从 startTime 开始向后查询,数据按时间升序排序
|
|
7372
|
+
*/
|
|
7373
|
+
order?: 0 | 1;
|
|
7374
|
+
/**
|
|
7375
|
+
* 单群聊的组织 ID,非超级群的频道 ID
|
|
7376
|
+
* * 该参数对 Web 平台无效
|
|
7377
|
+
* * Electron 平台下,当值为 undefined 时,将获取全部会话,其他查询条件失效
|
|
7378
|
+
*/
|
|
7379
|
+
channelId?: string;
|
|
7380
|
+
/**
|
|
7381
|
+
* 是否置顶优先
|
|
7382
|
+
* * 当前仅支持 Electron 平台
|
|
7383
|
+
* * 当 channelId 非 undefined 时,该参数无效
|
|
7384
|
+
*/
|
|
7385
|
+
topPriority?: boolean;
|
|
7386
|
+
/**
|
|
7387
|
+
* 会话类型,值为空或长度为 0 时,获取全部会话类型;仅 Electron 平台有效
|
|
7388
|
+
*/
|
|
7389
|
+
conversationTypes?: ConversationType[];
|
|
7390
|
+
};
|
|
7391
|
+
/**
|
|
7392
|
+
* 置顶列表查询参数
|
|
7393
|
+
*/
|
|
7394
|
+
declare type GetTopConversationListParams = {
|
|
7395
|
+
/**
|
|
7396
|
+
* 会话类型,值为空或长度为 0 时,获取全部会话类型
|
|
7397
|
+
*/
|
|
7398
|
+
conversationTypes?: ConversationType[];
|
|
7399
|
+
/**
|
|
7400
|
+
* 频道 ID,当值为 undefined 时,获取全部频道会话;
|
|
7401
|
+
* * 参数对超级群无效,超级群始终只返回默认频道数据
|
|
7402
|
+
*/
|
|
7403
|
+
channelId?: string;
|
|
7404
|
+
};
|
|
7405
|
+
/**
|
|
7406
|
+
* 未读列表查询参数
|
|
7407
|
+
*/
|
|
7408
|
+
declare type GetUnreadConversationListParams = Pick<GetTopConversationListParams, 'conversationTypes'>;
|
|
7409
|
+
/**
|
|
7410
|
+
* 全部列表查询参数
|
|
7411
|
+
*/
|
|
7412
|
+
declare type GetAllConversationListFilterParams = {
|
|
7413
|
+
/**
|
|
7414
|
+
* 频道 ID,当值为 undefined 时,获取全部频道会话
|
|
7415
|
+
* * 参数对超级群无效,超级群始终只返回默认频道数据
|
|
7416
|
+
*/
|
|
7417
|
+
channelId?: string;
|
|
7418
|
+
};
|
|
7419
|
+
/**
|
|
7420
|
+
* 按分页索引获取会话列表查询参数
|
|
7421
|
+
*/
|
|
7422
|
+
declare type GetConversationListByPageIndexParams = {
|
|
7423
|
+
/**
|
|
7424
|
+
* 分页索引
|
|
7425
|
+
*/
|
|
7426
|
+
index: number;
|
|
7427
|
+
/**
|
|
7428
|
+
* 分页数量
|
|
7429
|
+
*/
|
|
7430
|
+
limit: number;
|
|
7431
|
+
/**
|
|
7432
|
+
* 会话类型,值为空或长度为 0 时,获取全部会话类型
|
|
7433
|
+
*/
|
|
7434
|
+
conversationTypes?: ConversationType[];
|
|
7435
|
+
};
|
|
7436
|
+
/**
|
|
7437
|
+
* 会话列表查询参数
|
|
7438
|
+
* * type 为 ConversationListFilterType 的枚举值
|
|
7439
|
+
* * params 为对应的查询参数
|
|
7440
|
+
*/
|
|
7441
|
+
declare type ConversationListFilter = {
|
|
7442
|
+
type: typeof ConversationListFilterType.ALL;
|
|
7443
|
+
params?: GetAllConversationListFilterParams;
|
|
7444
|
+
} | {
|
|
7445
|
+
type: typeof ConversationListFilterType.TIMESTAMP;
|
|
7446
|
+
params: GetConversationListByTimestampParams;
|
|
7447
|
+
} | {
|
|
7448
|
+
type: typeof ConversationListFilterType.TOP;
|
|
7449
|
+
params?: GetTopConversationListParams;
|
|
7450
|
+
} | {
|
|
7451
|
+
type: typeof ConversationListFilterType.UNREAD;
|
|
7452
|
+
params?: GetUnreadConversationListParams;
|
|
7453
|
+
} | {
|
|
7454
|
+
type: typeof ConversationListFilterType.BLOCKED;
|
|
7455
|
+
params?: never;
|
|
7456
|
+
} | {
|
|
7457
|
+
type: typeof ConversationListFilterType.PAGE_INDEX;
|
|
7458
|
+
params: GetConversationListByPageIndexParams;
|
|
7459
|
+
};
|
|
7460
|
+
/**
|
|
7461
|
+
* 会话列表查询结果
|
|
7462
|
+
*/
|
|
7463
|
+
declare type GetConversationListResponse = {
|
|
7464
|
+
/**
|
|
7465
|
+
* 会话列表
|
|
7466
|
+
*/
|
|
7467
|
+
list: IReceivedConversation[];
|
|
7468
|
+
/**
|
|
7469
|
+
* 是否还有更多数据,当值为 undefined 时,需要业务自行判断
|
|
7470
|
+
*/
|
|
7471
|
+
hasNext?: boolean;
|
|
7472
|
+
};
|
|
7473
|
+
|
|
7474
|
+
/** 已读回执用户信息 */
|
|
7475
|
+
declare type ReadReceiptUser = {
|
|
7476
|
+
/** 用户 ID */
|
|
7477
|
+
userId: string;
|
|
7478
|
+
/** 该用户的阅读时间。0 表示用户没有发送已读回执 */
|
|
7479
|
+
timestamp: number;
|
|
7480
|
+
/** 该用户是否为被 @ 提醒的用户 */
|
|
7481
|
+
isMentioned: boolean;
|
|
7482
|
+
};
|
|
7483
|
+
/** 已读回执用户列表请求参数 */
|
|
7484
|
+
declare type ReadReceiptUsersOption = {
|
|
7485
|
+
/**
|
|
7486
|
+
* 分页游标,首页请求时可不传
|
|
7487
|
+
*/
|
|
7488
|
+
pageToken?: string;
|
|
7489
|
+
/**
|
|
7490
|
+
* 分页条数,最大值为 100
|
|
7491
|
+
*/
|
|
7492
|
+
pageCount: number;
|
|
7493
|
+
/**
|
|
7494
|
+
* 状态,若值非法则视为 0
|
|
7495
|
+
* * 0:获取已读列表
|
|
7496
|
+
* * 1:获取未读列表
|
|
7497
|
+
*/
|
|
7498
|
+
readStatus: 0 | 1;
|
|
7499
|
+
/**
|
|
7500
|
+
* 排序,若值非法则视为 0
|
|
7501
|
+
* * 0: 按读取时间降序查询
|
|
7502
|
+
* * 1: 按读取时间升序查询
|
|
7503
|
+
*/
|
|
7504
|
+
order: 0 | 1;
|
|
7505
|
+
};
|
|
7506
|
+
/** 消息已读回执列表请求结果 */
|
|
7507
|
+
declare type ReadReceiptUsersResult = {
|
|
7508
|
+
/** 分页游标 */
|
|
7509
|
+
pageToken: string;
|
|
7510
|
+
/** 总人数 */
|
|
7511
|
+
totalCount: number;
|
|
7512
|
+
/** 回执用户列表 */
|
|
7513
|
+
users: ReadReceiptUser[];
|
|
7514
|
+
};
|
|
7515
|
+
/** 消息已读回执响应数据 */
|
|
7516
|
+
declare type ReadReceiptResponseV5 = {
|
|
7517
|
+
/** 会话信息 */
|
|
7518
|
+
identifier: IConversationOption;
|
|
7519
|
+
/** 消息唯一 ID */
|
|
7520
|
+
messageUId: string;
|
|
7521
|
+
/** 已读回执的用户变更列表 */
|
|
7522
|
+
users: ReadReceiptUser[];
|
|
7523
|
+
/** 已读人数 */
|
|
7524
|
+
readCount: number;
|
|
7525
|
+
/** 未读人数 */
|
|
7526
|
+
unreadCount: number;
|
|
7527
|
+
/** 总人数 */
|
|
7528
|
+
totalCount: number;
|
|
7529
|
+
};
|
|
7530
|
+
/** 消息已读回执信息 */
|
|
7531
|
+
declare type ReadReceiptInfoV5 = {
|
|
7532
|
+
/** 消息 ID */
|
|
7533
|
+
messageUId: string;
|
|
7534
|
+
/** 未读人数 */
|
|
7535
|
+
unreadCount: number;
|
|
7536
|
+
/** 已读人数 */
|
|
7537
|
+
readCount: number;
|
|
7538
|
+
/** 总人数 */
|
|
7539
|
+
totalCount: number;
|
|
7540
|
+
};
|
|
7541
|
+
|
|
7542
|
+
/**
|
|
7543
|
+
* 进程内缓存数据
|
|
7544
|
+
*/
|
|
7545
|
+
interface IProcessCache {
|
|
7546
|
+
crtUserId: string;
|
|
7547
|
+
connectedTime: number;
|
|
7548
|
+
naviInfo: INaviInfo | null;
|
|
7549
|
+
connectionStatus: RCConnectionStatus;
|
|
7550
|
+
deviceId: string;
|
|
7551
|
+
deltaTime: number;
|
|
7552
|
+
}
|
|
7553
|
+
/**
|
|
7554
|
+
* 约束主进程 CppEngine 与 CppService 间的方法定义,以便于代码检查
|
|
7555
|
+
*/
|
|
7556
|
+
interface IIPCMethods {
|
|
7557
|
+
/**
|
|
7558
|
+
* 注册本渲染进程至主进程,以接收主进程的消息通知,同时同步主进程的当前缓存数据
|
|
7559
|
+
*/
|
|
7560
|
+
getMainProcessCache(): Promise<IProcessCache>;
|
|
7561
|
+
/**
|
|
7562
|
+
* 建立连接
|
|
7563
|
+
* @param token
|
|
7564
|
+
* @param reconnectKickEnable
|
|
7565
|
+
*/
|
|
7566
|
+
connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
|
|
7567
|
+
getNaviInfoFromCache(): INaviInfo | null;
|
|
7568
|
+
/**
|
|
7569
|
+
* 上报版本信息
|
|
7570
|
+
* @param version
|
|
7571
|
+
*/
|
|
7572
|
+
reportSDKInfo(version: {
|
|
7573
|
+
[name: string]: string;
|
|
7574
|
+
}): void;
|
|
7575
|
+
/**
|
|
7576
|
+
* 连接时间
|
|
7577
|
+
*/
|
|
7578
|
+
getConnectedTime(): number;
|
|
7579
|
+
/**
|
|
7580
|
+
* 调用非标准方法。所谓非标准方法,是为某些特定需求或产品添加,暂未作为标准接口添加至 API 层。
|
|
7581
|
+
* 对于未实现的方法,接口响应 Unsupport 错误码
|
|
7582
|
+
* @param method
|
|
7583
|
+
* @param args
|
|
7584
|
+
*/
|
|
7585
|
+
callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
|
|
7586
|
+
/**
|
|
7587
|
+
* 获取历史消息
|
|
7588
|
+
* @param conversationType
|
|
7589
|
+
* @param targetId
|
|
7366
7590
|
* @param timestamp
|
|
7367
7591
|
* @param count
|
|
7368
7592
|
* @param order
|
|
@@ -7373,7 +7597,7 @@ interface IEngine {
|
|
|
7373
7597
|
*/
|
|
7374
7598
|
timestamp: number,
|
|
7375
7599
|
/**
|
|
7376
|
-
*
|
|
7600
|
+
* 获取条数,有效值 `1` - `20`
|
|
7377
7601
|
*/
|
|
7378
7602
|
count: number,
|
|
7379
7603
|
/**
|
|
@@ -7403,7 +7627,7 @@ interface IEngine {
|
|
|
7403
7627
|
/**
|
|
7404
7628
|
* 删除历史消息 通过 messageUId
|
|
7405
7629
|
*/
|
|
7406
|
-
deleteRemoteMessage(
|
|
7630
|
+
deleteRemoteMessage(conversation: IConversationOption,
|
|
7407
7631
|
/**
|
|
7408
7632
|
* @description
|
|
7409
7633
|
* message 中 messageUId、setTime、messageDirection 为必须参数
|
|
@@ -7412,74 +7636,64 @@ interface IEngine {
|
|
|
7412
7636
|
messageUId: string;
|
|
7413
7637
|
sentTime: number;
|
|
7414
7638
|
messageDirection: MessageDirection;
|
|
7415
|
-
}[]
|
|
7416
|
-
/**
|
|
7417
|
-
* 会话的业务标识
|
|
7418
|
-
*/
|
|
7419
|
-
channelId: string): Promise<ErrorCode>;
|
|
7639
|
+
}[]): Promise<RCResult>;
|
|
7420
7640
|
recallMsg(conversation: IConversationOption, recallMsgOptions: IRecallMsgOptions): Promise<RCResult<IReceivedMessage>>;
|
|
7641
|
+
deleteRemoteMessageByTimestamp(conversation: IConversationOption, timestamp: number): Promise<RCResult>;
|
|
7421
7642
|
/**
|
|
7422
|
-
*
|
|
7423
|
-
*
|
|
7424
|
-
|
|
7425
|
-
|
|
7426
|
-
|
|
7427
|
-
* 会话的业务标识
|
|
7428
|
-
*/
|
|
7429
|
-
channelId: string): Promise<ErrorCode>;
|
|
7430
|
-
/**
|
|
7431
|
-
* 获取会话列表
|
|
7432
|
-
* @param count 指定获取数量, 不传则获取全部会话列表,默认 `300`
|
|
7433
|
-
*/
|
|
7434
|
-
getConversationList(
|
|
7435
|
-
/**
|
|
7436
|
-
* 拉取数量, 有效值 0 - 1000, 默认 300
|
|
7437
|
-
*/
|
|
7438
|
-
count: number,
|
|
7439
|
-
/**
|
|
7440
|
-
* 会话类型
|
|
7441
|
-
* @todo 待确认是否生效
|
|
7643
|
+
* 根据过滤条件获取会话列表
|
|
7644
|
+
* * 开启'会话列表支持超级群'功能后,结果数据中将包含超级群默认频道会话数据;
|
|
7645
|
+
*
|
|
7646
|
+
* @param filter 过滤条件
|
|
7647
|
+
* @returns 会话列表,始终保持时间升序返回
|
|
7442
7648
|
*/
|
|
7443
|
-
|
|
7649
|
+
getConversationListByFilter(filter: ConversationListFilter): Promise<RCResult<GetConversationListResponse>>;
|
|
7444
7650
|
/**
|
|
7445
|
-
*
|
|
7651
|
+
* 获取单一会话数据
|
|
7652
|
+
* @param conversationType
|
|
7653
|
+
* @param targetId
|
|
7654
|
+
* @param channelId
|
|
7446
7655
|
*/
|
|
7447
|
-
|
|
7656
|
+
getConversation(conversationType: ConversationType, targetId: string, channelId: string): Promise<RCResult<IReceivedConversation>>;
|
|
7448
7657
|
/**
|
|
7449
|
-
*
|
|
7658
|
+
* 批量设置会话置顶
|
|
7659
|
+
* @param conversations 会话列表
|
|
7660
|
+
* @param isTop 是否置顶
|
|
7661
|
+
* @param isUpdateTime 是否更新置顶时间
|
|
7662
|
+
* @param isCreateConversation 是否创建会话
|
|
7450
7663
|
*/
|
|
7451
|
-
|
|
7664
|
+
batchSetConversationToTop(conversations: IConversationOption[], isTop?: boolean, isUpdateTime?: boolean, isCreateConversation?: boolean): Promise<RCResult>;
|
|
7452
7665
|
/**
|
|
7453
|
-
*
|
|
7666
|
+
* 批量设置会话免打扰
|
|
7667
|
+
* @param conversations 会话列表
|
|
7668
|
+
* @param notificationLevel 免打扰级别
|
|
7454
7669
|
*/
|
|
7455
|
-
|
|
7670
|
+
batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<RCResult>;
|
|
7456
7671
|
/**
|
|
7457
|
-
*
|
|
7458
|
-
|
|
7459
|
-
|
|
7460
|
-
/**
|
|
7461
|
-
* 获取指定会话
|
|
7672
|
+
* 设置指定会话类型默认免打扰级别
|
|
7673
|
+
* @param conversationType 会话类型
|
|
7674
|
+
* @param notificationLevel 免打扰级别
|
|
7462
7675
|
*/
|
|
7463
|
-
|
|
7676
|
+
setConversationTypeNotificationLevel(conversationType: ConversationType, notificationLevel: NotificationLevel): Promise<RCResult>;
|
|
7464
7677
|
/**
|
|
7465
|
-
*
|
|
7678
|
+
* 获取指定会话类型默认免打扰级别
|
|
7679
|
+
* @param conversationType 会话类型
|
|
7466
7680
|
*/
|
|
7467
|
-
|
|
7681
|
+
getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<RCResult<NotificationLevel>>;
|
|
7468
7682
|
/**
|
|
7469
7683
|
* 删除会话
|
|
7470
7684
|
* @description 该删除操作会删除服务器端存储的会话数据
|
|
7471
7685
|
* @param conversationType
|
|
7472
7686
|
* @param targetId
|
|
7473
7687
|
*/
|
|
7474
|
-
removeConversation(
|
|
7688
|
+
removeConversation(conversation: IConversationOption): Promise<RCResult>;
|
|
7475
7689
|
batchRemoveConversation(conversations: IConversationOption[]): Promise<ErrorCode>;
|
|
7476
7690
|
/**
|
|
7477
7691
|
* 获取所有会话未读数
|
|
7478
|
-
* @param channelId 多组织 Id
|
|
7692
|
+
* @param channelId 多组织 Id,仅限于获取单群聊,超级群会话仅查询默认频道未读数
|
|
7479
7693
|
* @param conversationTypes
|
|
7480
7694
|
* @param includeMuted 包含已设置免打扰的会话
|
|
7481
7695
|
*/
|
|
7482
|
-
|
|
7696
|
+
getTotalUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): Promise<RCResult<number>>;
|
|
7483
7697
|
/**
|
|
7484
7698
|
* 获取指定会话未读数
|
|
7485
7699
|
*/
|
|
@@ -7488,6 +7702,10 @@ interface IEngine {
|
|
|
7488
7702
|
* 清除指定会话未读数
|
|
7489
7703
|
*/
|
|
7490
7704
|
clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
|
|
7705
|
+
/**
|
|
7706
|
+
* 清除全部会话未读数
|
|
7707
|
+
*/
|
|
7708
|
+
clearAllUnreadCount(): Promise<RCResult>;
|
|
7491
7709
|
/**
|
|
7492
7710
|
* 获取第一个未读消息
|
|
7493
7711
|
*/
|
|
@@ -7506,18 +7724,7 @@ interface IEngine {
|
|
|
7506
7724
|
* 清除指定会话消息草稿
|
|
7507
7725
|
*/
|
|
7508
7726
|
clearConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
|
|
7509
|
-
|
|
7510
|
-
* 从服务端拉取会话状态
|
|
7511
|
-
*/
|
|
7512
|
-
pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
|
|
7513
|
-
/**
|
|
7514
|
-
* 批量设置会话 置顶、免打扰
|
|
7515
|
-
*/
|
|
7516
|
-
batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
|
|
7517
|
-
batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<ErrorCode>;
|
|
7518
|
-
setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel: NotificationLevel, channelId?: string): Promise<number>;
|
|
7519
|
-
batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<ErrorCode>;
|
|
7520
|
-
getConversationNotificationLevel(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
|
|
7727
|
+
getConversationNotificationLevel(conversation: IConversationOption): Promise<RCResult<NotificationLevel>>;
|
|
7521
7728
|
getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<IAsyncRes<number>>;
|
|
7522
7729
|
sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void, traceId?: string): IPromiseResult<IReceivedMessage>;
|
|
7523
7730
|
/**
|
|
@@ -7527,15 +7734,9 @@ interface IEngine {
|
|
|
7527
7734
|
/**
|
|
7528
7735
|
* 消息注册
|
|
7529
7736
|
* @description
|
|
7530
|
-
* 消息注册需在应用初始化完成前进行,否则在搭配 C++
|
|
7531
|
-
* 本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
7532
|
-
* @param objectName 消息类型,如:RC:TxtMsg
|
|
7533
|
-
* @param isPersited 是否存储
|
|
7534
|
-
* @param isCounted 是否技术
|
|
7535
|
-
* @param searchProps 搜索字段,只在搭配协议栈使用时有效
|
|
7536
|
-
* @param isStatusMessage 是否是状态消息
|
|
7737
|
+
* 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
7537
7738
|
*/
|
|
7538
|
-
registerMessageType(objectName: string,
|
|
7739
|
+
registerMessageType(objectName: string, params: MessageTypeDescription): void;
|
|
7539
7740
|
/**
|
|
7540
7741
|
* 加入聊天室
|
|
7541
7742
|
* @param count 拉取消息数量
|
|
@@ -7552,8 +7753,8 @@ interface IEngine {
|
|
|
7552
7753
|
quitChatroom(chatroomId: string): Promise<ErrorCode>;
|
|
7553
7754
|
/**
|
|
7554
7755
|
* 获取聊天室信息
|
|
7555
|
-
* @param count
|
|
7556
|
-
* @param order
|
|
7756
|
+
* @param count 获取人数,范围 0 - 20
|
|
7757
|
+
* @param order 排序方式,1 正序,2 倒序
|
|
7557
7758
|
*/
|
|
7558
7759
|
getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
|
|
7559
7760
|
/**
|
|
@@ -7622,7 +7823,7 @@ interface IEngine {
|
|
|
7622
7823
|
createTag(tag: ITagParam): IPromiseResult;
|
|
7623
7824
|
/**
|
|
7624
7825
|
* 删除标签
|
|
7625
|
-
* @param tagId 标签id
|
|
7826
|
+
* @param tagId 标签 id
|
|
7626
7827
|
*/
|
|
7627
7828
|
removeTag(tagId: string): IPromiseResult;
|
|
7628
7829
|
/**
|
|
@@ -7636,31 +7837,31 @@ interface IEngine {
|
|
|
7636
7837
|
getTagList(): IPromiseResult<Array<ITagInfo>>;
|
|
7637
7838
|
/**
|
|
7638
7839
|
* 添加会话到标签(给多个会话增加标签)
|
|
7639
|
-
* @param tagId 标签id
|
|
7840
|
+
* @param tagId 标签 id
|
|
7640
7841
|
* @param conversations 要添加的会话列表
|
|
7641
7842
|
*/
|
|
7642
7843
|
addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
|
|
7643
7844
|
/**
|
|
7644
|
-
* 删除标签中的会话(从多个会话中批量删除指定标签)
|
|
7645
|
-
* @param tagId 标签id
|
|
7845
|
+
* 删除标签中的会话 (从多个会话中批量删除指定标签)
|
|
7846
|
+
* @param tagId 标签 id
|
|
7646
7847
|
* @param conversations 要删除的会话列表
|
|
7647
7848
|
*/
|
|
7648
7849
|
removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
|
|
7649
7850
|
/**
|
|
7650
|
-
* 删除会话中的标签(从单一会话中批量删除标签)
|
|
7851
|
+
* 删除会话中的标签 (从单一会话中批量删除标签)
|
|
7651
7852
|
* @param conversationType 会话类型
|
|
7652
|
-
* @param targetId 会话id
|
|
7853
|
+
* @param targetId 会话 id
|
|
7653
7854
|
* @param tagIds 要删除的标签列表
|
|
7654
7855
|
*/
|
|
7655
7856
|
removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult;
|
|
7656
7857
|
/**
|
|
7657
7858
|
* 获取标签下的会话列表
|
|
7658
|
-
* @param tagId 标签id
|
|
7859
|
+
* @param tagId 标签 id
|
|
7659
7860
|
*/
|
|
7660
7861
|
getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
|
|
7661
7862
|
/**
|
|
7662
7863
|
* 获取标签下的未读消息数
|
|
7663
|
-
* @param tagId 标签id
|
|
7864
|
+
* @param tagId 标签 id
|
|
7664
7865
|
* @param containMuted 是否包含免打扰会话
|
|
7665
7866
|
*/
|
|
7666
7867
|
getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
|
|
@@ -7684,15 +7885,15 @@ interface IEngine {
|
|
|
7684
7885
|
*/
|
|
7685
7886
|
getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
|
|
7686
7887
|
/**
|
|
7687
|
-
* 发送已读回执(V4)
|
|
7888
|
+
* 发送已读回执 (V4)
|
|
7688
7889
|
*/
|
|
7689
7890
|
sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
7690
7891
|
/**
|
|
7691
|
-
*
|
|
7892
|
+
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
7692
7893
|
*/
|
|
7693
7894
|
getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
7694
7895
|
/**
|
|
7695
|
-
* 多端同步会话的已读时间(V4)
|
|
7896
|
+
* 多端同步会话的已读时间 (V4)
|
|
7696
7897
|
*/
|
|
7697
7898
|
updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
|
|
7698
7899
|
/**
|
|
@@ -7700,15 +7901,13 @@ interface IEngine {
|
|
|
7700
7901
|
*/
|
|
7701
7902
|
getServerTime(): number;
|
|
7702
7903
|
/**
|
|
7703
|
-
* 获取设备ID
|
|
7904
|
+
* 获取设备 ID
|
|
7704
7905
|
*/
|
|
7705
7906
|
getDeviceId(): string;
|
|
7706
7907
|
/**
|
|
7707
7908
|
* 获取当前 userId
|
|
7708
7909
|
*/
|
|
7709
7910
|
getCurrentUserId(): string;
|
|
7710
|
-
getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
|
|
7711
|
-
getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
|
|
7712
7911
|
/**
|
|
7713
7912
|
* 设置用户在线状态监听器
|
|
7714
7913
|
*/
|
|
@@ -7763,7 +7962,7 @@ interface IEngine {
|
|
|
7763
7962
|
deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
|
|
7764
7963
|
batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
|
|
7765
7964
|
batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
|
|
7766
|
-
batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<
|
|
7965
|
+
batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<RCResult>;
|
|
7767
7966
|
/**
|
|
7768
7967
|
* 清空会话下历史消息
|
|
7769
7968
|
*/
|
|
@@ -7783,7 +7982,7 @@ interface IEngine {
|
|
|
7783
7982
|
/**
|
|
7784
7983
|
* 通过关键字与 channelId 搜索所有会话
|
|
7785
7984
|
*/
|
|
7786
|
-
searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes
|
|
7985
|
+
searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
7787
7986
|
searchConversationByContentWithAllChannel(keyword: string, customMessageTypes: string[], conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
|
|
7788
7987
|
/**
|
|
7789
7988
|
* 按内容搜索会话内的消息
|
|
@@ -7825,10 +8024,6 @@ interface IEngine {
|
|
|
7825
8024
|
* 删除时间戳前的未读数
|
|
7826
8025
|
*/
|
|
7827
8026
|
clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
|
|
7828
|
-
/**
|
|
7829
|
-
* 获取会话免打扰状态
|
|
7830
|
-
*/
|
|
7831
|
-
getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
|
|
7832
8027
|
/**
|
|
7833
8028
|
* 协议栈获取远端历史消息
|
|
7834
8029
|
*/
|
|
@@ -7836,18 +8031,6 @@ interface IEngine {
|
|
|
7836
8031
|
list: IReceivedMessage[];
|
|
7837
8032
|
hasMore: boolean;
|
|
7838
8033
|
}>;
|
|
7839
|
-
/**
|
|
7840
|
-
* 无差别获取本地免打扰列表
|
|
7841
|
-
*/
|
|
7842
|
-
getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
7843
|
-
/**
|
|
7844
|
-
* 无差别获取本地置顶列表
|
|
7845
|
-
*/
|
|
7846
|
-
getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
7847
|
-
/**
|
|
7848
|
-
* 获取单个群聊会话 @ 消息未读数
|
|
7849
|
-
*/
|
|
7850
|
-
getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
|
|
7851
8034
|
/**
|
|
7852
8035
|
* 获取所有群聊会话 @ 消息未读数
|
|
7853
8036
|
*/
|
|
@@ -7946,6 +8129,23 @@ interface IEngine {
|
|
|
7946
8129
|
setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
7947
8130
|
removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
7948
8131
|
getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
8132
|
+
getStatsUrlList(): Promise<RCResult<string[]>>;
|
|
8133
|
+
/**
|
|
8134
|
+
* 发送消息已读回执(V5 版本)
|
|
8135
|
+
*/
|
|
8136
|
+
sendReadReceiptResponseV5(conId: IConversationOption, messageUIdArray: string[]): Promise<RCResult>;
|
|
8137
|
+
/**
|
|
8138
|
+
* 获取消息已读人数信息(V5 版本)
|
|
8139
|
+
*/
|
|
8140
|
+
getMessageReadReceiptInfoV5(conId: IConversationOption, messageUIdArray: Array<string>): Promise<RCResult<ReadReceiptInfoV5[]>>;
|
|
8141
|
+
/**
|
|
8142
|
+
* 分页获取消息已读、未读人员列表(V5 版本)
|
|
8143
|
+
*/
|
|
8144
|
+
getMessagesReadReceiptUsersByPageV5(conId: IConversationOption, messageUId: string, opt: ReadReceiptUsersOption): Promise<RCResult<ReadReceiptUsersResult>>;
|
|
8145
|
+
/**
|
|
8146
|
+
* 按人查询消息是否已读(V5 版本)
|
|
8147
|
+
*/
|
|
8148
|
+
getMessagesReadReceiptByUsersV5(conId: IConversationOption, messageUId: string, userList: Array<string>): Promise<RCResult<ReadReceiptUsersResult>>;
|
|
7949
8149
|
rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
|
|
7950
8150
|
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
|
|
7951
8151
|
code: ErrorCode;
|
|
@@ -8009,7 +8209,7 @@ interface IExpansionListenerData {
|
|
|
8009
8209
|
}
|
|
8010
8210
|
|
|
8011
8211
|
/**
|
|
8012
|
-
* typing信息
|
|
8212
|
+
* typing 信息
|
|
8013
8213
|
* @category Interface
|
|
8014
8214
|
*/
|
|
8015
8215
|
interface ITypingUser {
|
|
@@ -8027,7 +8227,7 @@ interface ITypingUser {
|
|
|
8027
8227
|
messageType: string;
|
|
8028
8228
|
}
|
|
8029
8229
|
/**
|
|
8030
|
-
* typing通知消息接口
|
|
8230
|
+
* typing 通知消息接口
|
|
8031
8231
|
* @category Interface
|
|
8032
8232
|
*/
|
|
8033
8233
|
interface ITypingMessage {
|
|
@@ -8044,7 +8244,7 @@ interface ITypingMessage {
|
|
|
8044
8244
|
*/
|
|
8045
8245
|
channelId?: string;
|
|
8046
8246
|
/**
|
|
8047
|
-
* typing信息列表
|
|
8247
|
+
* typing 信息列表
|
|
8048
8248
|
*/
|
|
8049
8249
|
list: Array<ITypingUser>;
|
|
8050
8250
|
}
|
|
@@ -8108,35 +8308,23 @@ interface IUserGroupStatusInfo {
|
|
|
8108
8308
|
userGroupUnBindChannel?: IChannelAndUserGroupChangeData[];
|
|
8109
8309
|
}
|
|
8110
8310
|
|
|
8111
|
-
interface IUserSettingItem {
|
|
8112
|
-
targetId: number;
|
|
8113
|
-
type: number;
|
|
8114
|
-
key: string;
|
|
8115
|
-
value: any;
|
|
8116
|
-
version: number;
|
|
8117
|
-
status: number;
|
|
8118
|
-
tags: IConversationTag[];
|
|
8119
|
-
}
|
|
8120
|
-
interface IServerUserSetting {
|
|
8121
|
-
settings: {
|
|
8122
|
-
[key: string]: IUserSettingItem;
|
|
8123
|
-
};
|
|
8124
|
-
version: number;
|
|
8125
|
-
}
|
|
8126
|
-
|
|
8127
8311
|
interface IEngineWatcher extends IConnectionListener {
|
|
8128
8312
|
/**
|
|
8129
8313
|
* @param message 消息
|
|
8130
8314
|
* @param leftCount 参数废弃,值始终为 undefined
|
|
8131
|
-
* @param hasMore
|
|
8315
|
+
* @param hasMore 消息是否收取结束,仅 Electron 平台有效
|
|
8132
8316
|
*/
|
|
8133
8317
|
batchMessage: (messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean) => void;
|
|
8134
8318
|
chatroom: (event: IChatroomListenerData) => void;
|
|
8135
|
-
conversation: (event:
|
|
8319
|
+
conversation: (event: IUpdatedConversation[]) => void;
|
|
8136
8320
|
expansion: (event: IExpansionListenerData) => void;
|
|
8137
8321
|
tag: () => void;
|
|
8322
|
+
/**
|
|
8323
|
+
* C++ 协议栈对外通知会话 tag 变更时,不携带任何数据; 为保持 Web 与 C++ 协议栈通知一致,不抛数据
|
|
8324
|
+
*/
|
|
8138
8325
|
conversationTag: () => void;
|
|
8139
|
-
ultraGroupEnable: (
|
|
8326
|
+
ultraGroupEnable: () => void;
|
|
8327
|
+
sgRelationsSynced: () => void;
|
|
8140
8328
|
operateStatus: (status: IOperateStatusNotify) => void;
|
|
8141
8329
|
ultraGroupMessageExpansionUpdated: (list: IReceivedMessage[]) => void;
|
|
8142
8330
|
ultraGroupMessageModified: (list: IReceivedMessage[]) => void;
|
|
@@ -8180,6 +8368,7 @@ interface IEngineWatcher extends IConnectionListener {
|
|
|
8180
8368
|
databaseUpgradeWillStart: () => void;
|
|
8181
8369
|
databaseUpgrading: (progress: number) => void;
|
|
8182
8370
|
databaseUpgradeDidComplete: (code: ErrorCode) => void;
|
|
8371
|
+
readReceiptResponseV5?: (data: ReadReceiptResponseV5[]) => void;
|
|
8183
8372
|
}
|
|
8184
8373
|
|
|
8185
8374
|
declare type IErrorKeys = {
|
|
@@ -8214,7 +8403,7 @@ declare const isBoolean: (value: unknown) => boolean;
|
|
|
8214
8403
|
*/
|
|
8215
8404
|
declare const isNumber: (value: unknown) => boolean;
|
|
8216
8405
|
/**
|
|
8217
|
-
*
|
|
8406
|
+
* 检查参数是否为整数,可以指定最小值和最大值,区间包含最小值和最大值,
|
|
8218
8407
|
*/
|
|
8219
8408
|
declare const isInteger: (option: {
|
|
8220
8409
|
min?: number;
|
|
@@ -8259,14 +8448,10 @@ declare const isObject: (val: any) => boolean;
|
|
|
8259
8448
|
*/
|
|
8260
8449
|
declare const isFunction: (val: any) => boolean;
|
|
8261
8450
|
/**
|
|
8262
|
-
* 检查参数是否为undefined
|
|
8451
|
+
* 检查参数是否为 undefined
|
|
8263
8452
|
* @param val
|
|
8264
8453
|
*/
|
|
8265
8454
|
declare const isUndefined: (val: any) => boolean;
|
|
8266
|
-
/**
|
|
8267
|
-
* 检查参数是否为 null
|
|
8268
|
-
*/
|
|
8269
|
-
declare const isNull: (val: any) => boolean;
|
|
8270
8455
|
/**
|
|
8271
8456
|
* 检查参数是否为有效 http(s) 协议 url
|
|
8272
8457
|
* @param value
|
|
@@ -8296,20 +8481,6 @@ declare const isValidGroupId: (value: any) => boolean;
|
|
|
8296
8481
|
*/
|
|
8297
8482
|
declare const isValidFileType: (fileType: number) => boolean;
|
|
8298
8483
|
|
|
8299
|
-
/**
|
|
8300
|
-
* @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
|
|
8301
|
-
* @deprecated
|
|
8302
|
-
* @param source
|
|
8303
|
-
* @param event
|
|
8304
|
-
* @param options
|
|
8305
|
-
*/
|
|
8306
|
-
declare const forEach: (source: any, event: Function, options?: any) => void;
|
|
8307
|
-
/**
|
|
8308
|
-
* @deprecated
|
|
8309
|
-
* @param source
|
|
8310
|
-
* @param event
|
|
8311
|
-
*/
|
|
8312
|
-
declare const map: (source: any[], event: Function) => any[];
|
|
8313
8484
|
/**
|
|
8314
8485
|
* 判断当前是否运行在 electron 环境且搭配 c++ 协议栈使用
|
|
8315
8486
|
*/
|
|
@@ -8318,13 +8489,57 @@ declare const usingCppEngine: () => boolean;
|
|
|
8318
8489
|
* 将接收状态枚举值转换为接收转态详情
|
|
8319
8490
|
* @param status 状态枚举值
|
|
8320
8491
|
*/
|
|
8321
|
-
declare const
|
|
8492
|
+
declare const trans2IReceivedStatusInfo: (status: ReceivedStatus) => IReceivedStatusInfo;
|
|
8322
8493
|
/**
|
|
8323
8494
|
* 将接收状态详情转换为接收转态枚举值
|
|
8324
8495
|
* @param status 状态枚举值
|
|
8325
8496
|
*/
|
|
8326
8497
|
declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusInfo) => number;
|
|
8327
8498
|
|
|
8499
|
+
declare type PBModule = {
|
|
8500
|
+
toArrayBuffer: () => ArrayBuffer;
|
|
8501
|
+
getArrayData: never;
|
|
8502
|
+
[key: string]: Function;
|
|
8503
|
+
};
|
|
8504
|
+
declare class Codec$1<T> {
|
|
8505
|
+
#private;
|
|
8506
|
+
/**
|
|
8507
|
+
* 嵌套结构声明
|
|
8508
|
+
* key: pbname
|
|
8509
|
+
* value: [key: pbname + _ + 属性名,type: 值的 pbname ]
|
|
8510
|
+
*/
|
|
8511
|
+
private nestedMap;
|
|
8512
|
+
private readonly pbModules;
|
|
8513
|
+
constructor(
|
|
8514
|
+
/**
|
|
8515
|
+
* proto 协议描述
|
|
8516
|
+
*/
|
|
8517
|
+
desc: string,
|
|
8518
|
+
/**
|
|
8519
|
+
* 嵌套结构声明
|
|
8520
|
+
* key: pbname
|
|
8521
|
+
* value: [key: pbname + _ + 属性名,type: 值的 pbname ]
|
|
8522
|
+
*/
|
|
8523
|
+
nestedMap: Map<string, keyof T>);
|
|
8524
|
+
private _encode;
|
|
8525
|
+
/**
|
|
8526
|
+
* PB 数据序列化
|
|
8527
|
+
* @param pbname - PB 名称
|
|
8528
|
+
* @param params - 待序列化数据
|
|
8529
|
+
*/
|
|
8530
|
+
encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
|
|
8531
|
+
/**
|
|
8532
|
+
* 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
|
|
8533
|
+
* @param pbname 待解码数据的 PB 名
|
|
8534
|
+
* @param data 待解码数据
|
|
8535
|
+
*/
|
|
8536
|
+
decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
|
|
8537
|
+
/**
|
|
8538
|
+
* @deprecated
|
|
8539
|
+
*/
|
|
8540
|
+
getModule(pbname: string): PBModule;
|
|
8541
|
+
}
|
|
8542
|
+
|
|
8328
8543
|
/**
|
|
8329
8544
|
* 日志打印等级定义
|
|
8330
8545
|
* @category Enum
|
|
@@ -8388,7 +8603,6 @@ interface ILogData {
|
|
|
8388
8603
|
* @description
|
|
8389
8604
|
* Electron 环境下,以主进程 sessionId 入库,渲染进程 sessionId 存储于 content 内。
|
|
8390
8605
|
* 日志上报时,通过 `${mainSessionId}:${renderSessionId}` 形式作为 sessionId 上报
|
|
8391
|
-
* @TODO 需确认服务是否允许 `${mainSessionId}:${renderSessionId}` 的方式,以及 sessionId 是否超出长度。
|
|
8392
8606
|
*/
|
|
8393
8607
|
sessionId: string;
|
|
8394
8608
|
/**
|
|
@@ -8450,15 +8664,13 @@ declare abstract class BasicLogger {
|
|
|
8450
8664
|
/**
|
|
8451
8665
|
* 汇总 result 结果记录并记录日志
|
|
8452
8666
|
* @param tag
|
|
8453
|
-
* @param
|
|
8667
|
+
* @param res
|
|
8454
8668
|
* @param traceId
|
|
8455
8669
|
* @param summaryInfo - 日志摘要数据
|
|
8456
|
-
* @param
|
|
8457
|
-
* @param
|
|
8670
|
+
* @param success - 请求成功时追加的日志信息
|
|
8671
|
+
* @param fail - 请求失败时追加的日志信息
|
|
8458
8672
|
*/
|
|
8459
|
-
summary(tag: string, res: RCResult<
|
|
8460
|
-
[key: string]: string | number | boolean | undefined;
|
|
8461
|
-
}, successMsg?: () => string, failMsg?: () => string): void;
|
|
8673
|
+
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;
|
|
8462
8674
|
/**
|
|
8463
8675
|
* 内部质量数据统计接口,仅限 IMLib 与 RTCLib 内部使用
|
|
8464
8676
|
*/
|
|
@@ -8664,50 +8876,6 @@ interface IRuntime {
|
|
|
8664
8876
|
|
|
8665
8877
|
declare const runtime: IRuntime;
|
|
8666
8878
|
|
|
8667
|
-
declare type PBModule = {
|
|
8668
|
-
toArrayBuffer: () => ArrayBuffer;
|
|
8669
|
-
getArrayData: never;
|
|
8670
|
-
[key: string]: Function;
|
|
8671
|
-
};
|
|
8672
|
-
declare class Codec$1<T> {
|
|
8673
|
-
#private;
|
|
8674
|
-
/**
|
|
8675
|
-
* 嵌套结构声明
|
|
8676
|
-
* key: pbname
|
|
8677
|
-
* value: [key: pbname + _ + 属性名, type: 值的 pbname ]
|
|
8678
|
-
*/
|
|
8679
|
-
private nestedMap;
|
|
8680
|
-
private readonly pbModules;
|
|
8681
|
-
constructor(
|
|
8682
|
-
/**
|
|
8683
|
-
* proto 协议描述
|
|
8684
|
-
*/
|
|
8685
|
-
desc: string,
|
|
8686
|
-
/**
|
|
8687
|
-
* 嵌套结构声明
|
|
8688
|
-
* key: pbname
|
|
8689
|
-
* value: [key: pbname + _ + 属性名, type: 值的 pbname ]
|
|
8690
|
-
*/
|
|
8691
|
-
nestedMap: Map<string, keyof T>);
|
|
8692
|
-
private _encode;
|
|
8693
|
-
/**
|
|
8694
|
-
* PB 数据序列化
|
|
8695
|
-
* @param pbname - PB 名称
|
|
8696
|
-
* @param params - 待序列化数据
|
|
8697
|
-
*/
|
|
8698
|
-
encode<K extends keyof T>(key: K, params: T[K]): ArrayBuffer;
|
|
8699
|
-
/**
|
|
8700
|
-
* 数据反序列化,反序列化的结果为未加工的原始数据,decode 函数本身不处理 format 过程
|
|
8701
|
-
* @param pbname 待解码数据的 PB 名
|
|
8702
|
-
* @param data 待解码数据
|
|
8703
|
-
*/
|
|
8704
|
-
decode<K extends keyof T>(pbname: K, uint8array: Uint8Array): T[K];
|
|
8705
|
-
/**
|
|
8706
|
-
* @deprecated
|
|
8707
|
-
*/
|
|
8708
|
-
getModule(pbname: string): PBModule;
|
|
8709
|
-
}
|
|
8710
|
-
|
|
8711
8879
|
/**
|
|
8712
8880
|
* @deprecated
|
|
8713
8881
|
* 日志级别,已废弃
|
|
@@ -8818,7 +8986,7 @@ declare enum ConnectionStatus {
|
|
|
8818
8986
|
*/
|
|
8819
8987
|
RESPONSE_NAVI_TIMEOUT = 204,
|
|
8820
8988
|
/**
|
|
8821
|
-
* 证书过期,SDK不会重连
|
|
8989
|
+
* 证书过期,SDK 不会重连
|
|
8822
8990
|
*/
|
|
8823
8991
|
RC_LICENSE_EXPIRED = 31030,
|
|
8824
8992
|
/**
|
|
@@ -8841,11 +9009,11 @@ declare enum RTCMode {
|
|
|
8841
9009
|
*/
|
|
8842
9010
|
LIVE = 2,
|
|
8843
9011
|
/**
|
|
8844
|
-
*sip呼叫
|
|
9012
|
+
*sip 呼叫
|
|
8845
9013
|
*/
|
|
8846
9014
|
SIP = 4,
|
|
8847
9015
|
/**
|
|
8848
|
-
*
|
|
9016
|
+
* 呼叫模式。包括单呼和群呼
|
|
8849
9017
|
*/
|
|
8850
9018
|
CALL = 5,
|
|
8851
9019
|
/**
|
|
@@ -8970,6 +9138,26 @@ declare type IChatRoomEntries = IChatroomEntries;
|
|
|
8970
9138
|
*/
|
|
8971
9139
|
declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
|
|
8972
9140
|
|
|
9141
|
+
/**
|
|
9142
|
+
* @todo 后期禁用此方法,容易滥用,且会丢失上下文的数据类型跟踪
|
|
9143
|
+
* @deprecated
|
|
9144
|
+
* @param source
|
|
9145
|
+
* @param event
|
|
9146
|
+
* @param options
|
|
9147
|
+
*/
|
|
9148
|
+
declare const forEach: (source: any, event: Function, options?: any) => void;
|
|
9149
|
+
/**
|
|
9150
|
+
* @deprecated
|
|
9151
|
+
* @param source
|
|
9152
|
+
* @param event
|
|
9153
|
+
*/
|
|
9154
|
+
declare const map: (source: any[], event: Function) => any[];
|
|
9155
|
+
/**
|
|
9156
|
+
* 检查参数是否为 null
|
|
9157
|
+
* @deprecated
|
|
9158
|
+
*/
|
|
9159
|
+
declare const isNull: (val: any) => boolean;
|
|
9160
|
+
|
|
8973
9161
|
/** @deprecated */
|
|
8974
9162
|
declare type CodecPBMaps = {
|
|
8975
9163
|
readonly [pbname: string]: readonly string[];
|
|
@@ -9245,7 +9433,8 @@ interface IWatcher {
|
|
|
9245
9433
|
* 敏感词被拦截监听
|
|
9246
9434
|
*/
|
|
9247
9435
|
messageBlocked?: IMessageBlockedListener;
|
|
9248
|
-
ultraGroupEnable?: (
|
|
9436
|
+
ultraGroupEnable?: () => void;
|
|
9437
|
+
sgRelationsSynced?: () => void;
|
|
9249
9438
|
operateStatus?: (status: IOperateStatusNotify) => void;
|
|
9250
9439
|
ultraGroupMessageExpansionUpdated?: (list: IReceivedMessage[]) => void;
|
|
9251
9440
|
ultraGroupMessageModified?: (list: IReceivedMessage[]) => void;
|
|
@@ -9280,6 +9469,7 @@ interface IWatcher {
|
|
|
9280
9469
|
databaseUpgradeWillStart?: () => void;
|
|
9281
9470
|
databaseUpgrading?: (progress: number) => void;
|
|
9282
9471
|
databaseUpgradeDidComplete?: (code: ErrorCode) => void;
|
|
9472
|
+
readReceiptResponseV5?: (data: ReadReceiptResponseV5[]) => void;
|
|
9283
9473
|
}
|
|
9284
9474
|
interface IAPIContextOption {
|
|
9285
9475
|
/**
|
|
@@ -9287,7 +9477,7 @@ interface IAPIContextOption {
|
|
|
9287
9477
|
*/
|
|
9288
9478
|
appkey: string;
|
|
9289
9479
|
/**
|
|
9290
|
-
*
|
|
9480
|
+
* 自定义导航地址:
|
|
9291
9481
|
* 1. 私有云环境下该值为必填项
|
|
9292
9482
|
* 2. 当存在自定义导航地址时,SDK 内部默认地址将无效
|
|
9293
9483
|
* 3. 当存在自定义导航地址时,地址 url 中需包含 http/https 协议头,否则视为无效值
|
|
@@ -9302,7 +9492,7 @@ interface IAPIContextOption {
|
|
|
9302
9492
|
*/
|
|
9303
9493
|
miniCMPProxy: string[];
|
|
9304
9494
|
/**
|
|
9305
|
-
* typing状态过期时间
|
|
9495
|
+
* typing 状态过期时间
|
|
9306
9496
|
*/
|
|
9307
9497
|
typingExpireTime?: number;
|
|
9308
9498
|
/**
|
|
@@ -9340,6 +9530,19 @@ interface IAPIContextOption {
|
|
|
9340
9530
|
* 私有云环境配置
|
|
9341
9531
|
*/
|
|
9342
9532
|
environment?: string;
|
|
9533
|
+
/**
|
|
9534
|
+
* 启动线程阻塞检查
|
|
9535
|
+
*/
|
|
9536
|
+
eventLoopBlockingCheck?: boolean;
|
|
9537
|
+
/**
|
|
9538
|
+
* 开启已读回执信息本地存储
|
|
9539
|
+
*/
|
|
9540
|
+
enableReadReceiptStorage: boolean;
|
|
9541
|
+
/**
|
|
9542
|
+
* 启动导航服务 V2,默认关闭,仅私有云有效
|
|
9543
|
+
* @since 5.22.0
|
|
9544
|
+
*/
|
|
9545
|
+
useNaviV2?: boolean;
|
|
9343
9546
|
}
|
|
9344
9547
|
interface IConnectResult {
|
|
9345
9548
|
/**
|
|
@@ -9352,22 +9555,8 @@ interface IConnectResult {
|
|
|
9352
9555
|
userId?: string;
|
|
9353
9556
|
}
|
|
9354
9557
|
|
|
9355
|
-
/**
|
|
9356
|
-
* 会话聊天模块
|
|
9357
|
-
*/
|
|
9358
|
-
interface IChatModule {
|
|
9359
|
-
}
|
|
9360
|
-
|
|
9361
|
-
/**
|
|
9362
|
-
* 聊天室模块
|
|
9363
|
-
*/
|
|
9364
|
-
interface IChatroomModule {
|
|
9365
|
-
}
|
|
9366
|
-
|
|
9367
|
-
interface IDataHostingModule {
|
|
9368
|
-
}
|
|
9369
|
-
|
|
9370
9558
|
declare class APIContext {
|
|
9559
|
+
#private;
|
|
9371
9560
|
private static _context?;
|
|
9372
9561
|
static init(options: IAPIContextOption): APIContext;
|
|
9373
9562
|
/**
|
|
@@ -9385,7 +9574,7 @@ declare class APIContext {
|
|
|
9385
9574
|
*/
|
|
9386
9575
|
private _pluginContextQueue;
|
|
9387
9576
|
/**
|
|
9388
|
-
* 插件实例Map,用于重复初始化时返回实例
|
|
9577
|
+
* 插件实例 Map,用于重复初始化时返回实例
|
|
9389
9578
|
*/
|
|
9390
9579
|
private _pluginInstanseMap;
|
|
9391
9580
|
private readonly _engine;
|
|
@@ -9405,12 +9594,6 @@ declare class APIContext {
|
|
|
9405
9594
|
* engine 内部日志工具
|
|
9406
9595
|
*/
|
|
9407
9596
|
readonly logger: BasicLogger;
|
|
9408
|
-
/**
|
|
9409
|
-
* 聊天室业务模块
|
|
9410
|
-
*/
|
|
9411
|
-
get chatroom(): IChatroomModule;
|
|
9412
|
-
get chat(): IChatModule;
|
|
9413
|
-
get dataHosting(): IDataHostingModule;
|
|
9414
9597
|
constructor(options: IAPIContextOption);
|
|
9415
9598
|
/**
|
|
9416
9599
|
* 安装使用插件,并初始化插件实例
|
|
@@ -9426,25 +9609,25 @@ declare class APIContext {
|
|
|
9426
9609
|
* 聊天室用户加入退出多端同步消息
|
|
9427
9610
|
* @since 5.7.9
|
|
9428
9611
|
* 多端登录相关事件通知回调,包含三种通知 case
|
|
9429
|
-
* 1.
|
|
9430
|
-
* 2.
|
|
9431
|
-
* 3.
|
|
9432
|
-
*
|
|
9612
|
+
* 1. 多端登录情况,一端加入聊天室,需要通知另一终端,指定聊天室中所有成员,包括当前加入用户
|
|
9613
|
+
* 2. 多端登录情况,一端退出聊天室,需要通知另一终端,指定聊天室中所有成员,包括当前退出用户
|
|
9614
|
+
* 3. 用户多端加入聊天室场景:用户在 Android 端加入聊天室,在 Web 端登录后又加入一个新的聊天室,
|
|
9615
|
+
* 自动将用户从上一个聊天室踢出,被踢出聊天室中的所有成员,包括被踢出用户
|
|
9433
9616
|
* 注:case 3 如果开通了一个用户可加入多个聊天室的情况不会进行通知
|
|
9434
9617
|
*/
|
|
9435
9618
|
private _processChrmSyncMessage;
|
|
9436
9619
|
/**
|
|
9437
9620
|
* @since 5.7.9
|
|
9438
|
-
*
|
|
9621
|
+
* 封禁用户相关事件通知回调,包含两种通知 case
|
|
9439
9622
|
* 1. 封禁用户,聊天室中所有成员,包括被封禁用户
|
|
9440
|
-
*
|
|
9623
|
+
* 注:
|
|
9441
9624
|
* 封禁后用户被自动踢出聊天室
|
|
9442
9625
|
* 封禁后用户不会再收到被踢出的通知
|
|
9443
9626
|
*
|
|
9444
9627
|
* 2. 解除封禁,被解除封禁的成员
|
|
9445
|
-
*
|
|
9628
|
+
* 注:
|
|
9446
9629
|
* 用户未在线时,再登录时不会收到通知
|
|
9447
|
-
*
|
|
9630
|
+
* 服务端仅对主动解除封禁做通知,封禁时间到了,自动解除的不通知,此刻调用加入聊天室接口可成功
|
|
9448
9631
|
*/
|
|
9449
9632
|
private _processChrmMemBlockMessage;
|
|
9450
9633
|
/**
|
|
@@ -9469,7 +9652,7 @@ declare class APIContext {
|
|
|
9469
9652
|
*/
|
|
9470
9653
|
private _processChrmMemBanMessage;
|
|
9471
9654
|
/**
|
|
9472
|
-
*
|
|
9655
|
+
* 消息处理器(v2/v4/next 版本中兼容)
|
|
9473
9656
|
* 返回 false | undefined:消息继续向上抛出,true:内部处理或转为事件回调,无需向上抛出
|
|
9474
9657
|
*/
|
|
9475
9658
|
private _compatibleMessageProccessor;
|
|
@@ -9477,7 +9660,7 @@ declare class APIContext {
|
|
|
9477
9660
|
private _processReadReceiptRequestMessage;
|
|
9478
9661
|
private _processReadReceiptResponseMessage;
|
|
9479
9662
|
/**
|
|
9480
|
-
* 消息处理器(imlib-next
|
|
9663
|
+
* 消息处理器(imlib-next 中转为事件回调,无需抛出)
|
|
9481
9664
|
*/
|
|
9482
9665
|
private _messageProccessor;
|
|
9483
9666
|
private _messageReceiver;
|
|
@@ -9509,6 +9692,7 @@ declare class APIContext {
|
|
|
9509
9692
|
private _groupMessageDeliveredStatusListerer;
|
|
9510
9693
|
private _callInfoListener;
|
|
9511
9694
|
private _ultraGroupEnableListener;
|
|
9695
|
+
private _sgRelationsSyncedListener;
|
|
9512
9696
|
private _operateStatusListener;
|
|
9513
9697
|
private _ultraGroupMessageExpansionUpdatedListener;
|
|
9514
9698
|
private _ultraGroupMessageModifiedListener;
|
|
@@ -9554,6 +9738,7 @@ declare class APIContext {
|
|
|
9554
9738
|
* 数据库升级完成
|
|
9555
9739
|
*/
|
|
9556
9740
|
private _databaseUpgradeDidComplete;
|
|
9741
|
+
private _readReceiptResponseV5;
|
|
9557
9742
|
/**
|
|
9558
9743
|
* 业务层事件监听器挂载点
|
|
9559
9744
|
*/
|
|
@@ -9573,7 +9758,7 @@ declare class APIContext {
|
|
|
9573
9758
|
private _typingExpireTime;
|
|
9574
9759
|
private _typingChangedList;
|
|
9575
9760
|
/**
|
|
9576
|
-
* 启动定时移除typing
|
|
9761
|
+
* 启动定时移除 typing 信息
|
|
9577
9762
|
*/
|
|
9578
9763
|
private _startCheckTypingInfo;
|
|
9579
9764
|
private _notifyTypingChanged;
|
|
@@ -9588,7 +9773,12 @@ declare class APIContext {
|
|
|
9588
9773
|
getCurrentUserId(): string;
|
|
9589
9774
|
getConnectionStatus(): RCConnectionStatus;
|
|
9590
9775
|
/** 高阶函数,生成一个验证方法,验证是否处于连接中状态,并在连接状态可用时返回导航数据 */
|
|
9591
|
-
get
|
|
9776
|
+
get validateConnected(): () => RCResult<INaviInfo>;
|
|
9777
|
+
/**
|
|
9778
|
+
* 高阶函数,生成一个验证方法,验证是否处于登录状态
|
|
9779
|
+
* * 本地数据查询时,只需要验证用户已经登录过且未主动断开,无需校验当前连接状态
|
|
9780
|
+
*/
|
|
9781
|
+
get validateLogin(): () => RCResult<INaviInfo>;
|
|
9592
9782
|
get token(): string;
|
|
9593
9783
|
refetchNaviInfo(): IPromiseResult<INaviInfo | null>;
|
|
9594
9784
|
/**
|
|
@@ -9607,7 +9797,6 @@ declare class APIContext {
|
|
|
9607
9797
|
connect(token: string, reconnectKickEnable: boolean, traceId: string): Promise<IConnectResult>;
|
|
9608
9798
|
disconnect(closeDB?: boolean, disablePush?: boolean): Promise<void>;
|
|
9609
9799
|
reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
|
|
9610
|
-
private _getTokenWithoutNavi;
|
|
9611
9800
|
/**
|
|
9612
9801
|
* 超级群 channelId 转换
|
|
9613
9802
|
* @param type 会话类型
|
|
@@ -9618,7 +9807,6 @@ declare class APIContext {
|
|
|
9618
9807
|
* 获取当前缓存的导航数据
|
|
9619
9808
|
*/
|
|
9620
9809
|
getNaviInfoFromCache(): INaviInfo | null;
|
|
9621
|
-
private _registerMessageSearchPropsMapping;
|
|
9622
9810
|
/**
|
|
9623
9811
|
* 消息注册
|
|
9624
9812
|
* @description 消息注册需在应用初始化完成前进行
|
|
@@ -9634,7 +9822,6 @@ declare class APIContext {
|
|
|
9634
9822
|
* @param listener
|
|
9635
9823
|
*/
|
|
9636
9824
|
registerRTCSignalingListener(listener?: (buffer: Uint8Array) => void): void;
|
|
9637
|
-
checkSearchPropsMsg(messageType: string, msgContent: any): IAsyncRes;
|
|
9638
9825
|
/**
|
|
9639
9826
|
* 降低圈复杂度 - 将扩展验证的结果抽离
|
|
9640
9827
|
* @param expansion
|
|
@@ -9656,13 +9843,13 @@ declare class APIContext {
|
|
|
9656
9843
|
/**
|
|
9657
9844
|
* 发送群组消息已读回执
|
|
9658
9845
|
* 导航下发已读回执开关为 true 时调用
|
|
9659
|
-
* @param targetId 群组会话
|
|
9660
|
-
* @param messageUIds 消息
|
|
9846
|
+
* @param targetId 群组会话 Id
|
|
9847
|
+
* @param messageUIds 消息 UId
|
|
9661
9848
|
*/
|
|
9662
9849
|
sendReadReceiptMessage(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes>;
|
|
9663
9850
|
/**
|
|
9664
9851
|
* 获取群组消息已读列表
|
|
9665
|
-
* 已读回执目前 3 个版本 有 naviInfo.grpRRVer字段区分。
|
|
9852
|
+
* 已读回执目前 3 个版本 有 naviInfo.grpRRVer 字段区分。
|
|
9666
9853
|
* 0:为目前有公有先支持版本,调用 sendReadReceiptResponseV2
|
|
9667
9854
|
* 1. 为 v2 版本,仅供 beem 使用目前公有云已废弃
|
|
9668
9855
|
* 3. 为 v4 版本,目前仅海外 IMkit 使用
|
|
@@ -9671,16 +9858,16 @@ declare class APIContext {
|
|
|
9671
9858
|
*/
|
|
9672
9859
|
getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
|
|
9673
9860
|
/**
|
|
9674
|
-
* 发送已读回执(V4)
|
|
9861
|
+
* 发送已读回执 (V4)
|
|
9675
9862
|
*/
|
|
9676
9863
|
sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
9677
9864
|
/**
|
|
9678
|
-
*
|
|
9865
|
+
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
9679
9866
|
*/
|
|
9680
9867
|
getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
9681
9868
|
batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
|
|
9682
9869
|
/**
|
|
9683
|
-
*
|
|
9870
|
+
* 多端同步会话的已读时间(V4)
|
|
9684
9871
|
*/
|
|
9685
9872
|
updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
|
|
9686
9873
|
/**
|
|
@@ -9732,25 +9919,20 @@ declare class APIContext {
|
|
|
9732
9919
|
hasMore: boolean;
|
|
9733
9920
|
}>>;
|
|
9734
9921
|
/**
|
|
9735
|
-
*
|
|
9736
|
-
* @param count 指定获取数量, 不传则获取全部会话列表,默认 `300`
|
|
9737
|
-
*/
|
|
9738
|
-
getConversationList(count?: number, conversationType?: ConversationType, startTime?: number, order?: 0 | 1, channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
9739
|
-
/**
|
|
9740
|
-
* 分页获取会话列表,仅 electron中使用
|
|
9922
|
+
* 查询会话列表
|
|
9741
9923
|
*/
|
|
9742
|
-
|
|
9924
|
+
getConversationListByFilter(filter: ConversationListFilter): Promise<RCResult<IReceivedConversation[]>>;
|
|
9743
9925
|
/**
|
|
9744
|
-
*
|
|
9926
|
+
* 从本地缓存获取单一会话数据
|
|
9745
9927
|
* @param conversationType
|
|
9746
9928
|
* @param targetId
|
|
9747
9929
|
* @param channelId
|
|
9748
9930
|
*/
|
|
9749
|
-
getConversation(
|
|
9931
|
+
getConversation(conversation: IConversationOption): Promise<RCResult<IReceivedConversation>>;
|
|
9750
9932
|
/**
|
|
9751
9933
|
* 删除会话
|
|
9752
9934
|
*/
|
|
9753
|
-
removeConversation(
|
|
9935
|
+
removeConversation(conversation: IConversationOption): Promise<RCResult>;
|
|
9754
9936
|
batchRemoveConversation(conversations: IConversationOption[]): Promise<ErrorCode>;
|
|
9755
9937
|
/**
|
|
9756
9938
|
* 获取超级群会话列表
|
|
@@ -9760,10 +9942,6 @@ declare class APIContext {
|
|
|
9760
9942
|
* 获取超级群免打扰列表
|
|
9761
9943
|
*/
|
|
9762
9944
|
getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
9763
|
-
/**
|
|
9764
|
-
* 获取超级群置顶列表
|
|
9765
|
-
*/
|
|
9766
|
-
getTopUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
9767
9945
|
/**
|
|
9768
9946
|
* 清除会话消息未读数
|
|
9769
9947
|
*/
|
|
@@ -9771,18 +9949,19 @@ declare class APIContext {
|
|
|
9771
9949
|
/**
|
|
9772
9950
|
* 清除全部会话消息未读数
|
|
9773
9951
|
*/
|
|
9774
|
-
clearAllUnreadCount(): Promise<
|
|
9952
|
+
clearAllUnreadCount(): Promise<RCResult>;
|
|
9775
9953
|
/**
|
|
9776
9954
|
* 获取指定会话消息未读数
|
|
9777
9955
|
*/
|
|
9778
9956
|
getUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<number>>;
|
|
9779
9957
|
/**
|
|
9780
9958
|
* 获取所有会话未读数
|
|
9959
|
+
* * 自 5.20.0 版本开始,在开启了会话列表支持超级群功能后,该接口返回的未读数包含超级群未读数
|
|
9781
9960
|
* @param channelId 多组织 Id
|
|
9782
9961
|
* @param conversationTypes
|
|
9783
9962
|
* @param includeMuted 包含已设置免打扰的会话
|
|
9784
9963
|
*/
|
|
9785
|
-
getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<
|
|
9964
|
+
getTotalUnreadCount(channelId: string, conversationTypes?: ConversationType[], includeMuted?: boolean): Promise<RCResult<number>>;
|
|
9786
9965
|
/**
|
|
9787
9966
|
* 获取会话指定免打扰级别未读消息总数
|
|
9788
9967
|
* @param conversationTypes 会话类型
|
|
@@ -9795,26 +9974,9 @@ declare class APIContext {
|
|
|
9795
9974
|
*/
|
|
9796
9975
|
getFirstUnreadMessage(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<IReceivedMessage | null>>;
|
|
9797
9976
|
getFirstUnreadMessageInfo(conversationType: ConversationType, targetId: string, channelId: string): Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>;
|
|
9798
|
-
|
|
9799
|
-
|
|
9800
|
-
|
|
9801
|
-
* 是否免打扰
|
|
9802
|
-
* * -1: 全部消息通知(接收全部消息通知 -- 显示指定关闭免打扰功能)
|
|
9803
|
-
* * 0: 未设置(向上查询群或者APP级别设置)//存量数据中0表示未设置
|
|
9804
|
-
* * 1: 群聊超级群仅@消息通知(现在通知)单聊代表全部消息通知
|
|
9805
|
-
* * 2: @ 指定用户通知
|
|
9806
|
-
* * 4: @ 群全员通知
|
|
9807
|
-
* * 5: 消息通知被屏蔽,即不接收消息通知
|
|
9808
|
-
*/
|
|
9809
|
-
setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel?: NotificationLevel, channelId?: string): Promise<ErrorCode>;
|
|
9810
|
-
batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<ErrorCode>;
|
|
9811
|
-
/**
|
|
9812
|
-
* @deprecated 同时设置置顶、免打扰状态,为兼容 v2/v4 使用,v5 后不再支持
|
|
9813
|
-
* @returns
|
|
9814
|
-
*/
|
|
9815
|
-
setConversationStatus(conversationType: ConversationType, targetId: string, isTop?: boolean, notificationStatus?: 1 | 2, channelId?: string, isUpdateTime?: boolean): Promise<ErrorCode>;
|
|
9816
|
-
setConversationToTop(conversationType: ConversationType, targetId: string, isTop: boolean, channelId: string, isUpdateTime: boolean): Promise<ErrorCode>;
|
|
9817
|
-
batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<ErrorCode>;
|
|
9977
|
+
batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<RCResult>;
|
|
9978
|
+
/** 批量设置会话置顶 */
|
|
9979
|
+
batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isUpdateTime?: boolean, isCreateConversation?: boolean): Promise<RCResult>;
|
|
9818
9980
|
saveConversationMessageDraft(conversationType: ConversationType, targetId: string, draft: string, channelId?: string): Promise<ErrorCode>;
|
|
9819
9981
|
getConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<string>>;
|
|
9820
9982
|
clearConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
|
|
@@ -9833,18 +9995,17 @@ declare class APIContext {
|
|
|
9833
9995
|
* @param targetId
|
|
9834
9996
|
* @param list
|
|
9835
9997
|
*/
|
|
9836
|
-
deleteRemoteMessage(
|
|
9998
|
+
deleteRemoteMessage(conversation: IConversationOption, messages: {
|
|
9837
9999
|
messageUId: string;
|
|
9838
10000
|
sentTime: number;
|
|
9839
10001
|
messageDirection: MessageDirection;
|
|
9840
|
-
}[]
|
|
10002
|
+
}[]): Promise<RCResult>;
|
|
9841
10003
|
/**
|
|
9842
10004
|
* 根据时间戳删除指定时间之前的
|
|
9843
|
-
* @param
|
|
9844
|
-
* @param
|
|
9845
|
-
* @param timestamp
|
|
10005
|
+
* @param identifier 会话信息
|
|
10006
|
+
* @param timestamp 时间戳
|
|
9846
10007
|
*/
|
|
9847
|
-
deleteRemoteMessageByTimestamp(
|
|
10008
|
+
deleteRemoteMessageByTimestamp(identifier: IConversationOption, timestamp: number): Promise<RCResult>;
|
|
9848
10009
|
/**
|
|
9849
10010
|
* 加入聊天室,若聊天室不存在则创建聊天室
|
|
9850
10011
|
* @param roomId 聊天室房间 Id
|
|
@@ -9928,7 +10089,7 @@ declare class APIContext {
|
|
|
9928
10089
|
/**
|
|
9929
10090
|
* 拉取聊天室内的历史消息
|
|
9930
10091
|
* @param roomId
|
|
9931
|
-
* @param count
|
|
10092
|
+
* @param count 拉取消息条数,有效值范围 `1 - 20`
|
|
9932
10093
|
* @param order 获取顺序,默认值为 0。
|
|
9933
10094
|
* * 0:降序,用于获取早于指定时间戳发送的消息
|
|
9934
10095
|
* * 1:升序,用于获取晚于指定时间戳发送的消息
|
|
@@ -9954,7 +10115,7 @@ declare class APIContext {
|
|
|
9954
10115
|
* @param queryString STC 分段上传时的查询字符串
|
|
9955
10116
|
* @description
|
|
9956
10117
|
* `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
|
|
9957
|
-
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST
|
|
10118
|
+
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
|
|
9958
10119
|
* 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
|
|
9959
10120
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
9960
10121
|
* @returns
|
|
@@ -9980,7 +10141,7 @@ declare class APIContext {
|
|
|
9980
10141
|
createTag(tag: ITagParam): Promise<IAsyncRes>;
|
|
9981
10142
|
/**
|
|
9982
10143
|
* 删除标签
|
|
9983
|
-
* @param tagId 标签
|
|
10144
|
+
* @param tagId 标签 Id
|
|
9984
10145
|
*/
|
|
9985
10146
|
removeTag(tagId: string): Promise<IAsyncRes>;
|
|
9986
10147
|
/**
|
|
@@ -9994,31 +10155,31 @@ declare class APIContext {
|
|
|
9994
10155
|
getTagList(): Promise<IAsyncRes<Array<ITagInfo>>>;
|
|
9995
10156
|
/**
|
|
9996
10157
|
* 添加会话到标签(给多个会话增加标签)
|
|
9997
|
-
* @param tagId 标签
|
|
10158
|
+
* @param tagId 标签 Id
|
|
9998
10159
|
* @param conversations 要添加的会话列表
|
|
9999
10160
|
*/
|
|
10000
10161
|
addTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes>;
|
|
10001
10162
|
/**
|
|
10002
|
-
*
|
|
10003
|
-
* @param tagId 标签
|
|
10163
|
+
* 删除标签中的会话(从多个会话中批量删除指定标签)
|
|
10164
|
+
* @param tagId 标签 Id
|
|
10004
10165
|
* @param conversations 要删除的会话列表
|
|
10005
10166
|
*/
|
|
10006
10167
|
removeTagForConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes>;
|
|
10007
10168
|
/**
|
|
10008
|
-
*
|
|
10169
|
+
* 删除会话中的标签(从单一会话中批量删除标签)
|
|
10009
10170
|
* @param conversationType 会话类型
|
|
10010
|
-
* @param targetId 会话
|
|
10171
|
+
* @param targetId 会话 Id
|
|
10011
10172
|
* @param tagIds 要删除的标签列表
|
|
10012
10173
|
*/
|
|
10013
10174
|
removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes>;
|
|
10014
10175
|
/**
|
|
10015
10176
|
* 获取标签下的会话列表
|
|
10016
|
-
* @param tagId 标签
|
|
10177
|
+
* @param tagId 标签 Id
|
|
10017
10178
|
*/
|
|
10018
10179
|
getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): Promise<IAsyncRes<IReceivedConversationByTag[]>>;
|
|
10019
10180
|
/**
|
|
10020
10181
|
* 获取标签下的未读消息数
|
|
10021
|
-
* @param tagId 标签
|
|
10182
|
+
* @param tagId 标签 Id
|
|
10022
10183
|
* @param containMuted 是否包含免打扰会话
|
|
10023
10184
|
*/
|
|
10024
10185
|
getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number>>;
|
|
@@ -10034,19 +10195,7 @@ declare class APIContext {
|
|
|
10034
10195
|
* @param conversation
|
|
10035
10196
|
*/
|
|
10036
10197
|
getTagsForConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[]>>;
|
|
10037
|
-
|
|
10038
|
-
* 获取所有本地免打扰列表
|
|
10039
|
-
*/
|
|
10040
|
-
getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
10041
|
-
/**
|
|
10042
|
-
* 获取所有本地置顶列表
|
|
10043
|
-
*/
|
|
10044
|
-
getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
10045
|
-
/**
|
|
10046
|
-
* 获取未读会话列表
|
|
10047
|
-
*/
|
|
10048
|
-
getUnreadConversationList(conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
10049
|
-
getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
|
|
10198
|
+
getUnreadMentionedCount(conversation: IConversationOption): Promise<RCResult<number>>;
|
|
10050
10199
|
/**
|
|
10051
10200
|
* 获取所有群聊会话 @ 消息未读数
|
|
10052
10201
|
*/
|
|
@@ -10091,7 +10240,6 @@ declare class APIContext {
|
|
|
10091
10240
|
* @returns 未读数
|
|
10092
10241
|
*/
|
|
10093
10242
|
getAllUltraGroupUnreadCount(isMentioned?: boolean): Promise<IAsyncRes<number>>;
|
|
10094
|
-
getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
|
|
10095
10243
|
/**
|
|
10096
10244
|
* 超级群类型获取未读 @ 消息列表
|
|
10097
10245
|
* @param options
|
|
@@ -10209,7 +10357,7 @@ declare class APIContext {
|
|
|
10209
10357
|
* 通过时间戳批量清除本地消息
|
|
10210
10358
|
*/
|
|
10211
10359
|
batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
|
|
10212
|
-
batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<
|
|
10360
|
+
batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<RCResult>;
|
|
10213
10361
|
/**
|
|
10214
10362
|
* 清空会话下历史消息
|
|
10215
10363
|
*/
|
|
@@ -10255,7 +10403,7 @@ declare class APIContext {
|
|
|
10255
10403
|
getUserStatus(userId: string): Promise<IAsyncRes<{
|
|
10256
10404
|
status: string;
|
|
10257
10405
|
}>>;
|
|
10258
|
-
searchConversationByContent(keyword: string,
|
|
10406
|
+
searchConversationByContent(keyword: string, messageTypes?: string[], channelId?: string, conversationTypes?: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
10259
10407
|
searchConversationByContentWithAllChannel(keyword: string, customMessageTypes?: string[], conversationTypes?: ConversationType[]): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
10260
10408
|
searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId?: string): Promise<IAsyncRes<{
|
|
10261
10409
|
messages: IReceivedMessage[];
|
|
@@ -10292,20 +10440,14 @@ declare class APIContext {
|
|
|
10292
10440
|
setUltraGroupDefaultNotificationLevel(targetId: string, notificationLevel: NotificationLevel, channelId?: string): Promise<IAsyncRes<void>>;
|
|
10293
10441
|
/**
|
|
10294
10442
|
* 获取会话免打扰状态
|
|
10295
|
-
|
|
10296
|
-
getConversationNotificationLevel(
|
|
10297
|
-
setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<
|
|
10298
|
-
getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<
|
|
10299
|
-
/**
|
|
10300
|
-
* 获取会话免打扰状态
|
|
10301
|
-
*/
|
|
10302
|
-
getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId?: string): Promise<IAsyncRes<NotificationStatus>>;
|
|
10443
|
+
*/
|
|
10444
|
+
getConversationNotificationLevel(conversation: IConversationOption): Promise<RCResult<NotificationLevel>>;
|
|
10445
|
+
setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<RCResult>;
|
|
10446
|
+
getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<RCResult<NotificationLevel>>;
|
|
10303
10447
|
getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): Promise<IAsyncRes<{
|
|
10304
10448
|
list: IReceivedMessage[];
|
|
10305
10449
|
hasMore: boolean;
|
|
10306
10450
|
}>>;
|
|
10307
|
-
getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
10308
|
-
getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
10309
10451
|
clearData(): Promise<IAsyncRes<boolean>>;
|
|
10310
10452
|
createLogger(id: string, type: LogType): BasicLogger;
|
|
10311
10453
|
getConversations(conversationList: IConversationOption[]): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
@@ -10323,7 +10465,7 @@ declare class APIContext {
|
|
|
10323
10465
|
}>;
|
|
10324
10466
|
rtcPing(roomId: string, mode: number, mediaType?: number): Promise<IAsyncRes<any>>;
|
|
10325
10467
|
/**
|
|
10326
|
-
* SDK设置聊天室关联的
|
|
10468
|
+
* SDK 设置聊天室关联的 RTC 房间
|
|
10327
10469
|
*/
|
|
10328
10470
|
bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<ErrorCode>;
|
|
10329
10471
|
/**
|
|
@@ -10409,6 +10551,10 @@ declare class APIContext {
|
|
|
10409
10551
|
* 获取统计地址
|
|
10410
10552
|
*/
|
|
10411
10553
|
getStatsUrlList(): Promise<RCResult<string[]>>;
|
|
10554
|
+
sendReadReceiptResponseV5(conId: IConversationOption, messageUIdArray: string[]): Promise<RCResult>;
|
|
10555
|
+
getMessageReadReceiptInfoV5(conId: IConversationOption, messageUIdArray: Array<string>): Promise<RCResult<ReadReceiptInfoV5[]>>;
|
|
10556
|
+
getMessagesReadReceiptUsersByPageV5(conId: IConversationOption, messageUId: string, option: ReadReceiptUsersOption): Promise<RCResult<ReadReceiptUsersResult>>;
|
|
10557
|
+
getMessagesReadReceiptByUsersV5(conId: IConversationOption, messageUId: string, userList: Array<string>): Promise<RCResult<ReadReceiptUsersResult>>;
|
|
10412
10558
|
}
|
|
10413
10559
|
|
|
10414
10560
|
declare class RTCPluginContext extends PluginContext {
|
|
@@ -10610,6 +10756,11 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
10610
10756
|
getRTCJoinedUserInfo(userId: string): IPromiseResult<IRTCJoinedInfo[]>;
|
|
10611
10757
|
}
|
|
10612
10758
|
|
|
10759
|
+
/**
|
|
10760
|
+
* 会话聊天模块
|
|
10761
|
+
*/
|
|
10762
|
+
declare type IChatModule = Pick<IIPCMethods, 'getConversationListByFilter' | 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent'>;
|
|
10763
|
+
|
|
10613
10764
|
declare abstract class BasicEngine {
|
|
10614
10765
|
protected readonly rtcCodec: Codec<InnerRTCKeyMaps>;
|
|
10615
10766
|
protected readonly _watcher: IEngineWatcher;
|
|
@@ -10621,18 +10772,10 @@ declare abstract class BasicEngine {
|
|
|
10621
10772
|
abstract getConnectedTime(): number;
|
|
10622
10773
|
protected readonly _appkey: string;
|
|
10623
10774
|
private _rtcKVManager;
|
|
10624
|
-
/**
|
|
10625
|
-
* 聊天室业务模块
|
|
10626
|
-
*/
|
|
10627
|
-
abstract get chatroom(): IChatroomModule;
|
|
10628
10775
|
/**
|
|
10629
10776
|
* 会话聊天模块
|
|
10630
10777
|
*/
|
|
10631
10778
|
abstract get chat(): IChatModule;
|
|
10632
|
-
/**
|
|
10633
|
-
* 数据托管模块
|
|
10634
|
-
*/
|
|
10635
|
-
abstract get dataHosting(): IDataHostingModule;
|
|
10636
10779
|
/**
|
|
10637
10780
|
* 引擎初始化
|
|
10638
10781
|
* @param _appkey
|
|
@@ -10676,7 +10819,7 @@ declare abstract class BasicEngine {
|
|
|
10676
10819
|
*/
|
|
10677
10820
|
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): IPromiseResult<string>;
|
|
10678
10821
|
/**
|
|
10679
|
-
* 发送SDK版本
|
|
10822
|
+
* 发送 SDK 版本
|
|
10680
10823
|
* @param versionInfo
|
|
10681
10824
|
*/
|
|
10682
10825
|
abstract reportSDKInfo(versionInfo: {
|
|
@@ -10713,7 +10856,7 @@ declare abstract class BasicEngine {
|
|
|
10713
10856
|
hasMore: boolean;
|
|
10714
10857
|
}>;
|
|
10715
10858
|
/**
|
|
10716
|
-
* 获取历史消息(pc
|
|
10859
|
+
* 获取历史消息 (pc 端支持断档补偿,web 端同 getHistoryMessage)
|
|
10717
10860
|
* @param conversationType
|
|
10718
10861
|
* @param targetId
|
|
10719
10862
|
* @param timestamp
|
|
@@ -10750,86 +10893,15 @@ declare abstract class BasicEngine {
|
|
|
10750
10893
|
list: IReceivedMessage[];
|
|
10751
10894
|
hasMore: boolean;
|
|
10752
10895
|
}>>;
|
|
10753
|
-
/**
|
|
10754
|
-
* 删除历史消息 通过 messageUId
|
|
10755
|
-
*/
|
|
10756
|
-
abstract deleteRemoteMessage(conversationType: ConversationType, targetId: string,
|
|
10757
|
-
/**
|
|
10758
|
-
* @description
|
|
10759
|
-
* message 中 messageUId、setTime、messageDirection 为必须参数
|
|
10760
|
-
*/
|
|
10761
|
-
messages: {
|
|
10762
|
-
messageUId: string;
|
|
10763
|
-
sentTime: number;
|
|
10764
|
-
messageDirection: MessageDirection;
|
|
10765
|
-
}[],
|
|
10766
|
-
/**
|
|
10767
|
-
* 会话的业务标识
|
|
10768
|
-
*/
|
|
10769
|
-
channelId: string): Promise<ErrorCode>;
|
|
10770
10896
|
abstract recallMsg(conversation: IConversationOption, recallMsgOptions: IRecallMsgOptions): Promise<RCResult<IReceivedMessage>>;
|
|
10771
|
-
/**
|
|
10772
|
-
* 删除历史消息 通过 时间戳
|
|
10773
|
-
* @param timestamp 小于等于传入时间戳的消息均删除
|
|
10774
|
-
*/
|
|
10775
|
-
abstract deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number,
|
|
10776
|
-
/**
|
|
10777
|
-
* 会话的业务标识
|
|
10778
|
-
*/
|
|
10779
|
-
channelId: string): Promise<ErrorCode>;
|
|
10780
|
-
/**
|
|
10781
|
-
* 获取会话列表
|
|
10782
|
-
* @param count 指定获取数量, 不传则获取全部会话列表,默认 `300`
|
|
10783
|
-
*/
|
|
10784
|
-
abstract getConversationList(
|
|
10785
|
-
/**
|
|
10786
|
-
* 拉取数量, 有效值 0 - 1000, 默认 300
|
|
10787
|
-
*/
|
|
10788
|
-
count: number,
|
|
10789
|
-
/**
|
|
10790
|
-
* 会话类型
|
|
10791
|
-
* @todo 待确认是否生效
|
|
10792
|
-
*/
|
|
10793
|
-
conversationType?: ConversationType,
|
|
10794
|
-
/**
|
|
10795
|
-
* 起始时间
|
|
10796
|
-
*/
|
|
10797
|
-
startTime?: number,
|
|
10798
|
-
/**
|
|
10799
|
-
* 获取顺序
|
|
10800
|
-
*/
|
|
10801
|
-
order?: 0 | 1,
|
|
10802
|
-
/**
|
|
10803
|
-
* 会话的业务标识
|
|
10804
|
-
*/
|
|
10805
|
-
channelId?: string): IPromiseResult<IReceivedConversation[]>;
|
|
10806
|
-
/**
|
|
10807
|
-
* 分页获取会话列表,仅 electron中使用
|
|
10808
|
-
*/
|
|
10809
|
-
abstract getConversationsByPage(conversationTypes: ConversationType[], startTime: number, count: number, channelId: string, topPriority: boolean): IPromiseResult<IReceivedConversation[]>;
|
|
10810
|
-
/**
|
|
10811
|
-
* 获取指定会话
|
|
10812
|
-
*/
|
|
10813
|
-
abstract getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
|
|
10814
|
-
/**
|
|
10815
|
-
* 获取未读会话列表
|
|
10816
|
-
*/
|
|
10817
|
-
abstract getUnreadConversationList(conversationTypes: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
|
|
10818
10897
|
/**
|
|
10819
10898
|
* 删除会话
|
|
10820
10899
|
* @description 该删除操作会删除服务器端存储的会话数据
|
|
10821
10900
|
* @param conversationType
|
|
10822
10901
|
* @param targetId
|
|
10823
10902
|
*/
|
|
10824
|
-
abstract removeConversation(
|
|
10903
|
+
abstract removeConversation(conversation: IConversationOption): Promise<RCResult>;
|
|
10825
10904
|
abstract batchRemoveConversation(conversations: IConversationOption[]): Promise<ErrorCode>;
|
|
10826
|
-
/**
|
|
10827
|
-
* 获取所有会话未读数
|
|
10828
|
-
* @param channelId 多组织 Id
|
|
10829
|
-
* @param conversationTypes
|
|
10830
|
-
* @param includeMuted 包含已设置免打扰的会话
|
|
10831
|
-
*/
|
|
10832
|
-
abstract getAllConversationUnreadCount(channelId: string, conversationTypes: ConversationType[], includeMuted: boolean): IPromiseResult<number>;
|
|
10833
10905
|
/**
|
|
10834
10906
|
* 获取会话指定免打扰级别的未读总数
|
|
10835
10907
|
*/
|
|
@@ -10842,10 +10914,6 @@ declare abstract class BasicEngine {
|
|
|
10842
10914
|
* 清除指定会话未读数
|
|
10843
10915
|
*/
|
|
10844
10916
|
abstract clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
|
|
10845
|
-
/**
|
|
10846
|
-
* 清除全部会话未读数
|
|
10847
|
-
*/
|
|
10848
|
-
abstract clearAllUnreadCount(): Promise<ErrorCode>;
|
|
10849
10917
|
/**
|
|
10850
10918
|
* 获取第一个未读消息
|
|
10851
10919
|
*/
|
|
@@ -10864,16 +10932,6 @@ declare abstract class BasicEngine {
|
|
|
10864
10932
|
* 清除指定会话消息草稿
|
|
10865
10933
|
*/
|
|
10866
10934
|
abstract clearConversationMessageDraft(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
|
|
10867
|
-
/**
|
|
10868
|
-
* 从服务端拉取会话状态
|
|
10869
|
-
*/
|
|
10870
|
-
abstract pullConversationStatus(timestamp: number): Promise<IAsyncRes<IServerConversationStatus[]>>;
|
|
10871
|
-
/**
|
|
10872
|
-
* 批量设置会话 置顶、免打扰
|
|
10873
|
-
*/
|
|
10874
|
-
abstract batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
|
|
10875
|
-
abstract setConversationToTop(conversationType: ConversationType, targetId: string, isTop: boolean, channelId: string, isUpdateTime: boolean): Promise<ErrorCode>;
|
|
10876
|
-
abstract batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<ErrorCode>;
|
|
10877
10935
|
abstract sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions,
|
|
10878
10936
|
/**
|
|
10879
10937
|
* c++ 消息写库后存在自增 Id,必要时需要向业务层暴露,JSEngine 无需实现
|
|
@@ -10893,19 +10951,19 @@ declare abstract class BasicEngine {
|
|
|
10893
10951
|
*/
|
|
10894
10952
|
abstract getMessageReader(targetId: string, messageUId: string, channelId?: string): IPromiseResult<IMessageReaderResponse>;
|
|
10895
10953
|
/**
|
|
10896
|
-
* 发送已读回执(V4)
|
|
10954
|
+
* 发送已读回执 (V4)
|
|
10897
10955
|
*/
|
|
10898
10956
|
abstract sendReadReceiptMessageV4(conversation: IConversationOption, startMsgUid: string, endMsgUid: string): Promise<IAsyncRes>;
|
|
10899
10957
|
/**
|
|
10900
|
-
*
|
|
10958
|
+
* 获取消息已读回执列表,暂仅支持群聊 (V4)
|
|
10901
10959
|
*/
|
|
10902
10960
|
abstract getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): IPromiseResult<IMessageReadReceiptV4Response>;
|
|
10903
10961
|
/**
|
|
10904
|
-
*
|
|
10962
|
+
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
10905
10963
|
*/
|
|
10906
10964
|
abstract batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): IPromiseResult<IGroupReadReceiptData[]>;
|
|
10907
10965
|
/**
|
|
10908
|
-
* 多端同步会话的已读时间(V4)
|
|
10966
|
+
* 多端同步会话的已读时间 (V4)
|
|
10909
10967
|
*/
|
|
10910
10968
|
abstract updateConversationReadTime(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes>;
|
|
10911
10969
|
/**
|
|
@@ -10921,15 +10979,9 @@ declare abstract class BasicEngine {
|
|
|
10921
10979
|
/**
|
|
10922
10980
|
* 消息注册
|
|
10923
10981
|
* @description
|
|
10924
|
-
* 消息注册需在应用初始化完成前进行,否则在搭配 C++
|
|
10925
|
-
* 本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
10926
|
-
* @param objectName 消息类型,如:RC:TxtMsg
|
|
10927
|
-
* @param isPersited 是否存储
|
|
10928
|
-
* @param isCounted 是否技术
|
|
10929
|
-
* @param searchProps 搜索字段,只在搭配协议栈使用时有效
|
|
10930
|
-
* @param isStatusMessage 是否是状态消息
|
|
10982
|
+
* 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
10931
10983
|
*/
|
|
10932
|
-
abstract registerMessageType(objectName: string,
|
|
10984
|
+
abstract registerMessageType(objectName: string, desc: MessageRegisterParams): void;
|
|
10933
10985
|
/**
|
|
10934
10986
|
* 加入聊天室
|
|
10935
10987
|
* @param count 拉取消息数量
|
|
@@ -10946,8 +10998,8 @@ declare abstract class BasicEngine {
|
|
|
10946
10998
|
abstract quitChatroom(chatroomId: string): Promise<ErrorCode>;
|
|
10947
10999
|
/**
|
|
10948
11000
|
* 获取聊天室信息
|
|
10949
|
-
* @param count
|
|
10950
|
-
* @param order
|
|
11001
|
+
* @param count 获取人数,范围 0 - 20
|
|
11002
|
+
* @param order 排序方式,1 正序,2 倒序
|
|
10951
11003
|
*/
|
|
10952
11004
|
abstract getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
|
|
10953
11005
|
/**
|
|
@@ -11005,7 +11057,7 @@ declare abstract class BasicEngine {
|
|
|
11005
11057
|
* @param queryString STC 分段上传时的查询字符串
|
|
11006
11058
|
* @description
|
|
11007
11059
|
* `httpMethod` 与 `queryString` 为 STC S3 分段上传时的专属参数,STC 分段上传包含三个过程:
|
|
11008
|
-
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST
|
|
11060
|
+
* 1. 开始分段前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploads`
|
|
11009
11061
|
* 2. 上传请求前调用,此时 `httpMethod` 值应为 `PUT`,`queryString` 值为 `partNumber={partamNumer}&uploadId={uploadId}`
|
|
11010
11062
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`
|
|
11011
11063
|
* @returns
|
|
@@ -11029,7 +11081,7 @@ declare abstract class BasicEngine {
|
|
|
11029
11081
|
abstract createTag(tag: ITagParam): IPromiseResult;
|
|
11030
11082
|
/**
|
|
11031
11083
|
* 删除标签
|
|
11032
|
-
* @param tagId 标签id
|
|
11084
|
+
* @param tagId 标签 id
|
|
11033
11085
|
*/
|
|
11034
11086
|
abstract removeTag(tagId: string): IPromiseResult;
|
|
11035
11087
|
/**
|
|
@@ -11043,31 +11095,31 @@ declare abstract class BasicEngine {
|
|
|
11043
11095
|
abstract getTagList(): IPromiseResult<Array<ITagInfo>>;
|
|
11044
11096
|
/**
|
|
11045
11097
|
* 添加会话到标签(给多个会话增加标签)
|
|
11046
|
-
* @param tagId 标签id
|
|
11098
|
+
* @param tagId 标签 id
|
|
11047
11099
|
* @param conversations 要添加的会话列表
|
|
11048
11100
|
*/
|
|
11049
11101
|
abstract addTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
|
|
11050
11102
|
/**
|
|
11051
|
-
* 删除标签中的会话(从多个会话中批量删除指定标签)
|
|
11052
|
-
* @param tagId 标签id
|
|
11103
|
+
* 删除标签中的会话 (从多个会话中批量删除指定标签)
|
|
11104
|
+
* @param tagId 标签 id
|
|
11053
11105
|
* @param conversations 要删除的会话列表
|
|
11054
11106
|
*/
|
|
11055
11107
|
abstract removeTagForConversations(tagId: string, conversations: IConversationOption[]): IPromiseResult;
|
|
11056
11108
|
/**
|
|
11057
|
-
* 删除会话中的标签(从单一会话中批量删除标签)
|
|
11109
|
+
* 删除会话中的标签 (从单一会话中批量删除标签)
|
|
11058
11110
|
* @param conversationType 会话类型
|
|
11059
|
-
* @param targetId 会话id
|
|
11111
|
+
* @param targetId 会话 id
|
|
11060
11112
|
* @param tagIds 要删除的标签列表
|
|
11061
11113
|
*/
|
|
11062
11114
|
abstract removeTagsForConversation(conversation: IConversationOption, tagIds: string[]): IPromiseResult;
|
|
11063
11115
|
/**
|
|
11064
11116
|
* 获取标签下的会话列表
|
|
11065
|
-
* @param tagId 标签id
|
|
11117
|
+
* @param tagId 标签 id
|
|
11066
11118
|
*/
|
|
11067
11119
|
abstract getConversationListByTag(tagId: string, startTime: number, count?: number, channelId?: string): IPromiseResult<IReceivedConversationByTag[]>;
|
|
11068
11120
|
/**
|
|
11069
11121
|
* 获取标签下的未读消息数
|
|
11070
|
-
* @param tagId 标签id
|
|
11122
|
+
* @param tagId 标签 id
|
|
11071
11123
|
* @param containMuted 是否包含免打扰会话
|
|
11072
11124
|
*/
|
|
11073
11125
|
abstract getUnreadCountByTag(tagId: string, containMuted: boolean): IPromiseResult<number>;
|
|
@@ -11086,7 +11138,7 @@ declare abstract class BasicEngine {
|
|
|
11086
11138
|
*/
|
|
11087
11139
|
abstract getServerTime(): number;
|
|
11088
11140
|
/**
|
|
11089
|
-
* 获取设备ID
|
|
11141
|
+
* 获取设备 ID
|
|
11090
11142
|
*/
|
|
11091
11143
|
abstract getDeviceId(): string;
|
|
11092
11144
|
/**
|
|
@@ -11106,10 +11158,6 @@ declare abstract class BasicEngine {
|
|
|
11106
11158
|
* 获取超级群免打扰列表
|
|
11107
11159
|
*/
|
|
11108
11160
|
abstract getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
11109
|
-
/**
|
|
11110
|
-
* 获取超级群置顶列表
|
|
11111
|
-
*/
|
|
11112
|
-
abstract getTopUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
11113
11161
|
/**
|
|
11114
11162
|
* 上报超级群会话已读时间
|
|
11115
11163
|
* @param targetId
|
|
@@ -11177,8 +11225,6 @@ declare abstract class BasicEngine {
|
|
|
11177
11225
|
* @param targetIds
|
|
11178
11226
|
*/
|
|
11179
11227
|
abstract getUltraGroupUnreadInfoList(targetIds: string[]): Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>;
|
|
11180
|
-
abstract getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
|
|
11181
|
-
abstract getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
|
|
11182
11228
|
/**
|
|
11183
11229
|
* 设置用户在线状态监听器
|
|
11184
11230
|
*/
|
|
@@ -11245,7 +11291,6 @@ declare abstract class BasicEngine {
|
|
|
11245
11291
|
* 通过时间戳批量清除本地消息
|
|
11246
11292
|
*/
|
|
11247
11293
|
abstract batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<ErrorCode>;
|
|
11248
|
-
abstract batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<ErrorCode>;
|
|
11249
11294
|
/**
|
|
11250
11295
|
* 清空会话下历史消息
|
|
11251
11296
|
*/
|
|
@@ -11262,10 +11307,6 @@ declare abstract class BasicEngine {
|
|
|
11262
11307
|
* 设置消息搜索字段
|
|
11263
11308
|
*/
|
|
11264
11309
|
abstract setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
|
|
11265
|
-
/**
|
|
11266
|
-
* 通过关键字搜索会话
|
|
11267
|
-
*/
|
|
11268
|
-
abstract searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
|
|
11269
11310
|
/**
|
|
11270
11311
|
* 通过关键字搜索所有会话
|
|
11271
11312
|
*/
|
|
@@ -11282,7 +11323,7 @@ declare abstract class BasicEngine {
|
|
|
11282
11323
|
count: number;
|
|
11283
11324
|
}>;
|
|
11284
11325
|
/**
|
|
11285
|
-
* 按用户ID搜索会话内的消息
|
|
11326
|
+
* 按用户 ID 搜索会话内的消息
|
|
11286
11327
|
*/
|
|
11287
11328
|
abstract searchMessagesByUser(conversationType: ConversationType, targetId: string, userId: string, timestamp: number, count: number, channelId: string): IPromiseResult<{
|
|
11288
11329
|
messages: IReceivedMessage[];
|
|
@@ -11332,20 +11373,6 @@ declare abstract class BasicEngine {
|
|
|
11332
11373
|
* 查询指定超级群默认通知配置
|
|
11333
11374
|
*/
|
|
11334
11375
|
abstract getUltraGroupDefaultNotificationLevel(targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
|
|
11335
|
-
/**
|
|
11336
|
-
* 获取会话免打扰状态
|
|
11337
|
-
* @deprecated 已废弃,请使用 getConversationNotificationLevel
|
|
11338
|
-
*/
|
|
11339
|
-
abstract getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
|
|
11340
|
-
abstract setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel?: NotificationLevel, channelId?: string): Promise<ErrorCode>;
|
|
11341
|
-
abstract batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<ErrorCode>;
|
|
11342
|
-
/**
|
|
11343
|
-
* 获取会话免打扰状态
|
|
11344
|
-
* 旧:getConversationNotificationStatus
|
|
11345
|
-
*/
|
|
11346
|
-
abstract getConversationNotificationLevel(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
|
|
11347
|
-
abstract setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<IAsyncRes<void>>;
|
|
11348
|
-
abstract getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<IAsyncRes<NotificationLevel>>;
|
|
11349
11376
|
/**
|
|
11350
11377
|
* 协议栈获取远端历史消息
|
|
11351
11378
|
*/
|
|
@@ -11365,26 +11392,14 @@ declare abstract class BasicEngine {
|
|
|
11365
11392
|
key: string;
|
|
11366
11393
|
value: string;
|
|
11367
11394
|
}>;
|
|
11368
|
-
/**
|
|
11369
|
-
* 无差别获取本地免打扰列表
|
|
11370
|
-
*/
|
|
11371
|
-
abstract getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
|
|
11372
|
-
/**
|
|
11373
|
-
* 无差别获取本地置顶列表
|
|
11374
|
-
*/
|
|
11375
|
-
abstract getTopConversationList(conversationTypes: ConversationType[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[]>>;
|
|
11376
11395
|
/**
|
|
11377
11396
|
* 获取单个群聊会话 @ 消息未读数
|
|
11378
11397
|
*/
|
|
11379
|
-
abstract getUnreadMentionedCount(conversation: IConversationOption): Promise<
|
|
11398
|
+
abstract getUnreadMentionedCount(conversation: IConversationOption): Promise<RCResult<number>>;
|
|
11380
11399
|
/**
|
|
11381
11400
|
* 获取所有群聊会话 @ 消息未读数
|
|
11382
11401
|
*/
|
|
11383
11402
|
abstract getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
|
|
11384
|
-
/**
|
|
11385
|
-
* 获取本地全部会话的状态
|
|
11386
|
-
*/
|
|
11387
|
-
abstract getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
|
|
11388
11403
|
abstract clearData(): Promise<IAsyncRes<boolean>>;
|
|
11389
11404
|
/**
|
|
11390
11405
|
* 超级群获取指定会话未读 @ 消息列表
|
|
@@ -11429,7 +11444,7 @@ declare abstract class BasicEngine {
|
|
|
11429
11444
|
abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<IAsyncRes<any>>;
|
|
11430
11445
|
pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<IAsyncRes<number>>;
|
|
11431
11446
|
/**
|
|
11432
|
-
* 设置聊天室关联的rtc房间
|
|
11447
|
+
* 设置聊天室关联的 rtc 房间
|
|
11433
11448
|
*/
|
|
11434
11449
|
abstract bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<ErrorCode>;
|
|
11435
11450
|
/**
|
|
@@ -11610,6 +11625,15 @@ declare class SSEModule extends EventDispatcher<{
|
|
|
11610
11625
|
requestStreamMessageContent(messageUId: string): Promise<RCResult>;
|
|
11611
11626
|
}
|
|
11612
11627
|
|
|
11628
|
+
/**
|
|
11629
|
+
* 聊天室模块
|
|
11630
|
+
*/
|
|
11631
|
+
interface IChatroomModule {
|
|
11632
|
+
}
|
|
11633
|
+
|
|
11634
|
+
interface IDataHostingModule {
|
|
11635
|
+
}
|
|
11636
|
+
|
|
11613
11637
|
/**
|
|
11614
11638
|
* 错误码映射表,单个标签且对应唯一错误码
|
|
11615
11639
|
*/
|
|
@@ -11713,7 +11737,7 @@ interface IErrorCodeKey {
|
|
|
11713
11737
|
}
|
|
11714
11738
|
|
|
11715
11739
|
/**
|
|
11716
|
-
*
|
|
11740
|
+
* 预定义的验证规则,只包含 `值类型` 数据验证
|
|
11717
11741
|
* 引用类型数据需使用自定义 validator 校验函数进行校验
|
|
11718
11742
|
*/
|
|
11719
11743
|
declare enum AssertRules {
|
|
@@ -11754,7 +11778,7 @@ declare enum AssertRules {
|
|
|
11754
11778
|
*/
|
|
11755
11779
|
CONVERSATION = 8,
|
|
11756
11780
|
/**
|
|
11757
|
-
*
|
|
11781
|
+
* 会话类型验证,必须为 ConversationType
|
|
11758
11782
|
*/
|
|
11759
11783
|
CONVERSATION_TYPE = 9
|
|
11760
11784
|
}
|
|
@@ -11899,4 +11923,4 @@ declare class AppStorage {
|
|
|
11899
11923
|
}): void;
|
|
11900
11924
|
}
|
|
11901
11925
|
|
|
11902
|
-
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, 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,
|
|
11926
|
+
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 };
|