@rongcloud/engine 5.5.1 → 5.5.3

package/index.d.ts

@@ -540,7 +540,7 @@ declare enum ErrorCode {
     /**
      * HTTP 请求失败。
      */
-    RC_HTTP_REQ_TIMEOUT = 30005,
+    RC_HTTP_REQ_FAIL = 30005,
     /**
      * HTTP 接收失败。
      */
@@ -992,7 +992,7 @@ declare enum ConnectionStatus {
      */
     APPKEY_IS_FAKE = 20,
     /**
-    * 其他端登录，本端禁止连接和重连
+    * Electron 中，其他端登录，本端禁止连接和重连
     */
     FORBID_RECONNECT_BY_OTHER_SAME_CLIENT = 31023,
     /**
@@ -1356,6 +1356,8 @@ declare enum LogTagId {
     L_CONNECT_S = "L-connect-S",
     P_CONNECT_O = "P-connect-O",
     P_CONNECT_S = "P-connect-S",
+    L_NOTIFY_ULTRA_ONLINE_S = "L-notify-ultra-online-S",
+    L_ULTRA_SYNC_DONE_S = "L-ultra-sync-done-S",
     A_SEND_MSG_T = "A-send_msg-T",
     A_SEND_MSG_R = "A-send_msg-R",
     P_SEND_MSG_T = "P-send_msg-T",
@@ -1413,7 +1415,10 @@ declare enum LogTagId {
      */
     L_PB_ENCODE_E = "L-pb-encode-E",
     L_PB_DECODE_E = "L-pb-decode-E",
-    L_NOTIFY_NAVI_CHANGE_E = "L-notify_navi_change-E"
+    L_NOTIFY_NAVI_CHANGE_E = "L-notify_navi_change-E",
+    L_REPORT_FULL_LOG_O = "L-report_full_log-O",
+    L_REPORT_FULL_LOG_T = "L-report_full_log-T",
+    L_REPORT_FULL_LOG_R = "L-report_full_log-R"
 }
 
 /**
@@ -2249,6 +2254,44 @@ interface IBlockedMessageInfo {
         [key: string]: any;
     };
 }
+/**
+ * 超级群获取指定会话未读 @ 消息列表参数
+*/
+interface IUltraGroupUnreadMentionedOption {
+    /**
+     * 会话 ID
+    */
+    targetId: string;
+    /**
+     * 频道 ID
+    */
+    channelId?: string;
+    /**
+     * 消息的时间戳，首次获取传 0， 后续查询传未读 @ 列表中的消息时间戳
+    */
+    sentTime: number;
+    /**
+     * 数据个数，最大50
+    */
+    count: number;
+}
+/**
+ * 超级群获取指定会话 @ 未读消息列表结果
+*/
+interface IUltraUnreadMsg {
+    /**
+     * 消息 ID
+    */
+    messageUId?: string;
+    /**
+     * 消息时间戳
+    */
+    sentTime: number;
+    /**
+     * @ 类型： 1 所有人；2: 部分人
+    */
+    mentionedType?: number;
+}
 
 /**
  * TODO: 确定对外暴露的必要性
@@ -2339,6 +2382,10 @@ interface IReceivedConversationByTag extends IReceivedConversation {
 }
 interface IUltraGroupConversation extends IReceivedConversation {
     channelType?: UltraGroupChannelType;
+    /**
+     * 第一条未读消息
+    */
+    firstUnreadMessage?: IUltraUnreadMsg | null;
 }
 /**
  * 设置会话状态 参数 信息
@@ -2433,6 +2480,13 @@ interface IUltraChannelDeleteInfo {
     channelType: UltraGroupChannelType;
     deleteTime: number;
 }
+/**
+ * 获取超级群获取指定会话未读 @ 消息列表
+*/
+interface IUltraUnreadConversation {
+    targetId: string;
+    channelId?: string;
+}
 
 /**
  * 导航信息数据就结构
@@ -2590,7 +2644,12 @@ interface INaviInfo {
     bosAddr?: string;
     /**
      * 阿里上传配置，字符串数组，数组顺序代表 七牛、百度、阿里云 上传权重
-     * @example "[{"qiniu":"upload.qiniup.com","p":"1"},{"baidu":"gz.bcebos.com","p":"2"},{"aliyun":"oss-cn-beijing.aliyuncs.com","p":"3"}]"
+     * @example
+     * ```
+     * `[{"qiniu":"upload.qiniup.com","p":"1"},
+     *  {"baidu":"gz.bcebos.com","p":"2"},
+     *  {"aliyun":"oss-cn-beijing.aliyuncs.com","p":"3"}]`
+     * ```
      */
     ossConfig?: string;
     /**
@@ -3134,6 +3193,96 @@ interface IExtraMethod {
     updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
 }
 
+/**
+ * 当前运行时设备信息
+ */
+interface IOSInfo {
+    /** 软件运行时的 CPU 架构信息 */
+    arch: string;
+    /** 平台标识 */
+    platform: string;
+    /** 操作系统名称 */
+    type: string;
+    /** 操作系统 release 标识 */
+    release: string;
+    /** 操作系统版本信息 */
+    version: string;
+    /** 内存余量 */
+    freemem: number;
+    /** 系统内存总量 */
+    totalmem: number;
+    /** 本次操作系统运行时长 */
+    uptime: number;
+    cpus: {
+        /** CPU 型号标识 */
+        model: string;
+        /** 主频 MHz */
+        speed: number;
+        times: {
+            user: number;
+            nice: number;
+            sys: number;
+            idle: number;
+            irq: number;
+        };
+    }[];
+    networkInterfaces: {
+        /** 网卡接口标识 */
+        [link: string]: {
+            /** IP */
+            address: string;
+            /** 子网掩码 */
+            netmask: string;
+            /** IP 协议版本 */
+            family: string;
+            /** Mac Address */
+            mac: string;
+            /** 是否回环地址 */
+            internal: boolean;
+            /** CIDR */
+            cidr: string | null;
+        }[] | undefined;
+    };
+}
+
+interface IProcessInfo {
+    title: string;
+    platform: string;
+    arch: string;
+    pid: number;
+    ppid: number;
+    uptime: number;
+    cpuUsage: {
+        user: number;
+        system: number;
+    };
+    memoryUsage: {
+        rss: number;
+        heapTotal: number;
+        heapUsed: number;
+        external: number;
+        arrayBuffers: number;
+    };
+    resourceUsage: {
+        userCPUTime: number;
+        systemCPUTime: number;
+        maxRSS: number;
+        sharedMemorySize: number;
+        unsharedDataSize: number;
+        unsharedStackSize: number;
+        minorPageFault: number;
+        majorPageFault: number;
+        swappedOut: number;
+        fsRead: number;
+        fsWrite: number;
+        ipcSent: number;
+        ipcReceived: number;
+        signalsCount: number;
+        voluntaryContextSwitches: number;
+        involuntaryContextSwitches: number;
+    };
+}
+
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
  */
