@rongcloud/imlib-next 5.9.5 → 5.9.7

package/index.d.ts

@@ -266,6 +266,10 @@ interface IAReceivedMessage {
      * 超级群专有字段，拉取历史消息时表示该消息是否为超级群频道类型（仅超级群有效）
      */
     channelType?: UltraGroupChannelType;
+    /**
+     * 定向用户列表(仅支持群聊, 超级群)
+     */
+    directedUserIds?: string[];
 }
 declare type GetHistoryMessageOption = {
     /**
@@ -273,7 +277,8 @@ declare type GetHistoryMessageOption = {
      */
     timestamp?: number;
     /**
-     * 获取消息的数量，范围: 1-20
+     * 获取消息的数量，范围: 1-100
+     * 如果 SDK < 5.7.4，范围为 [1-20]；如果 SDK ≧ 5.7.4，范围为 [1-100]。默认值 `20`
      */
     count?: number;
     /**
@@ -704,7 +709,7 @@ interface ISendMessageOptions {
      */
     mentionedUserIdList?: string[];
     /**
-     * 用于发送群定向消息，只当 conversationType 值为 `ConversationType.GROUP` 时有效
+     * 用于发送群定向消息，只当 conversationType 值为 `群、超级群、讨论组、RTC聊天室` 时有效
      */
     directionalUserIdList?: string[];
     /**
@@ -1770,6 +1775,10 @@ interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo, I
      * 引用消息对象
      */
     referMsg: any;
+    /**
+     * 引用消息UID
+     */
+    referMsgUid: string;
     /**
      * 输入的文本消息内容
      */
@@ -1903,6 +1912,8 @@ declare type ISendSightMessageOptions = {
 declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取历史消息
+ * Electron 获取的是本地数据库
+ * Web 获取的是远端历史消息
  * @category 消息
  */
 declare function getHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>;
@@ -2139,7 +2150,6 @@ declare function getFirstUnreadMessage(conversation: IConversationOption): Promi
  * 获取第一条未读消息信息
  * @category 消息
  * @since 5.9.0
- * @hidden
  * @param conversation
  * 当没有未读消息时，返回的 data 为 null
  * 当第一条未读消息被撤回时，此信息不会更新
@@ -2453,6 +2463,23 @@ declare function getHistoryMessagesByMessageTypes(conversation: IConversationOpt
      */
     messages: IAReceivedMessage[];
 } & GetHistoryMessageResult>>;
+/**
+ * 获取本地与远端历史消息(该接口已解决消息断档)
+ * 1. 分页获取时，下次传的时间戳必须使用 getContinuousMessages 接口返回的 timestamp
+ * 2. 获取历史消息逻辑：优先获取本地数据历史消息，本地获取不到再获取远端历史消息，但是该情况可能会因为离线或者补偿消息存储天数影响，出现消息断档现象
+ * 消息断档现象：因为离线或者补偿消息存储天数影响，存储在本地数据库中消息存在不连续或者说中间某段时间消息丢失
+ * 比如离线消息和补偿消息都为 1 天，第一天 A 给 B 发送 1, 2, 3，第二天 A 给 B 发送 4, 5, 6,
+ * B 第二天再登入，由于离线消息和补偿消息都为 1 天，所以 B 只能收到 4, 5, 6。 1, 2, 3 消息丢失
+ * @param conversation
+ * @param option
+ * @returns
+ * @description 该接口需要业务层开启单群聊云存储服务
+ */
+declare function getContinuousMessages(conversation: IConversationOption, option: GetHistoryMessageOption): Promise<IAsyncRes<{
+    list: IAReceivedMessage[];
+    timestamp: number;
+    hasMore: boolean;
+}>>;
 /**
  * 将自己发送的指定时间之前的消息标记对方已读，状态值为 SentStatus.READ
  * @param conversation 会话
@@ -2600,6 +2627,7 @@ declare const index_searchMessages: typeof searchMessages;
 declare const index_searchMessageInTimeRange: typeof searchMessageInTimeRange;
 declare const index_searchMessagesByUser: typeof searchMessagesByUser;
 declare const index_getHistoryMessagesByMessageTypes: typeof getHistoryMessagesByMessageTypes;
+declare const index_getContinuousMessages: typeof getContinuousMessages;
 declare const index_setMessageStatusToRead: typeof setMessageStatusToRead;
 declare const index_setMessageReceivedStatus: typeof setMessageReceivedStatus;
 declare const index_setMessageReceivedStatusInfo: typeof setMessageReceivedStatusInfo;
@@ -2626,6 +2654,7 @@ declare namespace index {
     index_searchMessageInTimeRange as searchMessageInTimeRange,
     index_searchMessagesByUser as searchMessagesByUser,
     index_getHistoryMessagesByMessageTypes as getHistoryMessagesByMessageTypes,
+    index_getContinuousMessages as getContinuousMessages,
     index_setMessageStatusToRead as setMessageStatusToRead,
     index_setMessageReceivedStatus as setMessageReceivedStatus,
     index_setMessageReceivedStatusInfo as setMessageReceivedStatusInfo,