@rongcloud/engine 5.1.0 → 5.1.1-custom-qihoo.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.1.0
- * CommitId - a336c0de6ae1d26b24ec675889d919bcb2195568
- * Fri Jan 07 2022 15:56:12 GMT+0800 (China Standard Time)
+ * RCEngine - v5.1.1-custom-qihoo.1
+ * CommitId - 6d3b3f993e4c20bcb8f5ebd44d47ac0c94cb46df
+ * Thu Jan 20 2022 18:35:17 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -980,6 +980,10 @@ declare enum ErrorCode {
     EXTRA_METHOD_UNDEFINED = -4,
     /** 主进程内方法错误 */
     MAIN_PROCESS_ERROR = -5,
+    /**
+     * 参数变更
+     */
+    PARAMETER_CHANGED = -6,
     /**
      * 成功
      */
@@ -1679,6 +1683,10 @@ interface IBaseConversationInfo {
     targetId: string;
     channelId: string;
 }
+interface IConversationState extends IBaseConversationInfo {
+    unreadCount: number;
+    unreadMentionedCount: number;
+}
 
 /**
  * 导航信息数据就结构
@@ -3031,8 +3039,9 @@ interface IEngine {
      * @param isPersited 是否存储
      * @param isCounted 是否技术
      * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @param isStatusMessage 是否是状态消息
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[], isStatusMessage: boolean): void;
     /**
      * 加入聊天室
      * @param count 拉取消息数量
@@ -3192,6 +3201,8 @@ interface IEngine {
      * 获取当前 userId
      */
     getCurrentUserId(): string;
+    getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
+    getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
      * 设置用户在线状态监听器
      */
@@ -3972,10 +3983,8 @@ interface IWatcher {
     onDisconnect?: () => void;
     onSuspend?: () => void;
     readReceiptReceived?: (conversation: IConversationOption, messageUId: string, sentTime: number) => void;
-    messageReceiptRequest?: (conversation: IConversationOption, messageUId: string) => void;
-    messageReceiptResponse?: (conversation: IConversationOption, messageUId: string, sender: {
-        [responseUserIdList: string]: number;
-    }) => void;
+    messageReceiptRequest?: (conversation: IConversationOption, messageUId: string, senderUserId: string) => void;
+    messageReceiptResponse?: (conversation: IConversationOption, receivedUserId: string, messageUIdList: string[]) => void;
     /**
      * 敏感词被拦截监听
      */
@@ -4172,8 +4181,9 @@ declare class APIContext {
      * @param isPersited 是否存储
      * @param isCounted 是否技术
      * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @param isStatusMessage 是否是状态消息
      */
-    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[]): void;
+    registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): void;
     /**
      * 发送消息
      * @param conversationType
@@ -4491,6 +4501,10 @@ declare class APIContext {
        * 获取所有群聊会话 @ 消息未读数
        */
     getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
+    /**
+     * 获取本地全部会话的状态
+     */
+    getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
      * 对于未实现的方法，接口响应 Unsupport 错误码
@@ -4589,6 +4603,8 @@ declare class APIContext {
         list: IReceivedMessage[];
         hasMore: boolean;
     }>>;
+    getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
+    getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
     /**
      * 加入房间
      * @param roomId
@@ -5113,8 +5129,9 @@ declare abstract class AEngine implements IEngine {
      * @param isPersited 是否存储
      * @param isCounted 是否技术
      * @param searchProps 搜索字段，只在搭配协议栈使用时有效
+     * @param isStatusMessage 是否是状态消息
      */
-    abstract registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[]): void;
+    abstract registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps: string[], isStatusMessage: boolean): void;
     /**
      * 加入聊天室
      * @param count 拉取消息数量
@@ -5278,6 +5295,8 @@ declare abstract class AEngine implements IEngine {
      * 获取当前 userId
      */
     abstract getCurrentUserId(): string;
+    abstract getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
+    abstract getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
      * 设置用户在线状态监听器
     */
@@ -5400,6 +5419,10 @@ declare abstract class AEngine implements IEngine {
      * 获取所有群聊会话 @ 消息未读数
      */
     abstract getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
+    /**
+     * 获取本地全部会话的状态
+     */
+    abstract getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
     abstract joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType): IPromiseResult<IJoinRTCRoomData>;
     abstract quitRTCRoom(roomId: string): Promise<ErrorCode>;
     abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
@@ -5912,4 +5935,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, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, 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, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, 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 };
+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, 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, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, 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 };