@rongcloud/engine 5.1.2 → 5.2.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.1.2
- * CommitId - efd1b7f44d2517ab9a2fab003c298184d1f06fca
- * Thu Feb 17 2022 14:47:39 GMT+0800 (China Standard Time)
+ * RCEngine - v5.2.0
+ * CommitId - cda3e1dfb825b2da0cbcb293dd38c8393cd8773f
+ * Wed Mar 02 2022 15:48:24 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -44,6 +44,10 @@ declare enum ConversationType {
      * 需手动关注的公众号会话类型（MP)
      */
     PUBLIC_SERVICE = 8,
+    /**
+     * 超级群
+     */
+    ULTRA_GROUP = 10,
     /**
      * RTCLib 特有的会话类型
      */
@@ -360,6 +364,13 @@ declare class QueryWriter extends RetryableWriter {
     writeMessage(stream: RongStreamWriter): void;
 }
 
+/**
+ *  聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
+*/
+declare enum OperateStatus {
+    typing = 0
+}
+
 interface IConversationOption {
     conversationType: ConversationType;
     targetId: string;
@@ -726,6 +737,10 @@ interface IReceivedMessage {
      * 推送扩展
      */
     pushConfig?: IPushConfig;
+    /**
+     * 超级群专有字段，是否断档，服务端收到大量消息可能会断档，所以消息存在此标志位，断档需要客户手动拉取历史消息
+     */
+    isInterrupt?: boolean;
 }
 interface IUserProfile {
     /**
@@ -750,6 +765,26 @@ interface IUserProfile {
      */
     portrait?: string;
 }
+interface IOperateInfo {
+    targetId: string;
+    channelId?: string;
+    userId: string;
+    operationType: OperateStatus;
+    operationTime?: number;
+}
+interface IOperateSummary {
+    targetId: string;
+    channelId?: string;
+    count: number;
+    operationType: OperateStatus;
+}
+interface IOperateStatusNotify {
+    conversationType: ConversationType;
+    hasInfo: boolean;
+    hasSummary: boolean;
+    info: IOperateInfo[];
+    summary: IOperateSummary[];
+}
 interface IRecallMsgOptions {
     /**
      * 会话组织机构标识
@@ -885,6 +920,10 @@ interface ISendMsgOptions {
      * 客户端的消息标识
      */
     messageId?: string;
+    /**
+     * 超级群专有字段，是否断档，若断档需要客户判断是否拉取
+     */
+    isInterrupt?: boolean;
 }
 interface IInsertMsgOptions {
     senderUserId: string;
@@ -935,6 +974,63 @@ interface ISendExMsgOptions {
         [key: string]: string;
     } | null;
 }
+interface IUltraExMsgOptions {
+    canIncludeExpansion: boolean;
+    channelId: string;
+    conversationType: ConversationType;
+    targetId: string;
+    messageUId: string;
+    sendTime: number;
+    /**
+     * 删除的 keys
+    */
+    keys?: string[];
+    /**
+      * 扩展对象
+    */
+    expansion?: {
+        [key: string]: string;
+    };
+    /**
+      * 是否删除所有扩展
+    */
+    removeAll?: boolean;
+}
+interface IUltraModifyMsgOptions {
+    canIncludeExpansion?: boolean;
+    channelId: string;
+    conversationType: ConversationType;
+    targetId: string;
+    messageUId: string;
+    sendTime: number;
+    /**
+     * 消息内容
+     */
+    content: {
+        /**
+         * 消息内容 key-value，最终会进行 JSON 序列化后发送
+         */
+        [key: string]: any;
+        /**
+         * 消息可携带的用户数据
+         */
+        user?: IUserProfile;
+        /**
+         * 其他拓展信息
+         */
+        extra?: string;
+    };
+}
+interface IUltraMsgQueryInfo {
+    sendTime: number;
+    messageUId: string;
+    channelId?: string;
+}
+interface IUltraMsgQueryOptions {
+    conversationType: ConversationType;
+    targetId: string;
+    messages: IUltraMsgQueryInfo[];
+}
 /**
  * 被拦截的消息信息
  */
@@ -1324,6 +1420,22 @@ declare enum ErrorCode {
      * 开启`禁止把已在线客户端踢下线`开关后，该错误码标识已有同类型端在线，禁止链接
      */
     HAS_OHTER_SAME_CLIENT_ON_LINE = 35010,
+    /**
+     * IM 在初次连接成功后，需立即同步消息，标记上线，然后获取全量超级群会话列表，列表同步完成前，所有超级群相关功能接口应不可用
+     */
+    METHOD_NOT_AVAILABLE = 35011,
+    /**
+     * 该功能不支持超级群
+     */
+    METHOD_NOT_SUPPORT = 35012,
+    /**
+     * 消息数量没在范围内
+     */
+    MSG_LIMIT_ERROR = 35013,
+    /**
+     * 该功能仅支持超级群
+     */
+    METHOD_ONLY_SUPPORT_ULTRA_GROUP = 35014,
     /**
      * 上传文件失败
      */
@@ -1626,8 +1738,9 @@ interface IReceivedConversation {
      */
     matchCount?: number;
     /**
-     * @ 消息未读数
+     * 会话项变更时间戳
      */
+    versionTime?: number;
     unreadMentionedCount?: number;
 }
 interface IReceivedConversationByTag extends IReceivedConversation {
@@ -1673,6 +1786,7 @@ interface IUpdatedConversation {
     */
     channelId?: string;
     tags?: IUpdatedConversation[];
+    versionTime?: number;
     /**
      * @ 消息未读数
      */
@@ -1797,6 +1911,10 @@ interface INaviInfo {
      * @todo 需确认公有云与私有云区别
      */
     openUS: 0 | 1;
+    /**
+     * 超级群功能开关,1表示开
+     */
+    ugMsg?: 0 | 1;
     /**
      * 群离线消息最大下发条数，`0` 为关闭
      * @description 公有云独有配合
@@ -3514,6 +3632,18 @@ declare class DataCodec {
      * 格式化历史消息
     */
     private _formatHistoryMessages;
+    /**
+     * 格式化超级群消息变更列表
+    */
+    private _formatUltraMsgChangeList;
+    /**
+     * 格式化超级群消息变更列表
+    */
+    private _formatUltraOperateStatusNotifyList;
+    /**
+     * 格式化超级群变更后消息列表
+    */
+    private _formatUltraMsgList;
     /**
      * 格式化会话列表
     */
@@ -3595,9 +3725,13 @@ declare class DataCodec {
     */
     encodeChrmSyncMsg(time: number, count: number): any[];
     /**
-     * 序列化历史消息
+     * 序列化历史消息所需参数
     */
     encodeGetHistoryMsg(targetId: string, option: IGetMsgOption): any[];
+    /**
+     * 序列化同步超级群所需参数
+    */
+    encodeSuperSyncMsg(syncTime: number): any[];
     /**
      * 序列化会话列表
     */
@@ -3625,11 +3759,31 @@ declare class DataCodec {
     /**
      * 批量删除消息通过时间
     */
-    encodeClearMessages(targetId: string, timestamp: number, channelId: string): any[];
+    encodeClearMessages(targetId: string, timestamp: number, channelId: string, conversationType?: ConversationType): any[];
     /**
      * 未读数清除
     */
     encodeClearUnreadCount(conversation: IConversationOption, option: IClearMsgOption): any[];
+    /**
+     * 对已有的超级群消息扩展
+    */
+    encodeExpandUltraMessage(option: IUltraExMsgOptions, userId: string): any[];
+    /**
+     * 对已有的超级群消息扩展
+    */
+    encodemodifyMessage(option: IUltraModifyMsgOptions, userId: string): any[];
+    /**
+     * 超级群消息变更通知
+    */
+    encodeQueryMsgChange(time: number): any[];
+    /**
+     * 超级群消息变更通知
+    */
+    encodeMsgQuery(option: IUltraMsgQueryOptions): any[];
+    /**
+     * 正在输入中
+    */
+    encodeOperateStatus(targetId: string, conversationType: ConversationType, channelId: string, operationType: OperateStatus): any[];
     /**
      * 加入退出聊天室
     */
@@ -3697,6 +3851,10 @@ declare class DataCodec {
      * 序列号上报SDK信息
      */
     encodeReportSDKInfo(info: string): any;
+    /**
+     * 序列号超级群获取会话参数
+     */
+    encodeUltraGroup(syncTime: number, isEraseMsgContent: boolean): any;
     /**
      * ============ 以下为 RTC 相关 ============
      */
@@ -4000,6 +4158,11 @@ interface IWatcher {
      * 敏感词被拦截监听
      */
     messageBlocked?: IMessageBlockedListener;
+    ultraGroupEnable?: (conversations: IReceivedConversation[]) => void;
+    operateStatus?: (status: IOperateStatusNotify) => void;
+    ultraGroupMessageExpansionUpdated?: (list: IReceivedMessage[]) => void;
+    ultraGroupMessageModified?: (list: IReceivedMessage[]) => void;
+    ultraGroupMessageRecalled?: (list: IReceivedMessage[]) => void;
 }
 interface IAPIContextOption {
     /**
@@ -4136,6 +4299,11 @@ declare class APIContext {
     private _typingStatusListener;
     private _pullFinishedListener;
     private _MessageBlockedListener;
+    private _ultraGroupEnableListener;
+    private _operateStatusListener;
+    private _ultraGroupMessageExpansionUpdatedListener;
+    private _ultraGroupMessageModifiedListener;
+    private _ultraGroupMessageRecalledListener;
     /**
      * rtc 数据变更通知 pluginContext
      */
@@ -4265,6 +4433,18 @@ declare class APIContext {
      * 删除会话
      */
     removeConversation(conversationType: ConversationType, targetId: string, channelId?: string): Promise<ErrorCode>;
+    /**
+     * 获取超级群会话列表
+     */
+    getUltraGroupList(): Promise<IAsyncRes<IReceivedConversation[]>>;
+    /**
+     * 获取超级群免打扰列表
+     */
+    getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    /**
+     * 获取超级群置顶列表
+     */
+    getTopUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
     /**
      * 清除会话消息未读数
      */
@@ -4512,17 +4692,37 @@ declare class APIContext {
      * 获取所有本地置顶列表
      */
     getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
-    /**
-     * 获取单个群聊会话 @ 消息未读数
-     */
     getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
     /**
-       * 获取所有群聊会话 @ 消息未读数
-       */
+      * 获取所有群聊会话 @ 消息未读数
+      */
     getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     /**
-     * 获取本地全部会话的状态
+     * 超级群正在输入中
+     * @param options
+     */
+    sendUltraGroupTypingStatus(options: IConversationOption): Promise<IAsyncRes>;
+    /**
+     * 根据消息 ID 查询消息列表
+     * @param options
+     */
+    getUltraGroupMessageListByMessageUId(options: IUltraMsgQueryOptions): Promise<IAsyncRes>;
+    /**
+     * 扩展已有的超级群消息
+     * @param options 设置的扩展
+    */
+    expandUltraMessage(options: IUltraExMsgOptions): Promise<IAsyncRes<ErrorCode>>;
+    /**
+     * 修改已有的超级群消息
+     * @param options 设置的扩展
+    */
+    modifyMessage(options: IUltraModifyMsgOptions): Promise<IAsyncRes<ErrorCode>>;
+    /**
+     * 根据会话 ID 获取所有子频道 @ 消息未读数
+     * @todo
+     * @param targetId
      */
+    getUltraGroupUnreadMentionedCountByTargetId(targetId: string): Promise<IAsyncRes<number>>;
     getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
@@ -4930,6 +5130,11 @@ interface IEngineWatcher {
     expansion: (event: IExpansionListenerData) => void;
     tag: () => void;
     conversationTag: () => void;
+    ultraGroupEnable: (conversations: IReceivedConversation[]) => void;
+    operateStatus: (status: IOperateStatusNotify) => void;
+    ultraGroupMessageExpansionUpdated: (list: IReceivedMessage[]) => void;
+    ultraGroupMessageModified: (list: IReceivedMessage[]) => void;
+    ultraGroupMessageRecalled: (list: IReceivedMessage[]) => void;
     /**
      * RTC 数据变更
      */
@@ -5324,6 +5529,62 @@ declare abstract class AEngine implements IEngine {
      * 获取当前 userId
      */
     abstract getCurrentUserId(): string;
+    /**
+     * 获取所有超级群会话列表
+     */
+    abstract getUltraGroupList(): Promise<IAsyncRes<IReceivedConversation[]>>;
+    /**
+    * 获取超级群免打扰列表
+    */
+    abstract getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    /**
+     * 获取超级群置顶列表
+     */
+    abstract getTopUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    /**
+     * 上报超级群会话已读时间
+     * @param targetId
+     * @param channelId
+     */
+    abstract clearUltraUnreadcount(targetId: string, channelId: string): Promise<ErrorCode>;
+    /**
+     * 根据会话 ID 获取所有子频道 @ 消息未读数
+     * @todo
+     * @param targetId
+     */
+    abstract getUltraGroupUnreadMentionedCountByTargetId(targetId: string): Promise<IAsyncRes<number>>;
+    /**
+     * 超级群消息发送
+     * @param targetId
+     * @param options
+     */
+    abstract sendUltraMessage(targetId: string, options: ISendMsgOptions): Promise<IAsyncRes>;
+    /**
+     * 超级群消息正在输入中
+     * @param options
+     */
+    abstract sendUltraGroupTypingStatus(options: IConversationOption, operationType?: OperateStatus): Promise<IAsyncRes>;
+    /**
+     * 拉取超级群变更后的消息列表
+     * @param time
+     */
+    abstract getUltraGroupMessageListByMessageUId(options: IUltraMsgQueryOptions): Promise<IAsyncRes<Object>>;
+    /**
+     * 对已有的消息进行扩展
+     * @param options
+     */
+    abstract expandUltraMessage(options: IUltraExMsgOptions): Promise<IAsyncRes>;
+    /**
+     * 对已有的消息进行修改
+     * @param options
+     */
+    abstract modifyMessage(options: IUltraModifyMsgOptions): Promise<IAsyncRes>;
+    /**
+     * 超级群获取历史消息
+     * @param targetId
+     * @param options
+     */
+    abstract getUltraHistoryMsg(targetId: string, options: IGetMsgOption): Promise<IAsyncRes>;
     abstract getConversationListWithAllChannel(): IPromiseResult<IReceivedConversation[]>;
     abstract getConversationListWithAllChannelByPage(index: number, limit: number): IPromiseResult<IReceivedConversation[]>;
     /**
@@ -5743,6 +6004,10 @@ declare const isValidConversationType: (conversation: number) => boolean;
  * 判断是否是一个有效的文件类型
  */
 declare const isValidFileType: (fileType: number) => boolean;
+/**
+ * 判断是否是一个合法的消息扩展
+ */
+declare const isValidExpansion: (expansion: any) => boolean;
 
 /**
  * 预定义的验证规则，只包含`值类型`数据验证
@@ -5874,6 +6139,7 @@ declare const getBrowser: (runtime: IRuntime) => {
  * @param code 连接响应码
  */
 declare const formatConnectResponseCode: (code: number) => ErrorCode;
+declare const clone: (target: any) => any;
 
 /**
  * Navi 缓存数据有效时长，单位毫秒
@@ -5964,4 +6230,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, 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, IRTCUserData, 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, IRTCUserData, 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, IUltraExMsgOptions, IUltraModifyMsgOptions, 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, 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 };