@rongcloud/engine 5.2.0-alpha.1 → 5.2.1-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.2.0-alpha.1
- * CommitId - 68fc235a96486a3750698a56d22643a1093aa1c5
- * Tue Jan 18 2022 19:55:05 GMT+0800 (China Standard Time)
+ * RCEngine - v5.2.1-alpha.1
+ * CommitId - c92d4d82612fce55930384270b7c9e99cba689a2
+ * Mon Mar 07 2022 10:08:54 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -1432,6 +1432,10 @@ declare enum ErrorCode {
      * 消息数量没在范围内
      */
     MSG_LIMIT_ERROR = 35013,
+    /**
+     * 该功能仅支持超级群
+     */
+    METHOD_ONLY_SUPPORT_ULTRA_GROUP = 35014,
     /**
      * 上传文件失败
      */
@@ -1793,6 +1797,10 @@ interface IBaseConversationInfo {
     targetId: string;
     channelId: string;
 }
+interface IConversationState extends IBaseConversationInfo {
+    unreadCount: number;
+    unreadMentionedCount: number;
+}
 
 /**
  * 导航信息数据就结构
@@ -2281,6 +2289,10 @@ interface IRTCUsers {
              * 发布的资源数据，是一个 JSON 字符串，解析后为发布的资源列表
              */
             uris?: string;
+            /**
+             * 加房间的身份标识，保存主房间 roomId
+             */
+            extra?: string;
         };
     };
 }
