@rongcloud/imlib-next 5.18.0-alpha.2 → 5.18.0

package/index.d.ts

@@ -65,11 +65,11 @@ interface IUploadResult {
      */
     thumbnail?: string;
     /**
-     * 图片宽度
+     * 图片或缩略图宽度
      */
     width?: number;
     /**
-     * 图片高度
+     * 图片或缩略图高度
      */
     height?: number;
 }
@@ -443,31 +443,6 @@ declare function getDeviceId(): string;
  */
 declare function installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null;
 
-declare type API = (...args: any[]) => any;
-/** 可监控的 API */
-declare type MonitorableAPI<T extends API = API> = T & {
-    /** API 是否可被监控 */
-    monitorable: boolean;
-    /** 方法名 */
-    name: string;
-    /** 原始 API，调用该 API 不会触发监控 */
-    original: T;
-};
-/** 监听器类型 */
-declare type Monitor<T extends MonitorableAPI = MonitorableAPI> = (args: Parameters<T['original']>, result: ReturnType<T['original']>) => void;
-declare type Transformer<T extends MonitorableAPI<API> = MonitorableAPI<API>> = (args: Parameters<T['original']>) => Parameters<T['original']>;
-/**
- * 为 API 添加监听器，以监控调用行为，当指定 API 被调用时，会触发回调
- * @param api - 需要监控的 API 函数
- * @param monitor - 监控器函数
- * @param transformer - 参数的预处理函数，允许监控器在 API 执行之前对参数进行修改
- */
-declare function addMonitor<T extends MonitorableAPI>(api: T, monitor: Monitor<T>, transformer?: Transformer<T>): number;
-/**
- * 移除 API 监控
- */
-declare function removeMonitor(id: number): void;
-
 /**
  * 建立 IM 连接
  * @description 传入从用户身份令牌（Token），向融云聊天服务器发起连接请求。
@@ -503,7 +478,7 @@ declare function connect(token: string, reconnectKickEnable?: boolean): Promise<
  * console.info('成功断开');
  * ```
  */
-declare const disconnect: MonitorableAPI<(closeDB?: boolean | undefined) => Promise<void>>;
+declare function disconnect(closeDB?: boolean): Promise<void>;
 
 /**
  * 事件监听名称
@@ -1508,7 +1483,7 @@ declare function getConversation(options: IConversationOption): Promise<IAsyncRe
  * console.info('移除指定的会话结果：', conversation);
  * ```
  */
-declare const removeConversation: MonitorableAPI<(options: IConversationOption) => Promise<IAsyncRes<void>>>;
+declare function removeConversation(options: IConversationOption): Promise<IAsyncRes<void>>;
 /**
  * 批量删除会话
  * @param conversations 会话列表，最大数量为 20
@@ -1685,7 +1660,7 @@ declare function getUnreadCount(options: IConversationOption): Promise<IAsyncRes
  * console.info('清除指定会话未读数结果：', clearRes);
  * ```
  */
-declare const clearMessagesUnreadStatus: MonitorableAPI<(options: IConversationOption) => Promise<IAsyncRes<void>>>;
+declare function clearMessagesUnreadStatus(options: IConversationOption): Promise<IAsyncRes<void>>;
 /**
  * 清理全部未读数
  * @category 会话未读数
@@ -1723,7 +1698,7 @@ declare function clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>;
  * const res = await RongIMLib.setConversationNotificationLevel(options, notificationLevel);
  * console.info('设置会话免打扰结果：', res);
  */
-declare const setConversationNotificationLevel: MonitorableAPI<(options: IConversationOption, notificationLevel: NotificationLevel) => Promise<IAsyncRes<void>>>;
+declare function setConversationNotificationLevel(options: IConversationOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
 /**
  * 批量设置会话免打扰级别
  * @param conversations 会话列表, 最大数量为 20
@@ -1830,7 +1805,7 @@ declare function getConversationTypeNotificationLevel(conversationType: Conversa
  * console.info('设置会话是否置顶结果：', res);
  * ```
  */
-declare const setConversationToTop: MonitorableAPI<(options: IConversationOption, isTop?: boolean, isUpdateTime?: boolean) => Promise<IAsyncRes<void>>>;
+declare function setConversationToTop(options: IConversationOption, isTop?: boolean, isUpdateTime?: boolean): Promise<IAsyncRes<void>>;
 /**
  * 批量设置会话置顶
  * @param conversations 会话数组, 最大数量为 20
@@ -2671,6 +2646,16 @@ interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo, IAudi
      * 原图远程地址
      */
     imageUri: string;
+    /**
+     * 略缩图宽度
+     * @since 5.18.0
+     */
+    thumWidth?: number;
+    /**
+     * 略缩图高度
+     * @since 5.18.0
+     */
+    thumHeight?: number;
 }
 declare const _default$f: MessageConstructor<IImageMessageBody>;
 
