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

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.0.0
- * CommitId - c0ac4fad54a82abde97440721d302088e229b0b8
- * Mon Nov 15 2021 17:47:36 GMT+0800 (China Standard Time)
+ * RCEngine - v5.0.1-custom-qihoo.3
+ * CommitId - f511810a05b1ef295d16225d99189c244ea0fdfc
+ * Wed Nov 24 2021 15:31:55 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -365,6 +365,13 @@ interface IConversationOption {
     targetId: string;
     channelId?: string;
 }
+interface IServerRTCRoomEntry {
+    key: string;
+    value: string;
+    status: number;
+    timestamp: number;
+    uid: string;
+}
 interface IChrmKVEntry {
     key: string;
     value?: string;
@@ -434,13 +441,6 @@ interface IGetConversationListOption {
 interface IClearMsgOption {
     timestamp?: number;
 }
-interface IServerRTCRoomEntry {
-    key: string;
-    value: string;
-    status: number;
-    timestamp: number;
-    uid: string;
-}
 
 /**
  *  聊天室 kv 存储操作类型. 对方操作, 己方收到消息(RC:chrmKVNotiMsg)中会带入此值. 根据此值判断是删除还是更新
@@ -1611,6 +1611,10 @@ interface IReceivedConversation {
      * 搜索到的会话数量
      */
     matchCount?: number;
+    /**
+     * @ 消息未读数
+     */
+    unreadMentionedCount?: number;
 }
 interface IReceivedConversationByTag extends IReceivedConversation {
     isTopInTag: boolean;
@@ -1655,6 +1659,10 @@ interface IUpdatedConversation {
     */
     channelId?: string;
     tags?: IUpdatedConversation[];
+    /**
+     * @ 消息未读数
+     */
+    unreadMentionedCount?: number;
 }
 interface IBaseConversationInfo {
     conversationType: ConversationType;
@@ -2776,7 +2784,7 @@ interface IEngine {
     order: 0 | 1, 
     /**
      * 会话的业务标识
-    */
+     */
     channelId: string, 
     /**
      * 消息类型
@@ -2787,12 +2795,12 @@ interface IEngine {
     }>;
     /**
      * 删除历史消息 通过 messageUId
-    */
+     */
     deleteRemoteMessage(conversationType: ConversationType, targetId: string, 
     /**
      * @description
      * message 中 messageUId、setTime、messageDirection 为必须参数
-    */
+     */
     messages: {
         messageUId: string;
         sentTime: number;
@@ -2800,17 +2808,17 @@ interface IEngine {
     }[], 
     /**
      * 会话的业务标识
-    */
+     */
     channelId: string): Promise<ErrorCode>;
     recallMsg(conversationType: ConversationType, targetId: string, messageUId: string, sentTime: number, recallMsgOptions: IRecallMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
      * 删除历史消息 通过 时间戳
      * @param timestamp 小于等于传入时间戳的消息均删除
-    */
+     */
     deleteRemoteMessageByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, 
     /**
      * 会话的业务标识
-    */
+     */
     channelId: string): Promise<ErrorCode>;
     /**
      * 获取会话列表
@@ -2828,19 +2836,19 @@ interface IEngine {
     conversationType?: ConversationType, 
     /**
      * 起始时间
-    */
+     */
     startTime?: number, 
     /**
      * 获取顺序
-    */
+     */
     order?: 0 | 1, 
     /**
      * 会话的业务标识
-    */
+     */
     channelId?: string): IPromiseResult<IReceivedConversation[]>;
     /**
      * 获取指定会话
-    */
+     */
     getConversation(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<IReceivedConversation | null>;
     /**
      * 删除会话
@@ -2912,33 +2920,33 @@ interface IEngine {
     /**
      * 加入聊天室
      * @param count 拉取消息数量
-    */
+     */
     joinChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
      * 加入已存在的聊天室
      * @param count 拉取消息数量
-    */
+     */
     joinExistChatroom(chatroomId: string, count: number): Promise<ErrorCode>;
     /**
      * 退出聊天室
-    */
+     */
     quitChatroom(chatroomId: string): Promise<ErrorCode>;
     /**
      * 获取聊天室信息
      * @param count 获取人数, 范围 0 - 20
      * @param order 排序方式, 1 正序, 2 倒序
-    */
+     */
     getChatroomInfo(chatroomId: string, count: number, order: number): IPromiseResult<IChatroomInfo>;
     /**
      * 获取聊天室历史消息
-    */
+     */
     getChatroomHistoryMessages(chatroomId: string, timestamp: number, count: number, order: number): IPromiseResult<{
         list: IReceivedMessage[];
         hasMore: boolean;
     }>;
     /**
      * 设置聊天室属性
-    */
+     */
     setChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
      * 批量设置聊天室属性
@@ -2949,11 +2957,11 @@ interface IEngine {
     }>;
     /**
      * 强制设置聊天室属性
-    */
+     */
     forceSetChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
      * 删除聊天室属性
-    */
+     */
     removeChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
      * 批量删除聊天室属性
@@ -2964,15 +2972,15 @@ interface IEngine {
     }>;
     /**
      * 强制删除聊天室属性
-    */
+     */
     forceRemoveChatroomEntry(chatroomId: string, entry: IChrmKVEntry): Promise<ErrorCode>;
     /**
-      * 获取聊天室 key 对应 value
-    */
+     * 获取聊天室 key 对应 value
+     */
     getChatroomEntry(chatroomId: string, key: string): IPromiseResult<string | null>;
     /**
-      * 获取聊天室所有 key value
-    */
+     * 获取聊天室所有 key value
+     */
     getAllChatroomEntry(chatroomId: string): IPromiseResult<{
         [key: string]: string;
     }>;
@@ -2980,28 +2988,28 @@ interface IEngine {
      * 获取上传认证信息
      * @description
      * 若不传 fileName 百度上传认证字段（bosToken、bosDate、path）均返回 null
-    */
+     */
     getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string): Promise<IAsyncRes<IUploadAuth>>;
     /**
      * 获取文件上传后下载地址
-    */
+     */
     getFileUrl(fileType: FileType, uploadMethod: UploadMethod, fileName?: string, originName?: string): IPromiseResult<{
         downloadUrl: string;
     }>;
     /**
      * 创建标签
      * @param tag 标签
-    */
+     */
     createTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
      * 删除标签
      * @param tagId 标签id
-    */
+     */
     removeTag(tagId: string): IPromiseResult<IAsyncRes>;
     /**
      * 编辑标签
      * @param tag 标签
-    */
+     */
     updateTag(tag: ITagParam): IPromiseResult<IAsyncRes>;
     /**
      * 获取标签列表
@@ -3070,106 +3078,106 @@ interface IEngine {
     getCurrentUserId(): string;
     /**
      * 设置用户在线状态监听器
-    */
+     */
     setUserStatusListener(config: {
         userIds: string[];
     }, listener: Function): void;
     /**
      * 设置当前用户在线状态
-    */
+     */
     setUserStatus(status: number): Promise<ErrorCode>;
     /**
      * 订阅用户在线状态
-    */
+     */
     subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
     /**
      * 获取用户状态
-    */
+     */
     getUserStatus(userId: string): IPromiseResult<{
         status: string;
     }>;
     /**
      * 清空所有会话
-    */
+     */
     clearConversations(conversationTypes?: ConversationType[], channelId?: string): Promise<ErrorCode>;
     /**
      * 加入黑名单
-    */
+     */
     addToBlacklist(userId: string): Promise<ErrorCode>;
     /**
-      * 将指定用户移除黑名单
-    */
+     * 将指定用户移除黑名单
+     */
     removeFromBlacklist(userId: string): Promise<ErrorCode>;
     /**
-      * 获取黑名单列表
-    */
+     * 获取黑名单列表
+     */
     getBlacklist(): IPromiseResult<string[]>;
     /**
-      * 获取指定人员在黑名单中的状态
-    */
+     * 获取指定人员在黑名单中的状态
+     */
     getBlacklistStatus(userId: string): IPromiseResult<string>;
     /**
      * 向本地插入一条消息，不发送到服务器
-    */
+     */
     insertMessage(conversationType: ConversationType, targetId: string, insertOptions: IInsertMsgOptions): IPromiseResult<IReceivedMessage>;
     /**
      * 删除本地消息
-    */
+     */
     deleteMessages(timestamps: number[]): Promise<ErrorCode>;
     /**
      * 通过时间戳删除本地消息
-    */
+     */
     deleteMessagesByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, cleanSpace: boolean, channelId: string): Promise<ErrorCode>;
     /**
      * 清空会话下历史消息
-    */
+     */
     clearMessages(conversationType: ConversationType, targetId: string, channelId: string): Promise<ErrorCode>;
     /**
      * 获取消息
-    */
+     */
     getMessage(messageId: number): IPromiseResult<IReceivedMessage>;
     /**
      * 设置消息内容
-    */
+     */
     setMessageContent(messageId: number, content: any, messageType: string): Promise<ErrorCode>;
     /**
      * 设置消息搜索字段
-    */
+     */
     setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
     /**
      * 通过关键字搜索会话
-    */
+     */
     searchConversationByContent(keyword: string, customMessageTypes: string[], channelId: string, conversationTypes?: ConversationType[]): IPromiseResult<IReceivedConversation[]>;
     /**
      * 按内容搜索会话内的消息
-    */
+     */
     searchMessageByContent(conversationType: ConversationType, targetId: string, keyword: string, timestamp: number, count: number, total: number, channelId: string): IPromiseResult<{
         messages: IReceivedMessage[];
         count: number;
     }>;
     /**
      * 获取会话下所有未读的 @ 消息
-    */
+     */
     getUnreadMentionedMessages(conversationType: ConversationType, targetId: string, channelId: string): IReceivedMessage[];
     /**
      * 设置消息发送状态
-    */
+     */
     setMessageSentStatus(messageId: number, sentStatus: number): Promise<ErrorCode>;
     /**
      * 设置消息接收状态
-    */
+     */
     setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<ErrorCode>;
     /**
      * 删除时间戳前的未读数
-    */
+     */
     clearUnreadCountByTimestamp(conversationType: ConversationType, targetId: string, timestamp: number, channelId: string): Promise<ErrorCode>;
     /**
      * 获取会话免打扰状态
-    */
+     */
     getConversationNotificationStatus(conversationType: ConversationType, targetId: string, channelId: string): IPromiseResult<NotificationStatus>;
     /**
      * 协议栈获取远端历史消息
-    */
+     */
     getRemoteHistoryMessages(conversationType: ConversationType, targetId: string, timestamp: number, count: number, order: 0 | 1, channelId: string): IPromiseResult<{
         list: IReceivedMessage[];
         hasMore: boolean;
@@ -3179,9 +3187,17 @@ interface IEngine {
      */
     getBlockConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
     /**
-    * 无差别获取本地置顶列表
-    */
+     * 无差别获取本地置顶列表
+     */
     getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    /**
+     * 获取单个群聊会话 @ 消息未读数
+     */
+    getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
+    /**
+     * 获取所有群聊会话 @ 消息未读数
+     */
+    getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
@@ -4293,6 +4309,14 @@ declare class APIContext {
      * 获取所有本地置顶列表
      */
     getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    /**
+     * 获取单个群聊会话 @ 消息未读数
+     */
+    getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
+    /**
+       * 获取所有群聊会话 @ 消息未读数
+       */
+    getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     /**
      * 调用非标准方法。所谓非标准方法，是为某些特定需求或产品添加，暂未作为标准接口添加至 API 层。
      * 对于未实现的方法，接口响应 Unsupport 错误码
@@ -5158,6 +5182,14 @@ declare abstract class AEngine implements IEngine {
      * 无差别获取本地置顶列表
      */
     abstract getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+    /**
+     * 获取单个群聊会话 @ 消息未读数
+     */
+    abstract getUnreadMentionedCount(conversation: IConversationOption): Promise<IAsyncRes<number>>;
+    /**
+     * 获取所有群聊会话 @ 消息未读数
+     */
+    abstract getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     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>;