@rongcloud/imlib-next 5.0.0-alpha.9 → 5.0.1-custom-qihoo.3

package/dist/index.d.ts

@@ -298,7 +298,14 @@ interface IAReceivedConversation {
      * 会话是否置顶
      */
     isTop?: boolean;
+    /**
+     * 多组织 ID
+     */
     channelId?: string;
+    /**
+     * @ 消息未读数
+     */
+    unreadMentionedCount?: number;
 }
 interface ISendMessageOptions {
     /**
@@ -492,6 +499,15 @@ declare function setConversationToTop(options: IConversationOption, isTop?: bool
  * 获取置顶会话
  */
 declare function getTopConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>;
+/**
+ * 获取单个群会话 @ 消息未读数
+ * @param targetId 目标 ID
+ */
+declare function getUnreadMentionedCount(options: IConversationOption): Promise<IAsyncRes<number>>;
+/**
+ * 获取所有群会话 @ 消息未读数
+ */
+declare function getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
 
 /**
    * 加入聊天室
@@ -592,9 +608,25 @@ declare class BaseMessage<T = any> {
     readonly isCounted: boolean;
     constructor(messageType: string, content: T, isPersited?: boolean, isCounted?: boolean);
 }
-declare type DyncmicMessageTypeDefined<T> = new (content: T) => BaseMessage<T>;
+declare type MessageConstructor<T> = new (content: T) => BaseMessage<T>;
 
-interface IImageMessageBody {
+/**
+ * 群组内的消息包含的 @ 数据
+ */
+declare class MentionedInfo {
+    type?: MentionedType | undefined;
+    userIdList?: string[] | undefined;
+    mentionedContent?: string | undefined;
+    constructor(type?: MentionedType | undefined, userIdList?: string[] | undefined, mentionedContent?: string | undefined);
+}
+interface IMentionedInfo {
+    /**
+     * 群组消息中的 @ 信息
+     */
+    mentionedInfo?: MentionedInfo;
+}
+
+interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
     /**
     * 图片的略缩图
     * @description
@@ -608,12 +640,9 @@ interface IImageMessageBody {
      */
     imageUri: string;
 }
-declare const _default$a: DyncmicMessageTypeDefined<IImageMessageBody>;
+declare const _default$a: MessageConstructor<IImageMessageBody>;
 