@@ -3688,7 +3673,7 @@ declare const getMessage: typeof getLocalMessage;
 * console.info('消息发送结果：', sendRes);
 * ```
 */
-declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, message: BaseMessage, options?: ISendMessageOptions | undefined) => Promise<IAsyncRes<IAReceivedMessage>>>;
+declare function sendMessage(conversation: IConversationOption, message: BaseMessage, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 /**
 * 发送文本消息
 * @description 发送文本消息的快捷方式，等同于使用 new TextMessage() 创建消息体后调用 sendMessage() 方法
@@ -4104,7 +4089,7 @@ declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOpt
  * ```
  * @returns 返回一个 {@link IAsyncRes} 类型 Promise，data 结构为 {@link IAReceivedMessage} 类型
  */
-declare const recallMessage: MonitorableAPI<(conversation: IConversationOption, options: IRecallMessageOptions) => Promise<RCResult<IAReceivedMessage>>>;
+declare function recallMessage(conversation: IConversationOption, options: IRecallMessageOptions): Promise<RCResult<IAReceivedMessage>>;
 /**
  * 按消息 UId 删除消息
  * @category 消息
@@ -5319,4 +5304,4 @@ declare function getNotificationQuietHoursSetting(): Promise<RCResult<INotificat
 
 declare type IStreamMessageResponseEventData = IStreamMessageResponseEventData$1<IAReceivedMessage>;
 
-export { BaseMessage, _default$b as CombineMessage, _default$a as CombineV2Message, CombineV2MessageContent, _default$3 as CommandMessage, ConnectType, EventListeners, Events, _default$9 as FileMessage, _default$8 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$1 as GroupNotificationMessage, _default$e as HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, IAuditInfo, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, IStreamMessageBody, IStreamMessageResponseEventData, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadConfig, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, _default$f as ImageMessage, _default$2 as InformationNotificationMessage, _default$6 as LocationMessage, MentionedInfo, MessageAuditType, MessageConstructor, MessageType, Monitor, MonitorableAPI, _default$5 as ReferenceMessage, _default$4 as RichContentMessage, _default$d as SightMessage, _default as StreamMessage, _default$c as TextMessage, Transformer, UploadTask, _default$7 as VoiceMessage, __addSDKVersion, acceptFriendApplication, acceptGroupApplication, acceptGroupInvite, addConversationsToTag, addEventListener, addFriend, addGroupFollows, addGroupManagers, addMonitor, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, bindRTCRoomForChatroom, checkFriends, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages, clearMessagesUnreadStatus, clearRealtimeConUnreadCount, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createGroup, createUploadTask, deleteFriends, deleteLocalMessagesByTimestamp, deleteMessages, destroy, disconnect, dismissGroup, 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, getConversationTypeNotificationLevel, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getFriendAddPermission, getFriendApplications, getFriends, getFriendsInfo, getGroupApplications, getGroupFollows, getGroupMembers, getGroupMembersByRole, getGroupsInfo, getHistoryMessages, getJoinedGroups, getJoinedGroupsByRole, getMessage, getMessageReadReceiptV4, getMessageReader, getMyUserProfile, getMyUserProfileVisibility, getNotificationQuietHoursSetting, getProxy, getRealtimeConTotalUnreadCount, getRealtimeConUnreadCounts, getRealtimeConversations, getRemoteHistoryMessages, getServerTime, getSubscribeUserList, getSubscribeUserStatus, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, getUserProfiles, init, insertMessage, installPlugin, inviteUsersToGroup, joinChatRoom, joinExistChatRoom, joinGroup, kickGroupMembers, modifyMessage, onceEventListener, quitChatRoom, quitGroup, recallMessage, refuseFriendApplication, refuseGroupApplication, refuseGroupInvite, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeGroupFollows, removeGroupManagers, removeMessageExpansionForKey, removeMonitor, removeNotificationQuietHoursSetting, removeRealtimeConversations, removeTag, removeTagFromConversations, removeTagsFromConversation, requestStreamMessageContent, saveTextMessageDraft, searchConversationByContent, searchFriendsInfo, searchGroupMembers, searchJoinedGroups, searchMessages, searchUserProfileByUniqueId, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setConversationTypeNotificationLevel, setFriendAddPermission, setFriendInfo, setGroupMemberInfo, setGroupRemark, setMessageReceivedStatus, setNotificationQuietHoursWithSetting, setProxy, setUltraGroupDefaultNotificationLevel, stopUploadTask, subscribeUserStatus, testProxy, transferGroupOwner, unSubscribeUserStatus, updateExpansionForUltraGroupMessage, updateGroupInfo, updateMessageExpansion, updateMyUserProfile, updateMyUserProfileVisibility, updateTag, upload };
+export { BaseMessage, _default$b as CombineMessage, _default$a as CombineV2Message, CombineV2MessageContent, _default$3 as CommandMessage, ConnectType, EventListeners, Events, _default$9 as FileMessage, _default$8 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$1 as GroupNotificationMessage, _default$e as HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, IAuditInfo, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, IStreamMessageBody, IStreamMessageResponseEventData, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadConfig, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, _default$f as ImageMessage, _default$2 as InformationNotificationMessage, _default$6 as LocationMessage, MentionedInfo, MessageAuditType, MessageConstructor, MessageType, _default$5 as ReferenceMessage, _default$4 as RichContentMessage, _default$d as SightMessage, _default as StreamMessage, _default$c as TextMessage, UploadTask, _default$7 as VoiceMessage, __addSDKVersion, acceptFriendApplication, acceptGroupApplication, acceptGroupInvite, addConversationsToTag, addEventListener, addFriend, addGroupFollows, addGroupManagers, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, bindRTCRoomForChatroom, checkFriends, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages, clearMessagesUnreadStatus, clearRealtimeConUnreadCount, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createGroup, createUploadTask, deleteFriends, deleteLocalMessagesByTimestamp, deleteMessages, destroy, disconnect, dismissGroup, 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, getConversationTypeNotificationLevel, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getFriendAddPermission, getFriendApplications, getFriends, getFriendsInfo, getGroupApplications, getGroupFollows, getGroupMembers, getGroupMembersByRole, getGroupsInfo, getHistoryMessages, getJoinedGroups, getJoinedGroupsByRole, getMessage, getMessageReadReceiptV4, getMessageReader, getMyUserProfile, getMyUserProfileVisibility, getNotificationQuietHoursSetting, getProxy, getRealtimeConTotalUnreadCount, getRealtimeConUnreadCounts, getRealtimeConversations, getRemoteHistoryMessages, getServerTime, getSubscribeUserList, getSubscribeUserStatus, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, getUserProfiles, init, insertMessage, installPlugin, inviteUsersToGroup, joinChatRoom, joinExistChatRoom, joinGroup, kickGroupMembers, modifyMessage, onceEventListener, quitChatRoom, quitGroup, recallMessage, refuseFriendApplication, refuseGroupApplication, refuseGroupInvite, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeGroupFollows, removeGroupManagers, removeMessageExpansionForKey, removeNotificationQuietHoursSetting, removeRealtimeConversations, removeTag, removeTagFromConversations, removeTagsFromConversation, requestStreamMessageContent, saveTextMessageDraft, searchConversationByContent, searchFriendsInfo, searchGroupMembers, searchJoinedGroups, searchMessages, searchUserProfileByUniqueId, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setConversationTypeNotificationLevel, setFriendAddPermission, setFriendInfo, setGroupMemberInfo, setGroupRemark, setMessageReceivedStatus, setNotificationQuietHoursWithSetting, setProxy, setUltraGroupDefaultNotificationLevel, stopUploadTask, subscribeUserStatus, testProxy, transferGroupOwner, unSubscribeUserStatus, updateExpansionForUltraGroupMessage, updateGroupInfo, updateMessageExpansion, updateMyUserProfile, updateMyUserProfileVisibility, updateTag, upload };