@rongcloud/engine 5.9.7 → 5.9.8-enterprise-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -814,1002 +814,1426 @@ declare enum FileType {
814
814
  */
815
815
  declare enum ErrorCode {
816
816
  /**
817
- * 未知错误
818
- */
819
- TIMEOUT = -1,
820
- /**
817
+ * 0
821
818
  * 成功
822
819
  */
823
820
  SUCCESS = 0,
824
821
  /**
822
+ * 2
825
823
  * 主动断开连接
826
824
  */
827
825
  ACTIVE_DISCONNECT = 2,
828
826
  /**
827
+ * 405
829
828
  * 已被对方加入黑名单,消息发送失败
830
829
  */
831
830
  REJECTED_BY_BLACKLIST = 405,
832
831
  /**
832
+ * 20106
833
833
  * 在单聊中已被禁言
834
834
  * @since 5.9.4
835
835
  */
836
836
  FORBIDDEN_IN_PRIVATE = 20106,
837
837
  /**
838
+ * 20109
838
839
  * 系统会话不支持发送该消息
839
840
  * @since 5.8.2
840
841
  */
841
842
  SYS_CONVERSATION_NOT_SUPPORT_MESSAGE = 20109,
842
843
  /**
843
- * 服务端未知错误
844
- */
845
- RC_SERVER_UNKOWN_ERROR = 25104,
846
- /**
847
- * 未开通已读 V4
844
+ * 20512
845
+ * appkey的数据中心与请求云控的数据中心不匹配
846
+ * @since 5.8.5
848
847
  */
849
- RC_READ_RECEIPT_V4_INVALID = 26005,
850
- /**
851
- * 未开通会话驱动
852
- */
853
- RC_SERVER_DRIVE_UNREAD_COUNT_INVALID = 26006,
854
- /**
855
- * 消息 UID 传反
856
- */
857
- RC_SERVER_PARAMETER_MESSAGEUIDS_CONFUSED = 26007,
858
- /**
859
- * 会话 UID 不合法
860
- */
861
- RC_SERVER_PARAMETER_MESSAGEUID_INVALID = 26009,
862
- /**
863
- * 参数错误
864
- */
865
- RC_SERVER_PARAMETER_INVALID = 26010,
848
+ CLOUD_DATA_CENTER_INVALID = 20512,
866
849
  /**
850
+ * 20604
867
851
  * 发送消息频率过高,1 秒钟最多只允许发送 5 条消息
868
852
  */
869
853
  SEND_FREQUENCY_TOO_FAST = 20604,
870
854
  /**
855
+ * 20605
871
856
  * 操作被禁止,此错误码已被弃用
872
857
  */
873
858
  OPERATION_BLOCKED = 20605,
874
859
  /**
860
+ * 20606
875
861
  * 操作不支持,仅私有云有效,服务端禁用了该操作
876
862
  */
877
863
  OPERATION_NOT_SUPPORT = 20606,
878
864
  /**
865
+ * 20607
879
866
  * 请求超出了调用频率限制,请稍后再试
880
867
  */
881
868
  REQUEST_OVER_FREQUENCY = 20607,
882
869
  /**
870
+ * 21406
883
871
  * 不在讨论组
884
872
  */
885
873
  NOT_IN_DISCUSSION = 21406,
886
874
  /**
875
+ * 21501
887
876
  * 发送的消息中包含敏感词 (发送方发送失败,接收方不会收到消息)
888
877
  */
889
878
  SENSITIVE_SHIELD = 21501,
890
879
  /**
880
+ * 21502
891
881
  * 消息中敏感词已经被替换 (接收方可以收到被替换之后的消息)
892
882
  */
893
883
  SENSITIVE_REPLACE = 21502,
894
884
  /**
885
+ * 22201
895
886
  * 超级群扩展消息,但是原始消息不存在。
896
887
  */
897
888
  MESSAGE_EXPAND_NOT_EXIST = 22201,
898
889
  /**
890
+ * 22202
899
891
  * 超级群扩展消息,但是原始消息不支持扩展
900
892
  */
901
893
  MESSAGE_EXPAND_NOT_SUPPORT = 22202,
902
894
  /**
895
+ * 22203
903
896
  * 超级群扩展消息,扩展内容格式错误
904
897
  */
905
898
  MESSAGE_EXPAND_FORMAT_ERROR = 22203,
906
899
  /**
900
+ * 22204
907
901
  * 超级群扩展消息,无操作权限
908
902
  */
909
903
  MESSAGE_EXPAND_NOT_AUTHORIZED = 22204,
910
904
  /**
905
+ * 22406
911
906
  * 不在该群组中
912
907
  */
913
908
  NOT_IN_GROUP = 22406,
914
909
  /**
910
+ * 22408
915
911
  * 在群组中已被禁言。
916
912
  */
917
913
  FORBIDDEN_IN_GROUP = 22408,
918
914
  /**
915
+ * 23406
919
916
  * 不在该聊天室中。
920
917
  */
921
918
  NOT_IN_CHATROOM = 23406,
922
919
  /**
920
+ * 23407
923
921
  * 获取用户失败
924
922
  */
925
923
  GET_USERINFO_ERROR = 23407,
926
924
  /**
925
+ * 23408
927
926
  * 在该聊天室中已被禁言
928
927
  */
929
928
  FORBIDDEN_IN_CHATROOM = 23408,
930
929
  /**
930
+ * 23409
931
931
  * 已被踢出并禁止加入聊天室。被禁止的时间取决于服务端调用踢出接口时传入的时间。
932
932
  */
933
933
  RC_CHATROOM_USER_KICKED = 23409,
934
934
  /**
935
+ * 23410
935
936
  * 聊天室不存在
936
937
  */
937
938
  RC_CHATROOM_NOT_EXIST = 23410,
938
939
  /**
940
+ * 23411
939
941
  * 聊天室成员超限,开发者可以提交工单申请聊天室人数限制变更。
940
942
  */
941
943
  RC_CHATROOM_IS_FULL = 23411,
942
944
  /**
945
+ * 23412
943
946
  * 聊天室接口参数无效。请确认参数是否为空或者有效。
944
947
  */
945
948
  RC_CHATROOM_PATAMETER_INVALID = 23412,
946
949
  /**
950
+ * 23413
947
951
  * 查询聊天室历史消息异常
948
952
  */
949
953
  CHATROOM_GET_HISTORYMSG_ERROR = 23413,
950
954
  /**
955
+ * 23414
951
956
  * 聊天室云存储业务未开通
952
957
  */
953
958
  CHATROOM_NOT_OPEN_HISTORYMSG_STORE = 23414,
954
959
  /**
960
+ * 23423
955
961
  * 聊天室的 KV 属性个数超限,单个聊天室默认上限为 100 个
956
962
  */
957
963
  CHATROOM_KV_EXCEED = 23423,
958
964
  /**
965
+ * 23424
959
966
  * 没有权限修改聊天室中已存在的属性值
960
967
  */
961
968
  CHATROOM_KV_OVERWRITE_INVALID = 23424,
962
969
  /**
970
+ * 23425
963
971
  * 超过聊天室中状态设置频率,1 个聊天室 1 秒钟最多设置和删除状态 100 次
964
972
  */
965
973
  CHATROOM_SET_PROPERTY_OVER_FREQUENCY = 23425,
966
974
  /**
975
+ * 23426
967
976
  * 聊天室属性自定义设置,您可以在开发者后台免费基础功能页面中开启该功能。
968
977
  */
969
978
  CHATROOM_KV_STORE_NOT_OPEN = 23426,
970
979
  /**
980
+ * 23427
971
981
  * 聊天室属性不存在
972
982
  */
973
983
  CHATROOM_KEY_NOT_EXIST = 23427,
974
984
  /**
985
+ * 23428
975
986
  * 聊天室批量设置或删除KV部分不成功
976
987
  */
977
988
  CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
978
989
  /**
990
+ * 23429
979
991
  * 聊天室批量设置或删除KV数量超限(最多一次10条)
980
992
  */
981
993
  CHATROOM_KV_STORE_OUT_LIMIT = 23429,
982
994
  /**
995
+ * 23431
983
996
  * 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
984
997
  * @since 5.3.0
985
998
  */
986
999
  CHATROOM_KV_SET_ERROR = 23431,
987
1000
  /**
1001
+ * 24001
1002
+ * 没有注册DeviveId 也就是用户没有登陆
1003
+ * @deprecated
1004
+ */
1005
+ HAVNODEVICEID = 24001,
1006
+ /**
1007
+ * 24002
1008
+ * device Id 已经存在
1009
+ * @deprecated
1010
+ */
1011
+ DEVICEIDISHAVE = 24002,
1012
+ /**
1013
+ * 24009
1014
+ * 没有对应的用户或 token
1015
+ * @deprecated
1016
+ */
1017
+ FEILD = 24009,
1018
+ /**
1019
+ * 24011
1020
+ * channleName 是空
1021
+ * @deprecated
1022
+ */
1023
+ NULLCHANNELNAME = 24011,
1024
+ /**
1025
+ * 24015
1026
+ * 服务器内部错误
1027
+ * @deprecated
1028
+ */
1029
+ INTERNALERRROR = 24015,
1030
+ /**
1031
+ * 24401
988
1032
  * 超级群功能未开通
989
1033
  */
990
1034
  ULTRA_GROUP_SERVICE_UNAVAILABLE = 24401,
991
1035
  /**
1036
+ * 24402
992
1037
  * 超级群服务异常
993
1038
  */
994
1039
  ULTRA_GROUP_SERVICE_ERROR = 24402,
995
1040
  /**
1041
+ * 24403
996
1042
  * 超级群参数错误
997
1043
  */
998
1044
  ULTRA_GROUP_PARAMETER_ERROR = 24403,
999
1045
  /**
1046
+ * 24404
1000
1047
  * 超级群未知异常
1001
1048
  */
1002
1049
  ULTRA_GROUP_UNKNOWN_ERROR = 24404,
1003
1050
  /**
1051
+ * 24406
1004
1052
  * 非超级群成员
1005
1053
  */
1006
1054
  NOT_IN_ULTRA_GROUP = 24406,
1007
1055
  /**
1056
+ * 24408
1008
1057
  * 超级群成员禁言
1009
1058
  */
1010
1059
  FORBIDDEN_IN_ULTRA_GROUP = 24408,
1011
1060
  /**
1061
+ * 24410
1012
1062
  * 超级群不存在
1013
1063
  */
1014
1064
  ULTRA_GROUP_NOT_EXIST = 24410,
1015
1065
  /**
1066
+ * 24411
1016
1067
  * 超级群成员超限制
1017
1068
  */
1018
1069
  ULTRA_GROUP_MEMBERS_OVERSIZE = 24411,
1019
1070
  /**
1071
+ * 24412
1020
1072
  * 用户加入超级群数量超限
1021
1073
  */
1022
1074
  ULTRA_GROUP_JOINED_OVERSIZE = 24412,
1023
1075
  /**
1076
+ * 24413
1024
1077
  * 创建超级群频道,频道数超限
1025
1078
  */
1026
1079
  ULTRA_GROUP_CHANNELS_OVERSIZE = 24413,
1027
1080
  /**
1081
+ * 24414
1028
1082
  * 超级群频道 ID 不存在
1029
1083
  */
1030
1084
  ULTRA_GROUP_CHANNEL_ID_NOT_EXIST = 24414,
1031
1085
  /**
1086
+ * 24415
1032
1087
  * 超级群频道发送消息超限:超级群下每个频道有消息发送频率限制,默认每秒 30 条 频道内每秒发送消息总量超过限制会收到该错误码,建议延时发送或重试发送
1033
1088
  */
1034
1089
  ULTRA_GROUP_MESSAGE_SENT_OVER_FREQUENCY = 24415,
1035
1090
  /**
1091
+ * 24416
1036
1092
  * 用户不在超级群私有频道中
1037
1093
  * @since 5.4.2
1038
1094
  */
1039
1095
  ULTRA_GROUP_USER_NOT_IN_PRIVATE_CHANNEL = 24416,
1040
1096
  /**
1097
+ * 25101
1041
1098
  * 撤回消息参数无效,请确认撤回消息参数是否正确的填写
1042
1099
  */
1043
1100
  RECALL_MESSAGE = 25101,
1044
1101
  /**
1102
+ * 25102
1045
1103
  * 未开通单群聊云存储服务
1046
1104
  */
1047
1105
  MESSAGE_STORAGE_SERVICE_UNAVAILABLE = 25102,
1048
1106
  /**
1107
+ * 25104
1108
+ * 未知异常
1109
+ * @solution server unknown error
1110
+ */
1111
+ RC_SERVER_UNKOWN_ERROR = 25104,
1112
+ /**
1113
+ * 25107
1049
1114
  * IMLib 撤回消息可以撤回自己发送的消息和别人发送的消息,IM 服务有开关,控制只可以撤回自己发送的消息,当服务该开关打开时,撤回别人的消息会报这个错误。
1050
1115
  */
1051
1116
  RECALL_MESSAGE_USER_INVALID = 25107,
1052
1117
  /**
1118
+ * 26001
1053
1119
  * 远程推送设置参数无效,请确认是否正确的填写了远程推送参数
1054
1120
  */
1055
1121
  PUSH_PARAMETER_INVALID = 26001,
1056
1122
  /**
1123
+ * 26002
1057
1124
  * 表示客户端版本号低,需要同步版本号,可以提交工单申请打开用户级别配置开关
1058
1125
  */
1059
1126
  USER_SETTING_SYNCED_ERROR = 26002,
1060
1127
  /**
1128
+ * 26004
1061
1129
  * 用户会话标签个数超限,最多支持添加 20 个标签
1062
1130
  */
1063
1131
  CONVERSATION_TAG_OVERSIZE = 26004,
1064
1132
  /**
1133
+ * 26005
1134
+ * 未开通v4已读回执
1135
+ */
1136
+ RC_READ_RECEIPT_V4_INVALID = 26005,
1137
+ /**
1138
+ * 26006
1139
+ * 未开通会话驱动
1140
+ */
1141
+ RC_SERVER_DRIVE_UNREAD_COUNT_INVALID = 26006,
1142
+ /**
1143
+ * 26007
1144
+ * 消息 id 顺序错误
1145
+ */
1146
+ RC_SERVER_PARAMETER_MESSAGEUIDS_CONFUSED = 26007,
1147
+ /**
1148
+ * 26009
1149
+ * 消息id不合法
1150
+ */
1151
+ RC_SERVER_PARAMETER_MESSAGEUID_INVALID = 26009,
1152
+ /**
1153
+ * 26010
1154
+ * 参数有误
1155
+ */
1156
+ RC_SERVER_PARAMETER_INVALID = 26010,
1157
+ /**
1158
+ * 26020
1159
+ * 未开启在线状态订阅功能
1160
+ */
1161
+ RC_SUBSCRIBE_ONLINE_SERVICE_UNAVAILABLE = 26020,
1162
+ /**
1163
+ * 26021
1164
+ * 用户被订阅量达到上限, 详细查看开发文档。
1165
+ */
1166
+ RC_BESUBSCRIBED_USERIDS_COUNT_EXCEED_LIMIT = 26021,
1167
+ /**
1168
+ * 26022
1169
+ * 订阅用户数达到上限, 详细查看开发文档。
1170
+ */
1171
+ RC_SUBSCRIBED_USERIDS_EXCEED_LIMIT = 26022,
1172
+ /**
1173
+ * 30001
1065
1174
  * 当前连接已经被释放
1066
1175
  * @solution 表明当前 socket 已经释放,需要重新建立连接
1067
1176
  * @since 5.2.0
1068
1177
  */
1069
1178
  RC_NET_CHANNEL_INVALID = 30001,
1070
1179
  /**
1180
+ * 30002
1071
1181
  * 当前连接不可用
1072
1182
  * @solution 建议链接成功后再调用其他 api
1073
1183
  * @since 5.2.0
1074
1184
  */
1075
1185
  RC_NET_UNAVAILABLE = 30002,
1076
1186
  /**
1187
+ * 30003
1077
1188
  * 客户端发送消息请求,融云服务端响应超时
1078
1189
  * @since 5.2.0
1079
1190
  */
1080
1191
  RC_MSG_RESP_TIMEOUT = 30003,
1081
1192
  /**
1193
+ * 30004
1082
1194
  * 导航操作时,Http 请求失败
1083
1195
  * @since 5.2.0
1084
1196
  */
1085
1197
  RC_HTTP_SEND_FAIL = 30004,
1086
1198
  /**
1199
+ * 30005
1087
1200
  * 请求连接导航地址失败
1088
1201
  * @solution http 请求失败,建议本地使用 ping 或者 telnet 检查一下地址是否能正常访问
1089
1202
  * @since 5.2.0
1090
1203
  */
1091
1204
  RC_HTTP_REQ_FAIL = 30005,
1092
1205
  /**
1206
+ * 30006
1093
1207
  * 导航操作时,HTTP 接收失败
1094
1208
  * @since 5.2.0
1095
1209
  */
1096
1210
  RC_HTTP_RECV_FAIL = 30006,
1097
1211
  /**
1212
+ * 30007
1098
1213
  * 导航返回结果异常
1099
1214
  * @since 5.2.0
1100
1215
  */
1101
1216
  RC_NAVI_REQ_FAILED = 30007,
1102
1217
  /**
1218
+ * 30008
1103
1219
  * 导航 HTTP 返回数据格式错误
1104
1220
  * @since 5.2.0
1105
1221
  */
1106
1222
  RC_NODE_NOT_FOUND = 30008,
1107
1223
  /**
1224
+ * 30009
1108
1225
  * 导航数据解析后,其中不存在有效 IP 地址
1109
1226
  * @since 5.2.0
1110
1227
  */
1111
1228
  RC_DOMAIN_NOT_RESOLVE = 30009,
1112
1229
  /**
1230
+ * 30010
1113
1231
  * 创建连接失败
1114
1232
  * @solution 一般是本地网络导致连接不成功,建议更换网络重新尝试连接
1115
1233
  * @since 5.2.0
1116
1234
  */
1117
1235
  RC_SOCKET_NOT_CREATED = 30010,
1118
1236
  /**
1237
+ * 30011
1119
1238
  * 链接断开
1120
1239
  * @solution 连接断开,SDK 会进行重连
1121
1240
  * @since 5.2.0
1122
1241
  */
1123
1242
  RC_SOCKET_DISCONNECTED = 30011,
1124
1243
  /**
1244
+ * 30012
1125
1245
  * PING 失败
1126
1246
  * @solution 本地网络问题导致ping失败,SDK 会进入重连逻辑
1127
1247
  * @since 5.2.0
1128
1248
  */
1129
1249
  RC_PING_EXCEED_LIMIT = 30012,
1130
1250
  /**
1251
+ * 30013
1131
1252
  * PING 超时
1132
1253
  * @since 5.7.0
1133
1254
  */
1134
1255
  PONG_RECEIVED_ERROR = 30013,
1135
1256
  /**
1257
+ * 30014
1136
1258
  * 信令发送失败
1137
1259
  * @since 5.2.0
1138
1260
  */
1139
1261
  RC_MSG_SEND_FAIL = 30014,
1140
1262
  /**
1263
+ * 30015
1141
1264
  * 连接过于频繁
1142
1265
  */
1143
1266
  CONNECT_OVER_FREQUENCY = 30015,
1144
1267
  /**
1268
+ * 30016
1145
1269
  * 消息大小超限,消息体(序列化成 json 格式之后的内容)最大 128k bytes
1146
1270
  * @solution 建议检查发送的消息内容,防止超过消息体大小限制
1147
1271
  * @since 5.2.0
1148
1272
  */
1149
1273
  RC_MSG_CONTENT_EXCEED_LIMIT = 30016,
1150
1274
  /**
1275
+ * 30019
1151
1276
  * 网络连接不可用
1152
1277
  * @solution 网络问题,SDK 会进行重连
1153
1278
  * @since 5.7.9
1154
1279
  */
1155
1280
  RC_NETWORK_DOWN = 30019,
1156
1281
  /**
1282
+ * 30021
1157
1283
  * tcp 连接成功,rmtp 连接失败
1158
1284
  * @since 5.7.9
1159
1285
  */
1160
1286
  RC_TCP_DISCONNECTED_NO_RMTP = 30021,
1161
1287
  /**
1288
+ * 31000
1162
1289
  * 连接ACK超时
1163
1290
  * @solution 网络问题,SDK 会进行重连
1164
1291
  * @since 5.2.0
1165
1292
  */
1166
1293
  RC_CONN_ACK_TIMEOUT = 31000,
1167
1294
  /**
1295
+ * 31001
1168
1296
  * 信令版本错误
1169
1297
  * @since 5.2.0
1170
1298
  */
1171
1299
  RC_CONN_PROTO_VERSION_ERROR = 31001,
1172
1300
  /**
1301
+ * 31002
1173
1302
  * 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk版本}。 其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识, 移动/电信/联通}
1174
1303
  * @solution 一般是 appkey 错误导致,建议在融云的开发者后台中确认一下当前应用的 appkey 标识是否正确
1175
1304
  * @since 5.2.0
1176
1305
  */
1177
1306
  RC_CONN_IDENTIFIER_REJECTED = 31002,
1178
1307
  /**
1308
+ * 31003
1179
1309
  * 连接服务未开通,需要排查后台小程序(或桌面端)服务是否已开通
1180
1310
  * @solution 建议到开发者后台 - 服务管理开通对应业务服务
1181
1311
  * @since 5.2.0
1182
1312
  */
1183
1313
  RC_CONN_SERVER_UNAVAILABLE = 31003,
1184
1314
  /**
1315
+ * 31004
1185
1316
  * Token 无效;AppKey 和 Token 不匹配;Token 过期
1186
1317
  * @solution 建议确认从服务获取 token 时传入的 appkey 与客户端初始化使用的 appkey 是否为同一个
1187
1318
  * @since 5.2.0
1188
1319
  */
1189
1320
  RC_CONN_TOKEN_INCORRECT = 31004,
1190
1321
  /**
1322
+ * 31005
1191
1323
  * App 校验未通过(开通了 App 校验功能,但是校验未通过)
1192
1324
  * @since 5.2.0
1193
1325
  */
1194
1326
  RC_CONN_NOT_AUTHRORIZED = 31005,
1195
1327
  /**
1328
+ * 31006
1196
1329
  * 连接重定向
1197
1330
  * @since 5.2.0
1198
1331
  */
1199
1332
  RC_CONN_REDIRECTED = 31006,
1200
1333
  /**
1334
+ * 31007
1201
1335
  * 包名与后台注册信息不匹配
1202
1336
  * @since 5.2.0
1203
1337
  */
1204
1338
  RC_CONN_PACKAGE_NAME_INVALID = 31007,
1205
1339
  /**
1340
+ * 31008
1206
1341
  * AppKey 被封禁或已删除
1207
1342
  * @since 5.2.0
1208
1343
  */
1209
1344
  RC_CONN_APP_BLOCKED_OR_DELETED = 31008,
1210
1345
  /**
1346
+ * 31009
1211
1347
  * 连接失败,用户被封禁(客户端主动连接失败返回)
1212
1348
  * @since 5.2.0
1213
1349
  */
1214
1350
  RC_CONN_USER_BLOCKED = 31009,
1215
1351
  /**
1352
+ * 31010
1216
1353
  * 用户被踢下线
1217
1354
  * @since 5.2.0
1218
1355
  */
1219
1356
  RC_DISCONN_KICK = 31010,
1220
1357
  /**
1358
+ * 31011
1221
1359
  * 用户被封禁,导致 IM 连接被动断开
1222
1360
  * @since 5.2.0
1223
1361
  */
1224
1362
  RC_DISCONN_EXCEPTION = 31011,
1225
1363
  /**
1364
+ * 31012
1226
1365
  * 链路加密认证失败
1227
1366
  * @since 5.2.0
1228
1367
  */
1229
1368
  CONNECTION_ENCRYPT_AUTHORIZED_ERROR = 31012,
1230
1369
  /**
1370
+ * 31020
1231
1371
  * Token 已过期
1232
1372
  * @since 5.7.0
1233
1373
  */
1234
1374
  RC_CONN_TOKEN_EXPIRED = 31020,
1235
1375
  /**
1376
+ * 31021
1236
1377
  * Token 中携带 deviceId 时,检测 Token 中deviceId 与链接设备 deviceId 不一致
1237
1378
  * @since 5.7.0
1238
1379
  */
1239
1380
  RC_CONN_DEVICE_ERROR = 31021,
1240
1381
  /**
1382
+ * 31022
1241
1383
  * 页面域名不在安全域名白名单内,需通过开发者后台添加安全域名配置
1242
1384
  * @since 5.7.0
1243
1385
  */
1244
1386
  RC_CONN_HOSTNAME_ERROR = 31022,
1245
1387
  /**
1388
+ * 31023
1246
1389
  * 开启禁止把已在线客户端踢下线开关后,该错误码标识已有同类型端在线
1247
1390
  * @since 5.3.4
1248
1391
  */
1249
1392
  RC_DISCONN_SAME_CLIENT_ON_LINE = 31023,
1250
1393
  /**
1394
+ * 31024
1251
1395
  * 连接总数量超过服务设定的并发限定值(私有云专属)
1252
1396
  * @since 5.7.0
1253
1397
  */
1254
1398
  RC_LISCENSE_COUNT_OUT_OF_LIMIT = 31024,
1255
1399
  /**
1400
+ * 31025
1256
1401
  * 客户端连错环境,引发连接拒绝;如使用开发环境 Appkey 连接到生产环境
1257
1402
  * @since 5.7.0
1258
1403
  */
1259
1404
  RC_CONN_WRONG_CLUSTER = 31025,
1260
1405
  /**
1406
+ * 31026
1261
1407
  * 开启AppServer联合鉴权功能后,到AppServer认证失败
1262
1408
  * @since 5.2.0
1263
1409
  */
1264
1410
  RC_APP_AUTH_NOT_PASS = 31026,
1265
1411
  /**
1412
+ * 31027
1266
1413
  * 该 token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
1267
1414
  * @since 5.2.0
1268
1415
  */
1269
1416
  RC_OTP_USED = 31027,
1270
1417
  /**
1418
+ * 31028
1271
1419
  * Token 平台验证失败
1272
1420
  * @since 5.2.0
1273
1421
  */
1274
1422
  RC_PLATFORM_ERROR = 31028,
1275
1423
  /**
1424
+ * 31029
1276
1425
  * 用户已销户
1277
1426
  * @since 5.5.7
1278
1427
  */
1279
1428
  RC_ACCOUNT_CANCELLATION = 31029,
1280
1429
  /**
1430
+ * 31030
1281
1431
  * 私有云 License 检查不通过;APP License 过期
1282
1432
  * @since 5.5.1
1283
1433
  */
1284
1434
  RC_LICENSE_EXPIRED = 31030,
1285
1435
  /**
1436
+ * 32001
1286
1437
  * 协议层内部错误,查询,上传,下载过程中数据错误
1287
1438
  * @since 5.2.0
1288
1439
  */
1289
1440
  RC_QUERY_ACK_NO_DATA = 32001,
1290
1441
  /**
1442
+ * 32002
1291
1443
  * 协议层内部错误
1292
1444
  * @since 5.2.0
1293
1445
  */
1294
1446
  RC_MSG_DATA_INCOMPLETE = 32002,
1295
1447
  /**
1448
+ * 32011
1296
1449
  * 服务器主动断开连接(仅 quic 协议下触发)
1297
1450
  */
1298
1451
  RC_UDP_DISCONNECTED = 32011,
1299
1452
  /**
1453
+ * 32054
1300
1454
  * 链接被服务器中断,可能原因是运营商认为此链接非法或无效,直接断开 出现此错误码后,SDK 会自动触发重连,App 无需处理
1301
1455
  * @since 5.7.0
1302
1456
  */
1303
1457
  RC_TCP_RESET = 32054,
1304
1458
  /**
1459
+ * 32061
1305
1460
  * 连接被拒绝
1306
1461
  * @since 5.2.0
1307
1462
  */
1308
1463
  CONNECTION_REFUSED = 32061,
1309
1464
  /**
1465
+ * 33000
1310
1466
  * 将消息存储到本地数据时失败。 发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
1311
1467
  * @since 5.2.0
1312
1468
  */
1313
1469
  PROTOCOL_MESSAGE_SAVED_ERROR = 33000,
1314
1470
  /**
1315
- * 协议栈未初始化
1471
+ * 33001
1472
+ * 协议栈未初始化(可能原因:1,没有调用SDK初始化接口;2,SDK的so未正常加载)
1316
1473
  * @since 5.2.0
1317
1474
  */
1318
1475
  BIZ_ERROR_CLIENT_NOT_INIT = 33001,
1319
1476
  /**
1477
+ * 33002
1320
1478
  * 数据库错误
1321
1479
  * @since 5.2.0
1322
1480
  */
1323
1481
  BIZ_ERROR_DATABASE_ERROR = 33002,
1324
1482
  /**
1483
+ * 33003
1325
1484
  * 开发者接口调用时传入的参数错误
1326
1485
  * @since 5.2.0
1327
1486
  */
1328
1487
  BIZ_ERROR_INVALID_PARAMETER = 33003,
1329
1488
  /**
1489
+ * 33004
1330
1490
  * 通道无效
1331
1491
  */
1332
1492
  BIZ_ERROR_NO_CHANNEL = 33004,
1333
1493
  /**
1494
+ * 33005
1334
1495
  * 重新连接成功
1335
1496
  */
1336
1497
  BIZ_ERROR_RECONNECT_SUCCESS = 33005,
1337
1498
  /**
1499
+ * 33006
1338
1500
  * 连接中,再调用 connect 被拒绝
1339
1501
  */
1340
1502
  BIZ_ERROR_CONNECTING = 33006,
1341
1503
  /**
1504
+ * 33007
1342
1505
  * 历史消息云存储业务未开通
1343
1506
  * @since 5.2.0
1344
1507
  */
1345
1508
  MSG_ROAMING_SERVICE_UNAVAILABLE = 33007,
1346
1509
  /**
1510
+ * 33008
1347
1511
  * 消息存入本地数据库失败
1348
1512
  * @since 5.2.0
1349
1513
  */
1350
1514
  MSG_INSERT_ERROR = 33008,
1351
1515
  /**
1516
+ * 33009
1352
1517
  * 聊天室被回收
1353
1518
  * @since 5.2.0
1354
1519
  */
1355
1520
  MSG_DEL_ERROR = 33009,
1356
1521
  /**
1522
+ * 33100
1357
1523
  * 标签不存在
1358
1524
  * @solution 建议用户使用 RongIMLib.addTag 先创建标签,再添加会话到标签中
1359
1525
  * @since 5.2.0
1360
1526
  */
1361
1527
  TAG_NOT_EXIST = 33100,
1362
1528
  /**
1529
+ * 33101
1363
1530
  * 标签已存在
1364
1531
  * @since 5.2.0
1365
1532
  */
1366
1533
  TAG_EXISTS = 33101,
1367
1534
  /**
1535
+ * 33102
1368
1536
  * 标签不在会话中
1369
1537
  * @since 5.2.0
1370
1538
  */
1371
1539
  NO_TAG_IN_CONVER = 33102,
1372
1540
  /**
1541
+ * 34001
1373
1542
  * 连接已存在
1374
1543
  * @since 5.2.0
1375
1544
  */
1376
1545
  RC_CONNECTION_EXIST = 34001,
1377
1546
  /**
1547
+ * 34005
1378
1548
  * 连接环境不正确
1379
1549
  * @since 5.2.0
1380
1550
  */
1381
1551
  PACKAGE_ENVIRONMENT_ERROR = 34005,
1382
1552
  /**
1553
+ * 34006
1383
1554
  * 连接超时
1384
1555
  * @since 5.2.0
1385
1556
  */
1386
1557
  CONNECTION_TIMEOUT = 34006,
1387
1558
  /**
1559
+ * 34008
1388
1560
  * 消息不能被扩展,只支持单群聊,其他类型消息会返回此错误,消息在发送时,Message 对象的属性 canIncludeExpansion 置为 true 才能进行扩展
1389
1561
  * @since 5.2.0
1390
1562
  */
1391
1563
  MESSAGE_KV_NOT_SUPPORT = 34008,
1392
1564
  /**
1565
+ * 34009
1393
1566
  * 消息扩展失败,一般是网络原因导致的,请确保网络状态良好,并且融云 SDK 连接正常
1394
1567
  * @since 5.2.0
1395
1568
  */
1396
1569
  MESSAGE_EXPANDED_ERROR = 34009,
1397
1570
  /**
1571
+ * 34010
1398
1572
  * 消息扩展大小超出限制, 默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
1399
1573
  * @since 5.2.0
1400
1574
  */
1401
1575
  EXPANSION_LIMIT_EXCEET = 34010,
1402
1576
  /**
1577
+ * 34011
1403
1578
  * 媒体消息媒体文件 http 上传失败
1404
1579
  * @since 5.2.0
1405
1580
  */
1406
1581
  UPLOAD_FAIL = 34011,
1407
1582
  /**
1583
+ * 34013
1408
1584
  * 标签中添加/删除的会话数量超限,最多支持添加/删除 1000 个会话
1409
1585
  * @since 5.2.0
1410
1586
  */
1411
1587
  CONVER_OUT_LIMIT_ERROR = 34013,
1412
1588
  /**
1589
+ * 34014
1413
1590
  * 群已读回执版本不支持
1414
1591
  * @since 5.2.0
1415
1592
  */
1416
1593
  READ_RECEIPT_ERROR = 34014,
1417
1594
  /**
1595
+ * 34016
1418
1596
  * 用户级别设置未开通
1419
1597
  * @since 5.2.0
1420
1598
  */
1421
1599
  PUSH_CONTENT_CONFIG_SERVICE_UNAVAILABLE = 34016,
1422
1600
  /**
1601
+ * 34017
1423
1602
  * 消息拦截器处理接口返回的消息为空
1424
1603
  * @since 5.2.0
1425
1604
  */
1426
1605
  MESSAGE_INTERCEPTION_PRODUCED_NULL_MESSAGE = 34017,
1427
1606
  /**
1607
+ * 34018
1608
+ * 媒体文件上传异常,媒体文件不存在或文件大小为 0
1609
+ */
1610
+ MEDIA_EXCEPTION = 34018,
1611
+ /**
1612
+ * 34021
1428
1613
  * 消息未被注册
1429
1614
  * @since 5.2.0
1430
1615
  */
1431
1616
  MESSAGE_NOT_REGISTERED = 34021,
1432
1617
  /**
1618
+ * 34022
1433
1619
  * 该接口不支持超级群会话
1434
1620
  * @since 5.2.0
1435
1621
  */
1436
1622
  METHOD_NOT_SUPPORT = 34022,
1437
1623
  /**
1624
+ * 34024
1438
1625
  * 超级群频道不存在
1439
1626
  * @since 5.2.0
1440
1627
  */
1441
1628
  ULTRA_GROUP_CHANNEL_NOT_EXIST = 34024,
1442
1629
  /**
1630
+ * 34025
1443
1631
  * 扩展消息失败,因为消息中的会话类别与接口支持的会话类别不一致
1444
1632
  * @since 5.2.0
1445
1633
  */
1446
1634
  INCONSISTENT_CONVERSATION_TYPE = 34025,
1447
1635
  /**
1636
+ * 34201
1448
1637
  * 开发者调用的接口不支持传入的会话类型
1449
1638
  */
1450
1639
  CONVERSATION_TYPE_NOT_SUPPORT = 34201,
1451
1640
  /**
1641
+ * 34202
1642
+ * 开发者接口调用时传入的时间戳非法
1643
+ */
1644
+ INVALID_PARAMETER_TIMESTAMP = 34202,
1645
+ /**
1646
+ * 34203
1647
+ * 开发者接口调用时传入的 uid (服务器消息唯一 id)非法
1648
+ */
1649
+ INVALID_PARAMETER_MESSAGE_UID = 34203,
1650
+ /**
1651
+ * 34204
1652
+ * 开发者接口调用时传入的 messageId 非法或者找不到对应的 Message
1653
+ */
1654
+ INVALID_PARAMETER_MESSAGE_ID = 34204,
1655
+ /**
1656
+ * 34205
1657
+ * 开发者接口调用时传入的 Message 非法,或者 MessageContent 非法
1658
+ */
1659
+ INVALID_PARAMETER_MESSAGE_CONTENT = 34205,
1660
+ /**
1661
+ * 34206
1452
1662
  * 开发者接口调用时传入的 messageList 非法
1453
1663
  */
1454
1664
  MSG_LIMIT_ERROR = 34206,
1455
1665
  /**
1666
+ * 34207
1667
+ * 开发者接口调用时传入的 mediaType 非法
1668
+ */
1669
+ INVALID_PARAMETER_MEDIA_TYPE = 34207,
1670
+ /**
1671
+ * 34209
1672
+ * 开发者接口调用时传入的 ConversationType 非法
1673
+ */
1674
+ INVALID_PARAMETER_CONVERSATION_TYPE = 34209,
1675
+ /**
1676
+ * 34210
1677
+ * 开发者接口调用时传入的 targetId 非法
1678
+ */
1679
+ INVALID_PARAMETER_TARGET_ID = 34210,
1680
+ /**
1681
+ * 34211
1682
+ * 开发者调用频道相关接口时传入的 channelId 非法
1683
+ */
1684
+ INVALID_PARAMETER_CHANNEL_ID = 34211,
1685
+ /**
1686
+ * 34212
1687
+ * 开发者接口调用时传入的 tagId 非法
1688
+ */
1689
+ INVALID_PARAMETER_TAG_ID = 34212,
1690
+ /**
1691
+ * 34213
1692
+ * 开发者接口调用时传入的 tagName 非法
1693
+ */
1694
+ INVALID_PARAMETER_TAG_NAME = 34213,
1695
+ /**
1696
+ * 34214
1697
+ * 开发者接口调用时传入的 userId 非法
1698
+ */
1699
+ INVALID_PARAMETER_USER_ID = 34214,
1700
+ /**
1701
+ * 34215
1702
+ * 开发者接口调用时传入的 userIdList 非法
1703
+ */
1704
+ INVALID_PARAMETER_USERIDLIST = 34215,
1705
+ /**
1706
+ * 34217
1707
+ * 开发者接口调用时传入的 downloadMediaFileName 非法
1708
+ */
1709
+ INVALID_PARAMETER_DOWNLOADMEDIAFILENAME = 34217,
1710
+ /**
1711
+ * 34220
1712
+ * 开发者接口调用时传入的 MessageExpansion 非法
1713
+ */
1714
+ INVALID_PARAMETER_MESSAGE_EXPANSION = 34220,
1715
+ /**
1716
+ * 34228
1717
+ * PushNotificationLevel 无效
1718
+ */
1719
+ INVALID_PARAMETER_NOTIFICATION_LEVEL = 34228,
1720
+ /**
1721
+ * 34229
1722
+ * 开发者调用接口传入的 messageIds 参数为 空或者数组长度为 0
1723
+ * @solution 开发者调用接口传入的 messageIds 参数非法
1724
+ */
1725
+ INVALID_PARAMETER_MESSAGE_ARRAY = 34229,
1726
+ /**
1727
+ * 34230
1728
+ * 开发者调用接口传入的 ReceivedStatus 参数为 null
1729
+ * @solution 开发者调用接口传入的 ReceivedStatus 参非法
1730
+ */
1731
+ INVALID_PARAMETER_RECEIVED_STATUS = 34230,
1732
+ /**
1733
+ * 34231
1734
+ * 无效的超级群频道类型
1735
+ */
1736
+ INVALID_PARAMETER_CHANNEL_TYPE = 34231,
1737
+ /**
1738
+ * 34232
1739
+ * 开发者接口调用时传入的 count 非法
1740
+ */
1741
+ INVALID_PARAMETER_COUNT = 34232,
1742
+ /**
1743
+ * 34235
1744
+ * 开发者调用接口传入的 mediaUrl 地址为空
1745
+ */
1746
+ INVALID_PARAMETER_MEDIA_URL = 34235,
1747
+ /**
1748
+ * 34238
1456
1749
  * 非法的代理配置,RongIMProxy 为空或者非法
1457
1750
  * @since 5.7.0
1458
1751
  */
1459
1752
  INVALID_PARAMETER_PROXY = 34238,
1460
1753
  /**
1754
+ * 34239
1461
1755
  * 开发者接口调用 testProxy 时传入的代理测试服务非法
1462
1756
  * @since 5.7.0
1463
1757
  */
1464
1758
  INVALID_PARAMETER_TESTHOST = 34239,
1465
1759
  /**
1760
+ * 34240
1466
1761
  * 开发者接口调用 testProxy 接口时无法联通
1467
1762
  * @since 5.7.0
1468
1763
  */
1469
1764
  INVALID_CONNECT_TESTHOST_FAILED = 34240,
1470
1765
  /**
1766
+ * 34242
1767
+ * 开发者调用接口传入的 conversations 参数为 null 或者 conversations 数组包含 null 对象
1768
+ */
1769
+ INVALID_PARAMETER_CONVERSATIONS = 34242,
1770
+ /**
1771
+ * 34244
1772
+ * 开发者调用接口传入的 Message.SentStatus 参数为 null
1773
+ */
1774
+ INVALID_PARAMETER_SENT_STATUS = 34244,
1775
+ /**
1776
+ * 34245
1471
1777
  * 设置的代理地址不可用
1472
1778
  */
1473
1779
  RC_CONN_PROXY_UNAVAILABLE = 34245,
1474
1780
  /**
1781
+ * 34259
1782
+ * 参数 rtcRoomID 非法
1783
+ */
1784
+ INVALID_PARAMETER_RTCROOMID = 34259,
1785
+ /**
1786
+ * 34260
1787
+ * 参数 key 非法
1788
+ */
1789
+ INVALID_PARAMETER_KEY = 34260,
1790
+ /**
1791
+ * 34261
1792
+ * 参数keys 非法
1793
+ */
1794
+ INVALID_PARAMETER_KEYS = 34261,
1795
+ /**
1796
+ * 34262
1797
+ * 参数 value 非法
1798
+ */
1799
+ INVALID_PARAMETER_VALUE = 34262,
1800
+ /**
1801
+ * 34263
1802
+ * 参数 entries 非法
1803
+ */
1804
+ INVALID_PARAMETER_ENTRIES = 34263,
1805
+ /**
1806
+ * 34264
1807
+ * 参数 notificationExtra 非法
1808
+ */
1809
+ INVALID_PARAMETER_NOTIFICATION_EXTRA = 34264,
1810
+ /**
1811
+ * 34271
1812
+ * 参数 objectName 非法
1813
+ */
1814
+ INVALID_PARAMETER_MESSAGE_OBJECT_NAME = 34271,
1815
+ /**
1816
+ * 34272
1817
+ * 参数 before 非法
1818
+ * @solution beforeCount 无效,需要输入大于0 的正整数
1819
+ * @since 5.9.8
1820
+ */
1821
+ INVALID_PARAMETER_BEFORE = 34272,
1822
+ /**
1823
+ * 34273
1824
+ * 参数 after 非法
1825
+ * @solution afterCount 输入无效,需要输入大于0 的正整数
1826
+ * @since 5.9.8
1827
+ */
1828
+ INVALID_PARAMETER_AFTER = 34273,
1829
+ /**
1830
+ * 34274
1831
+ * 参数 keyword 非法
1832
+ */
1833
+ INVALID_PARAMETER_KEYWORD = 34274,
1834
+ /**
1835
+ * 34275
1836
+ * 参数 objectName 列表非法
1837
+ */
1838
+ INVALID_PARAMETER_MESSAGE_OBJECT_NAME_LIST = 34275,
1839
+ /**
1840
+ * 34276
1841
+ * 参数 offset 非法
1842
+ */
1843
+ INVALID_PARAMETER_OFFSET = 34276,
1844
+ /**
1845
+ * 34277
1846
+ * 参数 start time 非法
1847
+ */
1848
+ INVALID_PARAMETER_START_TIME = 34277,
1849
+ /**
1850
+ * 34278
1851
+ * 参数 end time 非法
1852
+ */
1853
+ INVALID_PARAMETER_END_TIME = 34278,
1854
+ /**
1855
+ * 34279
1856
+ * 参数 limit 非法
1857
+ */
1858
+ INVALID_PARAMETER_LIMIT = 34279,
1859
+ /**
1860
+ * 34280
1861
+ * MessageDirection错误
1862
+ */
1863
+ INVALID_MESSAGE_DIRECTION = 34280,
1864
+ /**
1865
+ * 34281
1866
+ * SentStatus错误
1867
+ */
1868
+ INVALID_MESSAGE_SENT_STATUS = 34281,
1869
+ /**
1870
+ * 34282
1871
+ * 参数 target id 列表非法
1872
+ */
1873
+ INVALID_PARAMETER_TARGETID_LIST = 34282,
1874
+ /**
1875
+ * 34284
1876
+ * 参数 ConversationType 列表非法
1877
+ * @since 5.9.8
1878
+ */
1879
+ INVALID_PARAMETER_CONVERSATION_TYPE_LIST = 34284,
1880
+ /**
1881
+ * 34288
1882
+ * 开发者调用接口传入的 ClearMessageOption 数组参数为空、数组长度为 0或超过限制、包含 null 或非法对象
1883
+ */
1884
+ INVALID_PARAMETER_CLEAR_MESSAGE_OPTION_LIST = 34288,
1885
+ /**
1886
+ * 34289
1887
+ * 参数 startMessageUID 无效
1888
+ * @since 5.9.8
1889
+ */
1890
+ INVALID_PARAMETER_START_MESSAGE_UID = 34289,
1891
+ /**
1892
+ * 34290
1893
+ * 参数 endMessageUID 无效
1894
+ * @since 5.9.8
1895
+ */
1896
+ INVALID_PARAMETER_END_MESSAGE_UID = 34290,
1897
+ /**
1898
+ * 34291
1475
1899
  * 不支持V4已读回执功能
1476
- * @since 5.9.0
1477
- * @hidden
1478
1900
  */
1479
- READ_RECEIPT_V4_NOT_SUPPORT = 34292,
1901
+ READ_RECEIPT_V4_NOT_SUPPORT = 34291,
1480
1902
  /**
1903
+ * 34292
1481
1904
  * 不支持更新v4已读回执信息
1482
- * @since 5.9.0
1483
- * @hidden
1484
1905
  */
1485
- READ_RECEIPT_V4_UPDATE_NOT_SUPPORT = 34293,
1906
+ READ_RECEIPT_V4_UPDATE_NOT_SUPPORT = 34292,
1907
+ /**
1908
+ * 34296
1909
+ * 发送定向消息时,传入的会话类型不支持
1910
+ * @solution 发送定向消息时,传入的会话类型不支持
1911
+ * @since 5.9.8
1912
+ */
1913
+ RC_DIRECTIONAL_MESSAGE_INVALID_CONVERSATION_TYPE = 34296,
1486
1914
  /**
1915
+ * 34301
1487
1916
  * 数据库未初始化
1488
- * @since 5.9.6
1489
1917
  */
1490
1918
  RC_DB_NOT_INIT = 34301,
1491
1919
  /**
1920
+ * 34302
1492
1921
  * 数据库错误
1493
- * @since 5.9.6
1494
1922
  */
1495
1923
  RC_DB_CORRUPT = 34302,
1496
1924
  /**
1925
+ * 34303
1497
1926
  * 数据库 SQL 执行异常
1498
- * @since 5.9.6
1499
1927
  */
1500
1928
  RC_DB_SQL_ERROR = 34303,
1501
1929
  /**
1930
+ * 34304
1502
1931
  * 查询数据不存在
1503
- * @since 5.9.6
1504
1932
  */
1505
1933
  RC_DB_DATA_NOT_FOUND = 34304,
1506
1934
  /**
1935
+ * 34305
1507
1936
  * 网络数据解析失败
1508
- * @since 5.9.6
1509
1937
  */
1510
1938
  RC_NET_DATA_ERROR = 34305,
1511
1939
  /**
1512
- * 方法未支持
1940
+ * 34306
1941
+ * 订阅事件传入的订阅类型非法
1513
1942
  */
1514
- NOT_SUPPORT = 35004,
1943
+ INVALID_PARAMETER_SUBSCRIBE_TYPE = 34306,
1515
1944
  /**
1516
- * 主进程内方法错误
1945
+ * 34307
1946
+ * 订阅事件传入的订阅时长非法[60s ~ 30天]
1517
1947
  */
1518
- MAIN_PROCESS_ERROR = 35005,
1948
+ INVALID_PARAMETER_SUBSCRIBE_EXPIRY = 34307,
1519
1949
  /**
1520
- * 无可用的 IM 服务地址
1950
+ * 34308
1951
+ * 订阅事件传入的订阅用户列表空或者数据类型非法
1521
1952
  */
1522
- SERVER_UNAVAILABLE = 35008,
1953
+ INVALID_PARAMETER_SUBSCRIBE_PUBLISHER_USERIDS = 34308,
1523
1954
  /**
1524
- * IM 在初次连接成功后,需立即同步消息,标记上线,然后获取全量超级群会话列表,列表同步完成前,所有超级群相关功能接口应不可用
1955
+ * 34309
1956
+ * 订阅事件传入的分页大小非法
1957
+ * @solution 订阅相关接口传入的分页大小非法[1~200]
1525
1958
  */
1526
- METHOD_NOT_AVAILABLE = 35011,
1959
+ INVALID_PARAMETER_SUBSCRIBE_PAGESIZE = 34309,
1527
1960
  /**
1528
- * 保存草稿失败
1529
- */
1530
- DRAFT_SAVE_ERROR = 35015,
1531
- /**
1532
- * 删除草稿失败
1961
+ * 34310
1962
+ * 子进程意外终止,如果是已连接状态,SDK 会自动重连
1963
+ * @since 5.9.8
1533
1964
  */
1534
- DRAFT_REMOVE_ERROR = 35016,
1965
+ SUB_PROCESS_EXIT = 34310,
1535
1966
  /**
1536
- * 删除会话失败
1967
+ * 34311
1968
+ * addon 模块不存在
1969
+ * @since 5.9.8
1537
1970
  */
1538
- CONVER_REMOVE_ERROR = 35020,
1971
+ ADDON_NOT_EXIST = 34311,
1539
1972
  /**
1540
- * 获取会话失败
1541
- */
1542
- CONVER_GET_ERROR = 35021,
1543
- /**
1544
- * 搜索字段对应消息错误
1973
+ * 35001
1974
+ * 群组信息异常
1975
+ * @deprecated
1545
1976
  */
1546
- SEARCH_PROPS_LIMIT_ERROR = 35022,
1977
+ GROUP_SYNC_ERROR = 35001,
1547
1978
  /**
1548
- * 无效的数据中心请求, appkey 不是该数据中心的,需要重定向到正确的数据中心
1979
+ * 35002
1980
+ * 匹配群信息异常
1981
+ * @deprecated
1549
1982
  */
1550
- CLOUD_DATA_CENTER_INVALID = 20512,
1551
- /** ============================= 错误码 -- 废弃部分 ============================= */
1983
+ GROUP_MATCH_ERROR = 35002,
1552
1984
  /**
1553
- * 未知原因失败。
1554
- * @deprecated
1985
+ * 35004
1986
+ * 方法未支持
1555
1987
  */
1556
- UNKNOWN = -2,
1988
+ NOT_SUPPORT = 35004,
1557
1989
  /**
1558
- * 参数错误
1559
- * 该错误码已废弃, 请使用 ErrorCode.BIZ_ERROR_INVALID_PARAMETER
1560
- * @deprecated
1990
+ * 35005
1991
+ * 主进程内方法错误
1561
1992
  */
1562
- PARAMETER_ERROR = -3,
1993
+ MAIN_PROCESS_ERROR = 35005,
1563
1994
  /**
1564
- * 未实现的方法定义,在应用层调用 callExtra 传入无法识别的方法名时抛出
1565
- * 该错误已废弃, 请使用 ErrorCode.NOT_SUPPORT
1995
+ * 35007
1996
+ * 已连接或者内部重连中,不允许调用重连,需先调用 disconnect 方法
1566
1997
  * @deprecated
1567
1998
  */
1568
- EXTRA_METHOD_UNDEFINED = -4,
1999
+ CAN_NOT_RECONNECT = 35007,
1569
2000
  /**
1570
- * 参数变更
1571
- * @deprecated
2001
+ * 35008
2002
+ * 无可用的 IM 服务地址
1572
2003
  */
1573
- PARAMETER_CHANGED = -6,
2004
+ SERVER_UNAVAILABLE = 35008,
1574
2005
  /**
1575
- * 己方取消已发出的通话请求
2006
+ * 35009
2007
+ * Web 端设置安全域名后,连接端域名不在安全域名范围内
1576
2008
  * @deprecated
1577
2009
  */
1578
- CANCEL = 1,
2010
+ HOSTNAME_ERROR = 35009,
1579
2011
  /**
1580
- * 己方拒绝收到的通话请求
2012
+ * 35010
2013
+ * 开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
1581
2014
  * @deprecated
1582
2015
  */
1583
- REJECT = 2,
2016
+ HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
1584
2017
  /**
1585
- * 己方挂断
1586
- * @deprecated
2018
+ * 35011
2019
+ * IM 在初次连接成功后,需立即同步消息,标记上线,然后获取全量超级群会话列表,列表同步完成前,所有超级群相关功能接口应不可用
1587
2020
  */
1588
- HANGUP = 3,
2021
+ METHOD_NOT_AVAILABLE = 35011,
1589
2022
  /**
1590
- * 己方忙碌
2023
+ * 35014
2024
+ * 该功能仅支持超级群
1591
2025
  * @deprecated
1592
2026
  */
1593
- BUSYLINE = 4,
2027
+ METHOD_ONLY_SUPPORT_ULTRA_GROUP = 35014,
1594
2028
  /**
1595
- * 己方未接听
1596
- * @deprecated
2029
+ * 35015
2030
+ * 保存草稿失败
1597
2031
  */
1598
- NO_RESPONSE = 5,
2032
+ DRAFT_SAVE_ERROR = 35015,
1599
2033
  /**
1600
- * 己方不支持当前引擎
1601
- * @deprecated
2034
+ * 35016
2035
+ * 删除草稿失败
1602
2036
  */
1603
- ENGINE_UN_SUPPORTED = 6,
2037
+ DRAFT_REMOVE_ERROR = 35016,
1604
2038
  /**
1605
- * 己方网络出错
1606
- * @deprecated
2039
+ * 35020
2040
+ * 删除会话失败
1607
2041
  */
1608
- NETWORK_ERROR = 7,
2042
+ CONVER_REMOVE_ERROR = 35020,
1609
2043
  /**
1610
- * 对方取消已发出的通话请求
1611
- * @deprecated
2044
+ * 35021
2045
+ * 获取会话失败
1612
2046
  */
1613
- REMOTE_CANCEL = 11,
2047
+ CONVER_GET_ERROR = 35021,
1614
2048
  /**
1615
- * 对方拒绝收到的通话请求
1616
- * @deprecated
2049
+ * 35022
2050
+ * 搜索字段对应消息错误
1617
2051
  */
1618
- REMOTE_REJECT = 12,
2052
+ SEARCH_PROPS_LIMIT_ERROR = 35022,
1619
2053
  /**
1620
- * 通话过程对方挂断
1621
- * @deprecated
2054
+ * 35024
2055
+ * 开发者调用时传入的消息类型无效
1622
2056
  */
1623
- REMOTE_HANGUP = 13,
2057
+ INVALID_PARAMETER_MESSAGE_TYPE = 35024,
1624
2058
  /**
1625
- * 对方忙碌
1626
- * @deprecated
2059
+ * 35025
2060
+ * 开发者调用时传入的 order 无效
1627
2061
  */
1628
- REMOTE_BUSYLINE = 14,
2062
+ INVALID_PARAMETER_ORDER = 35025,
1629
2063
  /**
1630
- * 对方未接听
1631
- * @deprecated
2064
+ * 35028
2065
+ * 开发者调用时传入的 draft 无效
1632
2066
  */
1633
- REMOTE_NO_RESPONSE = 15,
2067
+ INVALID_PARAMETER_DRAFT = 35028,
1634
2068
  /**
1635
- * 对方不支持当前引擎
1636
- * @deprecated
2069
+ * 35029
2070
+ * 开发者调用时传入的 message 无效, message 应是对象或者 BaseMessage 的子类
1637
2071
  */
1638
- REMOTE_ENGINE_UN_SUPPORTED = 16,
2072
+ INVALID_PARAMETER_MESSAGE = 35029,
1639
2073
  /**
1640
- * 对方网络错误
1641
- * @deprecated
2074
+ * 35030
2075
+ * 开发者调用 sendMessage 时传入的 pushContent 无效
1642
2076
  */
1643
- REMOTE_NETWORK_ERROR = 17,
2077
+ INVALID_PARAMETER_PUSH_CONTENT = 35030,
1644
2078
  /**
1645
- * VoIP 不可用
1646
- * @deprecated
2079
+ * 35031
2080
+ * 开发者调用上传语法糖接口时传入的 sendOptions 无效
1647
2081
  */
1648
- VOIP_NOT_AVALIABLE = 18,
2082
+ INVALID_PARAMETER_SENDOPTIONS = 35031,
1649
2083
  /**
1650
- * 加入讨论失败
1651
- * @deprecated
2084
+ * 35032
2085
+ * 开发者调用上传语法糖接口时传入的 contentDisposition 无效
1652
2086
  */
1653
- JOIN_IN_DISCUSSION = 21407,
2087
+ INVALID_PARAMETER_CONTENT_DISPOSITION = 35032,
1654
2088
  /**
1655
- * 创建讨论组失败
1656
- * @deprecated
2089
+ * 35033
2090
+ * 获取文件时,参数 saveName 无效
1657
2091
  */
1658
- CREATE_DISCUSSION = 21408,
2092
+ INVALID_PARAMETER_SAVE_NAME = 35033,
1659
2093
  /**
1660
- * 设置讨论组邀请状态失败
1661
- * @deprecated
2094
+ * 35034
2095
+ * 获取文件时,参数 serverType 无效
1662
2096
  */
1663
- INVITE_DICUSSION = 21409,
2097
+ INVALID_PARAMETER_SERVER_TYPE = 35034,
1664
2098
  /**
1665
- * 没有注册DeviveId 也就是用户没有登陆
1666
- * @deprecated
2099
+ * 35035
2100
+ * 开发者调用时传入的 cleanSpace 无效
1667
2101
  */
1668
- HAVNODEVICEID = 24001,
2102
+ INVALID_PARAMETER_CLEAN_SPACE = 35035,
1669
2103
  /**
1670
- * 已经存在
1671
- * @deprecated
2104
+ * 35036
2105
+ * 开发者调用时传入的 canIncludeExpansion 无效
1672
2106
  */
1673
- DEVICEIDISHAVE = 24002,
2107
+ INVALID_PARAMETER_CAN_INCLUDE_EXPANSION = 35036,
1674
2108
  /**
1675
- * 没有对应的用户或token
1676
- * @deprecated
2109
+ * 35037
2110
+ * 开发者调用时传入的 disableNotification 无效
1677
2111
  */
1678
- FEILD = 24009,
2112
+ INVALID_PARAMETER_DISABLE_NOTIFICATION = 35037,
1679
2113
  /**
1680
- * voip为空
1681
- * @deprecated
2114
+ * 35038
2115
+ * 开发者调用时传入的 checkDuplicate 无效
1682
2116
  */
1683
- VOIPISNULL = 24013,
2117
+ INVALID_PARAMETER_CHECK_DUPLICATE = 35038,
1684
2118
  /**
1685
- * 不支持的Voip引擎
1686
- * @deprecated
2119
+ * 35039
2120
+ * 开发者调用时传入的 isAutoDelete 无效
1687
2121
  */
1688
- NOENGINETYPE = 24010,
2122
+ INVALID_PARAMETER_IS_AUTO_DELETE = 35039,
1689
2123
  /**
1690
- * channleName 是空
1691
- * @deprecated
2124
+ * 35040
2125
+ * 开发者调用时传入的 isSendNotification 无效
1692
2126
  */
1693
- NULLCHANNELNAME = 24011,
2127
+ INVALID_PARAMETER_IS_SEND_NOTIFICATION = 35040,
1694
2128
  /**
1695
- * 生成Voipkey失败
1696
- * @deprecated
2129
+ * 35041
2130
+ * 开发者调用时传入的 isForce 无效
1697
2131
  */
1698
- VOIPDYANMICERROR = 24012,
2132
+ INVALID_PARAMETER_IS_FORCE = 35041,
1699
2133
  /**
1700
- * 没有配置voip
1701
- * @deprecated
2134
+ * 35042
2135
+ * 开发者调用时传入的 isTop 无效
1702
2136
  */
1703
- NOVOIP = 24014,
2137
+ INVALID_PARAMETER_IS_TOP = 35042,
1704
2138
  /**
1705
- * 服务器内部错误
1706
- * @deprecated
2139
+ * 35043
2140
+ * 开发者调用时传入的 isUpdateTime 无效
1707
2141
  */
1708
- INTERNALERRROR = 24015,
2142
+ INVALID_PARAMETER_IS_UPDATE_TIME = 35043,
1709
2143
  /**
1710
- * VOIP close
1711
- * @deprecated
2144
+ * 35044
2145
+ * 开发者调用时传入的 containMuted 无效
1712
2146
  */
1713
- VOIPCLOSE = 24016,
2147
+ INVALID_PARAMETER_CONTAIN_MUTED = 35044,
1714
2148
  /**
1715
- * 群组信息异常
1716
- * @deprecated 没有使用
2149
+ * 35045
2150
+ * 开发者调用时传入的 isStatusMessage 无效
1717
2151
  */
1718
- GROUP_SYNC_ERROR = 35001,
2152
+ INVALID_PARAMETER_IS_STATUS_MESSAGE = 35045,
1719
2153
  /**
1720
- * 匹配群信息异常
1721
- * @deprecated 没有使用
2154
+ * 35046
2155
+ * 开发者调用时传入的 isMentioned 无效
1722
2156
  */
1723
- GROUP_MATCH_ERROR = 35002,
2157
+ INVALID_PARAMETER_IS_MENTIONED = 35046,
1724
2158
  /**
1725
- * 已连接或者内部重连中,不允许调用重连,需先调用 disconnect 方法
1726
- * @deprecated
2159
+ * 35047
2160
+ * 开发者调用时传入的 isVoipPush 无效
1727
2161
  */
1728
- CAN_NOT_RECONNECT = 35007,
2162
+ INVALID_PARAMETER_IS_VOIP_PUSH = 35047,
1729
2163
  /**
1730
- * Web 端设置安全域名后,连接端域名不在安全域名范围内
1731
- * @deprecated
2164
+ * 35048
2165
+ * 开发者调用时传入的 mentionedType 无效
1732
2166
  */
1733
- HOSTNAME_ERROR = 35009,
2167
+ INVALID_PARAMETER_MENTIONED_TYPE = 35048,
1734
2168
  /**
1735
- * 开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
1736
- * @deprecated
2169
+ * 35049
2170
+ * 开发者调用时传入的 pushConfig 无效
1737
2171
  */
1738
- HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
2172
+ INVALID_PARAMETER_PUSH_CONFIG = 35049,
1739
2173
  /**
1740
- * 该功能仅支持超级群
1741
- * 该错误码已废弃, 请使用 ErrorCode.CONVERSATION_TYPE_NOT_SUPPORT
1742
- * @deprecated
2174
+ * 35050
2175
+ * 开发者调用时传入的 pushData 无效
1743
2176
  */
1744
- METHOD_ONLY_SUPPORT_ULTRA_GROUP = 35014,
2177
+ INVALID_PARAMETER_PUSH_DATA = 35050,
1745
2178
  /**
2179
+ * 36001
1746
2180
  * 加入聊天室Id为空
1747
2181
  * @deprecated
1748
2182
  */
1749
2183
  CHATROOM_ID_ISNULL = 36001,
1750
2184
  /**
2185
+ * 36002
1751
2186
  * 加入聊天室失败
1752
2187
  * @deprecated
1753
2188
  */
1754
2189
  CHARTOOM_JOIN_ERROR = 36002,
1755
2190
  /**
2191
+ * 36003
1756
2192
  * 拉取聊天室历史消息失败
1757
2193
  * @deprecated
1758
2194
  */
1759
2195
  CHATROOM_HISMESSAGE_ERROR = 36003,
1760
2196
  /**
2197
+ * 36004
1761
2198
  * 聊天室 kv 未找到
1762
2199
  * @deprecated
1763
2200
  */
1764
2201
  CHATROOM_KV_NOT_FOUND = 36004,
1765
2202
  /**
2203
+ * 37001
1766
2204
  * 加入黑名单异常
1767
2205
  * @deprecated
1768
2206
  */
1769
2207
  BLACK_ADD_ERROR = 37001,
1770
2208
  /**
2209
+ * 37002
1771
2210
  * 获得指定人员再黑名单中的状态异常
1772
2211
  * @deprecated
1773
2212
  */
1774
2213
  BLACK_GETSTATUS_ERROR = 37002,
1775
2214
  /**
2215
+ * 37003
1776
2216
  * 移除黑名单异常
1777
- * @deprecated
2217
+ * @deprecated
1778
2218
  */
1779
2219
  BLACK_REMOVE_ERROR = 37003,
1780
2220
  /**
2221
+ * 38001
1781
2222
  * 获取草稿失败
1782
2223
  * @deprecated
1783
2224
  */
1784
2225
  DRAF_GET_ERROR = 38001,
1785
2226
  /**
1786
- * 关注公众号失败
1787
- * @deprecated
1788
- */
1789
- SUBSCRIBE_ERROR = 39001,
1790
- /**
1791
- * 关注公众号失败
1792
- * @deprecated
1793
- */
1794
- QNTKN_FILETYPE_ERROR = 41001,
1795
- /**
2227
+ * 41002
1796
2228
  * 获取七牛token失败
1797
2229
  * @deprecated
1798
2230
  */
1799
2231
  QNTKN_GET_ERROR = 41002,
1800
2232
  /**
1801
- * cookie被禁用
1802
- * @deprecated
1803
- */
1804
- COOKIE_ENABLE = 51001,
1805
- /**
1806
- * 子进程意外终止,如果是已连接状态,SDK 会自动重连
1807
- */
1808
- SUB_PROCESS_EXIT = 34289,
1809
- /**
1810
- * addon 模块不存在
2233
+ * -1
2234
+ * 未知错误
1811
2235
  */
1812
- ADDON_NOT_EXIST = 34290
2236
+ TIMEOUT = -1
1813
2237
  }
1814
2238
 
1815
2239
  /**
@@ -2239,6 +2663,7 @@ declare enum LogTagId {
2239
2663
  L_SEND_MSG_R = "L-send_msg-R",
2240
2664
  L_PULL_MSG_T = "L-pull_msg-T",
2241
2665
  L_PULL_MSG_R = "L-pull_msg-R",
2666
+ L_PULL_MSG_E = "L-pull_msg-E",
2242
2667
  L_PULL_MSG_O = "L-pull_msg-O",
2243
2668
  L_PULL_ULTRA_MSG_T = "L-pull_ultra_msg-T",
2244
2669
  L_PULL_ULTRA_MSG_R = "L-pull_ultra_msg-R",
@@ -2360,7 +2785,13 @@ declare enum LogTagId {
2360
2785
  L_CLOUD_GET_CACHE_O = "L-cloud_get_cache-O",
2361
2786
  L_CLOUD_MSG_NTF_O = "L-cloud_msg_ntf-O",
2362
2787
  L_CLOUD_SET_AREA_CODE_O = "L-cloud_set_area_code-O",
2363
- L_CLOUD_SET_MRTR_O = "L-cloud_set_mrtr-O"
2788
+ L_CLOUD_SET_MRTR_O = "L-cloud_set_mrtr-O",
2789
+ /** 用户状态订阅 */
2790
+ L_SYNC_SUBSCRIBED_USER_STATUS_FINISHED_S = "L-sync_subscribed_user_status_finished-S",
2791
+ L_PULL_SUBSCRIBED_USER_RELATION_T = "L-pull_subscribed_user_relation-T",
2792
+ L_PULL_SUBSCRIBED_USER_RELATION_R = "L-pull_subscribed_user_relation-R",
2793
+ L_PULL_SUBSCRIBED_USER_STATUS_T = "L-pull_subscribed_user_status-T",
2794
+ L_PULL_SUBSCRIBED_USER_STATUS_R = "L-pull_subscribed_user_status-R"
2364
2795
  }
