@rongcloud/engine 4.5.2 → 4.5.5

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.5.2
- * CommitId - ba81ca4a531f2c59a5e2f0cecb5e05aab7e03210
- * Thu Nov 25 2021 10:37:04 GMT+0800 (China Standard Time)
+ * RCEngine - v4.5.5
+ * CommitId - 995181d9e191b32bf0910367a205e604999e026a
+ * Wed Jan 26 2022 11:32:58 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -558,12 +558,17 @@ interface IUserProfile {
     name?: string;
     /**
      * 用户头像地址
+     * @deprecated
      */
     portraitUri?: string;
     /**
      * user info 中附加信息
      */
     extra?: string;
+    /**
+     * 用户头像地址（向移动端兼容）
+     */
+    portrait?: string;
 }
 /**
  * 发送消息时的可选项信息
@@ -1733,6 +1738,10 @@ interface IRequest {
      * @default 10 * 1000 毫秒
      */
     timeout?: number;
+    /**
+     * 期望返回的数据格式，如果为 json 则返回后会对返回的数据进行一次 JSON.parse, 在小程序平台需要
+     */
+    dataType?: 'json' | 'text' | 'base64' | 'arraybuffer';
 }
 interface IStorage {
     setItem(key: string, value: string): void;
@@ -1852,6 +1861,10 @@ declare class WebSocketChannel extends ADataChannel {
      * @param apiVersion - apiVersion 需符合 `/\d+(\.\d+){2}/` 规则
      */
     connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string, protocolVer: ConnAckProtocolVer): Promise<ErrorCode>;
+    /**
+     * 发起连接请求
+     */
+    private _connect;
     /**
      * 当前累计心跳超时次数
      */
@@ -1901,6 +1914,7 @@ declare class CometChannel extends ADataChannel {
      * @returns
      */
     connect(appkey: string, token: string, hosts: string[], protocol: 'http' | 'https', apiVersion: string, protocolVer: ConnAckProtocolVer): Promise<ErrorCode>;
+    private _connect;
     private _idCount;
     private _generateMessageId;
     sendCometData(writer: BaseWriter, timeout?: number): Promise<void>;
@@ -2936,6 +2950,24 @@ declare enum LogType {
     RTC = "RTC"
 }
 
+/**
+ * 消息被拦截类型
+ */
+declare enum MessageBlockType {
+    /*!
+    全局敏感词：命中了融云内置的全局敏感词
+   */
+    GLOBAL = 1,
+    /*!
+     自定义敏感词拦截：命中了客户在融云自定义的敏感词
+    */
+    CUSTOM = 2,
+    /*!
+     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
+    */
+    THIRD_PARTY = 3
+}
+
 /**
  * 导航信息数据就结构
  */
@@ -3187,24 +3219,6 @@ interface ITypingMessage {
     list: Array<ITypingUser>;
 }
 
-/**
- * 消息被拦截类型
- */
-declare enum MessageBlockType {
-    /*!
-    全局敏感词：命中了融云内置的全局敏感词
-   */
-    GLOBAL = 1,
-    /*!
-     自定义敏感词拦截：命中了客户在融云自定义的敏感词
-    */
-    CUSTOM = 2,
-    /*!
-     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
-    */
-    THIRD_PARTY = 3
-}
-
 /**
  * 被拦截的消息信息
  */
@@ -3212,6 +3226,7 @@ interface IBlockedMessageInfo {
     blockedMessageUId: string;
     conversationType: number;
     targetId: string;
+    channelId: string;
     blockType: MessageBlockType;
 }
 
@@ -3490,14 +3505,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;
     /**
      * 获取当前缓存的导航数据
@@ -3578,6 +3601,10 @@ declare class APIContext {
      * 清除会话消息未读数
      */
     clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话消息未读数
+     */
+    clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取指定会话消息未读数
      */
@@ -3961,8 +3988,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
@@ -4638,8 +4666,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
@@ -4760,6 +4789,10 @@ declare abstract class AEngine implements IEngine {
      * 清除指定会话未读数
      */
     abstract clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话未读数
+     */
+    abstract clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取第一个未读消息
      */
@@ -5595,4 +5628,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, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEngine, IEngineWatcher, 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, IMessageBlockedListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntriesOption, IRemoveChatRoomEntryOption, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, 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, 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, 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, IBlockedMessageInfo, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEngine, IEngineWatcher, 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, IMessageBlockedListener, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntriesOption, IRemoveChatRoomEntryOption, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, 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, 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 };