@rongcloud/engine 5.0.1-custom-qihoo.3 → 5.0.2

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.0.1-custom-qihoo.3
- * CommitId - f511810a05b1ef295d16225d99189c244ea0fdfc
- * Wed Nov 24 2021 15:31:55 GMT+0800 (China Standard Time)
+ * RCEngine - v5.0.2
+ * CommitId - 2f7e168dbfa90aeb36ded32505fa5b07d1fde72f
+ * Thu Dec 30 2021 14:14:19 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -738,12 +738,17 @@ interface IUserProfile {
     name?: string;
     /**
      * 用户头像地址
+     * @deprecated
      */
     portraitUri?: string;
     /**
      * user info 中附加信息
      */
     extra?: string;
+    /**
+     * 用户头像地址（向移动端兼容）
+     */
+    portrait?: string;
 }
 interface IRecallMsgOptions {
     /**
@@ -876,6 +881,10 @@ interface ISendMsgOptions {
      * 20 个字符长度限制
     */
     channelId?: string;
+    /**
+     * 客户端的消息标识
+     */
+    messageId?: string;
 }
 interface IInsertMsgOptions {
     senderUserId: string;
@@ -933,6 +942,7 @@ interface IBlockedMessageInfo {
     blockedMessageUId: string;
     conversationType: number;
     targetId: string;
+    channelId: string;
     blockType: MessageBlockType;
 }
 
@@ -1269,7 +1279,7 @@ declare enum ErrorCode {
     */
     EXPANSION_LIMIT_EXCEET = 34010,
     /**
-     * 消息不支持扩展 (错误码与移动端对齐)
+     * 消息不支持扩展，原消息 canIncludeExpansion 值为 false (错误码与移动端对齐)
     */
     MESSAGE_KV_NOT_SUPPORT = 34008,
     CLEAR_HIS_TIME_ERROR = 34011,
@@ -2163,6 +2173,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
         key: string;
         value: string;
     }[];
+    kvEntries: IServerRTCRoomEntry[];
 }
 interface KVString {
     [key: string]: string;
@@ -2231,9 +2242,9 @@ interface IRequest {
      */
     timeout?: number;
     /**
-     * 返回数据类型，目前仅用于alipay
+     * 期望返回的数据格式，如果为 json 则返回后会对返回的数据进行一次 JSON.parse, 在小程序平台需要
      */
-    dataType?: string;
+    dataType?: 'json' | 'text' | 'base64' | 'arraybuffer';
 }
 interface IStorage {
     setItem(key: string, value: string): void;
@@ -3684,6 +3695,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;
     /**
      * 当前累计心跳超时次数
      */
@@ -3733,6 +3748,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>;
@@ -4078,6 +4094,10 @@ declare class APIContext {
      * 清除会话消息未读数
      */
     clearUnreadCount(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话消息未读数
+     */
+    clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取指定会话消息未读数
      */
@@ -4843,6 +4863,10 @@ declare abstract class AEngine implements IEngine {
      * 清除指定会话未读数
      */
     abstract clearConversationUnreadCount(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
+    /**
+     * 清除全部会话未读数
+     */
+    abstract clearAllUnreadCount(): Promise<ErrorCode>;
     /**
      * 获取第一个未读消息
      */
@@ -5698,4 +5722,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, IChatRoomEntries, IChatRoomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, 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, 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, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, 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, 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 };