2365
2796
 
2366
2797
  /** 统计数据标签 */
@@ -2539,6 +2970,77 @@ declare enum ConnectReason {
2539
2970
  TIMEOUT = 4
2540
2971
  }
2541
2972
 
2973
+ /**
2974
+ * 用户在线状态
2975
+ * @since 5.9.8
2976
+ */
2977
+ declare enum OnlineStatus {
2978
+ /**
2979
+ * 用户在线。
2980
+ * <p>标识用户当前处于在线状态。
2981
+ */
2982
+ ONLINE = 1,
2983
+ /**
2984
+ * 用户离线。
2985
+ * <p>标识用户当前处于离线状态,但未注销。
2986
+ */
2987
+ OFFLINE = 0
2988
+ }
2989
+ /**
2990
+ * 平台信息
2991
+ * @since 5.9.8
2992
+ */
2993
+ declare enum PlatformInfo {
2994
+ /**
2995
+ * 其他
2996
+ */
2997
+ Other = 0,
2998
+ /**
2999
+ * iOS
3000
+ */
3001
+ iOS = 1,
3002
+ /**
3003
+ * Android
3004
+ */
3005
+ Android = 2,
3006
+ /**
3007
+ * Web
3008
+ */
3009
+ Web = 3,
3010
+ /**
3011
+ * PC
3012
+ */
3013
+ PC = 4,
3014
+ /**
3015
+ * 小程序
3016
+ */
3017
+ Mini = 5
3018
+ }
3019
+ /**
3020
+ * 订阅类型
3021
+ * @since 5.9.8
3022
+ */
3023
+ declare enum SubscribeType {
3024
+ /**
3025
+ * 在线状态订阅
3026
+ */
3027
+ ONLINE_STATUS = 1
3028
+ }
3029
+ /**
3030
+ * 订阅操作类型
3031
+ * @since 5.9.8
3032
+ */
3033
+ declare enum SubscribeOperationType {
3034
+ /**
3035
+ * 订阅
3036
+ */
3037
+ SUBSCRIBE = 0,
3038
+ /**
3039
+ * 取消订阅
3040
+ */
3041
+ UNSUBSCRIBE = 1
3042
+ }
3043
+
2542
3044
  /**
2543
3045
  * 音视频模式
2544
3046
  */