-/**
- * 图片消息
- */
-interface IHQVoiceMessageBody {
+interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
     /**
      * 远程媒体资源地址
      */
@@ -627,12 +656,9 @@ interface IHQVoiceMessageBody {
      */
     duration: number;
 }
-declare const _default$9: DyncmicMessageTypeDefined<IHQVoiceMessageBody>;
+declare const _default$9: MessageConstructor<IHQVoiceMessageBody>;
 
-/**
- * 短视频消息
- */
-interface ISightMessageBody {
+interface ISightMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
     /**
      * 远程视频资源 url 地址
      */
@@ -655,23 +681,7 @@ interface ISightMessageBody {
      */
     name: string;
 }
-declare const _default$8: DyncmicMessageTypeDefined<ISightMessageBody>;
-
-/**
- * 群组内的消息包含的 @ 数据
- */
-declare class MentionedInfo {
-    type?: MentionedType | undefined;
-    userIdList?: string[] | undefined;
-    mentionedContent?: string | undefined;
-    constructor(type?: MentionedType | undefined, userIdList?: string[] | undefined, mentionedContent?: string | undefined);
-}
-interface IMentionedInfo {
-    /**
-     * 群组消息中的 @ 信息
-     */
-    mentionedInfo?: MentionedInfo;
-}
+declare const _default$8: MessageConstructor<ISightMessageBody>;
 
 /**
  * 文本消息
@@ -682,9 +692,9 @@ interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
      */
     content: string;
 }
-declare const _default$7: DyncmicMessageTypeDefined<ITextMessageBody>;
+declare const _default$7: MessageConstructor<ITextMessageBody>;
 
-interface ICombineMessageBody {
+interface ICombineMessageBody extends IExtraData, IUserInfo {
     /**
      * 存储在融云服务器的远端 HTML 文件路径
      */
@@ -702,12 +712,9 @@ interface ICombineMessageBody {
     */
     conversationType: ConversationType;
 }
-declare const _default$6: DyncmicMessageTypeDefined<ICombineMessageBody>;
+declare const _default$6: MessageConstructor<ICombineMessageBody>;
 
-/**
- * 文件消息
- */
-interface IFileMessageBody {
+interface IFileMessageBody extends IExtraData, IUserInfo {
     /**
      * 文件名称
      */
@@ -725,7 +732,7 @@ interface IFileMessageBody {
      */
     fileUrl: string;
 }
-declare const _default$5: DyncmicMessageTypeDefined<IFileMessageBody>;
+declare const _default$5: MessageConstructor<IFileMessageBody>;
 
 interface IGIFMessageBody extends IExtraData, IUserInfo {
     /**
@@ -745,14 +752,14 @@ interface IGIFMessageBody extends IExtraData, IUserInfo {
      */
     height: number;
 }
-declare const _default$4: DyncmicMessageTypeDefined<IGIFMessageBody>;
+declare const _default$4: MessageConstructor<IGIFMessageBody>;
 
 interface IVoiceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
     content: string;
     duration: number;
     extra: string;
 }
-declare const _default$3: DyncmicMessageTypeDefined<IVoiceMessageBody>;
+declare const _default$3: MessageConstructor<IVoiceMessageBody>;
 
 interface ILocationMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
     /**
@@ -772,7 +779,7 @@ interface ILocationMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
      */
     content: string;
 }
-declare const _default$2: DyncmicMessageTypeDefined<ILocationMessageBody>;
+declare const _default$2: MessageConstructor<ILocationMessageBody>;
 
 interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
     /**
@@ -792,7 +799,7 @@ interface IReferenceMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
      */
     objName: string;
 }
-declare const _default$1: DyncmicMessageTypeDefined<IReferenceMessageBody>;
+declare const _default$1: MessageConstructor<IReferenceMessageBody>;
 
 interface IArticle {
     title: string;
@@ -802,7 +809,7 @@ interface IArticle {
 }
 interface IRichContentMessageBody extends IArticle, IExtraData, IMentionedInfo, IUserInfo {
 }
-declare const _default: DyncmicMessageTypeDefined<IRichContentMessageBody>;
+declare const _default: MessageConstructor<IRichContentMessageBody>;
 
 /**
 * 发送消息
@@ -810,21 +817,75 @@ declare const _default: DyncmicMessageTypeDefined<IRichContentMessageBody>;
 */
 declare function sendMessage(conversation: IConversationOption, message: BaseMessage, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
 declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageBody, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
-declare function sendFileMessage(conversation: IConversationOption, file: Blob, onProgress?: Function, options?: ISendMessageOptions): Promise<unknown>;
-declare function sendImageMessage(conversation: IConversationOption, image: Blob, onProgress?: Function, options?: ISendMessageOptions): Promise<unknown>;
-declare function sendHQVoiceMessage(conversation: IConversationOption, audio: Blob, onProgress?: Function, options?: ISendMessageOptions): Promise<unknown>;
-declare function sendSightMessage(conversation: IConversationOption, messageBody: {
-    video: Blob;
+declare type ISendBody = IUserInfo & IExtraData & {
+    file: Blob;
+};
+/**
+ * 发送文件消息
+ */
+declare const sendFileMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: {
+    /**
+     * 文件上传进度回调
+     */
+    onProgress?: ((progress: number) => void) | undefined;
+    /**
+     * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
+     */
+    onComplete?: ((fileInfo: {
+        url: string;
+    }) => (void | BaseMessage)) | undefined;
+} | undefined, sendOptions?: ISendMessageOptions | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
+/**
+ * 发送图片消息
+ */
+declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: {
+    /**
+     * 文件上传进度回调
+     */
+    onProgress?: ((progress: number) => void) | undefined;
+    /**
+     * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
+     */
+    onComplete?: ((fileInfo: {
+        url: string;
+    }) => (void | BaseMessage)) | undefined;
+} | undefined, sendOptions?: ISendMessageOptions | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
+/**
+ * 发送高清语音消息，待发送的文件必须为 AAC 音频文件
+ */
+declare const sendHQVoiceMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: {
+    /**
+     * 文件上传进度回调
+     */
+    onProgress?: ((progress: number) => void) | undefined;
+    /**
+     * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
+     */
+    onComplete?: ((fileInfo: {
+        url: string;
+    }) => (void | BaseMessage)) | undefined;
+} | undefined, sendOptions?: ISendMessageOptions | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
+declare type ISendSightMessageOptions = {
     duration: number;
     thumbnail: string;
-    name: string;
-}, onProgress?: Function, options?: ISendMessageOptions): Promise<unknown>;
-declare function sendCombineMessage(conversation: IConversationOption, messageBody: {
-    file: Blob;
-    nameList: string[];
-    summaryList: string[];
-    conversationType: ConversationType;
-}, onProgress?: Function, options?: ISendMessageOptions): Promise<unknown>;
+    name?: string;
+} & ISendBody;
+/**
+ * 发送小视频消息
+ * @description 发送的小视频消息必须是 MP4 文件，且音频编码为 AAC，视频编码 H264，否则可能造成 iOS 或 Android 接收后不可播放问题
+ */
+declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISendSightMessageOptions, hooks?: {
+    /**
+     * 文件上传进度回调
+     */
+    onProgress?: ((progress: number) => void) | undefined;
+    /**
+     * 文件上传完成回调，可通过修改返回值以修改待发布的消息内容，如实现自定义消息
+     */
+    onComplete?: ((fileInfo: {
+        url: string;
+    }) => (void | BaseMessage)) | undefined;
+} | undefined, sendOptions?: ISendMessageOptions | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
 /**
  * 获取历史消息
  */
@@ -836,12 +897,12 @@ declare function getRemoteHistoryMessages(conversation: IConversationOption, opt
 /**
  * 发送单聊已读回执
  */
-declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number): Promise<IAsyncRes<void>>;
+declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<void>>;
 /**
  * 发送群已读回执请求
  * @param messageUIds 消息UID列表
  */
-declare function sendReadReceiptRequest(targetId: string, messageUId: string): Promise<IAsyncRes<void>>;
+declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<void>>;
 /**
  * 发送群阅读回执响应
  */
@@ -1158,4 +1219,4 @@ declare const MessageType: {
     RECALL_MESSAGE_TYPE: string;
 };
 
-export { BaseMessage, _default$6 as CombineMessage, ConnectType, Events, _default$5 as FileMessage, _default$4 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$9 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationUpdateItem, IFileMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IImageMessageBody, IInitOption, ILocationMessageBody, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISendMessageOptions, ISightMessageBody, ITextMessageBody, IVoiceMessageBody, _default$a as ImageMessage, _default$2 as LocationMessage, MentionedInfo$1 as MentionedInfo, MessageType, _default$1 as ReferenceMessage, _default as RichContentMessage, _default$8 as SightMessage, _default$7 as TextMessage, _default$3 as VoiceMessage, addConversationsToTag, addEventListener, addTag, clearEventListeners, clearHistoryMessages, clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, deleteLocalMessagesByTimestamp, deleteMessages, disconnect, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversationList, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getFileToken, getFileUrl, getFirstUnreadMessage, getHistoryMessages, getMessage, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getUnreadCount, getUnreadCountByTag, getUnreadMentionedMessages, init, insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent, searchMessages, sendCombineMessage, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, setChatRoomEntries, setChatRoomEntry, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus, updateMessageExpansion, updateTag };
+export { BaseMessage, _default$6 as CombineMessage, ConnectType, Events, _default$5 as FileMessage, _default$4 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$9 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationUpdateItem, IFileMessageBody, IGIFMessageBody, IHQVoiceMessageBody, IImageMessageBody, IInitOption, ILocationMessageBody, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISendMessageOptions, ISightMessageBody, ITextMessageBody, IVoiceMessageBody, _default$a as ImageMessage, _default$2 as LocationMessage, MentionedInfo$1 as MentionedInfo, MessageConstructor, MessageType, _default$1 as ReferenceMessage, _default as RichContentMessage, _default$8 as SightMessage, _default$7 as TextMessage, _default$3 as VoiceMessage, addConversationsToTag, addEventListener, addTag, clearEventListeners, clearHistoryMessages, clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, deleteLocalMessagesByTimestamp, deleteMessages, disconnect, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllUnreadMentionedCount, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversationList, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getFileToken, getFileUrl, getFirstUnreadMessage, getHistoryMessages, getMessage, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent, searchMessages, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, setChatRoomEntries, setChatRoomEntry, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus, updateMessageExpansion, updateTag };