@rongcloud/engine 5.20.2-alpha.1 → 5.20.2-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.d.ts CHANGED
@@ -251,6 +251,11 @@ declare const LogTagId: {
251
251
  readonly L_EVENT_LOOP_BLOCKING_S: "L-event_loop_blocking-S";
252
252
  readonly A_E_SEARCH_CONVERSATION_BY_CONTENT_T: "A-e_search_conversation_by_content-T";
253
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
+ /** 清除本地缓存 */
256
+ readonly A_CLEAR_LOCAL_CACHE_O: "A-clear_local_cache-O";
257
+ readonly A_E_SET_MESSAGE_STATUS_TO_READ_T: "A-e_set_message_status_to_read-T";
258
+ readonly A_E_SET_MESSAGE_STATUS_TO_READ_R: "A-e_set_message_status_to_read-R";
254
259
  };
255
260
 
256
261
  /**
@@ -661,7 +666,7 @@ declare enum ErrorCode {
661
666
  SYS_CONVERSATION_NOT_SUPPORT_MESSAGE = 20109,
662
667
  /**
663
668
  * 20512
664
- * appkey的数据中心与请求云控的数据中心不匹配
669
+ * appkey 的数据中心与请求云控的数据中心不匹配
665
670
  * @since 5.8.5
666
671
  */
667
672
  CLOUD_DATA_CENTER_INVALID = 20512,
