@rongcloud/imlib-next 5.6.1-beem → 5.6.1

package/index.d.ts

@@ -1,5 +1,5 @@
-import { LogLevel, EnableLogL, MessageDirection, ReceivedStatus, IReadReceiptInfo, IPushConfig, ConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUserProfile, IReceivedMessage, IConversationOption, ITypingMessage, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IReceivedConversation, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, ConversationType, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedType, IMessageReaderResponse, ITagParam, ITagInfo, IConversationTag, IReceivedConversationByTag, FileType, IUploadAuth, UploadMethod } from '@rongcloud/engine';
-export { ChatroomEntryType, ChatroomUserChangeType, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationOption, IConversationState, IConversationTag, IDeletedExpansion, IEventListener, IExpansionListenerData, IGetUltraGroupListOption, IGooglePushConfig, IMessageReader, IMessageReaderResponse, IOperateStatusNotify, IPushConfig, IRTCRoomBindOption, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogL, LogLevel, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, ReceivedStatus, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
+import { LogLevel, EnableLogL, MessageDirection, ReceivedStatus, IReadReceiptInfo, IPushConfig, ConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUserProfile, IReceivedMessage, IConversationOption, ITypingMessage, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IReceivedConversation, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IMessageDeliver, IGroupMessageDeliverStatus, ConversationType, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedType, IMessageReaderResponse, ITagParam, ITagInfo, IConversationTag, IReceivedConversationByTag, FileType, IUploadAuth, UploadMethod, IGroupMessageDeliverInfo } from '@rongcloud/engine';
+export { ChatroomEntryType, ChatroomUserChangeType, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationOption, IConversationState, IConversationTag, IDeletedExpansion, IDeliveredUser, IEventListener, IExpansionListenerData, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IMessageDeliver, IMessageReader, IMessageReaderResponse, IOperateStatusNotify, IPushConfig, IRTCRoomBindOption, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, ITagInfo, ITagParam, ITypingMessage, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IiOSPushConfig, LogL, LogLevel, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, ReceivedStatus, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
 
 declare enum Events {
     /**
@@ -106,7 +106,19 @@ declare enum Events {
      * 超级群私有频道成员变更-退出
      * @since 5.4.2
      */
-    ULTRA_GROUP_CHANNEL_USER_KICKED = "ULTRA_GROUP_CHANNEL_USER_KICKED"
+    ULTRA_GROUP_CHANNEL_USER_KICKED = "ULTRA_GROUP_CHANNEL_USER_KICKED",
+    /**
+     * 单聊消息送达通知
+     * @hidden 暂仅 Beem 使用，无需公开
+     * @since 5.6.0
+     */
+    PRIVATE_MESSAGE_DELIVERED = "PRIVATE_MESSAGE_DELIVERED",
+    /**
+     * 群组消息送达状态通知
+     * @hidden 暂仅 Beem 使用，无需公开
+     * @since 5.6.0
+     */
+    GROUP_MESSAGE_DELIVERED = "GROUP_MESSAGE_DELIVERED"
 }
 /**
  * 发送状态
@@ -202,7 +214,7 @@ declare type IInitOption = {
      */
     __reportLogLevel?: EnableLogL;
     /**
-     * IndexDB 数据库内的日志有效期，单位为小时，默认 IndexDB 内日志数据有效期 72 小时，有效值为 `24` - `168`
+     * IndexDB 数据库内的日志有效期，单位为小时，有效值为 `24` - `168`，默认 IndexDB 内日志数据有效期 168 小时
      */
     logExpireTime?: number;
 };
@@ -840,6 +852,14 @@ declare type EventListeners = {
     [Events.ULTRA_GROUP_CHANNEL_TYPE_CHANGE]: (list: IUltraChannelChangeInfo[]) => void;
     [Events.ULTRA_GROUP_CHANNEL_DELETE]: (list: IUltraChannelDeleteInfo[]) => void;
     [Events.ULTRA_GROUP_CHANNEL_USER_KICKED]: (list: IUltraChannelUserKickedInfo[]) => void;
+    /**
+     * @hidden
+     */
+    [Events.PRIVATE_MESSAGE_DELIVERED]: (list: IMessageDeliver[]) => void;
+    /**
+    * @hidden
+    */
+    [Events.GROUP_MESSAGE_DELIVERED]: (list: IGroupMessageDeliverStatus[]) => void;
 };
 
 /**
@@ -1024,8 +1044,10 @@ declare function setConversationToTop(options: IConversationOption, isTop?: bool
 /**
  * 获取置顶会话
  * @category 会话
+ * @param conversationTypes 会话类型
+ * @param channelId 不传或传 undefined 时获取全部 channelId 类型的置顶会话
  */
-declare function getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+declare function getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>;
 /**
  * 获取单个群会话 @ 消息未读数
  * @category 会话未读数
@@ -1702,7 +1724,7 @@ declare function insertMessage$1(conversation: IConversationOption, content: IRe
  * @category 消息
  * @param messageId 本地消息 ID 或 messageUId
 */
-declare function getMessage(messageId: number): Promise<IAsyncRes<IAReceivedMessage>>;
+declare function getMessage(messageId: number | string): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取会话下所有未读的 @ 消息
  * @category 消息
@@ -1956,9 +1978,11 @@ declare function searchMessageInTimeRange(conversation: {
  * @param option 配置参数
  */
 declare function getHistoryMessagesByMessageTypes(conversation: IConversationOption, option: IGetHistoryMessagesByTypesOption): Promise<IAsyncRes<{
+    /**
+     * @deprecated 字段已废弃即将删除，推荐使用 list
+     */
     messages: IAReceivedMessage[];
-    hasMore: boolean;
-}>>;
+} & GetHistoryMessageResult>>;
 /**
  * 将自己发送的指定时间之前的消息标记对方已读，状态值为 SentStatus.READ
  * @param conversation 会话
@@ -2004,13 +2028,26 @@ declare function clearMessages(conversation: IConversationOption): Promise<IAsyn
 declare function deleteMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>;
 /**
    * 向本地插入一条消息，不发送到服务器
-   * @param conversationType 会话类型
-   * @param targetId 目标 ID
+   * @param conversation 会话
    * @param message 消息体
-   * @param callback
+   * @param options
    * 注意：插入消息时，messageUid 将不会存入数据库
   */
-declare function insertMessage(conversation: IConversationOption, message: IAReceivedMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>;
+declare function insertMessage(conversation: IConversationOption, message: IAReceivedMessage | BaseMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>;
+/**
+ * 获取单聊消息的送达时间
+ * @param messageUId 消息 UID
+ * @hidden 暂时仅 BEEM 使用，无需在文档公开
+ * @description 暂仅支持 Electron 平台
+ */
+declare function getPrivateMessageDeliverTime(messageUId: string): Promise<IAsyncRes<number>>;
+/**
+ * 获取群组消息的送达状态
+ * @param messageUId 消息 UID
+ * @hidden 暂时仅 BEEM 使用，无需在文档公开
+ * @description 暂仅支持 Electron 平台
+ */
+declare function getGroupMessageDeliverList(targetId: string, messageUId: string): Promise<IAsyncRes<IGroupMessageDeliverInfo>>;
 
 /**
  * 清除本地数据, 包括消息列表、会话列表、拉取消息的时间戳
@@ -2031,6 +2068,8 @@ declare const index_deleteMessages: typeof deleteMessages;
 declare const index_clearMessages: typeof clearMessages;
 declare const index_deleteMessagesByTimestamp: typeof deleteMessagesByTimestamp;
 declare const index_insertMessage: typeof insertMessage;
+declare const index_getPrivateMessageDeliverTime: typeof getPrivateMessageDeliverTime;
+declare const index_getGroupMessageDeliverList: typeof getGroupMessageDeliverList;
 declare const index_clearLocalData: typeof clearLocalData;
 declare namespace index {
   export {
@@ -2048,6 +2087,8 @@ declare namespace index {
     index_clearMessages as clearMessages,
     index_deleteMessagesByTimestamp as deleteMessagesByTimestamp,
     index_insertMessage as insertMessage,
+    index_getPrivateMessageDeliverTime as getPrivateMessageDeliverTime,
+    index_getGroupMessageDeliverList as getGroupMessageDeliverList,
     index_clearLocalData as clearLocalData,
   };
 }