@@ -2296,6 +2308,12 @@ interface IJoinRTCRoomData extends IRTCUsers {
 interface KVString {
     [key: string]: string;
 }
+/**
+ * 设置 RTC 人员 inner、outer 数据
+ */
+interface IRTCUserData {
+    [key: string]: string;
+}
 
 interface IAsyncRes<T = any> {
     /**
@@ -2973,8 +2991,9 @@ interface IEngine {
      * 建立连接
      * @param token
      * @param naviInfo
+     * @param reconnectKickEnable
      */
-    connect(token: string, naviInfo: INaviInfo, versionInfo: string): Promise<ErrorCode>;
+    connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
     /**
      * 上报版本信息
      * @param version
@@ -3149,8 +3168,9 @@ interface IEngine {
      * @param isPersited 是否存储
      * @param isCounted 是否技术
      * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @param isStatusMessage 是否是状态消息
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[], isStatusMessage: boolean): void;
     /**
      * 加入聊天室
      * @param count 拉取消息数量
@@ -3434,7 +3454,7 @@ interface IEngine {
      * 获取所有群聊会话 @ 消息未读数
      */
     getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
-    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
     getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
@@ -3841,7 +3861,7 @@ declare class DataCodec {
     /**
      * 加入 RTC 房间
      */
-    encodeJoinRTCRoom(mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType): any[];
+    encodeJoinRTCRoom(mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): any[];
     /**
      * 退出 RTC 房间
      */
@@ -4129,8 +4149,8 @@ interface IWatcher {
     pullFinished?: ITagListener;
     onConnecting?: () => void;
     onConnected?: () => void;
-    onDisconnect?: () => void;
-    onSuspend?: () => void;
+    onDisconnect?: (status: ConnectionStatus) => void;
+    onSuspend?: (status: ConnectionStatus | ErrorCode) => void;
     readReceiptReceived?: (conversation: IConversationOption, messageUId: string, sentTime: number) => void;
     messageReceiptRequest?: (conversation: IConversationOption, messageUId: string, senderUserId: string) => void;
     messageReceiptResponse?: (conversation: IConversationOption, receivedUserId: string, messageUIdList: string[]) => void;
@@ -4252,8 +4272,8 @@ declare class APIContext {
     private _connectionStatusListener;
     _handleConnecting(): void;
     _handleConnected(): void;
-    _handleDisconnect(): void;
-    _handleSuspend(): void;
+    _handleDisconnect(status: ConnectionStatus): void;
+    _handleSuspend(status: ConnectionStatus | ErrorCode): void;
     private _messageReceiver;
     _batchMessageReceiver(messages: IReceivedMessage[], leftCount?: number, hasMore?: boolean): void;
     /**
@@ -4320,14 +4340,22 @@ declare class APIContext {
      * 建立连接，连接失败则抛出异常，连接成功后返回用户 userId，否则返回相应的错误码
      * @param token
      * @param refreshNavi 是否需要重新请求导航，当值为 `false` 时，优先使用有效缓存导航，若缓存失效则重新获取导航
+     * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
+     *  同一个账号在一台新设备上登录的时候，会把这个账号在之前登录的设备上踢出。
+        由于 SDK 有断线重连功能，存在下面情况。
+        用户在 A 设备登录，A 设备网络不稳定，没有连接成功，SDK 启动重连机制。
+        用户此时又在 B 设备登录，B 设备连接成功。
+        A 设备网络稳定之后，用户在 A 设备连接成功，B 设备被踢出。
+        这个字段就是为这种情况加的。
+        设置 reconnectKickEnable 为 true 时，SDK 重连的时候发现此时已有别的设备连接成功，不再强行踢出已有设备，而是踢出重连设备。
      */
-    connect(token: string, refreshNavi?: boolean): Promise<IConnectResult>;
+    connect(token: string, refreshNavi?: boolean, reconnectKickEnable?: boolean): Promise<IConnectResult>;
     /**
      * 拉取实时配置 web 端需更新 voipCall 字段
      */
     private _pullUserSettings;
     disconnect(): Promise<void>;
-    reconnect(): Promise<IConnectResult>;
+    reconnect(reconnectKickEnable?: boolean): Promise<IConnectResult>;
     private _getTokenWithoutNavi;
     /**
      * 获取当前缓存的导航数据
@@ -4340,8 +4368,9 @@ declare class APIContext {
      * @param isPersited 是否存储
      * @param isCounted 是否技术
      * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @param isStatusMessage 是否是状态消息
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): void;
     /**
      * 发送消息
      * @param conversationType
@@ -4694,6 +4723,7 @@ declare class APIContext {
      * @param targetId
      */
     getUltraGroupUnreadMentionedCountByTargetId(targetId: string): Promise<IAsyncRes<number>>;
+    getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
      * 对于未实现的方法，接口响应 Unsupport 错误码
@@ -4800,7 +4830,7 @@ declare class APIContext {
      * @param mode 房间模式：直播 or 会议
      * @param mediaType 直播房间模式下的媒体资源类型
      */
-    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number, joinType?: RTCJoinType): Promise<IAsyncRes<IJoinRTCRoomData>>;
+    joinRTCRoom(roomId: string, mode: RTCMode, mediaType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): Promise<IAsyncRes<IJoinRTCRoomData>>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     rtcPing(roomId: string, mode: number, mediaType?: number): Promise<ErrorCode>;
     getRTCRoomInfo(roomId: string): Promise<IAsyncRes<IRTCRoomInfo>>;
@@ -4867,6 +4897,14 @@ declare class APIContext {
 declare class PluginContext {
     protected readonly _context: APIContext;
     constructor(_context: APIContext);
+    /**
+     * 获取 context
+     */
+    __getContext(): APIContext;
+    /**
+     * 获取当前的导航数据
+     */
+    getNaviInfo(): INaviInfo | null;
     /**
      * 接收 IM 服务推送的消息，并通过返回 boolean 值决定此消息是否拦截
      * @param message
@@ -4950,8 +4988,9 @@ declare class RTCPluginContext extends PluginContext {
      * @param roomId
      * @param mode 房间模式：直播 or 会议
      * @param broadcastType
+     * @param innerUserData 加副房间时的主房间 Id
      */
-    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType): IPromiseResult<IJoinRTCRoomData>;
+    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
     getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
@@ -5137,8 +5176,9 @@ declare abstract class AEngine implements IEngine {
      * 建立连接
      * @param token
      * @param naviInfo
+     * @param reconnectKickEnable
      */
-    abstract connect(token: string, naviInfo: INaviInfo): Promise<ErrorCode>;
+    abstract connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
     /**
      * 发送SDK版本
      * @param versionInfo
@@ -5323,8 +5363,9 @@ declare abstract class AEngine implements IEngine {
      * @param isPersited 是否存储
      * @param isCounted 是否技术
      * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @param isStatusMessage 是否是状态消息
      */
-    abstract registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
+    abstract registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[], isStatusMessage: boolean): void;
     /**
      * 加入聊天室
      * @param count 拉取消息数量
@@ -5668,7 +5709,11 @@ declare abstract class AEngine implements IEngine {
      * 获取所有群聊会话 @ 消息未读数
      */
     abstract getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
-    abstract joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType): IPromiseResult<IJoinRTCRoomData>;
+    /**
+     * 获取本地全部会话的状态
+     */
+    abstract getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
+    abstract joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
     abstract quitRTCRoom(roomId: string): Promise<ErrorCode>;
     abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
     abstract getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
@@ -5959,6 +6004,10 @@ declare const isValidConversationType: (conversation: number) => boolean;
  * 判断是否是一个有效的文件类型
  */
 declare const isValidFileType: (fileType: number) => boolean;
+/**
+ * 判断是否是一个合法的消息扩展
+ */
+declare const isValidExpansion: (expansion: any) => boolean;
 
 /**
  * 预定义的验证规则，只包含`值类型`数据验证
@@ -6181,4 +6230,4 @@ declare enum CONNECTION_TYPE {
  */
 declare const version: string;
 
-export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraExMsgOptions, IUltraModifyMsgOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };
+export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraExMsgOptions, IUltraModifyMsgOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };