@rongcloud/engine 4.5.0 → 4.5.4-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v4.5.0
- * CommitId - 6173fb54cb501bbee4d58e1141394bbe6918faa5
- * Fri Oct 22 2021 14:19:17 GMT+0800 (China Standard Time)
+ * RCEngine - v4.5.4-alpha.1
+ * CommitId - d1ef74bf72f4e0ee7c6b727b0c7358824c4c5d6e
+ * Thu Dec 23 2021 18:35:11 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -365,6 +365,13 @@ interface IConversationOption {
     targetId: string;
     channelId?: string;
 }
+interface IServerRTCRoomEntry {
+    key: string;
+    value: string;
+    status: number;
+    timestamp: number;
+    uid: string;
+}
 interface IChrmKVEntry {
     key: string;
     value?: string;
@@ -432,13 +439,6 @@ interface IGetConversationListOption {
 interface IClearMsgOption {
     timestamp?: number;
 }
-interface IServerRTCRoomEntry {
-    key: string;
-    value: string;
-    status: number;
-    timestamp: number;
-    uid: string;
-}
 
 /**
  *  聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
@@ -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>;
@@ -2306,6 +2320,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
         key: string;
         value: string;
     }[];
+    kvEntries: IServerRTCRoomEntry[];
 }
 
 /**
@@ -2935,6 +2950,24 @@ declare enum LogType {
     RTC = "RTC"
 }
 
+/**
+ * 消息被拦截类型
+ */
+declare enum MessageBlockType {
+    /*!
+    全局敏感词：命中了融云内置的全局敏感词
+   */
+    GLOBAL = 1,
+    /*!
+     自定义敏感词拦截：命中了客户在融云自定义的敏感词
+    */
+    CUSTOM = 2,
+    /*!
+     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
+    */
+    THIRD_PARTY = 3
+}
+
 /**
  * 导航信息数据就结构
  */
@@ -3186,24 +3219,6 @@ interface ITypingMessage {
     list: Array<ITypingUser>;
 }
 
-/**
- * 消息被拦截类型
- */
-declare enum MessageBlockType {
-    /*!
-    全局敏感词：命中了融云内置的全局敏感词
-   */
-    GLOBAL = 1,
-    /*!
-     自定义敏感词拦截：命中了客户在融云自定义的敏感词
-    */
-    CUSTOM = 2,
-    /*!
-     第三方审核拦截：命中了第三方（数美）或模板路由决定不下发的状态
-    */
-    THIRD_PARTY = 3
-}
-
 /**
  * 被拦截的消息信息
  */
@@ -3211,6 +3226,7 @@ interface IBlockedMessageInfo {
     blockedMessageUId: string;
     conversationType: number;
     targetId: string;
+    channelId: string;
     blockType: MessageBlockType;
 }
 
@@ -5594,4 +5610,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 };