@rongcloud/imlib-next 5.5.2 → 5.5.4

package/index.d.ts

@@ -1,4 +1,4 @@
-import { LogLevel, MessageDirection, ReceivedStatus, IReadReceiptInfo, IPushConfig, ConnectionStatus, ErrorCode, IReceivedMessage, IConversationOption, IUpdatedConversation, IChatroomListenerData, IExpansionListenerData, ITypingMessage, IBlockedMessageInfo, IReceivedConversation, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUserProfile, ConversationType, IBaseConversationInfo, IConversationState, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedType, IMessageReaderResponse, ITagParam, ITagInfo, IConversationTag, IReceivedConversationByTag, FileType, IUploadAuth, UploadMethod } from '@rongcloud/engine';
+import { LogLevel, MessageDirection, ReceivedStatus, IReadReceiptInfo, IPushConfig, NotificationStatus, NotificationLevel, IUserProfile, IReceivedMessage, IConversationOption, ITypingMessage, ConnectionStatus, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IReceivedConversation, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IPluginGenerator, IAsyncRes, ConversationType, IBaseConversationInfo, IConversationState, 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, 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, ILogExtensions, ILogInfo, ILogInit, IMessageReader, IMessageReaderResponse, IOperateStatusNotify, IPluginGenerator, 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, LogLevel, LogSource, LogTagId, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, ReceivedStatus, UltraGroupChannelType, UploadMethod, logger } from '@rongcloud/engine';
 
 declare enum Events {
@@ -233,94 +233,6 @@ declare type GetHistoryMessageResult = {
     hasMore: boolean;
 };
 
-declare type EventListeners = {
-    [Events.CONNECTING]: () => void;
-    [Events.CONNECTED]: () => void;
-    [Events.DISCONNECT]: (status: ConnectionStatus) => void;
-    [Events.SUSPEND]: (status: ConnectionStatus | ErrorCode) => void;
-    [Events.MESSAGES]: (messages: IReceivedMessage[]) => void;
-    [Events.READ_RECEIPT_RECEIVED]: (conversation: IConversationOption, messageUId: string, sentTime: number) => void;
-    [Events.MESSAGE_RECEIPT_REQUEST]: (conversation: IConversationOption, messageUId: string, senderUserId: string) => void;
-    [Events.MESSAGE_RECEIPT_RESPONSE]: (conversation: IConversationOption, receivedUserId: string, messageUIdList: string[]) => void;
-    [Events.CONVERSATION]: (conversations: IUpdatedConversation[]) => void;
-    [Events.CHATROOM]: (event: IChatroomListenerData) => void;
-    [Events.EXPANSION]: (event: IExpansionListenerData) => void;
-    [Events.PULL_OFFLINE_MESSAGE_FINISHED]: () => void;
-    [Events.TAG]: () => void;
-    [Events.CONVERSATION_TAG]: () => void;
-    [Events.TYPING_STATUS]: (event: ITypingMessage[]) => void;
-    [Events.MESSAGE_BLOCKED]: (data: IBlockedMessageInfo) => void;
-    [Events.ULTRA_GROUP_ENABLE]: (list: IReceivedConversation[]) => void;
-    [Events.OPERATE_STATUS]: (status: IOperateStatusNotify) => void;
-    [Events.ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED]: (list: IReceivedMessage[]) => void;
-    [Events.ULTRA_GROUP_MESSAGE_MODIFIED]: (list: IReceivedMessage[]) => void;
-    [Events.ULTRA_GROUP_MESSAGE_RECALLED]: (list: IReceivedMessage[]) => void;
-    [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;
-};
-/**
- * 初始化
- * @param initOption
- */
-declare const init: (initOption: IInitOption) => void;
-/**
- * 装载 plugin 插件，并返回相应的插件实例，需在调用 `connect` 方法之前使用
- * @param plugins
- */
-declare function installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
-/**
- * 建立 IM 连接
- * @param token
- * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
- */
-declare function connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{
-    userId: string;
-}>>;
-/**
- * 断开当前用户的连接
- * @description 调用后将不再接收消息，不可发送消息，不可获取历史消息，不可获取会话列表
- */
-declare function disconnect(): Promise<void>;
-/**
- * 获取 IM 连接状态
- */
-declare function getConnectionStatus(): ConnectionStatus;
-/**
- * 当前服务器时间
- * 校准时间，可能存在误差
- */
-declare function getServerTime(): number;
-/**
-  * 获取 IM 连接用户的 id
-  */
-declare function getCurrentUserId(): string;
-/**
- * 绑定事件
- * @param eventType
- * @param listener
- * @param target
- */
-declare function addEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
-declare function onceEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
-/**
- * 移除事件
- */
-declare function removeEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
-/**
- * 移除同一类型下的所有事件
- */
-declare function removeEventListeners(eventType: string): void;
-/**
- * 清理所有事件
- */
-declare function clearEventListeners(): void;
-declare function __addSDKVersion(name: string, version: string): void;
-/**
- * 获取 deviceId
- */
-declare function getDeviceId(): string;
-
 declare class BaseMessage<T = any> {
     readonly messageType: string;
     content: T;
@@ -627,6 +539,154 @@ interface ISearchMessageInTimeRangeOption {
     offset?: number;
     limit?: number;
 }
+interface IMessagesEvent {
+    /**
+     * 接收的消息数据
+     */
+    messages: IReceivedMessage[];
+}
+interface IReadReceiptReceivedEvent {
+    /**
+     * 会话信息，包含会话属性
+     */
+    conversation: IConversationOption;
+    /**
+     * 消息的唯一 id
+     */
+    messageUId: string;
+    /**
+    * 消息发送时间
+    */
+    sentTime: number;
+}
+interface IMessageReceiptRequestEvent {
+    /**
+     * 会话信息，包含会话属性
+     */
+    conversation: IConversationOption;
+    /**
+     * 消息的唯一 id
+     */
+    messageUId: string;
+    /**
+     * 发送者ID
+     */
+    senderUserId: string;
+}
+interface IMessageReceiptResponseEvent {
+    /**
+     * 会话信息，包含会话属性
+     */
+    conversation: IConversationOption;
+    /**
+     * 接收者ID
+     */
+    receivedUserId: string;
+    /**
+     * 消息的唯一 id 列表
+     */
+    messageUIdList: string[];
+}
+interface ITypingStatusEvent {
+    /**
+     * typing 状态
+     */
+    status: ITypingMessage[];
+}
+interface IConversationEvent {
+    /**
+     * 会话信息数组
+     */
+    conversations: [];
+}
+
+declare type EventListeners = {
+    [Events.CONNECTING]: () => void;
+    [Events.CONNECTED]: () => void;
+    [Events.DISCONNECT]: (status: ConnectionStatus) => void;
+    [Events.SUSPEND]: (status: ConnectionStatus | ErrorCode) => void;
+    [Events.MESSAGES]: (event: IMessagesEvent) => void;
+    [Events.READ_RECEIPT_RECEIVED]: (event: IReadReceiptReceivedEvent) => void;
+    [Events.MESSAGE_RECEIPT_REQUEST]: (event: IMessageReceiptRequestEvent) => void;
+    [Events.MESSAGE_RECEIPT_RESPONSE]: (event: IMessageReceiptResponseEvent) => void;
+    [Events.CONVERSATION]: (event: IConversationEvent) => void;
+    [Events.CHATROOM]: (event: IChatroomListenerData) => void;
+    [Events.EXPANSION]: (event: IExpansionListenerData) => void;
+    [Events.PULL_OFFLINE_MESSAGE_FINISHED]: () => void;
+    [Events.TAG]: () => void;
+    [Events.CONVERSATION_TAG]: () => void;
+    [Events.TYPING_STATUS]: (event: ITypingStatusEvent) => void;
+    [Events.MESSAGE_BLOCKED]: (data: IBlockedMessageInfo) => void;
+    [Events.ULTRA_GROUP_ENABLE]: (list: IReceivedConversation[]) => void;
+    [Events.OPERATE_STATUS]: (status: IOperateStatusNotify) => void;
+    [Events.ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED]: (list: IReceivedMessage[]) => void;
+    [Events.ULTRA_GROUP_MESSAGE_MODIFIED]: (list: IReceivedMessage[]) => void;
+    [Events.ULTRA_GROUP_MESSAGE_RECALLED]: (list: IReceivedMessage[]) => void;
+    [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;
+};
+/**
+ * 初始化
+ * @param initOption
+ */
+declare const init: (initOption: IInitOption) => void;
+/**
+ * 装载 plugin 插件，并返回相应的插件实例，需在调用 `connect` 方法之前使用
+ * @param plugins
+ */
+declare function installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
+/**
+ * 建立 IM 连接
+ * @param token
+ * @param reconnectKickEnable 设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
+ */
+declare function connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{
+    userId: string;
+}>>;
+/**
+ * 断开当前用户的连接
+ * @description 调用后将不再接收消息，不可发送消息，不可获取历史消息，不可获取会话列表
+ */
+declare function disconnect(): Promise<void>;
+/**
+ * 获取 IM 连接状态
+ */
+declare function getConnectionStatus(): ConnectionStatus;
+/**
+ * 当前服务器时间
+ * 校准时间，可能存在误差
+ */
+declare function getServerTime(): number;
+/**
+  * 获取 IM 连接用户的 id
+  */
+declare function getCurrentUserId(): string;
+/**
+ * 绑定事件
+ * @param eventType
+ * @param listener
+ * @param target
+ */
+declare function addEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
+declare function onceEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
+/**
+ * 移除事件
+ */
+declare function removeEventListener<T extends Events>(eventType: T, listener: EventListeners[T], target?: any): void;
+/**
+ * 移除同一类型下的所有事件
+ */
+declare function removeEventListeners(eventType: string): void;
+/**
+ * 清理所有事件
+ */
+declare function clearEventListeners(): void;
+declare function __addSDKVersion(name: string, version: string): void;
+/**
+ * 获取 deviceId
+ */
+declare function getDeviceId(): string;
 
 /**
  * 获取会话列表
@@ -1662,4 +1722,4 @@ declare namespace index {
   };
 }
 
-export { BaseMessage, _default$6 as CombineMessage, ConnectType, EventListeners, Events, _default$5 as FileMessage, _default$4 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$9 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, IUploadHooks, IUploadMessageOption, IUserInfo, IVoiceMessageBody, _default$a as ImageMessage, _default$2 as LocationMessage, MentionedInfo$1 as MentionedInfo, MentionedInfo as MentionedInfoBody, MessageConstructor, MessageType, _default$1 as ReferenceMessage, _default as RichContentMessage, SentStatus, _default$8 as SightMessage, _default$7 as TextMessage, _default$3 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getFileToken, getFileUrl, getFirstUnreadMessage, getHistoryMessages, getMessage, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus$1 as setMessageReceivedStatus, setUltraGroupDefaultNotificationLevel, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateTag };
+export { BaseMessage, _default$6 as CombineMessage, ConnectType, EventListeners, Events, _default$5 as FileMessage, _default$4 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$9 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationEvent, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadHooks, IUploadMessageOption, IUserInfo, IVoiceMessageBody, _default$a as ImageMessage, _default$2 as LocationMessage, MentionedInfo$1 as MentionedInfo, MentionedInfo as MentionedInfoBody, MessageConstructor, MessageType, _default$1 as ReferenceMessage, _default as RichContentMessage, SentStatus, _default$8 as SightMessage, _default$7 as TextMessage, _default$3 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getFileToken, getFileUrl, getFirstUnreadMessage, getHistoryMessages, getMessage, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus$1 as setMessageReceivedStatus, setUltraGroupDefaultNotificationLevel, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateTag };