@rongcloud/imlib-next 5.9.3 → 5.9.4

package/index.d.ts

@@ -1,4 +1,4 @@
-import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, IReceivedStatusInfo, SentStatus, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse } from '@rongcloud/engine';
+import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, IReceivedStatusInfo, SentStatus, IReadReceiptResponseInfo, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse } from '@rongcloud/engine';
 export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineV2MessageContent, ICombinedMessage, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IFirstUnreadMessageInfo, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IMessageDeliver, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPrivateReadReceiptData, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ISyncReadStatusData, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IiOSPushConfig, InterruptionLevel, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OperateStatus, PushImportanceHonor, RCConnectionStatus, ReceivedStatus, SentStatus, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
 
 interface IThumbnailConfig {
@@ -200,7 +200,7 @@ interface IAReceivedMessage {
      */
     isCounted: boolean;
     /**
-     * 是否为离线消息
+     * 是否为离线消息, 在超级群会话中不适用
      */
     isOffLineMessage: boolean;
     /**
@@ -243,9 +243,9 @@ interface IAReceivedMessage {
      */
     sentStatus?: SentStatus;
     /**
-     * 消息已读回执信息，导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined
+     * 群已读回执信息(V1 版本为 IReadReceiptResponseInfo, V4 版本为 IReadReceiptInfo）
      */
-    readReceiptInfo?: IReadReceiptInfo;
+    readReceiptInfo?: IReadReceiptResponseInfo | IReadReceiptInfo;
     /**
      * 推送扩展
      */
@@ -671,6 +671,7 @@ interface ISendMessageOptions {
      * @description
      * 1. 状态消息只有 pub，没有 ack 应答
      * 2. 状态消息默认不存储，不计数，`isPersited` 与 `isCounted` 配置将失效
+     * @deprecated 请在注册消息时设置消息类型是否是状态消息
      */
     isStatusMessage?: boolean;
     /**
@@ -1249,8 +1250,12 @@ declare function getBlockedConversationList(): Promise<IAsyncRes<IBaseConversati
 /**
  * 设置会话是否置顶
  * @category 会话
+ * @param options 回话信息
+ * @param isTop 置顶状态
+ * @param isUpdateTime 是否更新会话操作时间，默认为更新，仅私有云环境有效
+ * @returns
  */
-declare function setConversationToTop(options: IConversationOption, isTop?: boolean): Promise<IAsyncRes<void>>;
+declare function setConversationToTop(options: IConversationOption, isTop?: boolean, isUpdateTime?: boolean): Promise<IAsyncRes<void>>;
 /**
  * 批量设置会话置顶
  * @param conversations 会话数组, 最大数量为 20
@@ -1929,7 +1934,7 @@ declare function sendReadReceiptResponse(targetId: string, messageUIds: string[]
  *  @param messageList 要回执的消息列表，结构为： \{senderUserId: [messageUId1, messageUId2]\}
  *  @param channelId
  */
-declare function sendReadReceiptResponseV2(targetId: string, messageList: {
+declare function sendReadReceiptResponseV2(targetId: string, messageList?: {
     [senderUserId: string]: string[];
 }, channelId?: string): Promise<IAsyncRes<void>>;
 /**
@@ -2121,7 +2126,7 @@ declare function getMessageReader(targetId: string, messageUId: string, channelI
  * @param isPersited  是否存储
  * @param isCounted   是否计数
  * @param searchProps  可搜索的属性
- * @param isStatusMessage  是否状态消息
+ * @param isStatusMessage  是否状态消息，状态消息不计数，不存储，仅在线能收到
 */
 declare function registerMessageType<T>(messageType: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): new (content: T) => BaseMessage<T>;
 /**
@@ -2397,7 +2402,7 @@ declare function getAllConversationList(channelId?: string): Promise<IAsyncRes<I
  * @param count 数量
  * @param channelId 频道 ID，不传则获取全部频道 ID 类型
  */
-declare function getConversationList(startTime: number, count: number, channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>;
+declare function getConversationList(startTime: number, count: number, channelId?: string, topPriority?: boolean): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
  * 根据消息内容搜索会话列表
  * @param keyword 搜索关键字