@@ -3185,7 +3687,11 @@ interface IRecallMsgOptions {
3185
3687
  /**
3186
3688
  * 是否删除原始消息(在移动端会使用到),为 true 时移动端会不显示小灰条提示
3187
3689
  */
3188
- isDelete?: boolean;
3690
+ isDelete?: boolean;
3691
+ /**
3692
+ * 定向消息撤回,人员列表
3693
+ */
3694
+ directionalUserIdList?: string[];
3189
3695
  }
3190
3696
  interface IRecallMsgContent {
3191
3697
  conversationType: number;
@@ -3209,6 +3715,10 @@ interface IRecallMsgContent {
3209
3715
  * 是否删除原始消息(在移动端会使用到),为 true 时移动端会不显示小灰条提示
3210
3716
  */
3211
3717
  isDelete?: boolean;
3718
+ /**
3719
+ * 定向消息撤回,人员列表
3720
+ */
3721
+ directionalUserIdList?: string[];
3212
3722
  }
3213
3723
  /**
3214
3724
  * 发送消息时的可选项信息
@@ -4517,6 +5027,18 @@ interface INaviInfo {
4517
5027
  * 消息断档开关
4518
5028
  */
4519
5029
  repairHisMsg?: number;
5030
+ /**
5031
+ * 超级群驱动配置
5032
+ * 第一位:是否开启消息变更SDK主动拉取模式(关闭全量离线消息变更功能)
5033
+ * 第二位:是否开启默认群频道功能(关闭空频道(""))
5034
+ */
5035
+ ugDriven?: number;
5036
+ /**
5037
+ * #用户订阅驱动配置,位标记!!:
5038
+ * 第一位:是否开启在线状态订阅功能
5039
+ * 第二位(预留):是否开启用户信息托管订阅功能
5040
+ */
5041
+ subDriven?: number;
4520
5042
  }