@@ -3637,6 +3786,14 @@ interface IEngine {
      */
     getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     clearData(): Promise<IAsyncRes<boolean>>;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    getMainProcessInfo(): IPromiseResult<IProcessInfo>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
     rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
         code: ErrorCode;
@@ -3944,6 +4101,10 @@ declare class DataCodec {
      * 格式化超级群变更后消息列表
     */
     private _formatUltraMsgList;
+    /**
+     * 格式化超级群获取指定会话未读 @ 消息列表
+    */
+    private _formatUltraGroupUnreadMentionedList;
     /**
      * 格式化会话列表
     */
@@ -4065,8 +4226,12 @@ declare class DataCodec {
     */
     encodeMsgQuery(option: IUltraMsgQueryOptions): any[];
     /**
-     * 正在输入中
+     * 序列化获取超级群获取指定会话未读 @ 消息列表参数
     */
+    encodeUnreadMentionedMsgQuery(option: IUltraGroupUnreadMentionedOption): any[];
+    /**
+     * 正在输入中
+     */
     encodeOperateStatus(targetId: string, conversationType: ConversationType, channelId: string, operationType: OperateStatus): any[];
     /**
      * 加入退出聊天室
@@ -5050,6 +5215,18 @@ declare class APIContext {
      */
     getAllUltraGroupUnreadCount(isMentioned?: boolean): Promise<IAsyncRes<number>>;
     getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
+    /**
+     * 超级群类型获取未读 @ 消息列表
+     * @param options
+     * @returns 指定会话未读 @ 消息列表
+    */
+    getUltraGroupUnreadMentionedMessages(options: IUltraGroupUnreadMentionedOption): Promise<IAsyncRes<IUltraUnreadMsg[]>>;
+    /**
+     * 超级群获取指定会话第一条未读消息时间戳
+     * @param conversation
+     * @returns 指定会话第一条未读消息时间戳
+    */
+    getUltraGroupFirstUnreadMessageTimestamp(options: IUltraGroupOption): Promise<IAsyncRes<IUltraUnreadMsg>>;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
      * 对于未实现的方法，接口响应 Unsupport 错误码
@@ -5057,6 +5234,18 @@ declare class APIContext {
      * @param args
      */
     callExtra(method: string | keyof IExtraMethod, ...args: any[]): Promise<IAsyncRes<unknown>>;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取当前渲染进程信息，仅限 Electron 平台可用
+     */
+    getProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    getMainProcessInfo(): IPromiseResult<IProcessInfo>;
     /**
      * 删除所有会话
     */
@@ -5333,13 +5522,21 @@ declare class PluginContext {
      * 获取服务时间
      */
     getServerTime(): number;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取当前渲染进程信息，仅限 Electron 平台可用
+     */
+    getProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    getMainProcessInfo(): IPromiseResult<IProcessInfo>;
 }
 
 declare class RTCPluginContext extends PluginContext {
-    /**
-     * 获取当前的导航数据
-     */
-    getNaviInfo(): INaviInfo | null;
     /**
      * 加入 RTC 房间
      * @deprecated
@@ -6247,6 +6444,26 @@ declare abstract class AEngine implements IEngine {
      */
     abstract getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
     abstract clearData(): Promise<IAsyncRes<boolean>>;
+    /**
+     * 超级群获取指定会话未读 @ 消息列表
+    */
+    abstract getUltraGroupUnreadMentionedMessages(options: IUltraGroupUnreadMentionedOption): Promise<IAsyncRes<IUltraUnreadMsg[]>>;
+    /**
+     * 超级群获取指定会话第一条未读消息时间戳
+    */
+    abstract getUltraGroupFirstUnreadMessageTimestamp(options: IUltraGroupOption): Promise<IAsyncRes<IUltraUnreadMsg>>;
+    /**
+     * 获取运行时的系统信息，仅限 Electron 平台可用
+     */
+    abstract getOSInfo(): IPromiseResult<IOSInfo>;
+    /**
+     * 获取当前渲染进程信息，仅限 Electron 平台可用
+     */
+    abstract getProcessInfo(): IPromiseResult<IProcessInfo>;
+    /**
+     * 获取应用主进程信息，仅限 Electron 平台可用
+     */
+    abstract getMainProcessInfo(): IPromiseResult<IProcessInfo>;
     /**
      * RTC 通用调用接口
      * 在非 Comet 协议下，入参 sourceData 应为 ArrayBuffer 数据，返回结果为 Uint8Array 数据
@@ -6867,4 +7084,4 @@ declare const ONE_LOG_SIZE_MAX = 1000;
  */
 declare const version: string;
 
-export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, 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, IRealTimeLog, 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, IUltraGroupConversation, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, randomNum, todo, usingCppEngine, validate, version };
+export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, 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, IOSInfo, IOperateStatusNotify, IPluginGenerator, IProcessInfo, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, 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, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUltraUnreadConversation, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getClientMessageId, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, isValidNotificationLevel, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, randomNum, todo, usingCppEngine, validate, version };