@rongcloud/engine 5.8.3-alpha.3 → 5.8.3

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
@@ -795,101 +795,77 @@ declare enum FileType {
795
795
  }
796
796
 
797
797
  /**
798
- * 融云 IM 错误码
799
- *
800
- * 本文件由 ErrorCodeGenerator 自动生成
801
- * 请勿擅自修改
802
- *
798
+ * IM 错误码范围段
799
+ * 2 开头为 IM Server 返回错误码
800
+ * 3 开头: 30000 到 33xxx 为协议栈错误码,34001 ~ 34999 为移动端自定错误码
801
+ * 备注:iOS 与 Android 错误码一致。Web 与移动端一致的错误码,也用此片段,比如 34008 (消息不支持扩展)
802
+ * 35001 ~ 39999 为 Web 端错误码 备注:由于 Web IM 历史版本 35xxx 36xxx 37xxx 38xxx 39xxxx 都占用过,所以错误码段范围较大
803
+ */
804
+ /**
805
+ * 错误码
803
806
  * @category Enum
804
807
  */
805
808
  declare enum ErrorCode {
806
- /**
807
- * 未知错误
808
- */
809
+ /** 超时 */
809
810
  TIMEOUT = -1,
810
811
  /**
811
- * 成功
812
+ * 未知原因失败。
812
813
  */
813
- SUCCESS = 0,
814
+ UNKNOWN = -2,
815
+ /** 参数错误 */
816
+ PARAMETER_ERROR = -3,
817
+ /** 未实现的方法定义,在应用层调用 callExtra 传入无法识别的方法名时抛出 */
818
+ EXTRA_METHOD_UNDEFINED = -4,
819
+ /** 主进程内方法错误 */
820
+ MAIN_PROCESS_ERROR = -5,
814
821
  /**
815
- * 主动断开连接
822
+ * 参数变更
816
823
  */
817
- ACTIVE_DISCONNECT = 2,
824
+ PARAMETER_CHANGED = -6,
818
825
  /**
819
- * 已被对方加入黑名单,消息发送失败
826
+ * 成功
820
827
  */
821
- REJECTED_BY_BLACKLIST = 405,
828
+ SUCCESS = 0,
822
829
  /**
823
- * 系统会话不支持发送该消息
824
- * @since 5.8.2
830
+ * 系统会话不支持发送消息
825
831
  */
826
832
  SYS_CONVERSATION_NOT_SUPPORT_MESSAGE = 20109,
827
833
  /**
828
- * 发送消息频率过高,1 秒钟最多只允许发送 5 条消息
829
- */
830
- SEND_FREQUENCY_TOO_FAST = 20604,
831
- /**
832
- * 操作被禁止,此错误码已被弃用
834
+ * 群组 Id 无效
835
+ * @deprecated 讨论组已废弃
833
836
  */
834
- OPERATION_BLOCKED = 20605,
837
+ RC_DISCUSSION_GROUP_ID_INVALID = 20407,
835
838
  /**
836
- * 操作不支持,仅私有云有效,服务端禁用了该操作
839
+ * 发送频率过快
837
840
  */
838
- OPERATION_NOT_SUPPORT = 20606,
839
- /**
840
- * 请求超出了调用频率限制,请稍后再试
841
- */
842
- REQUEST_OVER_FREQUENCY = 20607,
841
+ SEND_FREQUENCY_TOO_FAST = 20604,
843
842
  /**
844
- * 不在讨论组
843
+ * 不在讨论组。
844
+ * @deprecated 讨论组已废弃
845
845
  */
846
846
  NOT_IN_DISCUSSION = 21406,
847
847
  /**
848
- * 发送的消息中包含敏感词 (发送方发送失败,接收方不会收到消息)
848
+ * 群组被禁言
849
849
  */
850
- SENSITIVE_SHIELD = 21501,
851
- /**
852
- * 消息中敏感词已经被替换 (接收方可以收到被替换之后的消息)
853
- */
854
- SENSITIVE_REPLACE = 21502,
855
- /**
856
- * 超级群扩展消息,但是原始消息不存在。
857
- */
858
- MESSAGE_EXPAND_NOT_EXIST = 22201,
859
- /**
860
- * 超级群扩展消息,但是原始消息不支持扩展
861
- */
862
- MESSAGE_EXPAND_NOT_SUPPORT = 22202,
863
- /**
864
- * 超级群扩展消息,扩展内容格式错误
865
- */
866
- MESSAGE_EXPAND_FORMAT_ERROR = 22203,
850
+ FORBIDDEN_IN_GROUP = 22408,
867
851
  /**
868
- * 超级群扩展消息,无操作权限
852
+ * 撤回消息参数无效,请确认撤回消息参数是否正确的填写
869
853
  */
870
- MESSAGE_EXPAND_NOT_AUTHORIZED = 22204,
854
+ RECALL_MESSAGE = 25101,
871
855
  /**
872
- * 不在该群组中
856
+ * 不在群组。
873
857
  */
874
858
  NOT_IN_GROUP = 22406,
875
859
  /**
876
- * 在群组中已被禁言。
877
- */
878
- FORBIDDEN_IN_GROUP = 22408,
879
- /**
880
- * 不在该聊天室中。
860
+ * 不在聊天室。
881
861
  */
882
862
  NOT_IN_CHATROOM = 23406,
883
863
  /**
884
- * 获取用户失败
885
- */
886
- GET_USERINFO_ERROR = 23407,
887
- /**
888
- * 在该聊天室中已被禁言
864
+ *聊天室被禁言
889
865
  */
890
866
  FORBIDDEN_IN_CHATROOM = 23408,
891
867
  /**
892
- * 已被踢出并禁止加入聊天室。被禁止的时间取决于服务端调用踢出接口时传入的时间。
868
+ * 当前用户被目标聊天室封禁
893
869
  */
894
870
  RC_CHATROOM_USER_KICKED = 23409,
895
871
  /**
@@ -897,360 +873,231 @@ declare enum ErrorCode {
897
873
  */
898
874
  RC_CHATROOM_NOT_EXIST = 23410,
899
875
  /**
900
- * 聊天室成员超限,开发者可以提交工单申请聊天室人数限制变更。
876
+ * 聊天室成员已满
901
877
  */
902
878
  RC_CHATROOM_IS_FULL = 23411,
903
879
  /**
904
- * 聊天室接口参数无效。请确认参数是否为空或者有效。
880
+ * 获取聊天室信息参数无效
905
881
  */
906
882
  RC_CHATROOM_PATAMETER_INVALID = 23412,
907
883
  /**
908
- * 查询聊天室历史消息异常
884
+ * 聊天室异常
909
885
  */
910
886
  CHATROOM_GET_HISTORYMSG_ERROR = 23413,
911
887
  /**
912
- * 聊天室云存储业务未开通
888
+ * 没有打开聊天室消息存储
913
889
  */
914
890
  CHATROOM_NOT_OPEN_HISTORYMSG_STORE = 23414,
915
891
  /**
916
- * 聊天室的 KV 属性个数超限,单个聊天室默认上限为 100 个
892
+ * 聊天室 KV 设置超出最大值(已满, 默认最多设置 100 个)
917
893
  */
918
894
  CHATROOM_KV_EXCEED = 23423,
919
895
  /**
920
- * 没有权限修改聊天室中已存在的属性值
896
+ * 聊天室 KV 设置失败(kv 已存在, 需覆盖设置)
921
897
  */
922
898
  CHATROOM_KV_OVERWRITE_INVALID = 23424,
923
899
  /**
924
- * 超过聊天室中状态设置频率,1 个聊天室 1 秒钟最多设置和删除状态 100 次
925
- */
926
- CHATROOM_SET_PROPERTY_OVER_FREQUENCY = 23425,
927
- /**
928
- * 聊天室属性自定义设置,您可以在开发者后台免费基础功能页面中开启该功能。
900
+ * 未开通聊天室属性自定义设置。请在开发者后台"免费基础功能"页面开通"聊天室属性自定义设置
929
901
  */
930
902
  CHATROOM_KV_STORE_NOT_OPEN = 23426,
931
903
  /**
932
- * 聊天室属性不存在
904
+ * 聊天室Key不存在
933
905
  */
934
906
  CHATROOM_KEY_NOT_EXIST = 23427,
935
- /**
936
- * 聊天室批量设置或删除KV部分不成功
937
- */
938
- CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
939
- /**
940
- * 聊天室批量设置或删除KV数量超限(最多一次10条)
941
- */
942
- CHATROOM_KV_STORE_OUT_LIMIT = 23429,
943
- /**
944
- * 聊天室设置 KV 失败,出现在两人或者多端同时操作一个 KV。 如果出现该错误,为避免和其他端同时操作,请延时一定时间再试
945
- * @since 5.3.0
946
- */
947
907
  CHATROOM_KV_SET_ERROR = 23431,
948
908
  /**
949
- * 超级群功能未开通
950
- */
951
- ULTRA_GROUP_SERVICE_UNAVAILABLE = 24401,
952
- /**
953
- * 超级群服务异常
954
- */
955
- ULTRA_GROUP_SERVICE_ERROR = 24402,
956
- /**
957
- * 超级群参数错误
958
- */
959
- ULTRA_GROUP_PARAMETER_ERROR = 24403,
960
- /**
961
- * 超级群未知异常
962
- */
963
- ULTRA_GROUP_UNKNOWN_ERROR = 24404,
964
- /**
965
- * 非超级群成员
966
- */
967
- NOT_IN_ULTRA_GROUP = 24406,
968
- /**
969
- * 超级群成员禁言
970
- */
971
- FORBIDDEN_IN_ULTRA_GROUP = 24408,
972
- /**
973
- * 超级群不存在
974
- */
975
- ULTRA_GROUP_NOT_EXIST = 24410,
976
- /**
977
- * 超级群成员超限制
978
- */
979
- ULTRA_GROUP_MEMBERS_OVERSIZE = 24411,
980
- /**
981
- * 用户加入超级群数量超限
982
- */
983
- ULTRA_GROUP_JOINED_OVERSIZE = 24412,
984
- /**
985
- * 创建超级群频道,频道数超限
909
+ * 敏感词屏蔽
986
910
  */
987
- ULTRA_GROUP_CHANNELS_OVERSIZE = 24413,
988
- /**
989
- * 超级群频道 ID 不存在
990
- */
991
- ULTRA_GROUP_CHANNEL_ID_NOT_EXIST = 24414,
992
- /**
993
- * 超级群频道发送消息超限:超级群下每个频道有消息发送频率限制,默认每秒 30 条 频道内每秒发送消息总量超过限制会收到该错误码,建议延时发送或重试发送
994
- */
995
- ULTRA_GROUP_MESSAGE_SENT_OVER_FREQUENCY = 24415,
996
- /**
997
- * 用户不在超级群私有频道中
998
- * @since 5.4.2
999
- */
1000
- ULTRA_GROUP_USER_NOT_IN_PRIVATE_CHANNEL = 24416,
911
+ SENSITIVE_SHIELD = 21501,
1001
912
  /**
1002
- * 撤回消息参数无效,请确认撤回消息参数是否正确的填写
913
+ * 消息中含敏感词且敏感词已被替换
1003
914
  */
1004
- RECALL_MESSAGE = 25101,
915
+ SENSITIVE_REPLACE = 21502,
1005
916
  /**
1006
- * 未开通单群聊云存储服务
917
+ * 加入讨论失败
918
+ * @deprecated
1007
919
  */
1008
- MESSAGE_STORAGE_SERVICE_UNAVAILABLE = 25102,
920
+ JOIN_IN_DISCUSSION = 21407,
1009
921
  /**
1010
- * IMLib 撤回消息可以撤回自己发送的消息和别人发送的消息,IM 服务有开关,控制只可以撤回自己发送的消息,当服务该开关打开时,撤回别人的消息会报这个错误。
922
+ * 创建讨论组失败
923
+ * @deprecated
1011
924
  */
1012
- RECALL_MESSAGE_USER_INVALID = 25107,
925
+ CREATE_DISCUSSION = 21408,
1013
926
  /**
1014
- * 远程推送设置参数无效,请确认是否正确的填写了远程推送参数
927
+ * 设置讨论组邀请状态失败
928
+ * @deprecated
1015
929
  */
1016
- PUSH_PARAMETER_INVALID = 26001,
930
+ INVITE_DICUSSION = 21409,
1017
931
  /**
1018
- * 表示客户端版本号低,需要同步版本号,可以提交工单申请打开用户级别配置开关
932
+ *获取用户失败
1019
933
  */
1020
- USER_SETTING_SYNCED_ERROR = 26002,
934
+ GET_USERINFO_ERROR = 23407,
1021
935
  /**
1022
- * 用户会话标签个数超限,最多支持添加 20 个标签
936
+ * 在黑名单中。
1023
937
  */
1024
- CONVERSATION_TAG_OVERSIZE = 26004,
938
+ REJECTED_BY_BLACKLIST = 405,
1025
939
  /**
1026
- * 当前连接已经被释放
1027
- * @solution 表明当前 socket 已经释放,需要重新建立连接
1028
- * @since 5.2.0
940
+ * 通信过程中,当前 Socket 不存在。
1029
941
  */
1030
942
  RC_NET_CHANNEL_INVALID = 30001,
1031
943
  /**
1032
- * 当前连接不可用
1033
- * @solution 建议链接成功后再调用其他 api
1034
- * @since 5.2.0
944
+ * Socket 连接不可用。
1035
945
  */
1036
946
  RC_NET_UNAVAILABLE = 30002,
1037
947
  /**
1038
- * 客户端发送消息请求,融云服务端响应超时
1039
- * @since 5.2.0
948
+ * 通信超时。
1040
949
  */
1041
950
  RC_MSG_RESP_TIMEOUT = 30003,
1042
951
  /**
1043
- * 导航操作时,Http 请求失败
1044
- * @since 5.2.0
952
+ * 导航操作时,Http 请求失败。
1045
953
  */
1046
954
  RC_HTTP_SEND_FAIL = 30004,
1047
955
  /**
1048
- * 请求连接导航地址失败
1049
- * @solution http 请求失败,建议本地使用 ping 或者 telnet 检查一下地址是否能正常访问
1050
- * @since 5.2.0
956
+ * HTTP 请求失败。
1051
957
  */
1052
958
  RC_HTTP_REQ_FAIL = 30005,
1053
959
  /**
1054
- * 导航操作时,HTTP 接收失败
1055
- * @since 5.2.0
960
+ * HTTP 接收失败。
1056
961
  */
1057
962
  RC_HTTP_RECV_FAIL = 30006,
1058
963
  /**
1059
- * 导航返回结果异常
1060
- * @since 5.2.0
964
+ * 导航请求失败
1061
965
  */
1062
966
  RC_NAVI_REQ_FAILED = 30007,
1063
967
  /**
1064
- * 导航 HTTP 返回数据格式错误
1065
- * @since 5.2.0
968
+ * 导航数据解析后,其中不存在有效数据。
1066
969
  */
1067
970
  RC_NODE_NOT_FOUND = 30008,
1068
971
  /**
1069
- * 导航数据解析后,其中不存在有效 IP 地址
1070
- * @since 5.2.0
972
+ * 导航数据解析后,其中不存在有效 IP 地址。
1071
973
  */
1072
974
  RC_DOMAIN_NOT_RESOLVE = 30009,
1073
975
  /**
1074
- * 创建连接失败
1075
- * @solution 一般是本地网络导致连接不成功,建议更换网络重新尝试连接
1076
- * @since 5.2.0
976
+ * Socket 连接失败
1077
977
  */
1078
978
  RC_SOCKET_NOT_CREATED = 30010,
1079
979
  /**
1080
- * 链接断开
1081
- * @solution 连接断开,SDK 会进行重连
1082
- * @since 5.2.0
980
+ * Socket 连接断开
1083
981
  */
1084
982
  RC_SOCKET_DISCONNECTED = 30011,
1085
983
  /**
1086
- * PING 失败
1087
- * @solution 本地网络问题导致ping失败,SDK 会进入重连逻辑
1088
- * @since 5.2.0
984
+ * PING 连续失败次数超限制
1089
985
  */
1090
986
  RC_PING_EXCEED_LIMIT = 30012,
1091
987
  /**
1092
- * PING 超时
1093
- * @since 5.7.0
1094
- */
1095
- PONG_RECEIVED_ERROR = 30013,
1096
- /**
1097
- * 信令发送失败
1098
- * @since 5.2.0
988
+ * 消息发送失败。
1099
989
  */
1100
990
  RC_MSG_SEND_FAIL = 30014,
1101
991
  /**
1102
- * 连接过于频繁
1103
- */
1104
- CONNECT_OVER_FREQUENCY = 30015,
1105
- /**
1106
- * 消息大小超限,消息体(序列化成 json 格式之后的内容)最大 128k bytes
1107
- * @solution 建议检查发送的消息内容,防止超过消息体大小限制
1108
- * @since 5.2.0
992
+ * JSON 后的消息体超限, 目前最大 128kb
1109
993
  */
1110
994
  RC_MSG_CONTENT_EXCEED_LIMIT = 30016,
1111
995
  /**
1112
- * 网络连接不可用
1113
- * @solution 网络问题,SDK 会进行重连
1114
- * @since 5.7.9
996
+ * 网络不可用,未连接。
1115
997
  */
1116
998
  RC_NETWORK_DOWN = 30019,
1117
999
  /**
1118
- * tcp 连接成功,rmtp 连接失败
1119
- * @since 5.7.9
1000
+ * TCP 连上后,rmtp 还未连上时, TCP 连接断开。
1120
1001
  */
1121
1002
  RC_TCP_DISCONNECTED_NO_RMTP = 30021,
1122
1003
  /**
1123
- * 连接ACK超时
1124
- * @solution 网络问题,SDK 会进行重连
1125
- * @since 5.2.0
1004
+ * TCP 连接中,CMP 应答超时。
1126
1005
  */
1127
1006
  RC_CONN_ACK_TIMEOUT = 31000,
1128
1007
  /**
1129
- * 信令版本错误
1130
- * @since 5.2.0
1008
+ * 连接协议版本错误
1131
1009
  */
1132
1010
  RC_CONN_PROTO_VERSION_ERROR = 31001,
1133
1011
  /**
1134
- * 客户端 info 字段格式错误,正确格式:{平台类型}-{设备信息}-{sdk版本}。 其中设备信息:{手机类型}|{手机型号}|{网络类型,4G/WIFI}|{运营商标识, 移动/电信/联通}
1135
- * @solution 一般是 appkey 错误导致,建议在融云的开发者后台中确认一下当前应用的 appkey 标识是否正确
1136
- * @since 5.2.0
1012
+ * 客户端连接用设备 info 信息错误
1137
1013
  */
1138
1014
  RC_CONN_IDENTIFIER_REJECTED = 31002,
1139
1015
  /**
1140
1016
  * 连接服务未开通,需要排查后台小程序(或桌面端)服务是否已开通
1141
- * @solution 建议到开发者后台 - 服务管理开通对应业务服务
1142
- * @since 5.2.0
1143
1017
  */
1144
1018
  RC_CONN_SERVER_UNAVAILABLE = 31003,
1145
1019
  /**
1146
- * Token 无效;AppKey Token 不匹配;Token 过期
1147
- * @solution 建议确认从服务获取 token 时传入的 appkey 与客户端初始化使用的 appkey 是否为同一个
1148
- * @since 5.2.0
1020
+ * Token 无法解析,或 Token 已过期
1149
1021
  */
1150
1022
  RC_CONN_TOKEN_INCORRECT = 31004,
1151
1023
  /**
1152
- * App 校验未通过(开通了 App 校验功能,但是校验未通过)
1153
- * @since 5.2.0
1024
+ * 防黑产校验失败
1154
1025
  */
1155
1026
  RC_CONN_NOT_AUTHRORIZED = 31005,
1156
1027
  /**
1157
- * 连接重定向
1158
- * @since 5.2.0
1028
+ * 重定向,地址错误。
1159
1029
  */
1160
1030
  RC_CONN_REDIRECTED = 31006,
1161
1031
  /**
1162
- * 包名与后台注册信息不匹配
1163
- * @since 5.2.0
1032
+ * 包名不合法(目前仅限移动端使用)
1164
1033
  */
1165
1034
  RC_CONN_PACKAGE_NAME_INVALID = 31007,
1166
1035
  /**
1167
- * AppKey 被封禁或已删除
1168
- * @since 5.2.0
1036
+ * Appkey 已被封禁或删除
1169
1037
  */
1170
1038
  RC_CONN_APP_BLOCKED_OR_DELETED = 31008,
1171
1039
  /**
1172
- * 用户被封禁
1173
- * @since 5.2.0
1040
+ * 用户已被封禁
1174
1041
  */
1175
1042
  RC_CONN_USER_BLOCKED = 31009,
1176
1043
  /**
1177
- * 用户被踢下线
1178
- * @since 5.2.0
1044
+ * 其他端登录导致本端被踢
1179
1045
  */
1180
1046
  RC_DISCONN_KICK = 31010,
1181
1047
  /**
1182
- * 与服务器的连接已断开,用户被封禁
1183
- * @since 5.2.0
1048
+ * 用户在线时被封禁导致连接断开
1184
1049
  */
1185
1050
  RC_DISCONN_EXCEPTION = 31011,
1186
- /**
1187
- * 链路加密认证失败
1188
- * @since 5.2.0
1189
- */
1190
- CONNECTION_ENCRYPT_AUTHORIZED_ERROR = 31012,
1191
1051
  /**
1192
1052
  * Token 已过期
1193
- * @since 5.7.0
1194
1053
  */
1195
1054
  RC_CONN_TOKEN_EXPIRED = 31020,
1196
1055
  /**
1197
- * Token 中携带 deviceId 时,检测 Token 中deviceId 与链接设备 deviceId 不一致
1198
- * @since 5.7.0
1056
+ * Token 中携带 deviceId 时,检测 Token 中 deviceId 与链接设备 deviceId 不一致
1199
1057
  */
1200
1058
  RC_CONN_DEVICE_ERROR = 31021,
1201
1059
  /**
1202
1060
  * 页面域名不在安全域名白名单内,需通过开发者后台添加安全域名配置
1203
- * @since 5.7.0
1204
1061
  */
1205
1062
  RC_CONN_HOSTNAME_ERROR = 31022,
1206
1063
  /**
1207
1064
  * 开启禁止把已在线客户端踢下线开关后,该错误码标识已有同类型端在线
1208
- * @since 5.3.4
1209
1065
  */
1210
1066
  RC_DISCONN_SAME_CLIENT_ON_LINE = 31023,
1211
1067
  /**
1212
- * 连接总数量超过服务设定的并发限定值(私有云专属)
1213
- * @since 5.7.0
1068
+ * 连接数已达上限(私有云)
1214
1069
  */
1215
1070
  RC_LISCENSE_COUNT_OUT_OF_LIMIT = 31024,
1216
1071
  /**
1217
1072
  * 客户端连错环境,引发连接拒绝;如使用开发环境 Appkey 连接到生产环境
1218
- * @since 5.7.0
1219
1073
  */
1220
1074
  RC_CONN_WRONG_CLUSTER = 31025,
1221
1075
  /**
1222
- * 开启AppServer联合鉴权功能后,到AppServer认证失败
1223
- * @since 5.2.0
1076
+ * 开启 AppServer 联合鉴权功能后,到 AppServer 认证失败
1224
1077
  */
1225
1078
  RC_APP_AUTH_NOT_PASS = 31026,
1226
1079
  /**
1227
- * token 已经被使用过,无法进行连接 一次性 token 只能连接一次,之后再使用会上报此错误
1228
- * @since 5.2.0
1080
+ * One Time Password 已经被使用过
1229
1081
  */
1230
1082
  RC_OTP_USED = 31027,
1231
1083
  /**
1232
- * Token 平台验证失败
1233
- * @since 5.2.0
1084
+ * Token 绑定的平台与登录平台不符
1234
1085
  */
1235
1086
  RC_PLATFORM_ERROR = 31028,
1236
1087
  /**
1237
- * 用户已销户
1238
- * @since 5.5.7
1088
+ * 用户账号已销户
1239
1089
  */
1240
1090
  RC_ACCOUNT_CANCELLATION = 31029,
1241
1091
  /**
1242
- * 私有云 License 检查不通过;APP License 过期
1243
- * @since 5.5.1
1092
+ * License 授权过期(私有云)
1244
1093
  */
1245
1094
  RC_LICENSE_EXPIRED = 31030,
1246
1095
  /**
1247
- * 协议层内部错误,查询,上传,下载过程中数据错误
1248
- * @since 5.2.0
1096
+ * 协议层内部错误。query,上传下载过程中数据错误。
1249
1097
  */
1250
1098
  RC_QUERY_ACK_NO_DATA = 32001,
1251
1099
  /**
1252
- * 协议层内部错误
1253
- * @since 5.2.0
1100
+ * 协议层内部错误。
1254
1101
  */
1255
1102
  RC_MSG_DATA_INCOMPLETE = 32002,
1256
1103
  /**
@@ -1258,216 +1105,387 @@ declare enum ErrorCode {
1258
1105
  */
1259
1106
  RC_UDP_DISCONNECTED = 32011,
1260
1107
  /**
1261
- * 链接被服务器中断,可能原因是运营商认为此链接非法或无效,直接断开 出现此错误码后,SDK 会自动触发重连,App 无需处理
1262
- * @since 5.7.0
1108
+ * TCP 连接重置
1263
1109
  */
1264
1110
  RC_TCP_RESET = 32054,
1265
1111
  /**
1266
- * 连接被拒绝
1267
- * @since 5.2.0
1268
- */
1269
- CONNECTION_REFUSED = 32061,
1270
- /**
1271
- * 将消息存储到本地数据时失败。 发送或插入消息时,消息需要存储到本地数据库,当存库失败时,会回调此错误码
1272
- * @since 5.2.0
1273
- */
1274
- PROTOCOL_MESSAGE_SAVED_ERROR = 33000,
1275
- /**
1276
- * 协议栈未初始化
1277
- * @since 5.2.0
1112
+ * 未调用 init 初始化函数。
1278
1113
  */
1279
1114
  BIZ_ERROR_CLIENT_NOT_INIT = 33001,
1280
1115
  /**
1281
- * 数据库错误
1282
- * @since 5.2.0
1116
+ * 数据库初始化失败。
1283
1117
  */
1284
1118
  BIZ_ERROR_DATABASE_ERROR = 33002,
1285
1119
  /**
1286
- * 开发者接口调用时传入的参数错误
1287
- * @since 5.2.0
1120
+ * 传入参数无效。
1288
1121
  */
1289
1122
  BIZ_ERROR_INVALID_PARAMETER = 33003,
1290
1123
  /**
1291
- * 通道无效
1124
+ * 通道无效。
1292
1125
  */
1293
1126
  BIZ_ERROR_NO_CHANNEL = 33004,
1294
1127
  /**
1295
- * 重新连接成功
1128
+ * 重新连接成功。
1296
1129
  */
1297
1130
  BIZ_ERROR_RECONNECT_SUCCESS = 33005,
1298
1131
  /**
1299
- * 连接中,再调用 connect 被拒绝
1132
+ * 连接中,再调用 connect 被拒绝。
1300
1133
  */
1301
1134
  BIZ_ERROR_CONNECTING = 33006,
1302
1135
  /**
1303
- * 历史消息云存储业务未开通
1304
- * @since 5.2.0
1136
+ * 消息漫游服务未开通
1305
1137
  */
1306
1138
  MSG_ROAMING_SERVICE_UNAVAILABLE = 33007,
1307
1139
  /**
1308
1140
  * 消息存入本地数据库失败
1309
- * @since 5.2.0
1310
1141
  */
1311
1142
  MSG_INSERT_ERROR = 33008,
1312
1143
  /**
1313
- * 聊天室被回收
1314
- * @since 5.2.0
1144
+ * 删除本地消息失败
1315
1145
  */
1316
1146
  MSG_DEL_ERROR = 33009,
1317
- /**
1318
- * 标签不存在
1319
- * @solution 建议用户使用 RongIMLib.addTag 先创建标签,再添加会话到标签中
1320
- * @since 5.2.0
1321
- */
1322
- TAG_NOT_EXIST = 33100,
1323
1147
  /**
1324
1148
  * 标签已存在
1325
- * @since 5.2.0
1326
1149
  */
1327
1150
  TAG_EXISTS = 33101,
1328
1151
  /**
1329
- * 标签不在会话中
1330
- * @since 5.2.0
1152
+ * 标签不存在
1153
+ */
1154
+ TAG_NOT_EXIST = 33100,
1155
+ /**
1156
+ * 会话中不存在此标签
1331
1157
  */
1332
1158
  NO_TAG_IN_CONVER = 33102,
1333
1159
  /**
1334
1160
  * 连接已存在
1335
- * @since 5.2.0
1336
1161
  */
1337
1162
  RC_CONNECTION_EXIST = 34001,
1338
1163
  /**
1339
- * 连接环境不正确
1340
- * @since 5.2.0
1164
+ * 拉取历史消息
1165
+ * @deprecated
1341
1166
  */
1342
- PACKAGE_ENVIRONMENT_ERROR = 34005,
1167
+ CONVER_GETLIST_ERROR = 34002,
1343
1168
  /**
1344
- * 连接超时
1345
- * @since 5.2.0
1169
+ * 会话指定异常
1170
+ * @deprecated
1346
1171
  */
1347
- CONNECTION_TIMEOUT = 34006,
1172
+ CONVER_SETOP_ERROR = 34003,
1348
1173
  /**
1349
- * 消息不能被扩展,只支持单群聊,其他类型消息会返回此错误,消息在发送时,Message 对象的属性 canIncludeExpansion 置为 true 才能进行扩展
1350
- * @since 5.2.0
1174
+ * 获取会话未读消息总数失败
1175
+ * @deprecated
1351
1176
  */
1352
- MESSAGE_KV_NOT_SUPPORT = 34008,
1177
+ CONVER_TOTAL_UNREAD_ERROR = 34004,
1353
1178
  /**
1354
- * 消息扩展失败,一般是网络原因导致的,请确保网络状态良好,并且融云 SDK 连接正常
1355
- * @since 5.2.0
1179
+ * 获取指定会话类型未读消息数异常
1180
+ * @deprecated
1356
1181
  */
1357
- MESSAGE_EXPANDED_ERROR = 34009,
1182
+ CONVER_TYPE_UNREAD_ERROR = 34005,
1358
1183
  /**
1359
- * 消息扩展大小超出限制, 默认消息扩展字典 key 长度不超过 32 个字符,value 长度不超过 4096 个字符,设置的 Expansion 键值对不超过 300 个
1360
- * @since 5.2.0
1184
+ * 获取指定用户ID&会话类型未读消息数异常
1185
+ * @deprecated
1186
+ */
1187
+ CONVER_ID_TYPE_UNREAD_ERROR = 34006,
1188
+ /**
1189
+ * 扩展存储 key value 超出限制 (错误码与移动端对齐)
1361
1190
  */
1362
1191
  EXPANSION_LIMIT_EXCEET = 34010,
1363
1192
  /**
1364
- * 媒体消息媒体文件 http 上传失败
1365
- * @since 5.2.0
1193
+ * 消息不支持扩展,原消息 canIncludeExpansion 值为 false (错误码与移动端对齐)
1194
+ */
1195
+ MESSAGE_KV_NOT_SUPPORT = 34008,
1196
+ /**
1197
+ * 上传失败
1366
1198
  */
1367
1199
  UPLOAD_FAIL = 34011,
1368
1200
  /**
1369
- * 标签中添加/删除的会话数量超限,最多支持添加/删除 1000 个会话
1370
- * @since 5.2.0
1201
+ * 会话数量超出上限
1371
1202
  */
1372
1203
  CONVER_OUT_LIMIT_ERROR = 34013,
1373
1204
  /**
1374
- * 群已读回执版本不支持
1375
- * @since 5.2.0
1205
+ * 获取会话失败
1376
1206
  */
1377
- READ_RECEIPT_ERROR = 34014,
1207
+ CONVER_GET_ERROR = 35021,
1378
1208
  /**
1379
- * 用户级别设置未开通
1380
- * @since 5.2.0
1209
+ * 群组信息异常
1210
+ * @deprecated 没有使用
1381
1211
  */
1382
- PUSH_CONTENT_CONFIG_SERVICE_UNAVAILABLE = 34016,
1212
+ GROUP_SYNC_ERROR = 35001,
1383
1213
  /**
1384
- * 消息拦截器处理接口返回的消息为空
1385
- * @since 5.2.0
1214
+ * 匹配群信息异常
1215
+ * @deprecated 没有使用
1386
1216
  */
1387
- MESSAGE_INTERCEPTION_PRODUCED_NULL_MESSAGE = 34017,
1217
+ GROUP_MATCH_ERROR = 35002,
1388
1218
  /**
1389
- * 消息未被注册
1390
- * @since 5.2.0
1219
+ * 已读回执方法调用错误(导航开关为1时调用新接口,否则调用sendMessage)
1391
1220
  */
1392
- MESSAGE_NOT_REGISTERED = 34021,
1221
+ READ_RECEIPT_ERROR = 35003,
1393
1222
  /**
1394
- * 该接口不支持超级群会话
1395
- * @since 5.2.0
1223
+ * 公有云包不允许连接私有云环境
1396
1224
  */
1397
- METHOD_NOT_SUPPORT = 34022,
1225
+ PACKAGE_ENVIRONMENT_ERROR = 35006,
1398
1226
  /**
1399
- * 超级群频道不存在
1400
- * @since 5.2.0
1227
+ * 已连接或者内部重连中,不允许调用重连,需先调用 disconnect 方法
1228
+ * @deprecated 没有使用
1401
1229
  */
1402
- ULTRA_GROUP_CHANNEL_NOT_EXIST = 34024,
1230
+ CAN_NOT_RECONNECT = 35007,
1403
1231
  /**
1404
- * 扩展消息失败,因为消息中的会话类别与接口支持的会话类别不一致
1405
- * @since 5.2.0
1232
+ * 无可用的 IM 服务地址
1406
1233
  */
1407
- INCONSISTENT_CONVERSATION_TYPE = 34025,
1234
+ SERVER_UNAVAILABLE = 35008,
1408
1235
  /**
1409
- * 开发者调用的接口不支持传入的会话类型
1236
+ * Web 端设置安全域名后,连接端域名不在安全域名范围内
1410
1237
  */
1411
- METHOD_ONLY_SUPPORT_ULTRA_GROUP = 34201,
1238
+ HOSTNAME_ERROR = 35009,
1412
1239
  /**
1413
- * 开发者接口调用时传入的 messageList 非法
1240
+ * 开启`禁止把已在线客户端踢下线`开关后,该错误码标识已有同类型端在线,禁止链接
1241
+ * @deprecated 没有使用
1414
1242
  */
1415
- MSG_LIMIT_ERROR = 34206,
1243
+ HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
1416
1244
  /**
1417
- * 非法的代理配置,RongIMProxy 为空或者非法
1418
- * @since 5.7.0
1245
+ * IM 在初次连接成功后,需立即同步消息,标记上线,然后获取全量超级群会话列表,列表同步完成前,所有超级群相关功能接口应不可用
1419
1246
  */
1420
- INVALID_PARAMETER_PROXY = 34238,
1247
+ METHOD_NOT_AVAILABLE = 35011,
1421
1248
  /**
1422
- * 开发者接口调用 testProxy 时传入的代理测试服务非法
1423
- * @since 5.7.0
1249
+ * 该功能不支持超级群
1424
1250
  */
1425
- INVALID_PARAMETER_TESTHOST = 34239,
1251
+ METHOD_NOT_SUPPORT = 35012,
1426
1252
  /**
1427
- * 开发者接口调用 testProxy 接口时无法联通
1428
- * @since 5.7.0
1253
+ * 消息数量没在范围内
1429
1254
  */
1430
- INVALID_CONNECT_TESTHOST_FAILED = 34240,
1255
+ MSG_LIMIT_ERROR = 35013,
1431
1256
  /**
1432
- * 设置的代理地址不可用
1257
+ * 该功能仅支持超级群
1433
1258
  */
1434
- RC_CONN_PROXY_UNAVAILABLE = 34245,
1259
+ METHOD_ONLY_SUPPORT_ULTRA_GROUP = 35014,
1435
1260
  /**
1436
- * 主进程内方法错误
1261
+ * 加入聊天室Id为空
1262
+ * @deprecated
1437
1263
  */
1438
- MAIN_PROCESS_ERROR = 35001,
1264
+ CHATROOM_ID_ISNULL = 36001,
1265
+ /**
1266
+ * 加入聊天室失败
1267
+ * @deprecated
1268
+ */
1269
+ CHARTOOM_JOIN_ERROR = 36002,
1270
+ /**
1271
+ * 拉取聊天室历史消息失败
1272
+ * @deprecated
1273
+ */
1274
+ CHATROOM_HISMESSAGE_ERROR = 36003,
1275
+ /**
1276
+ * 聊天室 kv 未找到
1277
+ * @deprecated
1278
+ */
1279
+ CHATROOM_KV_NOT_FOUND = 36004,
1280
+ /**
1281
+ * 加入黑名单异常
1282
+ * @deprecated
1283
+ */
1284
+ BLACK_ADD_ERROR = 37001,
1285
+ /**
1286
+ * 获得指定人员再黑名单中的状态异常
1287
+ * @deprecated
1288
+ */
1289
+ BLACK_GETSTATUS_ERROR = 37002,
1290
+ /**
1291
+ * 移除黑名单异常
1292
+ * @deprecated
1293
+ */
1294
+ BLACK_REMOVE_ERROR = 37003,
1295
+ /**
1296
+ * 获取草稿失败
1297
+ * @deprecated
1298
+ */
1299
+ DRAF_GET_ERROR = 38001,
1439
1300
  /**
1440
1301
  * 保存草稿失败
1441
1302
  */
1442
- DRAFT_SAVE_ERROR = 35002,
1303
+ DRAF_SAVE_ERROR = 38002,
1443
1304
  /**
1444
1305
  * 删除草稿失败
1445
1306
  */
1446
- DRAFT_REMOVE_ERROR = 35003,
1307
+ DRAF_REMOVE_ERROR = 38003,
1308
+ /**
1309
+ * 关注公众号失败
1310
+ * @deprecated
1311
+ */
1312
+ SUBSCRIBE_ERROR = 39001,
1447
1313
  /**
1448
1314
  * 方法未支持
1449
1315
  */
1450
- NOT_SUPPORT = 35004,
1316
+ NOT_SUPPORT = 39002,
1451
1317
  /**
1452
- * 删除会话失败
1318
+ * 关注公众号失败
1319
+ * @deprecated
1453
1320
  */
1454
- CONVER_REMOVE_ERROR = 35005,
1321
+ QNTKN_FILETYPE_ERROR = 41001,
1455
1322
  /**
1456
- * 无可用的 IM 服务地址
1323
+ * 获取七牛token失败
1324
+ * @deprecated
1457
1325
  */
1458
- SERVER_UNAVAILABLE = 35008,
1326
+ QNTKN_GET_ERROR = 41002,
1459
1327
  /**
1460
- * IM 在初次连接成功后,需立即同步消息,标记上线,然后获取全量超级群会话列表,列表同步完成前,所有超级群相关功能接口应不可用
1328
+ * cookie被禁用
1329
+ * @deprecated
1461
1330
  */
1462
- METHOD_NOT_AVAILABLE = 35011,
1331
+ COOKIE_ENABLE = 51001,
1463
1332
  /**
1464
- * 获取会话失败
1333
+ * 没有注册DeviveId 也就是用户没有登陆
1334
+ *
1465
1335
  */
1466
- CONVER_GET_ERROR = 35021,
1336
+ HAVNODEVICEID = 24001,
1337
+ /**
1338
+ * 已经存在
1339
+ *
1340
+ */
1341
+ DEVICEIDISHAVE = 24002,
1342
+ /**
1343
+ * 没有对应的用户或token
1344
+ *
1345
+ */
1346
+ FEILD = 24009,
1347
+ /**
1348
+ * voip为空
1349
+ *
1350
+ */
1351
+ VOIPISNULL = 24013,
1352
+ /**
1353
+ * 不支持的Voip引擎
1354
+ */
1355
+ NOENGINETYPE = 24010,
1356
+ /**
1357
+ * channleName 是空
1358
+ */
1359
+ NULLCHANNELNAME = 24011,
1360
+ /**
1361
+ * 生成Voipkey失败
1362
+ */
1363
+ VOIPDYANMICERROR = 24012,
1364
+ /**
1365
+ * 没有配置voip
1366
+ */
1367
+ NOVOIP = 24014,
1368
+ /**
1369
+ * 服务器内部错误
1370
+ */
1371
+ INTERNALERRROR = 24015,
1372
+ /**
1373
+ * VOIP close
1374
+ */
1375
+ VOIPCLOSE = 24016,
1376
+ /**
1377
+ * 用户不在超级群私有频道白名单中
1378
+ */
1379
+ ULTRA_GROUP_USER_NOT_IN_PRIVATE_CHANNEL = 24416,
1380
+ /**
1381
+ * 己方取消已发出的通话请求
1382
+ * @deprecated
1383
+ */
1384
+ CANCEL = 1,
1385
+ /**
1386
+ * 己方拒绝收到的通话请求
1387
+ * @deprecated
1388
+ */
1389
+ REJECT = 2,
1390
+ /**
1391
+ * 己方挂断
1392
+ * @deprecated
1393
+ */
1394
+ HANGUP = 3,
1395
+ /**
1396
+ * 己方忙碌
1397
+ * @deprecated
1398
+ */
1399
+ BUSYLINE = 4,
1400
+ /**
1401
+ * 己方未接听
1402
+ * @deprecated
1403
+ */
1404
+ NO_RESPONSE = 5,
1405
+ /**
1406
+ * 己方不支持当前引擎
1407
+ * @deprecated
1408
+ */
1409
+ ENGINE_UN_SUPPORTED = 6,
1410
+ /**
1411
+ * 己方网络出错
1412
+ * @deprecated
1413
+ */
1414
+ NETWORK_ERROR = 7,
1415
+ /**
1416
+ * 对方取消已发出的通话请求
1417
+ * @deprecated
1418
+ */
1419
+ REMOTE_CANCEL = 11,
1420
+ /**
1421
+ * 对方拒绝收到的通话请求
1422
+ * @deprecated
1423
+ */
1424
+ REMOTE_REJECT = 12,
1425
+ /**
1426
+ * 通话过程对方挂断
1427
+ * @deprecated
1428
+ */
1429
+ REMOTE_HANGUP = 13,
1430
+ /**
1431
+ * 对方忙碌
1432
+ * @deprecated
1433
+ */
1434
+ REMOTE_BUSYLINE = 14,
1435
+ /**
1436
+ * 对方未接听
1437
+ * @deprecated
1438
+ */
1439
+ REMOTE_NO_RESPONSE = 15,
1440
+ /**
1441
+ * 对方网络错误
1442
+ * @deprecated
1443
+ */
1444
+ REMOTE_ENGINE_UN_SUPPORTED = 16,
1445
+ /**
1446
+ * 对方网络错误
1447
+ * @deprecated
1448
+ */
1449
+ REMOTE_NETWORK_ERROR = 17,
1450
+ /**
1451
+ * VoIP 不可用
1452
+ * @deprecated
1453
+ */
1454
+ VOIP_NOT_AVALIABLE = 18,
1455
+ /**
1456
+ * 聊天室批量设置kv部分不成功
1457
+ */
1458
+ CHATROOM_KV_STORE_NOT_ALL_SUCCESS = 23428,
1459
+ /**
1460
+ * 聊天室设置批量kv,一次不能超过10个
1461
+ */
1462
+ CHATROOM_KV_STORE_OUT_LIMIT = 23429,
1467
1463
  /**
1468
1464
  * 搜索字段对应消息错误
1469
1465
  */
1470
- SEARCH_PROPS_LIMIT_ERROR = 35022
1466
+ SEARCH_PROPS_LIMIT_ERROR = 35022,
1467
+ /**
1468
+ * 非法的代理配置,RongIMProxy 为空或者非法
1469
+ */
1470
+ INVALID_PARAMETER_PROXY = 34238,
1471
+ /**
1472
+ * 代理测试服务地址为空或者非法
1473
+ */
1474
+ INVALID_PARAMETER_TESTHOST = 34239,
1475
+ /**
1476
+ * 开发者接口调用 testProxy 接口时无法联通
1477
+ */
1478
+ INVALID_CONNECT_TESTHOST_FAILED = 34240,
1479
+ /**
1480
+ * 开发者调用 connect 时 proxy 服务设置失败
1481
+ * 移动端使用的为 31028,但web 端此状态码已经被占用,所以改为 web 端使用号码段 35XXX
1482
+ * @discussion 设置 setProxy 接口不可在连接或正在连接中的状态调用。
1483
+ */
1484
+ RC_CONN_PROXY_UNAVAILABLE = 35028,
1485
+ /**
1486
+ * proxy 服务不可用
1487
+ */
1488
+ PROXY_UNAVAILABLE = 17
1471
1489
  }
1472
1490
 
1473
1491
  /**
@@ -4840,9 +4858,6 @@ interface IEngine {
4840
4858
  * 批量设置会话 置顶、免打扰
4841
4859
  */
4842
4860
  batchSetConversationStatus(statusList: ISetConversationStatusOptions[]): Promise<ErrorCode>;
4843
- setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel: NotificationLevel, channelId?: string): Promise<number>;
4844
- getConversationNotificationLevel(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationLevel>;
4845
- getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[], isMentioned?: boolean): Promise<IAsyncRes<number>>;
4846
4861
  sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions, onBefore?: (messageId: number) => void, traceId?: string): IPromiseResult<IReceivedMessage>;
4847
4862
  /**
4848
4863
  * 断开连接
@@ -7880,7 +7895,6 @@ declare abstract class AEngine {
7880
7895
  * @deprecated 已废弃,请使用 getConversationNotificationLevel
7881
7896
  */
7882
7897
  abstract getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
7883
- abstract setConversationNotificationLevel(conversationType: ConversationType, targetId: string, notificationLevel?: NotificationLevel, channelId?: string): Promise<ErrorCode>;
7884
7898
  /**
7885
7899
  * 获取会话免打扰状态
7886
7900
  * 旧:getConversationNotificationStatus