4521
5043
 
4522
5044
  declare type Content = string | number | boolean | null;
@@ -6259,6 +6781,77 @@ interface INaviContextInfo {
6259
6781
  reason: ConnectReason;
6260
6782
  }
6261
6783
 
6784
+ /**
6785
+ * 订阅关系信息
6786
+ * @since 5.9.8
6787
+ */
6788
+ interface ISubscribeRelationInfo {
6789
+ /**
6790
+ * 用户 ID
6791
+ */
6792
+ userId: string;
6793
+ /**
6794
+ * 订阅类型
6795
+ */
6796
+ subscribeType: SubscribeType;
6797
+ /**
6798
+ * 订阅时间
6799
+ */
6800
+ subscribeTime: number;
6801
+ /**
6802
+ * 订阅有效期,单位为秒
6803
+ */
6804
+ expiry: number;
6805
+ /**
6806
+ * 订阅状态
6807
+ */
6808
+ operationType: SubscribeOperationType;
6809
+ }
6810
+ /**
6811
+ * 订阅用户状态信息
6812
+ * @since 5.9.8
6813
+ */
6814
+ interface ISubscribeUserStatusInfo {
6815
+ /**
6816
+ * 用户 ID
6817
+ */
6818
+ userId: string;
6819
+ /**
6820
+ * 订阅类型
6821
+ */
6822
+ subscribeType: SubscribeType;
6823
+ /**
6824
+ * 订阅时间
6825
+ */
6826
+ subscribeTime: number;
6827
+ /**
6828
+ * 订阅有效期,单位为秒
6829
+ */
6830
+ expiry: number;
6831
+ /**
6832
+ * 订阅状态详情
6833
+ */
6834
+ details?: ISubscribeStatusDetail[];
6835
+ }
6836
+ /**
6837
+ * 在线状态信息
6838
+ * @since 5.9.8
6839
+ */
6840
+ interface ISubscribeStatusDetail {
6841
+ /**
6842
+ * 状态变更时间
6843
+ */
6844
+ changeTime: number;
6845
+ /**
6846
+ * 状态值
6847
+ */
6848
+ eventValue: number;
6849
+ /**
6850
+ * 平台
6851
+ */
6852
+ platform: PlatformInfo;
6853
+ }
6854
+
6262
6855
  /**
6263
6856
  * 定义已废弃,请使用 `IRemoveChatroomEntries` 替换
6264
6857
  * @deprecated
@@ -6607,6 +7200,9 @@ interface IWatcher {
6607
7200
  * 同步已读状态 V4
6608
7201
  */