@@ -692,12 +697,12 @@ declare enum ErrorCode {
692
697
  NOT_IN_DISCUSSION = 21406,
693
698
  /**
694
699
  * 21501
695
- * 发送的消息中包含敏感词 (发送方发送失败,接收方不会收到消息)
700
+ * 发送的消息中包含敏感词(发送方发送失败,接收方不会收到消息)
696
701
  */
697
702
  SENSITIVE_SHIELD = 21501,
698
703
  /**
699
704
  * 21502
700
- * 消息中敏感词已经被替换 (接收方可以收到被替换之后的消息)
705
+ * 消息中敏感词已经被替换(接收方可以收到被替换之后的消息)
701
706
  */
702
707
  SENSITIVE_REPLACE = 21502,
703
708
  /**
@@ -737,8 +742,8 @@ declare enum ErrorCode {
737
742
  NOT_IN_CHATROOM = 23406,
738
743
  /**
739
744
  * 23407
740
- * 聊天室禁言白名单人数超限(最多5个)
741
- * 创建聊天室时,禁言白名单用户列表,支持批量设置,最多不超过 20 个
745
+ * 聊天室禁言白名单人数超限 (最多 5 个)
746
+ * 创建聊天室时,禁言白名单用户列表,支持批量设置,最多不超过 20 个
742
747
  */
743
748
  GET_USERINFO_ERROR = 23407,
744
749
  /**
@@ -803,23 +808,23 @@ declare enum ErrorCode {
803
808
  CHATROOM_KEY_NOT_EXIST = 23427,
804
809
  /**
805
810
  * 23428
806
- * 聊天室批量设置或删除KV部分不成功
811
+ * 聊天室批量设置或删除 KV 部分不成功
807
812
  */
808
813
  CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
809
814
  /**
810
815
  * 23429
811
- * 聊天室批量设置或删除KV数量超限(最多一次10条)
816
+ * 聊天室批量设置或删除 KV 数量超限(最多一次 10 条)
812
817
  */
813
818
  CHATROOM_KV_STORE_OUT_LIMIT = 23429,
814
819
  /**
815
820
  * 23431
816
- * 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
821
+ * 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
817
822
  * @since 5.3.0
818
823
  */
819
824
  CHATROOM_KV_SET_ERROR = 23431,
820
825
  /**
821
826
  * 24001
822
- * 没有注册DeviveId 也就是用户没有登陆
827
+ * 没有注册 DeviveId 也就是用户没有登陆
823
828
  * @deprecated
824
829
  */
825
830
  HAVNODEVICEID = 24001,
@@ -849,7 +854,7 @@ declare enum ErrorCode {
849
854
  RC_USER_PROFILE_KEY_NOT_ALLOW_SDK_SET = 24360,
850
855
  /**
851
856
  * 24361
852
- * 用户托管基本属性的key列表中没有此key
857
+ * 用户托管基本属性的 key 列表中没有此 key
853
858
  * @since 5.9.10
854
859
  */
855
860
  RC_USER_PROFILE_KEY_NOT_EXIST = 24361,
@@ -867,7 +872,7 @@ declare enum ErrorCode {
867
872
  RC_USER_PROFILE_EXT_KV_COUNT_EXCEED_LIMIT = 24363,
868
873
  /**
869
874
  * 24364
870
- * 用户托管基本属性或扩展属性的Value,字符超过最大上限
875
+ * 用户托管基本属性或扩展属性的 Value,字符超过最大上限
871
876
  * @since 5.9.10
872
877
  */
873
878
  RC_USER_PROFILE_VALUE_LENGTH_EXCEED_LIMIT = 24364,
@@ -1002,7 +1007,7 @@ declare enum ErrorCode {
1002
1007
  RC_ENTRUST_SERVER_PARAMETER_ERROR = 25403,
1003
1008
  /**
1004
1009
  * 25404
1005
- * 非法操作,非群主修改群权限相关,msg中返回传的对应的key
1010
+ * 非法操作,非群主修改群权限相关,msg 中返回传的对应的 key
1006
1011
  * @since 5.12.0
1007
1012
  */
1008
1013
  RC_GROUP_ILLEGAL_ERROR = 25404,
@@ -1086,7 +1091,7 @@ declare enum ErrorCode {
1086
1091
  RC_GROUP_OWNER_NOT_ALLOW_QUIT_OR_KICK = 25417,
1087
1092
  /**
1088
1093
  * 25418
1089
- * 用户ID不在群组中
1094
+ * 用户 ID 不在群组中
1090
1095
  * @since 5.12.0
1091
1096
  */
1092
1097
  RC_GROUP_USER_NOT_IN_GROUP = 25418,
@@ -1158,13 +1163,13 @@ declare enum ErrorCode {
1158
1163
  RC_GROUP_OLD_GROUP_NOT_ENTRUST = 25429,
1159
1164
  /**
1160
1165
  * 25430
1161
- * 群ID不合法,包含特殊字符
1166
+ * 群 ID 不合法,包含特殊字符
1162
1167
  * @since 5.12.0
1163
1168
  */
1164
1169
  RC_GROUP_ID_INVALID = 25430,
1165
1170
  /**
1166
1171
  * 25432
1167
- * pagetoken解析失败
1172
+ * pagetoken 解析失败
1168
1173
  * @since 5.12.0
1169
1174
  */
1170
1175
  RC_PAGE_TOKEN_PARSING_FAILED = 25432,
@@ -1275,7 +1280,7 @@ declare enum ErrorCode {
1275
1280
  CONVERSATION_TAG_OVERSIZE = 26004,
1276
1281
  /**
1277
1282
  * 26005
1278
- * 未开通v4已读回执
1283
+ * 未开通 v4 已读回执
1279
1284
  */
1280
1285
  RC_READ_RECEIPT_V4_INVALID = 26005,
1281
1286
  /**
@@ -1290,7 +1295,7 @@ declare enum ErrorCode {
1290
1295
  RC_SERVER_PARAMETER_MESSAGEUIDS_CONFUSED = 26007,
1291
1296
  /**
1292
1297
  * 26009
1293
- * 消息id不合法
1298
+ * 消息 id 不合法
1294
1299
  */
1295
1300
  RC_SERVER_PARAMETER_MESSAGEUID_INVALID = 26009,
1296
1301
  /**
@@ -1305,12 +1310,12 @@ declare enum ErrorCode {
1305
1310
  RC_SUBSCRIBE_ONLINE_SERVICE_UNAVAILABLE = 26020,
1306
1311
  /**
1307
1312
  * 26021
1308
- * 用户被订阅量达到上限, 详细查看开发文档。
1313
+ * 用户被订阅量达到上限,详细查看开发文档。
1309
1314
  */
1310
1315
  RC_BESUBSCRIBED_USERIDS_COUNT_EXCEED_LIMIT = 26021,
1311
1316
  /**
1312
1317
  * 26022
1313
- * 订阅用户数达到上限, 详细查看开发文档。
1318
+ * 订阅用户数达到上限,详细查看开发文档。
1314
1319
  */
1315
1320
  RC_SUBSCRIBED_USERIDS_EXCEED_LIMIT = 26022,
1316
1321
  /**
@@ -1397,7 +1402,7 @@ declare enum ErrorCode {
1397
1402
  /**
1398
1403
  * 30012
1399
1404
  * PING 失败
1400
- * @solution 本地网络问题导致ping失败,SDK 会进入重连逻辑
1405
+ * @solution 本地网络问题导致 ping 失败,SDK 会进入重连逻辑
1401
1406
  * @since 5.2.0
1402
1407
  */
1403
1408
  RC_PING_EXCEED_LIMIT = 30012,
@@ -1446,7 +1451,7 @@ declare enum ErrorCode {
1446
1451
  RC_TCP_DISCONNECTED_NO_RMTP = 30021,
1447
1452
  /**
1448
1453
  * 31000
1449
- * 连接ACK超时
1454
+ * 连接 ACK 超时
1450
1455
  * @solution 网络问题,SDK 会进行重连
1451
1456
  * @since 5.2.0
1452
1457
  */
@@ -1459,7 +1464,7 @@ declare enum ErrorCode {
1459
1464
  RC_CONN_PROTO_VERSION_ERROR = 31001,
1460
1465
  /**
1461
1466
  * 31002
1462
- * 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk版本}。 其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识, 移动/电信/联通}
1467
+ * 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk 版本}。其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识,移动/电信/联通}
1463
1468
  * @solution 一般是 appkey 错误导致,建议在融云的开发者后台中确认一下当前应用的 appkey 标识是否正确
1464
1469
  * @since 5.2.0
1465
1470
  */
@@ -1534,7 +1539,7 @@ declare enum ErrorCode {
1534
1539
  RC_CONN_TOKEN_EXPIRED = 31020,
1535
1540
  /**
1536
1541
  * 31021
1537
- * Token 中携带 deviceId 时,检测 Token 中deviceId 与链接设备 deviceId 不一致
1542
+ * Token 中携带 deviceId 时,检测 Token 中 deviceId 与链接设备 deviceId 不一致
1538
1543
  * @since 5.7.0
1539
1544
  */
1540
1545
  RC_CONN_DEVICE_ERROR = 31021,
@@ -1564,13 +1569,13 @@ declare enum ErrorCode {
1564
1569
  RC_CONN_WRONG_CLUSTER = 31025,
1565
1570
  /**
1566
1571
  * 31026
1567
- * 开启AppServer联合鉴权功能后,到AppServer认证失败
1572
+ * 开启 AppServer 联合鉴权功能后,到 AppServer 认证失败
1568
1573
  * @since 5.2.0
1569
1574
  */
1570
1575
  RC_APP_AUTH_NOT_PASS = 31026,
1571
1576
  /**
1572
1577
  * 31027
1573
- * 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
1578
+ * 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
1574
1579
  * @since 5.2.0
1575
1580
  */
1576
1581
  RC_OTP_USED = 31027,
@@ -1623,13 +1628,13 @@ declare enum ErrorCode {
1623
1628
  CONNECTION_REFUSED = 32061,
1624
1629
  /**
1625
1630
  * 33000
1626
- * 将消息存储到本地数据时失败。 发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
1631
+ * 将消息存储到本地数据时失败。发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
1627
1632
  * @since 5.2.0
1628
1633
  */
1629
1634
  PROTOCOL_MESSAGE_SAVED_ERROR = 33000,
1630
1635
  /**
1631
1636
  * 33001
1632
- * 协议栈未初始化(可能原因:1,没有调用SDK初始化接口;2,SDK的so未正常加载)
1637
+ * 协议栈未初始化(可能原因:1,没有调用 SDK 初始化接口;2,SDK so 未正常加载)
1633
1638
  * @since 5.2.0
1634
1639
  */
1635
1640
  BIZ_ERROR_CLIENT_NOT_INIT = 33001,
@@ -1729,7 +1734,7 @@ declare enum ErrorCode {
1729
1734
  MESSAGE_EXPANDED_ERROR = 34009,
1730
1735
  /**
1731
1736
  * 34010
1732
- * 消息扩展大小超出限制, 默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
1737
+ * 消息扩展大小超出限制,默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
1733
1738
  * @since 5.2.0
1734
1739
  */
1735
1740
  EXPANSION_LIMIT_EXCEET = 34010,
@@ -1804,7 +1809,7 @@ declare enum ErrorCode {
1804
1809
  INVALID_PARAMETER_TIMESTAMP = 34202,
1805
1810
  /**
1806
1811
  * 34203
1807
- * 开发者接口调用时传入的 uid (服务器消息唯一 id)非法
1812
+ * 开发者接口调用时传入的 uid (服务器消息唯一 id) 非法
1808
1813
  */
1809
1814
  INVALID_PARAMETER_MESSAGE_UID = 34203,
1810
1815
  /**
@@ -1879,7 +1884,7 @@ declare enum ErrorCode {
1879
1884
  INVALID_PARAMETER_TIMESTRING = 34224,
1880
1885
  /**
1881
1886
  * 34225
1882
- * RCConversationIdentifier 参数非法。 可能原因:开发者调用接口传入的 RCConversationIdentifier 参数类型不对或者参数为空
1887
+ * RCConversationIdentifier 参数非法。可能原因:开发者调用接口传入的 RCConversationIdentifier 参数类型不对或者参数为空
1883
1888
  * @solution conversation is not valid
1884
1889
  * @since 5.9.9
1885
1890
  */
@@ -1967,7 +1972,7 @@ declare enum ErrorCode {
1967
1972
  INVALID_PARAMETER_KEY = 34260,
1968
1973
  /**
1969
1974
  * 34261
1970
- * 参数keys 非法
1975
+ * 参数 keys 非法
1971
1976
  */
1972
1977
  INVALID_PARAMETER_KEYS = 34261,
1973
1978
  /**
@@ -1993,14 +1998,14 @@ declare enum ErrorCode {
1993
1998
  /**
1994
1999
  * 34272
1995
2000
  * 参数 before 非法
1996
- * @solution beforeCount 无效,需要输入大于0 的正整数
2001
+ * @solution beforeCount 无效,需要输入大于 0 的正整数
1997
2002
  * @since 5.9.8
1998
2003
  */
1999
2004
  INVALID_PARAMETER_BEFORE = 34272,
2000
2005
  /**
2001
2006
  * 34273
2002
2007
  * 参数 after 非法
2003
- * @solution afterCount 输入无效,需要输入大于0 的正整数
2008
+ * @solution afterCount 输入无效,需要输入大于 0 的正整数
2004
2009
  * @since 5.9.8
2005
2010
  */
2006
2011
  INVALID_PARAMETER_AFTER = 34273,
@@ -2036,12 +2041,12 @@ declare enum ErrorCode {
2036
2041
  INVALID_PARAMETER_LIMIT = 34279,
2037
2042
  /**
2038
2043
  * 34280
2039
- * MessageDirection错误
2044
+ * MessageDirection 错误
2040
2045
  */
2041
2046
  INVALID_MESSAGE_DIRECTION = 34280,
2042
2047
  /**
2043
2048
  * 34281
2044
- * SentStatus错误
2049
+ * SentStatus 错误
2045
2050
  */
2046
2051
  INVALID_MESSAGE_SENT_STATUS = 34281,
2047
2052
  /**
@@ -2062,14 +2067,14 @@ declare enum ErrorCode {
2062
2067
  INVALID_PARAMETER_CONVERSATION_TYPE_LIST = 34284,
2063
2068
  /**
2064
2069
  * 34287
2065
- * 开发者调用接口传入的 ConversationIdentifier 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
2066
- * @solution 传入的 ConversationList 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
2070
+ * 开发者调用接口传入的 ConversationIdentifier 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
2071
+ * @solution 传入的 ConversationList 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
2067
2072
  * @since 5.9.9
2068
2073
  */
2069
2074
  INVALID_PARAMETER_CONVERSATION_LIST = 34287,
2070
2075
  /**
2071
2076
  * 34288
2072
- * 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
2077
+ * 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0 或超过限制、包含 null 或非法对象
2073
2078
  */
2074
2079
  INVALID_PARAMETER_CLEAR_MESSAGE_OPTION_LIST = 34288,
2075
2080
  /**
@@ -2086,12 +2091,12 @@ declare enum ErrorCode {
2086
2091
  INVALID_PARAMETER_END_MESSAGE_UID = 34290,
2087
2092
  /**
2088
2093
  * 34291
2089
- * 不支持V4已读回执功能
2094
+ * 不支持 V4 已读回执功能
2090
2095
  */
2091
2096
  READ_RECEIPT_V4_NOT_SUPPORT = 34291,
2092
2097
  /**
2093
2098
  * 34292
2094
- * 不支持更新v4已读回执信息
2099
+ * 不支持更新 v4 已读回执信息
2095
2100
  */
2096
2101
  READ_RECEIPT_V4_UPDATE_NOT_SUPPORT = 34292,
2097
2102
  /**
@@ -2133,7 +2138,7 @@ declare enum ErrorCode {
2133
2138
  INVALID_PARAMETER_SUBSCRIBE_TYPE = 34306,
2134
2139
  /**
2135
2140
  * 34307
2136
- * 订阅事件传入的订阅时长非法[60s ~ 30天]
2141
+ * 订阅事件传入的订阅时长非法 [60s ~ 30 天]
2137
2142
  */
2138
2143
  INVALID_PARAMETER_SUBSCRIBE_EXPIRY = 34307,
2139
2144
  /**
@@ -2144,7 +2149,7 @@ declare enum ErrorCode {
2144
2149
  /**
2145
2150
  * 34309
2146
2151
  * 订阅事件传入的分页大小非法
2147
- * @solution 订阅相关接口传入的分页大小非法[1~200]
2152
+ * @solution 订阅相关接口传入的分页大小非法 [1~200]
2148
2153
  */
2149
2154
  INVALID_PARAMETER_SUBSCRIBE_PAGESIZE = 34309,
2150
2155
  /**
@@ -2338,7 +2343,7 @@ declare enum ErrorCode {
2338
2343
  HOSTNAME_ERROR = 35009,
2339
2344
  /**
2340
2345
  * 35010
2341
- * 开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
2346
+ * 开启 `禁止把已在线客户端踢下线` 开关后,该错误码标识已有同类型端在线,禁止链接
2342
2347
  * @deprecated
2343
2348
  */
2344
2349
  HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
@@ -2395,7 +2400,7 @@ declare enum ErrorCode {
2395
2400
  INVALID_PARAMETER_DRAFT = 35028,
2396
2401
  /**
2397
2402
  * 35029
2398
- * 开发者调用时传入的 message 无效, message 应是对象或者 BaseMessage 的子类
2403
+ * 开发者调用时传入的 message 无效,message 应是对象或者 BaseMessage 的子类
2399
2404
  */
2400
2405
  INVALID_PARAMETER_MESSAGE = 35029,
2401
2406
  /**
@@ -2541,7 +2546,7 @@ declare enum ErrorCode {
2541
2546
  SEND_READ_RECEIPT_CONF_ERROR = 35056,
2542
2547
  /**
2543
2548
  * 36001
2544
- * 加入聊天室Id为空
2549
+ * 加入聊天室 Id 为空
2545
2550
  * @deprecated
2546
2551
  */
2547
2552
  CHATROOM_ID_ISNULL = 36001,
@@ -2625,7 +2630,7 @@ declare enum ErrorCode {
2625
2630
  STREAM_MESSAGE_SYNCED = 39007,
2626
2631
  /**
2627
2632
  * 41002
2628
- * 获取七牛token失败
2633
+ * 获取七牛 token 失败
2629
2634
  * @deprecated
2630
2635
  */
2631
2636
  QNTKN_GET_ERROR = 41002,
@@ -6107,33 +6112,6 @@ interface IGroupMessageDeliverStatus {
6107
6112
  list: IGroupMessageDeliveredStatusInfo[];
6108
6113
  }
6109
6114
 
6110
- /**
6111
- * 异步任务结果结构
6112
- * @description 该结构即将废弃,请使用 {@link RCResult} 替代
6113
- * @category Interface
6114
- */
6115
- declare type IAsyncRes<T = void> = Pick<RCResult<T>, 'code' | 'data'> & {
6116
- msg?: string;
6117
- };
6118
- /**
6119
- * 异步任务结果定义
6120
- * @description
6121
- * 通过 `Promise.resolve` 来处理预期内的异常,进而通过 Uncatch Promise Error 暴露预期外的异常
6122
- * @category Type
6123
- */
6124
- declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
6125
-
6126
- /**
6127
- * 拓展方法定义,便于 electron-solution 实现时保持接口类型推导可用
6128
- */
6129
- interface IExtraMethod {
6130
- getHistoryMessagesByObjectNames(conversationType: ConversationType, targetId: string, sentTime: number, count: number, objectNames: string[], desc: 0 | 1, tag: string): Promise<IAsyncRes<{
6131
- list: IReceivedMessage[];
6132
- hasMore: boolean;
6133
- }>>;
6134
- updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
6135
- }
6136
-
6137
6115
  interface IServerAddressData {
6138
6116
  addr: string;
6139
6117
  protocol: EConnectProtocol;
@@ -6492,6 +6470,22 @@ interface INaviInfo {
6492
6470
  };
6493
6471
  }
6494
6472
 
6473
+ /**
6474
+ * 异步任务结果结构
6475
+ * @description 该结构即将废弃,请使用 {@link RCResult} 替代
6476
+ * @category Interface
6477
+ */
6478
+ declare type IAsyncRes<T = void> = Pick<RCResult<T>, 'code' | 'data'> & {
6479
+ msg?: string;
6480
+ };
6481
+ /**
6482
+ * 异步任务结果定义
6483
+ * @description
6484
+ * 通过 `Promise.resolve` 来处理预期内的异常,进而通过 Uncatch Promise Error 暴露预期外的异常
6485
+ * @category Type
6486
+ */
6487
+ declare type IPromiseResult<T = void> = Promise<IAsyncRes<T>>;
6488
+
6495
6489
  /**
6496
6490
  * 用户信息
6497
6491
  * @since 5.10.1
@@ -7053,7 +7047,7 @@ interface IGroupApplicationInfo {
7053
7047
  */
7054
7048
  type: GroupApplicationType;
7055
7049
  /**
7056
- * 申请发起时间
7050
+ * 操作时间:时间戳精确到毫秒
7057
7051
  */
7058
7052
  operationTime: number;
7059
7053
  /**
@@ -7575,13 +7569,6 @@ interface IIPCMethods {
7575
7569
  * 连接时间
7576
7570
  */
7577
7571
  getConnectedTime(): number;
7578
- /**
7579
- * 调用非标准方法。所谓非标准方法,是为某些特定需求或产品添加,暂未作为标准接口添加至 API 层。
7580
- * 对于未实现的方法,接口响应 Unsupport 错误码
7581
- * @param method
7582
- * @param args
7583
- */
7584
- callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
7585
7572
  /**
7586
7573
  * 获取历史消息
7587
7574
  * @param conversationType
@@ -8018,7 +8005,7 @@ interface IIPCMethods {
8018
8005
  /**
8019
8006
  * 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
8020
8007
  */
8021
- updateMessageReceiptStatus(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): IPromiseResult<boolean>;
8008
+ updateMessageReceiptStatus(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<RCResult<boolean>>;
8022
8009
  /**
8023
8010
  * 删除时间戳前的未读数
8024
8011
  */
@@ -8034,7 +8021,7 @@ interface IIPCMethods {
8034
8021
  * 获取所有群聊会话 @ 消息未读数
8035
8022
  */
8036
8023
  getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
8037
- clearData(): Promise<IAsyncRes<boolean>>;
8024
+ clearLocalData(): Promise<RCResult<boolean>>;
8038
8025
  /**
8039
8026
  * 获取运行时的系统信息,仅限 Electron 平台可用
8040
8027
  */
@@ -8582,7 +8569,6 @@ declare type EnableLogL = LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR;
8582
8569
  declare type LogContent = string | number | boolean | null;
8583
8570
  declare type LogType = 'IM' | 'RTC';
8584
8571
  /**
8585
- * @hidden
8586
8572
  * 日志数据结构
8587
8573
  */
8588
8574
  interface ILogData {
@@ -8623,40 +8609,6 @@ interface ILogData {
8623
8609
  loggerId?: string;
8624
8610
  }
8625
8611
 
8626
- declare type LogReader = (startTime: number, endTime: number, level: LogL, realtimeReport: boolean, tableName?: string) => Promise<{
8627
- logs: ILogData[];
8628
- }>;
8629
- declare type LogWriter = (data: ILogData) => void;
8630
- /**
8631
- * @hidden
8632
- */
8633
- declare class LogDBProxy {
8634
- #private;
8635
- /**
8636
- * 仅供内部使用,谨慎调用
8637
- */
8638
- read(startTime: number, endTime: number, level: LogL, realtimeReport: boolean, tableName?: string): Promise<{
8639
- logs: ILogData[];
8640
- }>;
8641
- /**
8642
- * 仅供内部使用,谨慎调用
8643
- */
8644
- write(data: ILogData): void | Promise<void>;
8645
- /**
8646
- * 设置日志读取实现
8647
- */
8648
- setLogReader(reader: LogReader): this;
8649
- /**
8650
- * 设置日志写入实现
8651
- */
8652
- setLogWriter(writer: LogWriter): this;
8653
- }
8654
- /**
8655
- * @hidden
8656
- * 创建一个默认的日志代理
8657
- */
8658
- declare function createLogDBProxy(): LogDBProxy;
8659
-
8660
8612
  /**
8661
8613
  * Logger 抽象基类,定义日志采集接口与进程内打印,
8662
8614
  * 由子类继承实现入库逻辑
@@ -8665,12 +8617,15 @@ declare abstract class BasicLogger {
8665
8617
  protected readonly _appkey: string;
8666
8618
  protected readonly _id: string;
8667
8619
  protected readonly _type: LogType;
8668
- protected readonly logDB: LogDBProxy;
8669
8620
  /**
8670
8621
  * traceId 计数
8671
8622
  */
8672
8623
  private static _traceIdCount;
8673
- constructor(_appkey: string, _id: string, _type: LogType, logDB: LogDBProxy);
8624
+ constructor(_appkey: string, _id: string, _type: LogType);
8625
+ /**
8626
+ * 由子类继承实现日志入库
8627
+ */
8628
+ protected abstract _handleWrite(data: ILogData): void;
8674
8629
  protected _write(logData: ILogData): void;
8675
8630
  /**
8676
8631
  * 创建事务追踪 ID,全局唯一,便于跨进程、异步事务追踪,需要考虑多进程
@@ -8710,8 +8665,6 @@ declare abstract class BasicLogger {
8710
8665
  * 内部质量数据统计接口
8711
8666
  */
8712
8667
  record: (tag: string, content?: LogContent | undefined, traceId?: string | undefined) => void;
8713
- abstract getTimestamp4RealtimeLog(): number;
8714
- abstract setTimestamp4RealtimeLog(timestamp: number): void;
8715
8668
  }
8716
8669
 
8717
8670
  declare type ILogger = Pick<BasicLogger, 'createTraceId' | 'info' | 'warn' | 'error' | 'debug' | 'setOutputLevel'>;
@@ -9568,9 +9521,14 @@ interface IAPIContextOption {
9568
9521
  */
9569
9522
  eventLoopBlockingCheck?: boolean;
9570
9523
  /**
9571
- * 日志存储代理
9524
+ * 开启已读回执信息本地存储
9525
+ */
9526
+ enableReadReceiptStorage: boolean;
9527
+ /**
9528
+ * 启动导航服务 V2,默认关闭,仅私有云有效
9529
+ * @since 5.22.0
9572
9530
  */
9573
- loggerProxy?: LogDBProxy;
9531
+ useNaviV2?: boolean;
9574
9532
  }
9575
9533
  interface IConnectResult {
9576
9534
  /**
@@ -10284,13 +10242,6 @@ declare class APIContext {
10284
10242
  * 根据超级群的 targetId 数组,获取每个超级群下所有频道会话信息
10285
10243
  */
10286
10244
  getUltraGroupUnreadInfoList(targetIds: string[]): Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>;
10287
- /**
10288
- * 调用非标准方法。所谓非标准方法,是为某些特定需求或产品添加,暂未作为标准接口添加至 API 层。
10289
- * 对于未实现的方法,接口响应 Unsupport 错误码
10290
- * @param method 方法名
10291
- * @param args
10292
- */
10293
- callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
10294
10245
  /**
10295
10246
  * 获取运行时的系统信息,仅限 Electron 平台可用
10296
10247
  */
@@ -10413,7 +10364,7 @@ declare class APIContext {
10413
10364
  /**
10414
10365
  * 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
10415
10366
  */
10416
- setMessageStatusToRead(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
10367
+ setMessageStatusToRead(conversation: IConversationOption, timestamp: number): Promise<RCResult<boolean>>;
10417
10368
  /**
10418
10369
  * 设置当前用户在线状态
10419
10370
  * @deprecated 老版 V2 中用到
@@ -10476,7 +10427,7 @@ declare class APIContext {
10476
10427
  list: IReceivedMessage[];
10477
10428
  hasMore: boolean;
10478
10429
  }>>;
10479
- clearData(): Promise<IAsyncRes<boolean>>;
10430
+ clearLocalData(): Promise<RCResult<boolean>>;
10480
10431
  createLogger(id: string, type: LogType): BasicLogger;
10481
10432
  getConversations(conversationList: IConversationOption[]): Promise<IAsyncRes<IReceivedConversation[]>>;
10482
10433
  /**
@@ -10831,13 +10782,6 @@ declare abstract class BasicEngine {
10831
10782
  * 获取 engine 包内部 logger 工具
10832
10783
  */
10833
10784
  getInnerLogger(): BasicLogger;
10834
- /**
10835
- * 调用非标准方法。所谓非标准方法,是为某些特定需求或产品添加,暂未作为标准接口添加至 API 层。
10836
- * 对于未实现的方法,接口响应 Unsupport 错误码
10837
- * @param method
10838
- * @param args
10839
- */
10840
- abstract callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
10841
10785
  /**
10842
10786
  * 建立连接
10843
10787
  * @param token
@@ -11384,7 +11328,7 @@ declare abstract class BasicEngine {
11384
11328
  /**
11385
11329
  * 将自己发送的指定时间之前的消息标记对方已读,状态值为 SentStatus.READ
11386
11330
  */
11387
- abstract updateMessageReceiptStatus(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): IPromiseResult<boolean>;
11331
+ abstract updateMessageReceiptStatus(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<RCResult<boolean>>;
11388
11332
  /**
11389
11333
  * 删除时间戳前的未读数
11390
11334
  */
@@ -11428,7 +11372,7 @@ declare abstract class BasicEngine {
11428
11372
  * 获取所有群聊会话 @ 消息未读数
11429
11373
  */
11430
11374
  abstract getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
11431
- abstract clearData(): Promise<IAsyncRes<boolean>>;
11375
+ abstract clearLocalData(): Promise<RCResult<boolean>>;
11432
11376
  /**
11433
11377
  * 超级群获取指定会话未读 @ 消息列表
11434
11378
  */
@@ -11951,4 +11895,4 @@ declare class AppStorage {
11951
11895
  }): void;
11952
11896
  }
11953
11897
 
11954
- 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, LogDBProxy, 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, createLogDBProxy, 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 };
11898
+ 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, 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 };