@rongcloud/imlib-next 5.0.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,1000 @@
+import { LogLevel, MessageDirection, IReadReceiptInfo, IPushConfig, IPluginGenerator, ConnectionStatus, IEventListener, NotificationStatus, IConversationOption, IReceivedConversation, ConversationType, IChatroomInfo, IUserProfile, IMessageReaderResponse, IAsyncRes, IReceivedMessage, ITagParam, ITagInfo, IConversationTag, IReceivedConversationByTag } from '@rongcloud/engine';
+export { ConnectionStatus, ConversationType, IChatroomListenerData, IConversationOption, IDeletedExpansion, IExpansionListenerData, IPluginGenerator, IUpdatedExpansion, LogLevel, MessageDirection, NotificationStatus, ReceivedStatus, UploadMethod } from '@rongcloud/engine';
+
+declare type IInitOption = {
+    /**
+     * 应用 appkey 标识
+     */
+    appkey: string;
+    /**
+     * 修改 engine log 打印等级
+     */
+    logLevel?: LogLevel;
+    /**
+     * 修改默认的 log 输出函数
+     */
+    logStdout?: (logLevel: LogLevel, content: string) => void;
+    /**
+     * 自定义导航地址，公有云用户不推荐修改
+     */
+    navigators?: string[];
+    /**
+     * 连接方式，默认使用 'websocket'
+     */
+    connectType?: 'websocket' | 'comet';
+    /**
+     * 小程序平台专属配置
+     */
+    customCMP?: string[];
+    /**
+     * 是否打开 IndexDB 存储, 默认为 true
+     */
+    indexDBSwitch?: boolean;
+    /**
+     * 是否校验证书，默认为 true
+     */
+    checkCA?: boolean;
+};
+/**
+ * 用户收到的消息结构
+ */
+interface IAReceivedMessage {
+    /**
+     * 消息类型
+     * @example RC:TxtMsg
+     */
+    messageType: string;
+    /**
+     * 消息内容
+     */
+    content: Object;
+    /**
+     * 消息发送者的用户 id
+     */
+    senderUserId: string;
+    /**
+     * 会话 id
+     */
+    targetId: string;
+    /**
+     * 会话的业务标识
+     */
+    channelId: string;
+    /**
+     * 会话类型
+     * * 1: 单聊
+     * * 3: 群聊
+     * * 4: 聊天室
+     * * 5: 客服会话
+     * * 6: 系统消息
+     * * 7: 默认关注的公众号
+     * * 8: 手动关注的公众号
+     * * 9: RTCLib 房间
+     */
+    type: number;
+    /**
+     * 消息在服务器端的发送时间
+     */
+    sentTime: number;
+    /**
+     * 消息接收时间，该时间通过消息的 `sentTime` 值在本地进行计算得出，不推荐使用
+     * @description 当 isOffLineMessage 为 true 时，该值无效
+     */
+    receivedTime: number;
+    /**
+     * 服务端存储的消息 Id
+     */
+    messageUId: string;
+    /**
+     * 消息方向
+     * * 1: 发送
+     * * 2: 接收
+     */
+    messageDirection: MessageDirection;
+    /**
+     * 是否存储
+     * @default true
+     */
+    isPersited: boolean;
+    /**
+     * 是否计数
+     * @default true
+     */
+    isCounted: boolean;
+    /**
+     * 是否为离线消息
+     */
+    isOffLineMessage: boolean;
+    /**
+     * 是否为 @ 消息
+     */
+    isMentioned?: boolean;
+    /**
+     * 消息是否静默
+     * @description 静默消息不会发送 Push 信息和本地通知提醒
+     */
+    disableNotification?: boolean;
+    /**
+     * 是否是状态消息
+     */
+    isStatusMessage?: boolean;
+    /**
+     * 是否支持消息扩展
+    */
+    canIncludeExpansion: boolean;
+    /**
+     * 消息扩展
+    */
+    expansion?: {
+        [key: string]: any;
+    } | null;
+    /**
+     * 消息接收状态
+    */
+    receivedStatus: number;
+    /**
+     * 消息已读回执信息，导航配置grpRRVer=1时群组类型消息内存在, 其他情况为undefined
+     */
+    readReceiptInfo?: IReadReceiptInfo;
+    /**
+     * 推送扩展
+     */
+    pushConfig?: IPushConfig;
+}
+declare type ISetChatroomEntryOption = {
+    key: string;
+    value: string;
+    isAutoDelete?: boolean;
+    isSendNotification?: boolean;
+    notificationExtra?: string;
+};
+declare type ISetChatroomEntriesOption = {
+    entries: {
+        key: string;
+        value: string;
+    }[];
+    isAutoDelete?: boolean;
+    notificationExtra?: string;
+};
+declare type IRemoveChatroomEntryOption = {
+    key: string;
+    isSendNotification?: boolean;
+    notificationExtra?: string;
+};
+declare type IRemoveChatroomEntriesOption = {
+    entries: string[];
+    notificationExtra?: string;
+};
+declare type GetHistoryMessageOption = {
+    /**
+     * 获取此时间之前的消息，0 为从当前时间拉取
+     */
+    timestamp?: number;
+    /**
+     * 获取消息的数量，范围: 1-20
+     */
+    count?: number;
+    /**
+     * 获取消息的排列顺序
+     * * 0: 升序
+     * * 1: 降序
+     */
+    order?: 0 | 1;
+};
+declare type GetHistoryMessageResult = {
+    list: IAReceivedMessage[];
+    hasMore: boolean;
+};
+
+/**
+ * 初始化
+ * @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 连接
+ */
+declare function connect(token: string): Promise<{
+    id: string;
+}>;
+/**
+ * 断开当前用户的连接
+ * @description 调用后将不再接收消息，不可发送消息，不可获取历史消息，不可获取会话列表
+ */
+declare function disconnect(): Promise<void>;
+/**
+ * 获取 IM 连接状态
+ */
+declare function getConnectionStatus(): ConnectionStatus;
+/**
+ * 当前服务器时间
+ * 校准时间，可能存在误差
+ */
+declare function getServerTime(): number;
+/**
+  * 获取 IM 连接用户的 id
+  */
+declare function getCurrentUserId(): string;
+/**
+ * 绑定事件
+ */
+declare function addEvent(eventType: string, listener: IEventListener, target?: any): void;
+declare function onceEvent(eventType: string, listener: IEventListener, target?: any): void;
+/**
+ * 移除事件
+ */
+declare function removeEvent(eventType: string, listener: IEventListener, target?: any): void;
+/**
+ * 移除同一类型下的所有事件
+ */
+declare function removeAllEvents(eventType: string): void;
+/**
+ * 清理所有事件
+ */
+declare function clearEvents(): void;
+
+interface IConversationUpdateItem {
+    time: number;
+    val: any;
+}
+declare type MentionedInfo = {
+    /**
+     * `@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人`
+     */
+    type?: 1 | 2;
+    /**
+     * 被 @ 的用户 Id 列表，仅在 `type` 为 `2` 时有效
+     */
+    userIdList?: Array<string>;
+};
+interface IReceivedUpdateConversation {
+    updatedItems: {
+        [key: string]: IConversationUpdateItem;
+    };
+    type: number;
+    targetId: string;
+    latestMessage?: IAReceivedMessage;
+    unreadMessageCount?: number;
+    hasMentioned?: boolean;
+    mentionedInfo?: MentionedInfo;
+    lastUnreadTime?: number;
+    notificationStatus?: NotificationStatus;
+    isTop?: boolean;
+}
+/**
+ * 用户收到的会话结构
+ */
+interface IAReceivedConversation {
+    /**
+     * 会话类型
+     * * 1: 单聊
+     * * 3: 群聊
+     * * 4: 聊天室
+     * * 5: 客服会话
+     * * 6: 系统消息
+     * * 7: 默认关注的公众号
+     * * 8: 手动关注的公众号
+     * * 9: RTCLib 房间
+     */
+    type: number;
+    /**
+     * 会话 id
+     */
+    targetId: string;
+    /**
+     * 会话中的最后一条消息
+     */
+    latestMessage: IAReceivedMessage | null;
+    /**
+     * 当前会话的未读消息数
+     */
+    unreadMessageCount?: number;
+    /**
+     * 是否包含 @ 自己的消息
+     * @description 仅在 `conversationType` 为 `ConversationType.GROUP` 时有效
+     */
+    hasMentioned?: boolean;
+    /**
+     * 消息中的 @ 数据
+     * @description 仅在 `conversationType` 为 `ConversationType.GROUP` 时有效
+     */
+    mentionedInfo?: MentionedInfo;
+    /**
+     * 会话中消息的最后未读时间
+     */
+    lastUnreadTime?: number;
+    /**
+     * 会话免打扰状态
+     * * 1: 开启免打扰
+     * * 2: 关闭免打扰
+     */
+    notificationStatus?: NotificationStatus;
+    /**
+     * 会话是否置顶
+     */
+    isTop?: boolean;
+}
+interface ISendMessageOptions {
+    /**
+     * 是否是状态消息，一般为无需注册的自定义消息
+     * @description
+     * 1. 状态消息只有 pub，没有 ack 应答
+     * 2. 状态消息默认不存储，不计数，`isPersited` 与 `isCounted` 配置将失效
+     */
+    isStatusMessage?: boolean;
+    /**
+     * 是否发送静默消息
+     * @description
+     * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
+     */
+    disableNotification?: boolean;
+    /**
+     * Push 信息
+     */
+    pushContent?: string;
+    /**
+     * Push 通知携带的附加信息
+     */
+    pushData?: string;
+    /**
+     * 是否为 @ 消息，只当 conversationType 值为 `ConversationType.GROUP` 时有效
+     */
+    isMentioned?: boolean;
+    /**
+     * `@` 消息类型
+     * @description `1: @ 所有人 2: @ 指定用户`
+     */
+    mentionedType?: 1 | 2;
+    /**
+     * 被 @ 的用户 Id 列表，当 `mentionedType` 值为 `1` 时，该值可为空
+     */
+    mentionedUserIdList?: string[];
+    /**
+     * 用于发送群定向消息，只当 conversationType 值为 `ConversationType.GROUP` 时有效
+     */
+    directionalUserIdList?: string[];
+    /**
+     * 当对方为 iOS 设备且未在线时，其将收到 Voip Push. 此配置对 Android 无影响
+     */
+    isVoipPush?: boolean;
+    /**
+     * 消息是否支持拓展内容
+     */
+    canIncludeExpansion?: boolean;
+    /**
+     * 消息拓展内容数据
+     */
+    expansion?: {
+        [key: string]: string;
+    };
+    /**
+     * 黑/白名单
+     * @todo 功能未知，需确认
+     */
+    isFilerWhiteBlacklist?: boolean;
+    /**
+     * 移动端推送配置
+    */
+    pushConfig?: IPushConfig;
+}
+interface ISendMessageBody {
+    /**
+     * 消息类型，即消息结构的 ObjectName，某个版本抛弃
+     */
+    messageType: string;
+    /**
+     * 消息内容，某个版本抛弃
+     */
+    content?: any;
+    /**
+     * 是否存储
+     * @description 只在发送未注册过的自定义消息时有效，否则使用注册时的配置
+     */
+    isPersited?: boolean;
+    /**
+     * 是否计数
+     * @description 只在发送未注册过的自定义消息时有效，否则使用注册时的配置
+     */
+    isCounted?: boolean;
+}
+
+/**
+   * 获取会话列表
+   * @param options
+   */
+declare function getConversationList(options: {
+    /**
+     * 会话数量
+     */
+    count?: number;
+    /**
+     * 获取起始时间
+     * 默认值: 0
+     * order 为 0 startTime 默认值为当前时间
+     * order 为 1 startTime 默认值为所有会话中最早的消息时间
+    */
+    startTime?: number;
+    /**
+     * 默认值: 0
+     * 0 获取 startTime 之前的
+     * 1 获取 startTime 之后的
+    */
+    order?: 0 | 1;
+    /**
+     * 强制从服务器拉取
+     */
+    force?: false;
+}, channelId?: string): Promise<{
+    code: number;
+    data: IAReceivedConversation[];
+}>;
+/**
+ * 获取指定会话实例，通过实例可实现向指定会话收发消息等功能
+ * @description 通过该方法获取的会话可能并不存在于当前的会话列表中，此处只作为功能性封装语法糖
+ * @param options
+ */
+declare function getConversation(options: IConversationOption): Promise<{
+    code: number;
+    data: IReceivedConversation | null | undefined;
+}>;
+/**
+ * 移除指定的会话实例
+ */
+declare function removeConversation(options: IConversationOption): Promise<void>;
+/**
+ * 获取会话文本草稿
+ * @params conversationType 会话乐行
+ * @params targetId 目标 ID
+*/
+declare function getTextMessageDraft(options: IConversationOption): Promise<{
+    code: number;
+    data: string;
+}>;
+/**
+ * 设置会话文本草稿
+ * @params conversationType 会话乐行
+ * @params targetId 目标 ID
+ * @params draft 草稿内容
+*/
+declare function saveTextMessageDraft(options: IConversationOption, draft: string): Promise<void>;
+/**
+ * 删除会话文本草稿
+ * @params conversationType 会话乐行
+ * @params targetId 目标 ID
+*/
+declare function clearTextMessageDraft(options: IConversationOption): Promise<void>;
+/**
+ * 获取当前所有会话的消息未读数
+ * @description
+ * 1. 清除浏览器缓存会导致会话未读数不准确
+ * 2. 会话消息未读数存储在 WebStorage 中, 若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
+ * 3. 其他端删除会话可能会导致会话未读数不准确
+ * @param includeMuted 是否包含免打扰会话
+ * @param conversationTypes 要获取未读数的会话类型，若为空，则默认获取单聊、群聊及系统消息未读数
+ */
+declare function getTotalUnreadCount(includeMuted?: boolean, conversationTypes?: ConversationType[]): Promise<{
+    code: number;
+    data: number;
+}>;
+/**
+ * 获取单个会话的未读数
+ *
+ */
+declare function getUnreadCount(options: IConversationOption): Promise<{
+    code: number;
+    data: number;
+}>;
+/**
+ * 清除会话未读数
+ * 原：clearUnreadCount
+ */
+declare function clearMessagesUnreadStatus(options: IConversationOption): Promise<{
+    code: number;
+}>;
+/**
+ * 设置会话免打扰
+ * 原： setConversationStatus，免打扰和置顶一体的
+ * 是否免打扰
+ * * 1: 开启免打扰
+ * * 2: 关闭免打扰
+ */
+declare function setConversationNotificationStatus(conversation: IConversationOption, notificationStatus: NotificationStatus): Promise<void>;
+/**
+ * 获取免打扰状态
+ * getConversationNotificationStatus
+ */
+declare function getConversationNotificationStatus(conversation: IConversationOption): Promise<{
+    code: number;
+    data: NotificationStatus | undefined;
+}>;
+/**
+ * 获取免打扰状态列表
+ * getBlockedConversationList
+ */
+declare function getBlockedConversationList(conversationTypeList: ConversationType[]): Promise<IAReceivedConversation[]>;
+/**
+ * 设置会话是否置顶
+ */
+declare function setConversationToTop(conversation: IConversationOption, isTop?: boolean): Promise<void>;
+/**
+ * 获取置顶会话
+ */
+declare function getTopConversationList(conversationTypeList: ConversationType[]): Promise<IAReceivedConversation[]>;
+
+/**
+   * 加入聊天室
+   */
+declare function joinChatRoom(targetId: string, options: {
+    /**
+      * 拉取消息数
+      */
+    count: number;
+}): Promise<void>;
+/**
+ * 加入已存在的聊天室
+ */
+declare function joinExistChatRoom(targetId: string, options: {
+    /**
+     * 拉取消息数
+     */
+    count: number;
+}): Promise<void>;
+/**
+ * 退出聊天室
+ */
+declare function quitChatRoom(targetId: string): Promise<void>;
+/**
+ * 获取聊天室房间数据
+ * @description count 或 order 有一个为 0 时，只返回成员总数，不返回成员列表信息
+ */
+declare function getChatRoomInfo(targetId: string, options: {
+    /**
+     * 获取聊天室的人数，传值范围：0-20，默认为 0
+     */
+    count?: number;
+    /**
+     * 聊天室的人员排序，默认为 0
+     * * 1: 升序
+     * * 2: 降序
+     */
+    order?: 0 | 1 | 2;
+}): Promise<IChatroomInfo>;
+/**
+ * 设置聊天室自定义属性
+ * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+ */
+declare function setChatRoomEntry(targetId: string, options: ISetChatroomEntryOption): Promise<void>;
+/**
+ * 批量设置聊天室自定义属性
+ * @param options ISetChatroomEntryOption数组
+ */
+declare function setChatRoomEntries(targetId: string, options: ISetChatroomEntriesOption): Promise<void>;
+/**
+ * 强制 增加/修改 任意聊天室属性
+ * @description 仅聊天室中不存在此属性或属性设置者为己方时可设置成功
+ */
+declare function forceSetChatRoomEntry(targetId: string, options: ISetChatroomEntryOption): Promise<void>;
+/**
+ * 删除聊天室属性
+ * @description 仅限于删除自己设置的聊天室属性
+ * @param key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+ * @param isSendNotification? 删除成功后是否发送通知消息
+ * @param notificationExtra? RC:chrmKVNotiMsg 通知消息中携带的附加信息
+ */
+declare function removeChatRoomEntry(targetId: string, options: IRemoveChatroomEntryOption): Promise<void>;
+/**
+ * 批量删除聊天室属性
+ * @description 仅限于删除自己设置的聊天室属性
+ * @param entries[] 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+ * @param notificationExtra? RC:chrmKVNotiMsg 通知消息中携带的附加信息
+ */
+declare function removeChatRoomEntries(targetId: string, options: IRemoveChatroomEntriesOption): Promise<void>;
+/**
+ * 强制删除聊天室内的任意属性
+ * @description
+ */
+declare function forceRemoveChatRoomEntry(targetId: string, options: IRemoveChatroomEntryOption): Promise<void>;
+/**
+ * 获取聊天室的指定属性
+ */
+declare function getChatRoomEntry(targetId: string, 
+/**
+   * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
+   */
+key: string): Promise<{
+    code: number;
+    data: string | number | boolean;
+}>;
+/**
+ * 获取聊天室的所有属性
+ */
+declare function getAllChatRoomEntries(targetId: string): Promise<{
+    code: number;
+    data: {
+        [key: string]: string | number | boolean;
+    };
+}>;
+/**
+ * 获取聊天室的历史消息
+ */
+declare function getChatroomHistoryMessages(targetId: string, options: GetHistoryMessageOption): Promise<{
+    code: number;
+    data: GetHistoryMessageResult;
+}>;
+
+/**
+* 发送消息
+* @param options
+*/
+declare function sendMessage(conversation: IConversationOption, message: ISendMessageBody, options?: ISendMessageOptions): Promise<IAReceivedMessage>;
+declare function sendTextMessage(conversation: IConversationOption, text: string, options?: ISendMessageOptions): Promise<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;
+    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>;
+/**
+   * 获取历史消息
+   * web端与getRemoteHistoryMessages相同
+   */
+declare function getHistoryMessages(conversation: IConversationOption, options: GetHistoryMessageOption): Promise<{
+    code: number;
+    data: GetHistoryMessageResult;
+}>;
+/**
+ * 获取远程历史消息
+ */
+declare function getRemoteHistoryMessages(conversation: IConversationOption, options: GetHistoryMessageOption): Promise<{
+    code: number;
+    data: GetHistoryMessageResult;
+}>;
+/**
+ * 发送单聊已读回执
+ */
+declare function sendReadReceiptMessage(targetId: string, messageUId: string, lastMessageSendTime: number): Promise<IAReceivedMessage>;
+/**
+ * 发送群已读回执
+ * @param messageUIds 消息UID列表
+ */
+declare function sendReadReceiptRequest(targetId: string, messageUIds: string[]): Promise<void>;
+/**
+ * 发送阅读回执响应
+ */
+declare function sendReadReceiptResponse(targetId: string, messageUIds: string[]): Promise<IAReceivedMessage>;
+/**
+ * 多端同步阅读状态
+ * @param conversation
+ * @param timestamp
+ */
+declare function sendSyncReadStatusMessage(conversation: IConversationOption, lastMessageSendTime: number): Promise<IAReceivedMessage>;
+/**
+ * 撤回消息
+ * @param options
+ */
+declare function recallMessage(conversation: IConversationOption, options: {
+    /**
+     * 消息的唯一id，客户端依赖此属性查找要撤回的消息
+     */
+    messageUId: string;
+    /**
+     * 消息发送时间，服务端依赖此属性查找要撤回的消息
+     */
+    sentTime: number;
+    /**
+     * 撤回消息携带用户信息
+    */
+    user?: IUserProfile;
+    /**
+      * 是否发送静默消息
+      * @description
+      * 当值为 `true` 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒
+    */
+    disableNotification?: boolean;
+    /**
+     * 移动端推送配置
+    */
+    pushConfig?: IPushConfig;
+}): Promise<{
+    code: number;
+    data: IAReceivedMessage;
+}>;
+/**
+ * 按消息 id 删除消息
+ */
+declare function deleteMessages(conversation: IConversationOption, messages: {
+    /**
+     * 消息 id
+     */
+    messageUId: string;
+    /**
+     * 消息发送时间
+     */
+    sentTime: number;
+    /**
+     * 消息方向
+     * * 1: 发送
+     * * 2: 接收
+     */
+    messageDirection: MessageDirection;
+}[]): Promise<void>;
+/**
+ * 按时间戳删除消息
+ */
+declare function clearHistoryMessages(conversation: IConversationOption, options: {
+    /**
+     * 清除时间点, 该时间之前的消息将被清除
+     */
+    timestamp: number;
+}): Promise<void>;
+/**
+ * 更新（添加、替换）消息扩展属性
+ * @param expansion 要更新的消息扩展信息键值对
+ * @param message 要更新的原始消息体
+*/
+declare function updateMessageExpansion(conversation: IConversationOption, expansion: {
+    [key: string]: any;
+}, message: IAReceivedMessage): Promise<void>;
+/**
+ * 删除扩展存储
+ * @params keys 需删除消息扩展的 keys
+ * @params message 原始消息体
+*/
+declare function removeMessageExpansionForKey(conversation: IConversationOption, keys: string[], message: IAReceivedMessage): Promise<void>;
+/**
+ * 发送typing消息
+ * @param typingContentType 输入状态消息类型
+ * @returns
+ */
+declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<{
+    code: number;
+    data: IAReceivedMessage;
+}>;
+/**
+ * 获取群已读列表
+ * @param messageUId 消息UID
+ * @returns
+ */
+declare function getMessageReader(targetId: string, messageUId: string, channelId: string): Promise<{
+    code: number;
+    data: IMessageReaderResponse;
+}>;
+/**
+   * 注册自定义消息
+   * @param messageType 消息类型
+   * @param isPersited  是否存储
+   * @param isCounted   是否计数
+   * @param prototypes  消息属性名称
+  */
+declare function registerMessageType(messageType: string, isPersited: boolean, isCounted: boolean, prototypes?: string[]): Promise<void>;
+/**
+ * 获取第一条未读消息
+ * @param conversation
+ */
+declare function getFirstUnreadMessage(conversation: IConversationOption): Promise<IAsyncRes<IReceivedMessage | null>>;
+
+/**
+ * 创建标签
+ * @param tag 标签信息
+ */
+declare function addTag(tag: ITagParam): Promise<void>;
+/**
+ * 删除标签
+ * @param tagId 标签 ID
+ */
+declare function removeTag(tagId: string): Promise<void>;
+/**
+ * 编辑标签
+ * @param tag 标签信息
+*/
+declare function updateTag(tag: ITagParam): Promise<void>;
+/**
+ * 获取标签列表
+ */
+declare function getTags(): Promise<{
+    code: number;
+    data: ITagInfo[] | undefined;
+}>;
+/**
+* 获取会话下的标签
+* @param conversation 会话信息
+*/
+declare function getTagsFromConversation(conversation: IConversationOption): Promise<{
+    code: number;
+    data: IConversationTag[] | undefined;
+}>;
+/**
+ * 添加会话到指定标签
+ * @param tagId 标签 ID
+ * @param conversations 要添加的会话列表
+ */
+declare function addConversationsToTag(tagId: string, conversations: IConversationOption[]): Promise<void>;
+/**
+ * 删除指定标签中会话
+ * @param tagId 标签 ID
+ * @param conversations 要删除的会话列表
+ */
+declare function removeConversationsFromTag(tagId: string, conversations: IConversationOption[]): Promise<void>;
+/**
+ * 从指定会话中删除多个标签
+ * @param conversation 会话
+ * @param tagIds 要删除的标签列表
+ */
+declare function removeTagsFromConversation(conversation: IConversationOption, tagIds: string[]): Promise<void>;
+/**
+   * 从多个会话中删除指定的标签
+   * @param tagId 标签 ID
+   * @param conversations 要删除的会话列表
+  */
+declare function removeTagFromConversations(tagId: string, conversations: IConversationOption[]): Promise<void>;
+/**
+ * 分页获取标签下会话列表
+ * @param tagId 标签id
+ * @param count 获取数量
+ * @param timestamp 会话时间戳
+ */
+declare function getConversationsFromTagByPage(tagId: string, count: number, startTime: number): Promise<{
+    code: number;
+    data: IReceivedConversationByTag[] | undefined;
+}>;
+/**
+ * 根据标签获取未读消息数
+ * @param tagId 标签id
+ * @param containMuted 是否包含免打扰
+ */
+declare function getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<{
+    code: number;
+    data: number | undefined;
+}>;
+/**
+ * 设置标签中会话置顶
+ * @param tagId 标签id
+ * @param conversation 会话
+ * @param status 状态
+ */
+declare function setConversationToTopInTag(tagId: string, conversation: IConversationOption, isTop: boolean): Promise<void>;
+
+declare enum WatchEvent {
+    CONNECTING = "connecting",
+    CONNECTED = "connected",
+    DISCONNECT = "disconnect",
+    SUSPEND = "suspend",
+    MESSAGES = "messages",
+    READ_RECEIPT_RECEIVED = "readReceiptReceived",
+    MESSAGE_RECEIPT_REQUEST = "messageReceiptRequest",
+    MESSAGE_RECEIPT_RESPONSE = "messageReceiptResponse",
+    CONVERSATION = "conversation",
+    CHATROOM = "chatroom",
+    EXPANSION = "expansion",
+    PULL_OFFLINE_MESSAGE_FINISHED = "pullOfflineMessageFinished",
+    TAG = "tag",
+    CONVERSATION_TAG = "conversationTag",
+    TYPING_STATUS = "typingStatus"
+}
+
+/**
+ * 图片消息
+ */
+
+interface IImageMessageBody extends ISendMessageBody {
+    /**
+    * 图片的略缩图
+    * @description
+    * 1. 必须是 base64 字符串, 图片类型为 JPG
+    * 2. base64 字符串大小不可超过 80 KB
+    * 3. 字符串前无媒体类型前缀
+    */
+    content: string;
+    /**
+     * 原图远程地址
+     */
+    imageUri: string;
+}
+declare const _default$5: any;
+
+/**
+ * 图片消息
+ */
+
+interface IHQVoiceMessageBody extends ISendMessageBody {
+    /**
+     * 远程媒体资源地址
+     */
+    remoteUrl: string;
+    /**
+     * 编解码类型，默认为 aac 音频
+     */
+    type?: string;
+    /**
+     * 语音消息的时长，最大值为 60 （单位：秒）
+     */
+    duration: number;
+}
+declare const _default$4: any;
+
+/**
+ * 短视频消息
+ */
+
+interface ISightMessageBody extends ISendMessageBody {
+    /**
+     * 远程视频资源 url 地址
+     */
+    sightUrl: string;
+    /**
+     * 小视频首帧的缩略图进行 Base64 编码的结果值，格式为 JPG
+     * @description 注意在 Base64 进行 Encode 后需要将所有 \r\n 和 \r 和 \n 替换成空
+     */
+    content: string;
+    /**
+     * 视频时长，单位：秒
+     */
+    duration: number;
+    /**
+     * 视频尺寸，单位：Byte
+     */
+    size: number;
+    /**
+     * 视频文件名称
+     */
+    name: string;
+}
+declare const _default$3: any;
+
+/**
+ * 文本消息
+ */
+
+interface ITextMessageBody extends ISendMessageBody {
+    /**
+     * 文本消息内容
+     */
+    content: string;
+}
+declare const _default$2: any;
+
+/**
+ * 富文本消息
+ */
+
+interface ICombineMessageBody extends ISendMessageBody {
+    /**
+     * 存储在融云服务器的远端 HTML 文件路径
+     */
+    remoteUrl: string;
+    /**
+     * 在会话界面显示的合并转发消息中，前 4 条消息的用户名称
+    */
+    nameList: string;
+    /**
+     * 在会话界面显示的合并转发消息中，前 4 条消息的简略信息，与 nameList 属 性相对应
+    */
+    summaryList: string;
+    /**
+     * 会话类型，目前合并转发功能支持二人会话及群聊会话，二人会话是 1 、群组会话是 3
+    */
+    conversationType: ConversationType;
+}
+declare const _default$1: any;
+
+/**
+ * 文件消息
+ */
+
+declare const _default: any;
+
+export { _default$1 as CombineMessage, _default as FileMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default$4 as HQVoiceMessage, IAReceivedConversation, IAReceivedMessage, ICombineMessageBody, IConversationUpdateItem, IHQVoiceMessageBody, IImageMessageBody, IInitOption, IReceivedUpdateConversation, IRemoveChatroomEntriesOption, IRemoveChatroomEntryOption, ISendMessageBody, ISendMessageOptions, ISetChatroomEntriesOption, ISetChatroomEntryOption, ISightMessageBody, ITextMessageBody, _default$5 as ImageMessage, MentionedInfo, _default$3 as SightMessage, _default$2 as TextMessage, WatchEvent, addConversationsToTag, addEvent, addTag, clearEvents, clearHistoryMessages, clearMessagesUnreadStatus, clearTextMessageDraft, connect, deleteMessages, disconnect, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getFirstUnreadMessage, getHistoryMessages, getMessageReader, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getUnreadCount, getUnreadCountByTag, init, installPlugin, joinChatRoom, joinExistChatRoom, onceEvent, quitChatRoom, recallMessage, registerMessageType, removeAllEvents, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEvent, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, sendCombineMessage, sendFileMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptRequest, sendReadReceiptResponse, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, setChatRoomEntries, setChatRoomEntry, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, updateMessageExpansion, updateTag };