6609
7202
  syncReadStatus?: (data: ISyncReadStatusData) => void;
7203
+ subscribedUserStatusChange?: (data: ISubscribeUserStatusInfo[]) => void;
7204
+ subscribedRelationChange?: (data: ISubscribeRelationInfo[]) => void;
7205
+ syncSubscribedUserStatusFinished?: () => void;
6610
7206
  }
6611
7207
  interface IAPIContextOption {
6612
7208
  /**
@@ -6665,6 +7261,10 @@ interface IAPIContextOption {
6665
7261
  * 日志服务地址
6666
7262
  */
6667
7263
  logServerUrl?: string;
7264
+ /**
7265
+ * 自定义上传地址
7266
+ */
7267
+ uploadDomain?: string;
6668
7268
  }
6669
7269
 
6670
7270
  interface IPluginGenerator<API, InitOption> {
@@ -6768,6 +7368,14 @@ declare class APIContext {
6768
7368
  private _runtime;
6769
7369
  private static _context?;
6770
7370
  static init(runtime: IRuntime, options: IAPIContextOption): APIContext;
7371
+ /**
7372
+ * 获取 APIContext 实例
7373
+ */
7374
+ static getContext(): APIContext | undefined;
7375
+ /**
7376
+ * 获取初始化配置
7377
+ */
7378
+ getOptions(): IAPIContextOption;
6771
7379
  static destroy(): Promise<void>;
6772
7380
  private _token;
6773
7381
  /**
@@ -6902,6 +7510,9 @@ declare class APIContext {
6902
7510
  private _userGroupStatusListener;
6903
7511
  private _messageReadReceipt;
6904
7512
  private _syncReadStatus;
7513
+ private _subscribedUserStatusChange;
7514
+ private _subscribedRelationChange;
7515
+ private _syncSubscribedUserStatusFinished;
6905
7516
  /**
6906
7517
  * rtc 数据变更通知 pluginContext
6907
7518
  */
@@ -6957,6 +7568,12 @@ declare class APIContext {
6957
7568
  disconnect(closeDB?: boolean): Promise<void>;
6958
7569
  reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
6959
7570
  private _getTokenWithoutNavi;
7571
+ /**
7572
+ * 超级群 channelId 转换
7573
+ * @param type 会话类型
7574
+ * @returns
7575
+ */
7576
+ private _channelIdConvert;
6960
7577
  /**
6961
7578
  * 获取当前缓存的导航数据
6962
7579
  */
@@ -7473,6 +8090,23 @@ declare class APIContext {
7473
8090
  * 获取单聊消息送达信息
7474
8091
  */
7475
8092
  getPrivateMessageDeliverTime(messageUId: string, channelId?: string): Promise<IAsyncRes<number>>;
8093
+ private _isEnableSubDriven;
8094
+ /**
8095
+ * 订阅用户状态事件
8096
+ */
8097
+ subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<IAsyncRes<string[]>>;
8098
+ /**
8099
+ * 取消订阅用户状态事件
8100
+ */
8101
+ unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<IAsyncRes<void>>;
8102
+ /**
8103
+ * 获取已订阅列表
8104
+ */
8105
+ getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
8106
+ /**
8107
+ * 获取指定用户的在线状态
8108
+ */
8109
+ getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
7476
8110
  /**
7477
8111
  * 删除所有会话
7478
8112
  */
@@ -7551,14 +8185,17 @@ declare class APIContext {
7551
8185
  setMessageStatusToRead(conversationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
7552
8186
  /**
7553
8187
  * 设置当前用户在线状态
8188
+ * @deprecated 老版 V2 中用到
7554
8189
  */
7555
8190
  setUserStatus(status: number): Promise<ErrorCode>;
7556
8191
  /**
7557
8192
  * 订阅用户在线状态
8193
+ * @deprecated 老版 V2 中用到
7558
8194
  */
7559
8195
  subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
7560
8196
  /**
7561
8197
  * 获取用户在线状态
8198
+ * @deprecated 老版 V2 中用到
7562
8199
  */
7563
8200
  getUserStatus(userId: string): Promise<IAsyncRes<{
7564
8201
  status: string;
@@ -7569,9 +8206,13 @@ declare class APIContext {
7569
8206
  messages: IReceivedMessage[];
7570
8207
  count: number;
7571
8208
  }>>;
8209
+ searchMessageByContentAndMessageType(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, messageTypes: string[], channelId?: string): IPromiseResult<{
8210
+ messages: IReceivedMessage[];
8211
+ }>;
7572
8212
  searchMessagesByUser(conversationType: ConversationType, targetId: string, userId: string, timestamp: number, count?: number, channelId?: string): Promise<IAsyncRes<{
7573
8213
  messages: IReceivedMessage[];
7574
8214
  }>>;
8215
+ getMessagesByTimestamp(conversation: IConversationOption, timestamp: number, beforeCount: number, afterCount: number): IPromiseResult<IReceivedMessage[]>;
7575
8216
  searchMessageByContentWithAllChannel(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number): Promise<IAsyncRes<{
7576
8217
  messages: IReceivedMessage[];
7577
8218
  count: number;
@@ -7986,6 +8627,9 @@ interface IEngineWatcher extends IConnectionListener {
7986
8627
  * 同步已读状态 V4
7987
8628
  */
7988
8629
  syncReadStatus: (data: ISyncReadStatusData) => void;
8630
+ subscribedUserStatusChange?: (data: ISubscribeUserStatusInfo[]) => void;
8631
+ subscribedRelationChange?: (data: ISubscribeRelationInfo[]) => void;
8632
+ syncSubscribedUserStatusFinished?: () => void;
7989
8633
  }
7990
8634
  /**
7991
8635
  * 引擎定义
@@ -8649,6 +9293,9 @@ declare abstract class AEngine {
8649
9293
  messages: IReceivedMessage[];
8650
9294
  count: number;
8651
9295
  }>;
9296
+ abstract searchMessageByContentAndMessageType(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, messageTypes: string[], channelId?: string): IPromiseResult<{
9297
+ messages: IReceivedMessage[];
9298
+ }>;
8652
9299
  /**
8653
9300
  * 按用户ID搜索会话内的消息
8654
9301
  */
@@ -8818,6 +9465,30 @@ declare abstract class AEngine {
8818
9465
  * 设置当前网络
8819
9466
  */
8820
9467
  abstract setNetwork(data: INetwork, isUnPrintLog?: boolean): void;
9468
+ /**
9469
+ * 订阅用户状态事件
9470
+ */
9471
+ abstract subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<IAsyncRes<string[]>>;
9472
+ /**
9473
+ * 取消订阅用户状态事件
9474
+ */
9475
+ abstract unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<IAsyncRes<void>>;
9476
+ /**
9477
+ * 获取已订阅列表
9478
+ */
9479
+ abstract getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
9480
+ /**
9481
+ * 获取指定用户的在线状态
9482
+ */
9483
+ abstract getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
9484
+ /**
9485
+ * 获取本地指定时间戳前后 N 条消息方法
9486
+ * @param conversation
9487
+ * @param timestamp
9488
+ * @param beforeCount
9489
+ * @param afterCount
9490
+ */
9491
+ abstract getMessagesByTimestamp(conversation: IConversationOption, timestamp: number, beforeCount: number, afterCount: number): IPromiseResult<IReceivedMessage[]>;
8821
9492
  }
8822
9493
 
8823
9494
  interface IUrlCenterInitOption {
@@ -8863,6 +9534,230 @@ declare class UrlCenter {
8863
9534
  }
8864
9535
  declare const urlCenter: UrlCenter;
8865
9536
 
9537
+ /**
9538
+ * 错误码映射表,单个标签且对应唯一错误码
9539
+ */
9540
+ interface IErrorCodeKey {
9541
+ 'set.proxy': number;
9542
+ 'test.proxy': number;
9543
+ 'test.proxy.socksHost': number;
9544
+ 'test.proxy.socksPort': number;
9545
+ channelId: number;
9546
+ count: number;
9547
+ startTime: number;
9548
+ keyword: number;
9549
+ messageTypes: number;
9550
+ conversation: number;
9551
+ conversationType: number;
9552
+ targetId: number;
9553
+ endTime: number;
9554
+ offset: number;
9555
+ limit: number;
9556
+ userId: number;
9557
+ timestamp: number;
9558
+ sentTime: number;
9559
+ order: number;
9560
+ messageId: number;
9561
+ receivedStatus: number;
9562
+ receivedStatusInfo: number;
9563
+ sentStatus: number;
9564
+ content: number;
9565
+ messageType: number;
9566
+ messageIds: number;
9567
+ typingContentType: number;
9568
+ cleanSpace: number;
9569
+ messageDirection: number;
9570
+ canIncludeExpansion: number;
9571
+ expansion: number;
9572
+ disableNotification: number;
9573
+ messages: number;
9574
+ checkDuplicate: number;
9575
+ messageUId: number;
9576
+ key: number;
9577
+ value: number;
9578
+ isAutoDelete: number;
9579
+ isSendNotification: number;
9580
+ notificationExtra: number;
9581
+ entries: number;
9582
+ isForce: number;
9583
+ rtcRoomId: number;
9584
+ token: number;
9585
+ conversations: number;
9586
+ draft: number;
9587
+ conversationTypes: number;
9588
+ levels: number;
9589
+ notificationLevel: number;
9590
+ notificationLevels: number;
9591
+ notificationStatus: number;
9592
+ isTop: number;
9593
+ isUpdateTime: number;
9594
+ message: number;
9595
+ isStatusMessage: number;
9596
+ pushContent: number;
9597
+ pushData: number;
9598
+ isMentioned: number;
9599
+ mentionedType: number;
9600
+ mentionedUserIdList: number;
9601
+ directionalUserIdList: number;
9602
+ directedUserIds: number;
9603
+ isVoipPush: number;
9604
+ pushConfig: number;
9605
+ startMsgUId: number;
9606
+ endMsgUId: number;
9607
+ clearMessageOption: number;
9608
+ keys: number;
9609
+ searchContent: number;
9610
+ senderUserId: number;
9611
+ tagId: number;
9612
+ tagName: number;
9613
+ tagIds: number;
9614
+ containMuted: number;
9615
+ channelType: number;
9616
+ targetIds: number;
9617
+ file: number;
9618
+ fileType: number;
9619
+ contentDisposition: number;
9620
+ mediaUrl: number;
9621
+ filename: number;
9622
+ saveName: number;
9623
+ serverType: number;
9624
+ subscribeType: number;
9625
+ expiry: number;
9626
+ subscribeUserIds: number;
9627
+ subscribePageSize: number;
9628
+ beforeCount: number;
9629
+ afterCount: number;
9630
+ }
9631
+
9632
+ declare const ErrorCodeMap: IErrorCodeKey;
9633
+
9634
+ /**
9635
+ * 预定义的验证规则,只包含`值类型`数据验证
9636
+ * 引用类型数据需使用自定义 validator 校验函数进行校验
9637
+ */
9638
+ declare enum AssertRules {
9639
+ /**
9640
+ * 类型为字符串,且长度大于 0
9641
+ */
9642
+ STRING = 0,
9643
+ /**
9644
+ * 类型仅为 String
9645
+ */
9646
+ ONLY_STRING = 1,
9647
+ /**
9648
+ * 类型为数字
9649
+ */
9650
+ NUMBER = 2,
9651
+ /**
9652
+ * 类型为布尔值
9653
+ */
9654
+ BOOLEAN = 3,
9655
+ /**
9656
+ * 类型为对象
9657
+ */
9658
+ OBJECT = 4,
9659
+ /**
9660
+ * 类型为数组
9661
+ */
9662
+ ARRAY = 5,
9663
+ /**
9664
+ * 类型为 callback 回调对象,包含 callback.onSuccess、callback.onError
9665
+ */
9666
+ CALLBACK = 6,
9667
+ /**
9668
+ * ChannelId 验证,必须为 String 且不超过 20 位 且不能包含下划线
9669
+ */
9670
+ CHANNEL_ID = 7,
9671
+ /**
9672
+ * 类型为会话
9673
+ */
9674
+ CONVERSATION = 8,
9675
+ /**
9676
+ * 会话类型验证, 必须为 ConversationType
9677
+ */
9678
+ CONVERSATION_TYPE = 9
9679
+ }
9680
+ declare const validators: {
9681
+ 0: (str: unknown) => boolean;
9682
+ 1: (value: unknown) => boolean;
9683
+ 2: (value: unknown) => boolean;
9684
+ 3: (value: any) => boolean;
9685
+ 4: (val: any) => boolean;
9686
+ 5: (arr: unknown) => boolean;
9687
+ 6: (callback: any) => boolean;
9688
+ 7: (value: any) => boolean;
9689
+ 8: (value: any) => boolean;
9690
+ 9: (conversation: number) => boolean;
9691
+ };
9692
+ declare class RCAssertError extends Error {
9693
+ constructor(message?: string);
9694
+ }
9695
+ /**
9696
+ * 参数校验,该方法用于对业务层入参数据检查,及时抛出异常通知业务层进行修改
9697
+ * @deprecated 优先使用 `validate` 替代,禁止直接 throw error 阻断调用栈
9698
+ * @description
9699
+ * 1. 必填参数,value 需符合 validator 验证规,否则抛出异常
9700
+ * 2. 非必填参数,value 可为 undefined | null 或符合 validator 规则
9701
+ * @param key 字段名,仅用于验证失败时给出提示信息
9702
+ * @param value 待验证的值
9703
+ * @param validator 期望类型或校验规则函数,若使用规则函数
9704
+ * @param required 是否为必填参数,默认为 `false`
9705
+ */
9706
+ declare const assert: (key: string, value: any, validator: AssertRules | ((value: any) => boolean), required?: boolean) => void;
9707
+ /**
9708
+ * 参数校验,该方法用于对业务层入参数据检查,与 `assert` 函数不同的是其返回 boolean 值而非直接抛出异常
9709
+ * @description
9710
+ * 1. 必填参数,value 需符合 validator 验证规,否则抛出异常
9711
+ * 2. 非必填参数,value 可为 undefined | null 或符合 validator 规则
9712
+ * @param key 字段名,仅用于验证失败时给出提示信息
9713
+ * @param value 待验证的值
9714
+ * @param validator 期望类型或校验规则函数,若使用规则函数
9715
+ * @param required 是否为必填参数,默认为 `false`
9716
+ */
9717
+ declare const validate: (key: string, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean) => boolean;
9718
+
9719
+ declare class ValidatorManage<T> {
9720
+ private _logTagT;
9721
+ private _logTagR;
9722
+ private verificationFaileList;
9723
+ private context?;
9724
+ private logger?;
9725
+ private option?;
9726
+ constructor(_logTagT: string, _logTagR: string);
9727
+ /**
9728
+ * 添加效验参数
9729
+ * @param key 错误码标签
9730
+ * @param value 需要校验的值
9731
+ * @param validator 效验规则
9732
+ * @param required 是否必填
9733
+ * @param message 自定义错误信息
9734
+ */
9735
+ validate(key: keyof IErrorCodeKey, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean, message?: string): this;
9736
+ private _getValidationResult;
9737
+ /**
9738
+ * 内部验证接口是否完成初始化,若未完成初始化,返回状态码 `ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT`
9739
+ * @param handler 验证初始化完成的回调,其接收 APIContext, BasicLogger 与 IAPIContextOption 两个类型参数
9740
+ * @param errorTag 验证失败时,需要留存的日志信息
9741
+ * @description 对外接口定义中,使用此函数验证 SDK 初始化是否完成。
9742
+ */
9743
+ ifReady(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => Promise<IAsyncRes<T>>): Promise<IAsyncRes<T>>;
9744
+ /**
9745
+ * 尝试调用需要初始化完成的函数,若未完成初始化,抛出异常 `Not initialized yet!`
9746
+ * @param handler
9747
+ * @returns
9748
+ * @throw `Not initialized yet!`
9749
+ * @description 对外接口定义中,若无明确 code 码返回的情况下,使用该函数验证 SDK 初始化是否完成。
9750
+ * 新增接口不可使用。
9751
+ */
9752
+ try2do(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => T): T;
9753
+ /**
9754
+ * `_ifReady` 同步版本,若未完成初始化,返回状态码 `ErrorCode.BIZ_ERROR_CLIENT_NOT_INIT`
9755
+ * @param handler 验证初始化完成的回调,其接收 APIContext, BasicLogger 与 IAPIContextOption 两个类型参数
9756
+ * @description 对外接口定义中,使用此函数验证 SDK 初始化是否完成。
9757
+ */
9758
+ ifReadySync<T>(handler: (context: APIContext, logger: BasicLogger, option: IAPIContextOption) => IAsyncRes<T>): IAsyncRes<T>;
9759
+ }
9760
+
8866
9761
  declare class AppStorage {
8867
9762
  private _cache;
8868
9763
  private _storageKey;
@@ -8961,6 +9856,13 @@ declare const isBoolean: (value: unknown) => boolean;
8961
9856
  * @param value
8962
9857
  */
8963
9858
  declare const isNumber: (value: unknown) => boolean;
9859
+ /**
9860
+ * 检查参数是否为整数, 可以指定最小值和最大值,区间包含最小值和最大值,
9861
+ */
9862
+ declare const isInteger: (option: {
9863
+ min?: number;
9864
+ max?: number;
9865
+ }) => (value: number) => boolean;
8964
9866
  /**
8965
9867
  * 检查参数是否为数组
8966
9868
  * 只做类型检查,不做长度检查
@@ -8968,6 +9870,24 @@ declare const isNumber: (value: unknown) => boolean;
8968
9870
  * @param arr
8969
9871
  */
8970
9872
  declare const isArray: (arr: unknown) => boolean;
9873
+ /**
9874
+ * 检查参数是否为数组
9875
+ * 做长度检查、每一项的类型检查
9876
+ */
9877
+ declare const isLimitedArray: (option: {
9878
+ minLength?: number | undefined;
9879
+ maxLength?: number | undefined;
9880
+ itemValidator?: ((val: unknown) => boolean) | undefined;
9881
+ }) => (arr: any[]) => boolean;
9882
+ /**
9883
+ * 有限制的字符串
9884
+ * 做长度检查、自定义检查
9885
+ */
9886
+ declare const isLimitedString: (option: {
9887
+ minLength?: number | undefined;
9888
+ maxLength?: number | undefined;
9889
+ validator?: ((val: string) => boolean) | undefined;
9890
+ }) => (str: unknown) => boolean;
8971
9891
  /**
8972
9892
  * 检查参数是否为 ArrayBuffer
8973
9893
  * @param arr
@@ -8977,7 +9897,7 @@ declare const isArrayBuffer: (arr: unknown) => boolean;
8977
9897
  * 检查参数是否为长度非 0 的字符串
8978
9898
  * @param str
8979
9899
  */
8980
- declare const notEmptyString: (str: string) => boolean;
9900
+ declare const notEmptyString: (str: unknown) => boolean;
8981
9901
  /**
8982
9902
  * 检查参数是否为长度非 0 的数组
8983
9903
  * @param str
@@ -9015,6 +9935,10 @@ declare const notEmptyObject: (val: Object) => boolean;
9015
9935
  declare const isValidConversationType: (conversation: number) => boolean;
9016
9936
  declare const isValidNotificationLevel: (level: number) => boolean;
9017
9937
  declare const isValidChannelId: (value: any) => boolean;
9938
+ /**
9939
+ * 检查是否是有效的 targetId
9940
+ */
9941
+ declare const isValidTargetId: (value: any) => boolean;
9018
9942
  declare const isTypeInConversationList: (type: number) => boolean;
9019
9943
  /**
9020
9944
  * 判断是否是一个有效的文件类型
@@ -9090,75 +10014,6 @@ declare class SuspendablePromise<T> {
9090
10014
  abort(): void;
9091
10015
  }
9092
10016
 
9093
- /**
9094
- * 预定义的验证规则,只包含`值类型`数据验证
9095
- * 引用类型数据需使用自定义 validator 校验函数进行校验
9096
- */
9097
- declare enum AssertRules {
9098
- /**
9099
- * 类型为字符串,且长度大于 0
9100
- */
9101
- STRING = 0,
9102
- /**
9103
- * 类型仅为 String
9104
- */
9105
- ONLY_STRING = 1,
9106
- /**
9107
- * 类型为数字
9108
- */
9109
- NUMBER = 2,
9110
- /**
9111
- * 类型为布尔值
9112
- */
9113
- BOOLEAN = 3,
9114
- /**
9115
- * 类型为对象
9116
- */
9117
- OBJECT = 4,
9118
- /**
9119
- * 类型为数组
9120
- */
9121
- ARRAY = 5,
9122
- /**
9123
- * 类型为 callback 回调对象,包含 callback.onSuccess、callback.onError
9124
- */
9125
- CALLBACK = 6,
9126
- /**
9127
- * ChannelId 验证,必须为 String 且不超过 20 位 且不能包含下划线
9128
- */
9129
- CHANNEL_ID = 7,
9130
- /**
9131
- * 类型为会话
9132
- */
9133
- CONVERSATION = 8
9134
- }
9135
- declare class RCAssertError extends Error {
9136
- constructor(message?: string);
9137
- }
9138
- /**
9139
- * 参数校验,该方法用于对业务层入参数据检查,及时抛出异常通知业务层进行修改
9140
- * @deprecated 优先使用 `validate` 替代,禁止直接 throw error 阻断调用栈
9141
- * @description
9142
- * 1. 必填参数,value 需符合 validator 验证规,否则抛出异常
9143
- * 2. 非必填参数,value 可为 undefined | null 或符合 validator 规则
9144
- * @param key 字段名,仅用于验证失败时给出提示信息
9145
- * @param value 待验证的值
9146
- * @param validator 期望类型或校验规则函数,若使用规则函数
9147
- * @param required 是否为必填参数,默认为 `false`
9148
- */
9149
- declare const assert: (key: string, value: any, validator: AssertRules | ((value: any) => boolean), required?: boolean) => void;
9150
- /**
9151
- * 参数校验,该方法用于对业务层入参数据检查,与 `assert` 函数不同的是其返回 boolean 值而非直接抛出异常
9152
- * @description
9153
- * 1. 必填参数,value 需符合 validator 验证规,否则抛出异常
9154
- * 2. 非必填参数,value 可为 undefined | null 或符合 validator 规则
9155
- * @param key 字段名,仅用于验证失败时给出提示信息
9156
- * @param value 待验证的值
9157
- * @param validator 期望类型或校验规则函数,若使用规则函数
9158
- * @param required 是否为必填参数,默认为 `false`
9159
- */
9160
- declare const validate: (key: string, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean) => boolean;
9161
-
9162
10017
  /**
9163
10018
  * 通过文件类型生成上传唯一文件名
9164
10019
  */
@@ -9257,6 +10112,10 @@ declare const transformReceivedStatusInfo: (status: ReceivedStatus) => IReceived
9257
10112
  * @param status 状态枚举值
9258
10113
  */
9259
10114
  declare const transformReceivedStatusFlag: (receivedStatusInfo: IReceivedStatusInfo) => number;
10115
+ /**
10116
+ * 补齐订阅平台状态
10117
+ */
10118
+ declare const completeSubscriptionPlatformStatus: (status: ISubscribeStatusDetail[]) => ISubscribeStatusDetail[];
9260
10119
 
9261
10120
  /**
9262
10121
  * Navi 缓存数据有效时长,单位毫秒
@@ -9476,6 +10335,11 @@ interface IUploadTask {
9476
10335
  */
9477
10336
  userId?: string;
9478
10337
  }
10338
+ /**
10339
+ * 消息采样率,用于采样率规则,后面的数值代表计算采样率的分母
10340
+ * 1 代表 100% 0.1 代表 10% 0.001 代表 1%
10341
+ * 0 代表不抽样
10342
+ */
9479
10343
  interface IMRTRConfig {
9480
10344
  chatroom: number;
9481
10345
  group: number;
@@ -9595,4 +10459,4 @@ declare type AbsCodec<T> = Codec<T>;
9595
10459
  */
9596
10460
  declare const version: string;
9597
10461
 
9598
- export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BaseCloudController, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICloudController, ICombineV2MessageContent, ICombinedMessage, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IFirstUnreadMessageInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IMRTRConfig, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerAddressData, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUploadTask, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, InterruptionLevel, InvokerType, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, READ_RECEIPT_CATCH_TIME, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, VERSION, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, unInitStatisticDB, urlCenter, usingCppEngine, validate, version };
10462
+ export { AConnectionMgr, AEngine, APIContext, AbsCodec, AppStorage, AreaCode, AssertRules, BaseCloudController, BasicLogger, BasicNavi, BasicReporter, BasicStaticConfigManager, BasicStatistic, BasicStatisticReporter, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectReason, ConnectType, ConnectionStatus, Content, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, EConnectProtocol, EnableLogL, EnterpriseType, ErrorCode, ErrorCodeMap, EventEmitter, FORMATED_VERSION, FileType, HTTP_TIMEOUT, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBaseStatisticsData, IBlockedMessageInfo, ICancelRoomPKOptions, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IClearMessageOption, ICloudController, ICombineV2MessageContent, ICombinedMessage, IConnectResult, IConnectionListener, IConnectionStatusListener, IConversationIdentifier, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IFirstUnreadMessageInfo, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogDB, ILogData, ILogger, IMRTRConfig, IM_CHATROOM_PULL_INTERVAL_TIME, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageDeliver, IMessageDeliveredListener, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMetionedData, INaviCache, INaviContextInfo, INaviInfo, INetwork, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerAddressData, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStaticConfig, IStatistic, IStatisticDB, IStatisticData, IStatisticsCMPData, IStatisticsCSData, IStatisticsDurData, IStatisticsNaviData, IStatisticsNetworkData, IStatisticsRMTPData, IStatisticsWebsocketData, IStorage, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUploadTask, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, IndexDBLogger, IndexDBReporter, IndexDBStatistic, IndexDBStatisticReporter, RTCKeyMaps as InnerRTCKeyMaps, InterruptionLevel, InvokerType, ItypingStateListener, KVString, LOCAL_STORAGE_KEYS, LiveRole, LiveType, LogContent, LogL, LogLevel, LogSource, LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MAX_UPLOAD_FILE_SIZE, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NaviCacheType, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OnlineStatus, OperateStatus, PlatformInfo, PluginContext, ProtocalType, PushImportanceHonor, RCAssertError, RCConnectionStatus, RC_DEFAULT_USER, READ_RECEIPT_CATCH_TIME, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATIC_CONFIG_CACHE_TIME, STATIC_CONFIG_IV, STATIC_CONFIG_KEY, STATUS_MESSAGE, SentStatus, StatisticL, StatisticsTag, StatisticsVersion, StoreKeys, SubscribeOperationType, SubscribeType, SuspendablePromise, TagChangeType, Type, UPLOAD_FILE_CHUNK_SIZE, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMentionedType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, UserGroupChangeType, VERSION, ValidatorManage, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketNavi, appendUrl, assert, clone, cloneByJSON, completeSubscriptionPlatformStatus, deInitLogDB, decryptCBC, fixUrlProtocol, forEach, getBrowser, getClientMessageId, getDeviceId, getMessageUIdHash, getMimeKey, getUUID, getUUID22, getUploadFileName, getbundleId, httpRequest, indexOf, initLogDB, initStatisticDB, isArray, isArrayBuffer, isBoolean, isConnnectAckCode as isConnnectAck, isDisconnectCode as isDisconnectedByServer, isFunction, isHttpUrl, isInObject, isInclude, isInteger, isLimitedArray, isLimitedString, isNull, isNumber, isObject, isStartCloudController, isString, isTypeInConversationList, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, isValidTargetId, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, statisticTranscsv, todo, transcsv, transformReceivedStatusFlag, transformReceivedStatusInfo, unInitStatisticDB, urlCenter, usingCppEngine, validate, validators, version };