@rongcloud/engine 5.3.0 → 5.3.3

package/index.d.ts

@@ -820,6 +820,10 @@ interface IRecallMsgOptions {
        * 其他拓展信息
        */
     extra?: string;
+    /**
+     * 是否删除原始消息(在移动端会使用到)，为 true 时移动端会不显示小灰条提示
+     */
+    isDelete?: boolean;
 }
 interface IRecallMsgContent {
     conversationType: number;
@@ -839,6 +843,10 @@ interface IRecallMsgContent {
      * 发送消息携带的用户信息
     */
     user?: IUserProfile;
+    /**
+     * 是否删除原始消息(在移动端会使用到)，为 true 时移动端会不显示小灰条提示
+     */
+    isDelete?: boolean;
 }
 /**
  * 发送消息时的可选项信息
@@ -1066,6 +1074,7 @@ interface IBlockedMessageInfo {
     targetId: string;
     channelId: string;
     blockType: MessageBlockType;
+    extra: any;
 }
 
 /**
@@ -1646,7 +1655,7 @@ declare enum NotificationLevel {
     /**
     * @ 群全员通知
     */
-    AT_GROUP_ALL_USER_NOFICATION = 4,
+    AT_GROUP_ALL_USER_NOTIFICATION = 4,
     /**
     * 消息通知被屏蔽，即不接收消息通知
     */
@@ -2379,6 +2388,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
         value: string;
     }[];
     kvEntries: IServerRTCRoomEntry[];
+    offlineKickTime: number;
 }
 interface KVString {
     [key: string]: string;
@@ -3101,6 +3111,7 @@ interface IEngine {
      * @param reconnectKickEnable
      */
     connect(token: string, naviInfo: INaviInfo, reconnectKickEnable?: boolean): Promise<ErrorCode>;
+    requestNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
     /**
      * 上报版本信息
      * @param version
@@ -5276,34 +5287,6 @@ declare class RTCPluginContext extends PluginContext {
     endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
 }
 
-declare abstract class ANavi {
-    protected readonly _runtime: IRuntime;
-    protected readonly _options: IAPIContextOption;
-    protected readonly _apiVersion: string;
-    protected readonly _appkey: string;
-    protected _naviInfo: INaviInfo | null;
-    constructor(_runtime: IRuntime, _options: IAPIContextOption);
-    /**
-     * @param uris
-     * @param appkey
-     * @param token
-     */
-    protected abstract _reqNavi(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
-    /**
-     * 获取导航数据
-     * @param token
-     * @param dynamicUris token 携带的动态导航地址
-     * @param force 是否强制重新获取并清空缓存数据
-     */
-    getInfo(token: string, dynamicUris: string[], force: boolean, checkCA?: boolean): Promise<INaviInfo | null>;
-    protected setNaviInfo2Cache(token: string, naviInfo: INaviInfo): void;
-    getInfoFromCache(token: string): INaviInfo | null;
-    /**
-     * 清空导航数据：内存数据、缓存数据
-     */
-    private _clear;
-}
-
 interface IEngineWatcher {
     /**
      * @param message 消息
@@ -5335,23 +5318,33 @@ declare abstract class AEngine implements IEngine {
     readonly runtime: IRuntime;
     protected readonly _watcher: IEngineWatcher;
     protected readonly _options: IAPIContextOption;
-    /**
-     * 当前用户 Id
-     */
-    currentUserId: string;
     /**
      * 连接时间
     */
     abstract getConnectedTime(): number;
-    readonly navi: ANavi;
     protected readonly _appkey: string;
     protected readonly _apiVer: string;
+    protected readonly _apiVersion: string;
+    protected _naviInfo: INaviInfo | null;
     /**
      * 引擎初始化
      * @param _appkey
      */
     constructor(runtime: IRuntime, _watcher: IEngineWatcher, _options: IAPIContextOption);
-    protected abstract _createNavi(): ANavi;
+    abstract requestNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
+    /**
+     * 获取导航数据
+     * @param token
+     * @param dynamicUris token 携带的动态导航地址
+     * @param force 是否强制重新获取并清空缓存数据
+     */
+    getNaviInfo(token: string, dynamicUris: string[], force: boolean, checkCA?: boolean): Promise<INaviInfo | null>;
+    protected setNaviInfo2Cache(token: string, naviInfo: INaviInfo): void;
+    getInfoFromCache(token: string): INaviInfo | null;
+    /**
+     * 清空导航数据：内存数据、缓存数据
+     */
+    private _clear;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
      * 对于未实现的方法，接口响应 Unsupport 错误码
@@ -6541,6 +6534,10 @@ declare const MAX_MESSAGE_CONTENT_BYTES: number;
  * IM Comet 发送 pullmsg(嗅探 + 等待信令) 超时时间 45s
  */
 declare const IM_COMET_PULLMSG_TIMEOUT = 45000;
+/**
+ * IM 加入聊天室后定时拉取消息和 KV 时间间隔
+ */
+declare const IM_CHATROOM_PULL_INTERVAL_TIME: number;
 /**
  * storage key 使用的前缀
 */
@@ -6586,4 +6583,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, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IInsertMsgOptions, IIsValidExpansion, 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, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRecallMsgContent, 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, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, OperateStatus, 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 };
+export { AEngine, 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, IGetMsgOption, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_CHATROOM_PULL_INTERVAL_TIME, 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, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRecallMsgContent, 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, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, OperateStatus, 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 };