@rongcloud/im-kit 5.36.0

package/dist/index.d.ts

@@ -0,0 +1,1646 @@
+import { IPushConfig, IConversationOption, RCConnectionStatus, ErrorCode, LogL, PluginContext, ILogger, IPluginGenerator } from '@rongcloud/engine';
+export { IPushConfig } from '@rongcloud/engine';
+import { IAReceivedMessage, ReadReceiptInfoV5, ConversationType, NotificationLevel, BaseMessage, ISendMessageOptions } from '@rongcloud/imlib-next';
+
+/**
+ * 功能开关定义
+ */
+declare enum RCKitCommand {
+    /**
+     * 显示打开的会话界面的链接状态提醒
+     * * true - 显示（Default）
+     * * false - 隐藏
+     */
+    SHOW_CONNECTION_STATUS = "SHOW_CONNECTION_STATUS",
+    /**
+     * 显示消息已读与已发送状态
+     * * true - 开启（Default）
+     * * false - 关闭，仅展示发送中、发送失败状态
+     */
+    SHOW_MESSAGE_STATE = "SHOW_MESSAGE_STATE",
+    /**
+     * 进入会话时是否默认展示最新消息，仅 Electron 平台支持修改，Web 平台默认展示最新消息，修改无效。
+     * * true - 进入会话，会话中展示的是最新消息（Default）
+     * * false - 进入会话，会话中展示的是最近已读消息
+     */
+    FOCUS_ON_LATEST_MESSAGE = "FOCUS_ON_LATEST_MESSAGE",
+    /**
+     * '@所有人'功能开关
+     * * true - 开启
+     * * false - 关闭（Default）
+     */
+    AT_ALL = "AT_ALL",
+    /**
+     * 显示用户在线状态显示，需配合初始化时定义 `reqUserOnlineStatus` 钩子使用才能生效。
+     * * true - 显示
+     * * false - 隐藏（Default）
+     */
+    SHOW_USER_ONLINE_STATE = "SHOW_USER_ONLINE_STATE",
+    /**
+     * 引用或回复消息时，默认 @ 消息发送者
+     * * true - 开启（Default）
+     * * false - 关闭
+     */
+    PROMPT_SENDER_WHEN_QUOTE_MESSAGE = "PROMPT_SENDER_WHEN_QUOTE_MESSAGE",
+    /**
+     * 删除会话的同时，删除本地与远端的消息
+     * * true - 开启（Default）
+     * * false - 关闭
+     */
+    DELETE_MESSAGES_WHILE_DELETE_CONVERSATION = "DELETE_MESSAGES_WHILE_DELETE_CONVERSATION"
+}
+
+declare class EventDispatcher<T> {
+    private _listeners;
+    addEventListener<K extends keyof T>(type: K | string, listener: (evt: T[K]) => void, target?: any): void;
+    onceEventListener<K extends keyof T>(type: K | string, listener: (evt: T[K]) => void, target?: any): void;
+    removeEventListener<K extends keyof T>(type: K | string, listener: (evt: T[K]) => void, target?: any): void;
+    removeEventListeners(type: string | keyof T): void;
+    removeAllEventListeners(): void;
+    /**
+     * 派发事件，以同步或异步的方式执行事件监听器。
+     * @description
+     * 当 `defer` 为 `true` 时，会将事件监听器的执行推迟到下一个事件循环中，而非立即执行。
+     * @param event - 事件对象
+     * @param defer - 异步执行事件监听器，默认为 `true`。
+     */
+    dispatchEvent<K extends keyof T>(event: T[K], defer?: boolean): void;
+    private _handleDispatchEvent;
+}
+
+interface IRCKitCachedMessage extends IAReceivedMessage {
+    /**
+     * 对应的发送事务 ID，本地生成的消息会携带此 ID，用于匹配相关事件
+     */
+    transactionId: number;
+    /**
+     * 上传进度
+     * * 100 为上传完成
+     * * -1 为上传失败
+     */
+    progress?: number;
+    /**
+     * 待上传文件 Blob
+     */
+    file?: File;
+    kitReadReceiptInfo?: ReadReceiptInfoV5;
+}
+
+/** 群组会话中的汇总 @ 信息类型 */
+declare enum RCKitMentionedType {
+    /**
+     * 无 @ 信息
+     */
+    NONE = 0,
+    /**
+     * 有人在群内 @ 所有人
+     */
+    AT_ALL = 1,
+    /**
+     * 有人在群内 @ 我
+     */
+    AT_ME = 2
+}
+
+/**
+ * 会话缓存数据结构
+ */
+interface IRCKitCachedConversation {
+    /** 根据 targetId、conversationType、channelId 生成的唯一标识 */
+    key: string;
+    /** 会话 ID */
+    targetId: string;
+    /** 会话类型 */
+    conversationType: ConversationType;
+    /** Channel ID */
+    channelId: string;
+    /** 名称 */
+    name: string;
+    /** 头像 */
+    portraitUri: string;
+    /** 草稿数据 */
+    draft: string;
+    /** 最后一条消息 */
+    latestMessage: null | IRCKitCachedMessage;
+    /** 是否置顶 */
+    isTop: boolean;
+    /** 免打扰配置等级 */
+    notificationLevel: NotificationLevel;
+    /** 未读消息数 */
+    unreadCount: number;
+    /** 最后一条消息时间 */
+    updateTime: number;
+    /** 在线状态，未开启在线状态显示或未配置查询钩子的情况下，值均为 `false`; 非单聊会话均为 false */
+    online: boolean;
+    /** 群成员数量，单聊会话中始终为 0 */
+    memberCount: number;
+    /** 群组会话中的汇总 @ 信息类型 */
+    mentionedType: RCKitMentionedType;
+    /** 是否处于被标记已读状态 */
+    markReaded: boolean;
+    /** 是否处于被标记未读状态 */
+    markUnread: boolean;
+}
+
+/**
+ * 会话面板标题栏功能拓展定义
+ */
+declare type IRCKitConversationExtension = {
+    /** 功能 ID，业务层自行定义 */
+    id: string;
+    /** 功能图标 */
+    icon: string;
+    /** 过滤器，用于控制对哪些会话可见，不配置的情况下默认所有会话可见 */
+    filter?: (conversation: IRCKitCachedConversation) => boolean;
+};
+declare type IRCKitPushConfigHook = (message: IRCKitCachedMessage) => IPushConfig;
+
+interface IRCKitUserProfile {
+    /**
+     * 用户 ID
+     */
+    userId: string;
+    /**
+     * 用户名
+     */
+    name: string;
+    /**
+     * 头像 url
+     */
+    portraitUri?: string;
+}
+/**
+ * 缓存的用户数据
+ */
+interface ICacheUserProfile extends IRCKitUserProfile {
+    /**
+     * 标识用户数据为默认数据，必要时需要从业务获取更新数据
+     */
+    usingDefault: boolean;
+    /**
+     * 头像 url
+     */
+    portraitUri: string;
+    /**
+     * 在线状态
+     */
+    online: boolean;
+}
+interface IRCKitUserOnlineStatus {
+    /**
+     * 用户 ID
+     */
+    userId: string;
+    /**
+     * 在线状态
+     */
+    online: boolean;
+}
+
+interface IRCKitGroupProfile {
+    /**
+     * 群组 ID
+     */
+    groupId: string;
+    /**
+     * 群组名称
+     */
+    name: string;
+    /**
+     * 群组头像 url
+     */
+    portraitUri?: string;
+    /**
+     * 群组成员数量
+     */
+    memberCount: number;
+}
+/**
+ * 群组成员信息
+ */
+interface IRCKitGroupMemberProfile {
+    /**
+     * 用户 ID
+     */
+    userId: string;
+    /**
+     * 群内显示的昵称，若无昵称，则显示用户名称
+     */
+    nickname?: string;
+}
+/**
+ * 缓存的群组数据
+ */
+interface ICacheGroupProfile extends IRCKitGroupProfile {
+    /**
+     * 正在使用默认数据，通常是由于从业务获取数据失败导致
+     */
+    usingDefault: boolean;
+    portraitUri: string;
+}
+
+interface IRCKitSystemProfile {
+    /**
+     * 系统会话 ID
+     */
+    systemId: string;
+    /**
+     * 系统会话名称
+     */
+    name: string;
+    /**
+     * 会话头像 url
+     */
+    portraitUri?: string;
+}
+interface ICacheSystemProfile extends IRCKitSystemProfile {
+    /**
+     * 标识为默认数据，必要时需要从业务获取更新数据
+     */
+    usingDefault: boolean;
+    portraitUri: string;
+}
+
+interface IRCKitServiceHooks {
+    /**
+     * 根据 userId 批量获取用户信息
+     * @param userIds - 用户 ID 列表
+     */
+    reqUserProfiles(userIds: string[]): Promise<IRCKitUserProfile[]>;
+    /**
+     * 根据 groupId 批量获取群组信息
+     * @param groupIds - 群组 ID 列表
+     */
+    reqGroupProfiles(groupIds: string[]): Promise<IRCKitGroupProfile[]>;
+    /**
+     * 批量获取系统会话信息，当会话列表中存在 ConversationType.SYSTEM 类型时，会调用此方法获取系统会话信息
+     * @param targetIds - 系统会话 ID 列表
+     */
+    reqSystemProfiles(targetIds: string[]): Promise<IRCKitSystemProfile[]>;
+    /**
+     * 获取群组成员信息
+     * @param groupId - 群组 ID
+    */
+    reqGroupMembers(groupId: string): Promise<IRCKitGroupMemberProfile[]>;
+    /**
+      * [可选]定义默认用户信息，以替换 SDK 默认初始数据，如头像、名称规则等
+      * @param userId - 用户 ID
+      */
+    getDefaultUserProfile?(userId: string): IRCKitUserProfile;
+    /**
+      * [可选]定义默认群组信息，以替换 SDK 默认数据，，如头像、名称规则等
+      * @param groupId - 群组 ID
+      */
+    getDefaultGroupProfile?(groupId: string): IRCKitGroupProfile;
+    /**
+      * [可选]定义默认系统会话信息，以替换 SDK 默认数据，，如头像、名称规则等
+      * @param systemId - 系统会话 ID
+      */
+    getDefaultSystemProfile?(systemId: string): IRCKitSystemProfile;
+    /**
+     * [可选]请求用户在线状态
+     * @param userIds - 用户 ID 列表
+     */
+    reqUserOnlineStatus?(userIds: string[]): Promise<IRCKitUserOnlineStatus[]>;
+}
+
+/**
+ * 语言包词条
+ */
+interface IRCKitLanguageEntries {
+    'conv.loading.msg': string;
+    'conv.mentioned.me.msg': string;
+    'conv.mentioned.all.msg': string;
+    'conv.draft.msg': string;
+    'message.list.select': string;
+    'message.list.unselect': string;
+    'message.list.recall.by.self': string;
+    'message.list.recall.by.other': string;
+    'message.list.reedit.msg': string;
+    'message.list.read': string;
+    'message.list.back': string;
+    'message.list.reedit': string;
+    'message.list.read-receipt.tooltip.all-unread': string;
+    'message.list.read-receipt.tooltip.all-read': string;
+    'message.list.read-receipt.tooltip.read-count': string;
+    'message.list.read-receipt.tooltip.unread-count': string;
+    'message-type.RC:ImgMsg': string;
+    'message-type.RC:HQVCMsg': string;
+    'message-type.RC:VcMsg': string;
+    'message-type.RC:GIFMsg': string;
+    'message-type.RC:FileMsg': string;
+    'message-type.RC:SightMsg': string;
+    'message-type.RC:ImgTextMsg': string;
+    'message-type.RC:LBSMsg': string;
+    'message-type.RC:CombineMsg': string;
+    'message-type.RC:CombineV2Msg': string;
+    'message-type.RC:ReferenceMsg': string;
+    'message-type.unknown': string;
+    'time.format.today': string;
+    'time.format.yesterday': string;
+    'time.format.monday': string;
+    'time.format.tueday': string;
+    'time.format.wedday': string;
+    'time.format.thurday': string;
+    'time.format.friday': string;
+    'time.format.satday': string;
+    'time.format.sunday': string;
+    'time.format.full': string;
+    'input.menu.item.photo': string;
+    'input.menu.item.images': string;
+    'input.menu.item.files': string;
+    'input.menu.item.emoji': string;
+    'input.placeholder': string;
+    'input.send': string;
+    'input.reply.prefix': string;
+    'input.mentioned.all': string;
+    'input.placeholder.search': string;
+    'conversation.menu.item.add_top': string;
+    'conversation.menu.item.remove_top': string;
+    'conversation.menu.item.mute': string;
+    'conversation.menu.item.unmute': string;
+    'conversation.menu.item.mark_read': string;
+    'conversation.menu.item.mark_unread': string;
+    'conversation.menu.item.remove': string;
+    'message.menu.item.reply': string;
+    'message.menu.item.multi.choice': string;
+    'message.menu.item.copy': string;
+    'message.menu.item.forward': string;
+    'message.menu.item.delete': string;
+    'message.menu.item.speech.to.text': string;
+    'message.menu.item.cancel.speech.to.text': string;
+    'message.speech.to.text.failed': string;
+    'message.speech.to.text.empty': string;
+    'message.speech.to.text.unsupported': string;
+    'message.menu.item.recall': string;
+    'conversation.empty.desc': string;
+    'conversation.list.empty.desc': string;
+    'conversation.list.bar.title': string;
+    'conversation.detail.bar.typing': string;
+    'conversation.detail.bar.typing.audio': string;
+    'alert.req.msg.error': string;
+    'alert.pickfiles.maxcount': string;
+    'alert.paste.not.supported': string;
+    'alert.delete.message.failed': string;
+    'alert.delete.messages.partial.failure': string;
+    'alert.delete.conversation.failed': string;
+    /** IMLib 等与网络相关失败（如错误码 30002） */
+    'alert.imlib.failed.network': string;
+    /** IMLib 失败通用提示 */
+    'alert.imlib.failed.generic': string;
+    'alert.forward.not.supported': string;
+    'alert.forward.over.length': string;
+    'alert.delete.over.length': string;
+    'alert.send.message.maxcount': string;
+    'alert.message-deleted': string;
+    'alert.conversation.list.not.ready': string;
+    'dialog.delete.msg': string;
+    'dialog.delete.msg.confirm': string;
+    'dialog.tips.msg': string;
+    'dialog.cancel.msg': string;
+    'dialog.delete.msg.content': string;
+    'dialog.confirm.msg': string;
+    'dialog.forwarding.msg': string;
+    'dialog.recall.msg': string;
+    'dialog.forwarding.confirm': string;
+    'take-photo.send-btn.label': string;
+    'take-photo.cancel-btn.label': string;
+    'take-photo.retry-btn.label': string;
+    'take-photo.msg.camera-starting': string;
+    'take-photo.msg.camera-startup-failure': string;
+    'multi-choice.menu.selected-count': string;
+    'multi-choice.menu.forward-item-by-item': string;
+    'multi-choice.menu.delete': string;
+    'private.combine-msg.title': string;
+    'group.combine-msg.title': string;
+    'private.combine-msg.signal.title': string;
+    'connection.status.suspended': string;
+    'connection.status.disconnected': string;
+    'connection.status.connecting': string;
+    'toast.forward.success': string;
+    'toast.copy.success': string;
+}
+
+/**
+ * 语言行文方向
+ */
+declare type RCKitLanguageDirection = 'ltr' | 'rtl';
+
+/** SDK 内置输入区菜单 ID */
+declare enum RCKitInputMenuID {
+    /** 拍照功能按钮 */
+    PHOTO = "input.menu.item.photo",
+    /** 图片选择按钮，允许多选 */
+    IMAGES = "input.menu.item.images",
+    /** 文件选择按钮，文件选择允许选择图片，并以文件的方式发送 */
+    FILES = "input.menu.item.files",
+    /** 表情按钮 */
+    EMOJI = "input.menu.item.emoji",
+    /** + 号按钮 */
+    PLUS = "input.menu.item.plus"
+}
+/**
+ * Emoji 字符表情库 ID
+ */
+declare const RCKitChatEmojiLibraryID = "RCKitChatEmojiLibraryID";
+/** 输入区菜单按钮位置 */
+declare enum RCKitInputMenuPosition {
+    /** 收入 Plus 二级菜单 */
+    SECONDARY_MENU = 0,
+    /** 输入框左侧显示 */
+    LEFT = 1
+}
+interface IRCKitInputMenuItem {
+    /** 菜单 ID，SDK 在派发点击事件时包含此数据，同时也通过此 ID 查询多语言 UI 展示文案 */
+    id: RCKitInputMenuID | string;
+    /** 当存在 position 相同的菜单项时，根据 order 确定排序，order 值越低排序越靠前 */
+    order: number;
+    /** 菜单图标 */
+    icon: string;
+    /** 菜单图标 */
+    hoverIcon?: string;
+    /** 过滤器 */
+    filter?: (conversation: IRCKitCachedConversation) => boolean;
+    /** 二级菜单项列表，如果存在则点击该菜单项时会显示二级菜单而不是直接执行操作 */
+    submenu?: IRCKitInputMenuItem[];
+}
+interface IRCKitInputMenu {
+    /** 菜单列表 */
+    items: IRCKitInputMenuItem[];
+}
+/**
+ * 图片表情库数据
+ */
+interface IRCKitImageEmojiLibrary {
+    /**
+     * 表情库 ID，业务自行定义
+     */
+    id: string;
+    /**
+     * 表情库图标，用于表情面板按钮显示
+     */
+    icon: string;
+    /**
+     * 表情面板内的单项显示宽度
+     */
+    itemWidth: number;
+    /**
+     * 表情面板内的单项显示高度
+     */
+    itemHeight: number;
+    /**
+     * 表情列表
+     */
+    items: Array<IRCKitImageEmoji>;
+    /**
+     * 排序值，值越小排序越靠前
+     */
+    order: number;
+}
+interface IRCKitGifImageInfo {
+    /**
+     * Gif 图片尺寸，单位 Byte
+     */
+    size: number;
+    /**
+     * Gif 图片宽度
+     */
+    width: number;
+    /**
+     * Gif 图片高度
+     */
+    height: number;
+}
+/**
+ * 图片表情数据
+ */
+interface IRCKitImageEmoji {
+    /**
+     * 网络资源托管地址, 如：https://xxxxx，地址需确保各端网络环境的可访问性
+     */
+    url: string;
+    /**
+     * 缩略图数据，需为 base64 字符串，同时也作为表情面板展示用，以避免直接原图造成流量浪费
+     */
+    thumbnail: string;
+    /**
+     * 若图片资源为 Gif 图片，且希望以 Gif 消息形式发送，则需要提供 Gif 图片信息，否则默认以静态图片消息进行发送
+     */
+    gif?: IRCKitGifImageInfo;
+}
+interface IRCKitChatEmojiLibrary {
+    /**
+     * 表情库图标，用于表情面板按钮显示
+     */
+    icon: string;
+    /**
+     * 字符表情数组
+     */
+    chats: string[];
+}
+
+/**
+ * 消息气泡对齐方式
+ */
+declare enum RCKitBubbleLayout {
+    /**
+     * 消息气泡全部居左侧显示
+     */
+    LEFT_JUSTIFYING = "left-justifying",
+    /**
+     * 消息气泡左右分布，己方气泡显示在右侧，他人气泡显示在左侧
+     */
+    LEFT_RIGHT = "left-right"
+}
+interface IRCKitMessageBubbleCfg {
+    /** 圆角半径 */
+    radius?: number;
+    /** 消息对齐方式：左对齐 or 左右分布 */
+    layout?: RCKitBubbleLayout;
+    /** 己方气泡背景色，支持数字 (0xD2E1FE) 或 16 进制字符串 ("#D2E1FE") */
+    backgroundColorForMyself?: number | string;
+    /** 他人气泡背景色，支持数字 (0xF3F5FA) 或 16 进制字符串 ("#F3F5FA") */
+    backgroundColorForOthers?: number | string;
+    /** 己方文本颜色，支持数字 (0x020814) 或 16 进制字符串 ("#020814") */
+    textColorForMyself?: number | string;
+    /** 他人文本颜色，支持数字 (0x020814) 或 16 进制字符串 ("#020814") */
+    textColorForOthers?: number | string;
+    /**
+     * 单聊中展示己方头像，默认不展示
+     */
+    showMyProfileInPrivateConversation?: boolean;
+    /**
+     * 单聊中展示己方名称，默认不展示
+     */
+    showMyNameInPrivateConversation?: boolean;
+    /**
+     * 群聊中展示己方头像，默认不展示
+     */
+    showMyProfileInGroupConversation?: boolean;
+    /**
+     * 群聊中展示己方名称，默认不展示
+     */
+    showMyNameInGroupConversation?: boolean;
+    /**
+     * 单聊中展示对方头像，默认不展示
+     */
+    showOthersProfileInPrivateConversation?: boolean;
+    /**
+     * 单聊中展示对方名称，默认不展示
+     */
+    showOthersNameInPrivateConversation?: boolean;
+    /**
+     * 群聊中展示对方头像，默认展示
+     */
+    showOthersProfileInGroupConversation?: boolean;
+    /**
+     * 群聊中展示对方名称，默认不展示
+     */
+    showOthersNameInGroupConversation?: boolean;
+}
+
+/**
+ * 会话菜单项 ID
+ */
+declare enum RCKitConversationMenuID {
+    /** 会话置顶 */
+    ADD_TOP = "conversation.menu.item.add_top",
+    /** 取消置顶 */
+    REMOVE_TOP = "conversation.menu.item.remove_top",
+    /** 会话免打扰 */
+    MUTE = "conversation.menu.item.mute",
+    /** 取消免打扰 */
+    UNMUTE = "conversation.menu.item.unmute",
+    /** 标记已读 */
+    MARK_READ = "conversation.menu.item.mark_read",
+    /** 标记未读 */
+    MARK_UNREAD = "conversation.menu.item.mark_unread",
+    /** 删除会话 */
+    REMOVE = "conversation.menu.item.remove"
+}
+interface IRCKitConversationMenuItem {
+    /**
+     * 菜单 ID，SDK 在派发点击事件时包含此数据，同时也通过此 ID 查询多语言 UI 展示文案
+     */
+    id: RCKitConversationMenuID | string;
+    /**
+     * 菜单图标
+     */
+    icon: string;
+    /**
+     * 过滤器，返回 true 时显示菜单，返回 false 时不显示菜单
+     * @param conversation
+     */
+    filter?: (conversation: IRCKitCachedConversation) => boolean;
+}
+
+/**
+ * 事件基类 Event<T, D = void, R = void>
+ * @template T 事件类型
+ * @template D 事件实例包含的数据类型定义
+ * @template R 事件处理器通过 `evt.sendResult(data)` 回传给事件派发者的数据类型定义
+ */
+declare class RCKitEvent<T extends string, D = void, R = void> {
+    /**
+     * 事件类型
+     */
+    readonly type: T;
+    /**
+     * 事件处理器通过 `evt.sendResult(data)` 回传给事件派发者的数据
+     * - false 表示并未等待事件处理器回传数据
+     * - true 表示事件处理器已经回传了数据
+     * - function 表示事件处理器正在等待回传数据
+     */
+    private _resolve;
+    private _promise?;
+    private _stopped;
+    private _defaultPrevented;
+    /**
+     * 事件实例包含的数据
+     */
+    readonly data: D;
+    constructor(
+    /**
+     * 事件类型
+     */
+    type: T, data?: D);
+    /**
+     * @returns 是否阻止了事件的传播
+     */
+    isImmediatePropagationStopped(): boolean;
+    /**
+     * 阻止同类型监听器的调用
+     */
+    stopImmediatePropagation(): void;
+    /**
+     * @returns 是否阻止了事件的默认行为
+     */
+    isDefaultPrevented(): boolean;
+    /**
+     * 阻止事件的默认行为
+     * @description 该方法不会阻止事件的传播，也并非所有事件都有默认行为
+     */
+    preventDefault(): void;
+    /**
+     * 向事件派发者发送数据
+     * @param data
+     */
+    sendResult(data: R): void;
+    /**
+     * 等待时间监听者回传数据
+     * @returns
+     */
+    awaitResult(): Promise<R>;
+    /**
+     * 克隆事件实例
+     * @param ignoreResult 是否忽略回传数据，若为 true，则克隆的事件实例通过 `evt.sendResult(data)` 无法回传数据
+     * @returns
+     */
+    clone(ignoreResult: boolean): RCKitEvent<T, D, R>;
+}
+
+interface IRCKitDeleteMessageData {
+    /**
+     * 被删除的原始消息
+     */
+    target: IRCKitCachedMessage;
+    /**
+     * 替换的撤回消息，仅在撤回操作时存在
+     */
+    recallMsg?: IRCKitCachedMessage;
+}
+interface IRCKitConversationExtensionClick {
+    /** 设置拓展功能时定义的 ID */
+    id: string;
+    /** 点击功能时所处的当前会话数据 */
+    conversation: IRCKitCachedConversation;
+}
+interface IRCKitConversationMenuItemClick {
+    /** 会话菜单项 ID */
+    id: string;
+    /** 会话数据 */
+    conversation: IRCKitCachedConversation;
+}
+interface IRCKitInputMenuItemClick {
+    id: string;
+    conversation: IRCKitCachedConversation;
+}
+interface IRCKitConversationIconClick {
+    conversation: IConversationOption;
+    profile: {
+        name: string;
+        nickname?: string;
+        userId: string;
+        portraitUri: string;
+    };
+}
+interface IRCKitMessageMenuItemClick {
+    /** 消息菜单项 ID */
+    id: string;
+    /** 消息数据 */
+    message: IRCKitCachedMessage;
+}
+interface IRCKitMessageLinkClick {
+    /** mail 或者 url */
+    type: string;
+    /** 地址 */
+    address: string;
+}
+declare enum RCKitModalBtnType {
+    /** 取消按钮 */
+    CANCEL = 0,
+    /** 确认按钮 */
+    CONFIRM = 1
+}
+interface IRCKitConnectionStatusChange {
+    status: RCConnectionStatus;
+    code?: ErrorCode;
+}
+declare class ConnectionStatusChangeEvent extends RCKitEvent<'CONNECTION_STATUS_CHANGE', IRCKitConnectionStatusChange> {
+    constructor(status: RCConnectionStatus, code?: ErrorCode);
+}
+interface IRCKitConversationSelectedEventData {
+    conversation: IRCKitCachedConversation | null;
+    focusInput?: boolean;
+}
+declare type ConversationSelectedEvent = RCKitEvent<'CONVERSATION_SELECTED', IRCKitConversationSelectedEventData>;
+declare type ConfirmEvent = RCKitEvent<'CONFIRM_EVENT', string, boolean>;
+declare type AlertEvent = RCKitEvent<'ALERT_EVENT', string>;
+declare enum RCKitModalForwardingType {
+    /** 单条转发 */
+    SINGLE = "single",
+    /** 合并转发 */
+    MERGE = "merge"
+}
+interface IRCKitModalForwardingResult {
+    type: RCKitModalBtnType;
+    list?: IRCKitCachedConversation[];
+}
+declare type ForwardingEvent = RCKitEvent<'FORWARDING_EVENT', RCKitModalForwardingType, IRCKitModalForwardingResult>;
+interface IRCKitModalDeleteMessage {
+    /**
+     * 待删除或撤回消息
+     */
+    messages: IRCKitCachedMessage[];
+}
+interface IRCKitModalDeleteMessageResult {
+    type: RCKitModalBtnType;
+}
+declare type DeleteMessageModalEvent = RCKitEvent<'DELETE_MESSAGE_MODAL_EVENT', IRCKitModalDeleteMessage, IRCKitModalDeleteMessageResult>;
+declare type UserProfilesUpdateEvent = RCKitEvent<'USER_PROFILES_UPDATE', ICacheUserProfile[]>;
+declare type GroupProfilesUpdateEvent = RCKitEvent<'GROUP_PROFILES_UPDATE', ICacheGroupProfile[]>;
+declare type GroupMembersUpdateEvent = RCKitEvent<'GROUP_MEMBERS_UPDATE', {
+    groupId: string;
+    members: IRCKitGroupMemberProfile[];
+}>;
+declare type SystemProfilesUpdateEvent = RCKitEvent<'SYSTEM_PROFILES_UPDATE', ICacheSystemProfile[]>;
+declare type ConversationMenuItemClickEvent = RCKitEvent<'CONVERSATION_MENU_ITEM_CLICK', IRCKitConversationMenuItemClick>;
+/**
+ * 会话列表首屏渲染事件
+ */
+declare type ConversationListFirstScreenRenderingEvent = RCKitEvent<'CONVERSATION_LIST_RESET', IRCKitCachedConversation[]>;
+declare type ConversationItemOrderChangeEvent = RCKitEvent<'CONVERSATION_ITEM_ORDER_CHANGE', {
+    order: number;
+    conversation: IRCKitCachedConversation;
+}[]>;
+declare type ConversationListItemChangeEvent = RCKitEvent<'CONVERSATION_ITEM_CHANGE', IRCKitCachedConversation[]>;
+declare type ConversationItemRemoveEvent = RCKitEvent<'CONVERSATIN_ITEM_REMOVE', IRCKitCachedConversation[]>;
+declare type MessageStateChangeEvent = RCKitEvent<'MESSAGE_STATE_CHANGE', IRCKitCachedMessage[]>;
+declare type InsertNewMessagesEvent = RCKitEvent<'INSERT_NEW_MESSAGES', IRCKitCachedMessage[]>;
+declare type RecvNewMessagesEvent = RCKitEvent<'RECV_NEW_MESSAGES', IRCKitCachedMessage[]>;
+declare type FileUploadProgressEvent = RCKitEvent<'FILE_UPLOAD_PROGRESS', {
+    message: IRCKitCachedMessage;
+    /**
+     * 上传进度，与 msg.progress 一致
+     */
+    progress: number;
+}>;
+declare type MessagesDeletedEvent = RCKitEvent<'MESSAGES_DELETED', IRCKitDeleteMessageData[]>;
+declare type BeforeSystemConversationOpenEvent = RCKitEvent<'BEFORE_SYSTEM_CONVERSATION_OPEN', IRCKitCachedConversation>;
+declare type DownloadLinkEvent = RCKitEvent<'DOWNLOAD_LINK_EVENT', IRCKitCachedMessage>;
+declare type FileSendFailedEvent = RCKitEvent<'FILE_SEND_FAILED_EVENT', File[]>;
+declare type AudioPlayState = {
+    /**
+     * 播放进度
+     */
+    progress: number;
+    /**
+     * 播放状态
+     * - playing: 播放中
+     * - stopped: 已停止，需配合 process 确认停止原因是否为播放完成
+     */
+    status: 'playing' | 'stopped';
+    /**
+     * 播放中的音频所属消息 uid
+     */
+    messageUId: string;
+    /**
+     * 播放中的音频所属消息 transactionId
+     */
+    transactionId?: number;
+};
+/**
+ * 音频消息播放事件
+ */
+declare type AudioPlayEvent = RCKitEvent<'AUDIO_PLAY_EVENT', AudioPlayState>;
+declare type SetTextareaValueEvent = RCKitEvent<'SET_TEXTAREA_VALUE_EVENT', string>;
+/**
+ * 语音转文字状态变更事件
+ */
+interface IRCKitSpeechToTextStateChange {
+    /**
+     * 消息 UID
+     */
+    messageUId: string;
+    /**
+     * 转换状态
+     * - converting: 转换中
+     * - success: 转换成功
+     * - error: 转换失败
+     */
+    status: 'converting' | 'success' | 'error';
+    /**
+     * 转换后的文本（仅在 success 状态时存在）
+     */
+    text?: string;
+    /**
+     * 转换失败错误码（仅在接口返回 code 不为 SUCCESS 时存在）
+     */
+    errorCode?: ErrorCode;
+}
+declare type SpeechToTextStateChangeEvent = RCKitEvent<'SPEECH_TO_TEXT_STATE_CHANGE', IRCKitSpeechToTextStateChange>;
+/**
+ * 内部事件类型定义
+ * @description - 对内事件继承对外事件定义，原因在于事件派发至外部时，外部未必会进行拦截处理，SDK 内部需要保持默认实现。
+ */
+interface EventDefined {
+    /**
+     * 用户信息变更事件
+     */
+    USER_PROFILES_UPDATE: UserProfilesUpdateEvent;
+    /**
+     * 群组信息变更事件
+     */
+    GROUP_PROFILES_UPDATE: GroupProfilesUpdateEvent;
+    /**
+     * 群组成员信息变更事件
+     */
+    GROUP_MEMBERS_UPDATE: GroupMembersUpdateEvent;
+    /**
+     * 连接状态变更事件
+     */
+    CONNECTION_STATUS_CHANGE: ConnectionStatusChangeEvent;
+    /**
+     * 语言变更事件
+     */
+    LANGUAGE_CHANGE: RCKitEvent<'LANGUAGE_CHANGE', {
+        lang: string;
+        direction: 'ltr' | 'rtl';
+    }>;
+    /**
+     * 会话列表首屏渲染事件
+     */
+    CONVERSATION_LIST_RESET: ConversationListFirstScreenRenderingEvent;
+    /**
+     * 会话列表项属性变更事件
+     */
+    CONVERSATION_ITEM_CHANGE: ConversationListItemChangeEvent;
+    /**
+     * 会话列表项顺序变更事件，会话列表接收到该事件后需要重新设置元素位置，并更新 UI 元素属性展示信息
+     */
+    CONVERSATION_ITEM_ORDER_CHANGE: ConversationItemOrderChangeEvent;
+    /**
+     * 会话列表项删除事件
+     */
+    CONVERSATIN_ITEM_REMOVE: ConversationItemRemoveEvent;
+    /**
+     * 选中会话变更事件
+     */
+    CONVERSATION_SELECTED: ConversationSelectedEvent;
+    /**
+     * 系统会话信息变更事件
+     */
+    SYSTEM_PROFILES_UPDATE: SystemProfilesUpdateEvent;
+    /**
+     * 通知销毁缓存数据，该事件仅在发现新登录用户与上次登录用户不一致时触发
+     */
+    DESTROY_USER_CACHE: RCKitEvent<'DESTROY_USER_CACHE'>;
+    /**
+     * 通知初始化缓存数据，该事件仅在用户首次登录后触发一次
+     */
+    INIT_USER_CACHE: RCKitEvent<'INIT_USER_CACHE'>;
+    /**
+     * 确认弹窗事件
+     */
+    CONFIRM_EVENT: ConfirmEvent;
+    /**
+     * 弹窗提醒事件
+     */
+    ALERT_EVENT: AlertEvent;
+    /**
+     * 消息转发弹框事件
+     */
+    FORWARDING_EVENT: ForwardingEvent;
+    /**
+     * 消息删除弹框事件
+     */
+    DELETE_MESSAGE_MODAL_EVENT: DeleteMessageModalEvent;
+    /**
+     * 媒体消息弹框事件
+     */
+    MEDIA_MESSAGE_MODAL_EVENT: RCKitEvent<'MEDIA_MESSAGE_MODAL_EVENT', IRCKitCachedMessage>;
+    /**
+     * 合并转发消息弹框事件
+     */
+    COMBINE_MESSAGE_MODAL_EVENT: RCKitEvent<'COMBINE_MESSAGE_MODAL_EVENT', IRCKitCachedMessage>;
+    /**
+     * 拍照弹框事件
+     */
+    TAKE_PHOTO_MODAL_EVENT: RCKitEvent<'TAKE_PHOTO_MODAL_EVENT'>;
+    /**
+     * 消息被删除或撤回通知
+     */
+    MESSAGES_DELETED: MessagesDeletedEvent;
+    /**
+     * 接收到 SDK 内部无法处理的消息，业务层可通过监听该事件获取消息
+     */
+    UNSCHEDULED_MESSAGES: RCKitEvent<'UNSCHEDULED_MESSAGES', IAReceivedMessage[]>;
+    /**
+     * 会话菜单项点击事件
+     */
+    CONVERSATION_MENU_ITEM_CLICK: ConversationMenuItemClickEvent;
+    /**
+     * 消息菜单项点击事件
+     */
+    MESSAGE_MENU_ITEM_CLICK: RCKitEvent<'MESSAGE_MENU_ITEM_CLICK', IRCKitMessageMenuItemClick>;
+    /**
+     * 输入框菜单按钮点击事件
+     */
+    INPUT_MENU_ITEM_CLICK: RCKitEvent<'INPUT_MENU_ITEM_CLICK', IRCKitInputMenuItemClick>;
+    /**
+     * 系统会话打开前的事件，业务层可通过监听该事件拦截系统会话打开，以自定义系统会话的打开方式
+     */
+    BEFORE_SYSTEM_CONVERSATION_OPEN: BeforeSystemConversationOpenEvent;
+    /**
+     * 接收到新消息，UI 和各数据模块可根据该事件处理 UI 变更
+     */
+    RECV_NEW_MESSAGES: RecvNewMessagesEvent;
+    /**
+     * 插入新消息，UI 和各数据模块可根据该事件处理 UI 变更
+     */
+    INSERT_NEW_MESSAGES: InsertNewMessagesEvent;
+    /**
+     * 消息状态变更事件，一般为发送状态变更，或文件上传进度变更等
+     */
+    MESSAGE_STATE_CHANGE: MessageStateChangeEvent;
+    /**
+     * 上传进度变更事件
+     */
+    FILE_UPLOAD_PROGRESS: FileUploadProgressEvent;
+    /**
+     * 业务拓展功能按钮点击事件，直接向业务层派发
+     */
+    CONVERSATION_EXTENSION_CLICK: RCKitEvent<'CONVERSATION_EXTENSION_CLICK', IRCKitConversationExtensionClick>;
+    /**
+     * 消息列表头像点击事件
+     */
+    CONVERSATION_ICON_CLICK: RCKitEvent<'CONVERSATION_ICON_CLICK', IRCKitConversationIconClick>;
+    /**
+     * 消息列表 Header 头像点击事件
+     */
+    CONVERSATION_NAVI_CLICK: RCKitEvent<'CONVERSATION_NAVI_CLICK', IRCKitCachedConversation>;
+    /**
+     * 文本消息中链接点击事件
+     */
+    MESSAGE_LINK_CLICK: RCKitEvent<'MESSAGE_LINK_CLICK', IRCKitMessageLinkClick>;
+    DOWNLOAD_LINK_EVENT: DownloadLinkEvent;
+    FILE_SEND_FAILED_EVENT: FileSendFailedEvent;
+    /** 音频消息播放事件 */
+    AUDIO_PLAY_EVENT: AudioPlayEvent;
+    SET_TEXTAREA_VALUE_EVENT: SetTextareaValueEvent;
+    /** 语音转文字状态变更事件 */
+    SPEECH_TO_TEXT_STATE_CHANGE: SpeechToTextStateChangeEvent;
+    /**
+     * 会话栏开关变更事件
+     */
+    CONVERSATION_BAR_SWITCH_CHANGE: RCKitEvent<'CONVERSATION_BAR_SWITCH_CHANGE', boolean>;
+    /**
+     * 会话详情返回按钮开关变更事件
+     */
+    CONVERSATION_DETAIL_BACK_SWITCH_CHANGE: RCKitEvent<'CONVERSATION_DETAIL_BACK_SWITCH_CHANGE', boolean>;
+    /**
+     * 会话栏标题变更事件
+     */
+    CONVERSATION_BAR_TITLE_CHANGE: RCKitEvent<'CONVERSATION_BAR_TITLE_CHANGE', string>;
+    /**
+     * 提示框显示事件
+     */
+    TOAST_EVENT: RCKitEvent<'TOAST_EVENT', {
+        message: string;
+        showIcon?: boolean;
+    }>;
+    /**
+     * 调整消息列表滚动位置
+     */
+    ADJUST_MESSAGE_LIST_SCROLL: RCKitEvent<InnerEvent.ADJUST_MESSAGE_LIST_SCROLL>;
+}
+/**
+ * 内部事件类型集合
+ */
+declare enum InnerEvent {
+    /**
+     * 用户信息变更事件
+     */
+    USER_PROFILES_UPDATE = "USER_PROFILES_UPDATE",
+    /**
+     * 群组信息变更事件
+     */
+    GROUP_PROFILES_UPDATE = "GROUP_PROFILES_UPDATE",
+    /**
+     * 群组成员信息变更事件
+     */
+    GROUP_MEMBERS_UPDATE = "GROUP_MEMBERS_UPDATE",
+    INIT_USER_CACHE = "INIT_USER_CACHE",
+    DESTROY_USER_CACHE = "DESTROY_USER_CACHE",
+    SYSTEM_PROFILES_UPDATE = "SYSTEM_PROFILES_UPDATE",
+    CONVERSATION_ITEM_CHANGE = "CONVERSATION_ITEM_CHANGE",
+    CONVERSATION_LIST_RESET = "CONVERSATION_LIST_RESET",
+    CONVERSATION_ITEM_ORDER_CHANGE = "CONVERSATION_ITEM_ORDER_CHANGE",
+    CONVERSATIN_ITEM_REMOVE = "CONVERSATIN_ITEM_REMOVE",
+    MESSAGE_STATE_CHANGE = "MESSAGE_STATE_CHANGE",
+    INSERT_NEW_MESSAGES = "INSERT_NEW_MESSAGES",
+    FILE_UPLOAD_PROGRESS = "FILE_UPLOAD_PROGRESS",
+    LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
+    AUDIO_PLAY_EVENT = "AUDIO_PLAY_EVENT",
+    SET_TEXTAREA_VALUE_EVENT = "SET_TEXTAREA_VALUE_EVENT",
+    ADJUST_MESSAGE_LIST_SCROLL = "ADJUST_MESSAGE_LIST_SCROLL",
+    /**
+     * 语音转文字状态变更事件（对内事件）
+     */
+    SPEECH_TO_TEXT_STATE_CHANGE = "SPEECH_TO_TEXT_STATE_CHANGE",
+    /**
+     * 接收到新消息事件（对内事件）
+     */
+    RECV_NEW_MESSAGES = "RECV_NEW_MESSAGES",
+    /**
+     * 连接状态变更事件
+     */
+    CONNECTION_STATUS_CHANGE = "CONNECTION_STATUS_CHANGE",
+    /**
+     * 会话栏开关变更事件
+     */
+    CONVERSATION_BAR_SWITCH_CHANGE = "CONVERSATION_BAR_SWITCH_CHANGE",
+    /**
+     * 会话详情返回按钮开关变更事件
+     */
+    CONVERSATION_DETAIL_BACK_SWITCH_CHANGE = "CONVERSATION_DETAIL_BACK_SWITCH_CHANGE",
+    /**
+     * 会话栏标题变更事件
+     */
+    CONVERSATION_BAR_TITLE_CHANGE = "CONVERSATION_BAR_TITLE_CHANGE",
+    /**
+     * 提示框显示事件
+     */
+    TOAST_EVENT = "TOAST_EVENT"
+}
+/**
+ * 事件枚举
+ */
+declare enum RCKitEvents {
+    /**
+     * 确认弹窗事件
+     */
+    CONFIRM_EVENT = "CONFIRM_EVENT",
+    /**
+     * 弹窗提醒事件
+     */
+    ALERT_EVENT = "ALERT_EVENT",
+    /**
+     * 消息删除弹框事件
+     */
+    DELETE_MESSAGE_MODAL_EVENT = "DELETE_MESSAGE_MODAL_EVENT",
+    /**
+     * 媒体消息弹框事件
+     */
+    MEDIA_MESSAGE_MODAL_EVENT = "MEDIA_MESSAGE_MODAL_EVENT",
+    /**
+     * 合并转发消息 V1 版本弹框事件
+     */
+    COMBINE_MESSAGE_MODAL_EVENT = "COMBINE_MESSAGE_MODAL_EVENT",
+    /**
+     * 消息转发弹框事件
+     */
+    FORWARDING_EVENT = "FORWARDING_EVENT",
+    /**
+     * 拍照弹框事件
+     */
+    TAKE_PHOTO_MODAL_EVENT = "TAKE_PHOTO_MODAL_EVENT",
+    /**
+     * 接收到 SDK 内部无法处理的消息，业务层可通过监听该事件获取消息
+     */
+    UNSCHEDULED_MESSAGES = "UNSCHEDULED_MESSAGES",
+    /**
+     * 业务拓展功能按钮点击事件
+     */
+    CONVERSATION_EXTENSION_CLICK = "CONVERSATION_EXTENSION_CLICK",
+    /**
+     * 系统会话打开前的事件，业务层可通过监听该事件拦截系统会话打开，以自定义系统会话的打开方式
+     */
+    BEFORE_SYSTEM_CONVERSATION_OPEN = "BEFORE_SYSTEM_CONVERSATION_OPEN",
+    /**
+     * 会话菜单项点击事件
+     */
+    CONVERSATION_MENU_ITEM_CLICK = "CONVERSATION_MENU_ITEM_CLICK",
+    /**
+     * 输入框菜单点击事件
+     */
+    INPUT_MENU_ITEM_CLICK = "INPUT_MENU_ITEM_CLICK",
+    /**
+     * 选中会话变更事件，该事件会在会话列表中选中会话时触发
+     */
+    CONVERSATION_SELECTED = "CONVERSATION_SELECTED",
+    /**
+     * 消息列表头像点击事件
+     */
+    CONVERSATION_ICON_CLICK = "CONVERSATION_ICON_CLICK",
+    /**
+     * 消息列表 Header 头像点击事件
+     */
+    CONVERSATION_NAVI_CLICK = "CONVERSATION_NAVI_CLICK",
+    /**
+     * 消息菜单点击事件
+     */
+    MESSAGE_MENU_ITEM_CLICK = "MESSAGE_MENU_ITEM_CLICK",
+    /**
+     * 文本消息中链接点击事件
+     */
+    MESSAGE_LINK_CLICK = "MESSAGE_LINK_CLICK",
+    /**
+     * 下载链接事件
+     */
+    DOWNLOAD_LINK_EVENT = "DOWNLOAD_LINK_EVENT",
+    /**
+     * 文件发送失败事件，一般是由于文件超出尺寸限制或为空文件导致
+     */
+    FILE_SEND_FAILED_EVENT = "FILE_SEND_FAILED_EVENT",
+    /**
+     * 消息被删除或撤回通知
+     */
+    MESSAGES_DELETED = "MESSAGES_DELETED",
+    /**
+     * 提示框显示事件
+     */
+    TOAST_EVENT = "TOAST_EVENT"
+}
+
+/**
+ * 消息菜单项 ID
+ */
+declare enum RCKitMessageMenuID {
+    /** 回复/引用 */
+    REPLY = "message.menu.item.reply",
+    /** 多选 */
+    MULTI_CHOICE = "message.menu.item.multi.choice",
+    /** 复制 */
+    COPY = "message.menu.item.copy",
+    /** 转发 */
+    FORWARD = "message.menu.item.forward",
+    /** 删除 */
+    DELETE = "message.menu.item.delete",
+    /** 转文字 */
+    SPEECH_TO_TEXT = "message.menu.item.speech.to.text",
+    /** 取消转文字 */
+    CANCEL_SPEECH_TO_TEXT = "message.menu.item.cancel.speech.to.text",
+    /** 撤回 */
+    RECALL = "message.menu.item.recall"
+}
+interface IRCKitMessageMenuItem {
+    /**
+     * 菜单 ID，SDK 在派发点击事件时包含此数据，同时也通过此 ID 查询多语言 UI 展示文案
+     */
+    id: RCKitMessageMenuID | string;
+    /**
+     * 菜单图标
+     */
+    icon: string;
+    /**
+     * 过滤器，返回 true 时显示菜单，返回 false 时不显示菜单
+     * @param message
+     */
+    readonly filter?: (message: IRCKitCachedMessage) => boolean;
+}
+
+interface IRCKitConversationItemCfg {
+    /**
+     * 会话 item 圆角大小
+     */
+    radius?: number;
+    /**
+     * 头像大小
+     */
+    portraitSize?: 'large' | 'small';
+    /**
+     * 置顶背景颜色，支持数字 (0xEFF4FF) 或 16 进制字符串 ("#EFF4FF")
+     */
+    topBackgroundColor?: number | string;
+    /**
+     * hover 背景颜色，支持数字 (0xF3F5FA) 或 16 进制字符串 ("#F3F5FA")
+     */
+    hoverBackgroundColor?: number | string;
+    /**
+     * 选中背景颜色，支持数字 (0xD2E1FE) 或 16 进制字符串 ("#D2E1FE")
+     */
+    activeBackgroundColor?: number | string;
+}
+
+interface IRCKitHQVoiceMessageComponentProps {
+    /**
+     * 是否为己方发送的消息
+     */
+    isOwner: boolean;
+    /**
+     * 是否播放中
+     */
+    playing: boolean;
+    /**
+     * 播放进度
+     */
+    progress: number;
+    /**
+     * 语音消息时长
+     */
+    duration: number;
+    /**
+     * 切换播放与暂停状态
+     */
+    toggle: () => void;
+}
+
+interface IRCKitComponentContext {
+    /**
+     * 代理 vue 的 computed 方法，以便于业务使用计算属性
+     */
+    computed: <T>(fn: () => T) => T;
+    /**
+     * 代理 vue 的 ref 方法，以便于业务使用 ref 做响应式监听
+     */
+    ref: <T = number | boolean | string | null>(value?: T) => {
+        value?: T;
+    };
+    /**
+     * 代理 vue 的 reactive 方法，以便于在模版中使用响应式数据
+     */
+    reactive: (obj: object) => any;
+    /**
+     * 获取当前语言
+     */
+    getLanguage(): string;
+    /**
+     * 获取当前用户 ID
+     */
+    getCurrentUserId(): string;
+}
+interface IRCKitDefineCustomElementOptions<T> {
+    setup: (props: T, ctx: IRCKitComponentContext) => any;
+    template: string;
+    styles?: string[];
+}
+/**
+ * 可重写组件枚举定义
+ */
+declare enum RCKitOverrideAbleComponent {
+    /**
+     * 语音消息组件
+     */
+    HQVoiceMessageComponent = "HQVoiceMessageComponent"
+}
+/**
+ * 定义可重写组件 Props 类型定义
+ */
+interface IRCKitOverrideAbleComponentProps {
+    HQVoiceMessageComponent: IRCKitHQVoiceMessageComponentProps;
+}
+
+/**
+ * 消息组件 Props 数据结构定义
+ */
+declare type IRCKitMessageComponentProps = {
+    /**
+     * 消息数据
+     */
+    message: IRCKitCachedMessage;
+};
+
+interface IRCKitCustomMessageComponentOpts extends IRCKitDefineCustomElementOptions<IRCKitMessageComponentProps> {
+    /**
+     * 消息组件标签
+     */
+    tag: string;
+}
+/**
+ * 自定义消息注册配置
+ */
+interface IRCKitRegisterMessageTypeOpts {
+    /** 是否计数 */
+    isCounted?: boolean;
+    /**
+     * 消息是否存储
+     * @description
+     * - `true`: 消息将进入数据库存储，并将在消息列表中显示，开发者必须提供 `digest` 摘要函数，同时可定义 `component` 组件来声明其在消息列表中的展示方式。
+     * - `false`: 消息不会进入数据库存储，也不会在消息列表中显示。SDK 会将消息通过 `RCKitEvents.UNSCHEDULED_MESSAGES` 事件抛给开发者自行处理。
+     */
+    isPersited?: boolean;
+    /** 是否为状态消息：状态消息不计数不存储，且不进入离线补偿，仅限在线时收取 */
+    isStatusMessage?: boolean;
+    /** 检索消息 key，用于消息搜索匹配 */
+    searchProps?: string[];
+    /**
+     * 消息摘要计算函数，用于自定义消息在会话列表和消息列表中的展示。
+     * 在同时定义了 `component` 与 `digest` 属性的情况下，SDK 会优先使用 `component` 组件进行消息渲染。
+     */
+    digest?: (message: IRCKitCachedMessage, language: string) => string;
+    /**
+     * 当 `isPersited` 为 `true` 时，可通过赋值 `component` 属性来定义相应的气泡 UI 渲染组件。
+     * 当该值为空时，SDK 将通过 `digest` 摘要计算函数，渲染消息为灰条消息进行展示。
+     */
+    component?: IRCKitCustomMessageComponentOpts;
+}
+
+interface IRCKitInitOpts {
+    /**
+     * 业务数据模块钩子，用于向 SDK 注入用户信息、群组信息等。
+     */
+    hooks: IRCKitServiceHooks;
+    /**
+     * 日志输出等级，默认值 `LogL.WARN(2)`
+     */
+    logLevel?: LogL.DEBUG | LogL.INFO | LogL.WARN | LogL.ERROR;
+    /**
+     * 初始语言配置。
+     * @description 若不传或值非法，则默认 `zh_CN`。
+     */
+    language?: string;
+    /**
+     * 允许对己方已发送消息进行撤回操作的最大时间，单位：秒。
+     * @description 若不传或值非法，则默认 120 秒
+     */
+    allowedToRecallTime?: number;
+    /**
+     * 允许对己方发送的撤回消息进行编辑操作的最大时间，单位：秒。
+     * @description 若不传或值非法，则默认 60 秒
+     */
+    allowedToReEditTime?: number;
+    /**
+     * 弹窗父级 DOM，不传默认为 document.body
+     */
+    modalContainerId?: string;
+}
+declare class RCKitApplication extends EventDispatcher<EventDefined> {
+    private context;
+    private readonly _logger;
+    private readonly _ctx;
+    private readonly _uiModule;
+    private _isReady;
+    constructor(context: PluginContext, _logger: ILogger, opts: IRCKitInitOpts);
+    private _onIMDestroy;
+    /**
+     * 定义功能开关，可通过 `RCKitCommand` 查看所有支持的功能配置项。必须在 `ready` 之前调用。
+     */
+    setCommandSwitch(command: RCKitCommand, enable: boolean): void;
+    /**
+     * 查询功能开关开启状态，可通过 `RCKitCommand` 查看所有支持的功能配置项。
+     */
+    getCommandSwitch(command: RCKitCommand): boolean;
+    /**
+     * 设置会话栏开关
+     * @param enable 是否开启
+     */
+    setConversationBarSwitch(enable: boolean): void;
+    /**
+     * 设置会话详情返回按钮开关
+     * @param enable 是否开启
+     */
+    setConversationDetailBackSwitch(enable: boolean): void;
+    /**
+     * 设置会话栏标题，仅当会话栏开启时才能设置成功
+     * @param value 标题内容，undefined 表示使用默认值
+     */
+    setConversationBarTitle(value?: string): void;
+    /**
+     * 注册自定义组件，以替换 SDK 默认组件，必须在 `ready` 之前调用。
+     * @param tag - 自定义组件标签名
+     * @param opts - 自定义组件定义
+     * @example ```ts
+     * app.registerCustomElement(RCKitOverrideAbleComponent.HQVoiceMessageComponent, {
+     *    template: '<span class="test" @click="handleClick">{{ content }}</span>',
+     *    setup(props, ctx) {
+     *      const { computed, lang } = ctx;
+     *      const handleClick = () => {
+     *        // 处理自定义事件
+     *      };
+     *      return {
+     *        content: computed(() => {
+     *          return lang.value === 'en_US' ? 'Hello' : '你好';
+     *        }),
+     *      },
+     *    },
+     *    styles: ['.test { color: red; }'],
+     * });
+     * ```
+     */
+    registerCustomElement<T extends keyof IRCKitOverrideAbleComponentProps>(tag: T, opts: IRCKitDefineCustomElementOptions<{
+        value: IRCKitOverrideAbleComponentProps[T];
+    }>): void;
+    /**
+     * 注册自定义消息类型，必须在 `ready` 之前调用。
+     */
+    registerMessageType<T = any>(messageType: string, options: IRCKitRegisterMessageTypeOpts): new (content: T) => BaseMessage<T>;
+    /**
+     * 获取内置语言包词条拷贝
+     * @param lang 传参确认要获取的语言包
+     */
+    cloneLanguageEntries(lang: string): {
+        [key: string]: string;
+    } | null;
+    /**
+     * 注册语言包，也可用于覆盖既有语言包；仅 `ready` 调用前有效。
+     * @param lang - 语言包定义，如 `zh_CN`
+     * @param entries - 语言包词条定义
+     * @param direction - 语言的行文方向，默认 'ltr'; 仅当首次注册指定语言包时有效。
+     */
+    registerLanguagePack(lang: string, entries: {
+        [key: string]: string;
+    } | IRCKitLanguageEntries, direction?: RCKitLanguageDirection): void;
+    /**
+     * 语言切换功能接口
+     * @param lang - 要切换的目标语言
+     */
+    setLanguage(lang: string): void;
+    /**
+     * 获取当前使用的语言
+     */
+    getLanguage(): string;
+    /**
+     * 获取支持的语言列表
+     */
+    getSupportedLanguages(): string[];
+    /**
+     * 设置自定义推送配置钩子，用于在消息发送前，修改移动端接收推送时的标题、内容等。
+     * @param hook
+     */
+    setPushConfigHook(hook: IRCKitPushConfigHook): void;
+    /**
+     * 更新用户信息
+     * @param profile
+     */
+    updateUserProfile(profile: IRCKitUserProfile): void;
+    /**
+     * 更新群组信息
+     * @param profile
+     */
+    updateGroupProfile(profile: IRCKitGroupProfile): void;
+    /**
+     * 更新用户在线状态
+     * @param userId 用户 ID
+     * @param online 在线状态
+     */
+    updateUserOnlineStatus(userId: string, online: boolean): void;
+    /**
+     * 立即刷新用户成员列表，调用该方法会同步更新群组 `memberCount` 信息。
+     * 该操作仅影响本地缓存数据与 UI 显示，不会向融云服务端发送请求。
+     * @param groupId 群组 ID
+     * @param members 成员列表
+     */
+    updateGroupMembers(groupId: string, members: IRCKitGroupMemberProfile[]): void;
+    /**
+     * 添加群组成员，调用该方法会同步更新群组 `memberCount` 信息。
+     * 该操作仅影响本地缓存数据与 UI 显示，不会向融云服务端发送请求。
+     */
+    addGroupMembers(groupId: string, members: IRCKitGroupMemberProfile[]): void;
+    /**
+     * 删除群组成员，调用该方法会同步更新群组 `memberCount` 信息。
+     * 该操作仅影响本地缓存数据与 UI 显示，不会向融云服务端发送请求。
+    */
+    removeGroupMembers(groupId: string, members: string[]): void;
+    /**
+     * 获取会话菜单拷贝
+     * @returns
+     */
+    cloneConversationMenu(): IRCKitConversationMenuItem[];
+    setConversationMenu(menu: IRCKitConversationMenuItem[]): void;
+    cloneMessageMenu(): IRCKitMessageMenuItem[];
+    setMessageMenu(menu: IRCKitMessageMenuItem[]): void;
+    /**
+     * 打开指定会话，若会话不存在于当前显示的会话列表内，新建会话并将其置于会话列表尽可能靠前位置
+     * @param conversation
+     */
+    openConversation(conversation: IConversationOption, focusInput?: boolean): Promise<{
+        code: number;
+    }>;
+    /**
+     * 删除指定会话
+     * @param conversation
+     */
+    removeConversation(conversation: IConversationOption): Promise<void>;
+    /**
+     * 获取当前打开中的会话，若未打开任何会话，则返回 null
+     * @returns
+     */
+    getOpenedConversation(): IRCKitCachedConversation | null;
+    /**
+     * 向右侧会话详情面板添加功能拓展，仅在 `ready` 之前调用有效。
+     * @param extension
+     * @description - 添加拓展后，当用户点击时，会向业务层派发 {@link RCKitEvents.CONVERSATION_EXTENSION_CLICK} 事件。
+     */
+    setConversationExtension(extensions: IRCKitConversationExtension[]): void;
+    /**
+     * 获取输入框菜单配置拷贝
+     * @returns
+     */
+    cloneInputMenu(): IRCKitInputMenu;
+    /**
+     * 设置新的输入框菜单配置
+     * @param menu
+     */
+    setInputMenu(menu: IRCKitInputMenu): void;
+    cloneMessageBubbleCfg(): IRCKitMessageBubbleCfg;
+    setMessageBubbleCfg(config: IRCKitMessageBubbleCfg): void;
+    /**
+     * 获取会话列表 Item 配置拷贝
+     */
+    cloneConversationItemCfg(): IRCKitConversationItemCfg;
+    /**
+     * 设置会话列表 Item 配置
+     * @param config
+     */
+    setConversationItemCfg(config: IRCKitConversationItemCfg): void;
+    /**
+     * 获取已存在的图片表情库列表拷贝
+     * @returns
+     */
+    cloneImageEmojiLibraries(): IRCKitImageEmojiLibrary[];
+    /**
+     * 设置图片表情库列表
+     * @param libraries
+     */
+    setImageEmojiLibraries(libraries: IRCKitImageEmojiLibrary[]): void;
+    /**
+     * 获取已存在的字符表情库拷贝
+     */
+    cloneChatEmojiLibrary(): IRCKitChatEmojiLibrary;
+    /**
+     * 设置字符表情库
+     */
+    setChatEmojiLibrary(library: IRCKitChatEmojiLibrary): void;
+    /**
+     * 发送消息
+     * @param conversation - 会话
+     * @param message - 消息
+     * @param options - 发送选项
+     */
+    sendMessage(conversation: IConversationOption, message: BaseMessage<any>, options?: ISendMessageOptions): Promise<{
+        code: number;
+        message?: IAReceivedMessage;
+    }>;
+    /**
+     * 向本地插入一条消息
+     * @param conversation - 会话
+     * @param message - 消息
+     */
+    insertMessage(conversation: IConversationOption, message: BaseMessage<any>): Promise<{
+        code: number;
+    }>;
+    /**
+     * 通知 SDK 配置准备完成，以便 SDK 依据配置进行初始化。
+     */
+    ready(): void;
+    /**
+     * 检测 SDK 是否已完成初始化
+     * @returns 是否已完成初始化
+     */
+    ifReady(): boolean;
+    getCurrentUserId(): string;
+    /**
+     * 反初始化
+     */
+    destroy(): void;
+}
+
+/**
+ * Web IM Kit 构建版本代码 Commit ID
+ */
+declare const RCKIT_COMMIT_VERSION: string;
+/**
+ * Web IM Kit 版本号
+ */
+declare const RCKIT_VERSION: string;
+
+/**
+ * 判断是否为移动端设备（窗口宽度 <= 768px）
+ * @returns {boolean} 是否为移动端
+ */
+declare const isMobileDevice: () => boolean;
+
+declare const RCKitInstaller: IPluginGenerator<RCKitApplication, IRCKitInitOpts>;
+
+export { BeforeSystemConversationOpenEvent, DeleteMessageModalEvent, IRCKitCachedConversation, IRCKitCachedMessage, IRCKitChatEmojiLibrary, IRCKitComponentContext, IRCKitConversationExtension, IRCKitConversationExtensionClick, IRCKitConversationIconClick, IRCKitConversationItemCfg, IRCKitConversationMenuItem, IRCKitConversationMenuItemClick, IRCKitCustomMessageComponentOpts, IRCKitDefineCustomElementOptions, IRCKitDeleteMessageData, IRCKitGifImageInfo, IRCKitGroupMemberProfile, IRCKitGroupProfile, IRCKitHQVoiceMessageComponentProps, IRCKitImageEmoji, IRCKitImageEmojiLibrary, IRCKitInitOpts, IRCKitInputMenu, IRCKitInputMenuItem, IRCKitInputMenuItemClick, IRCKitLanguageEntries, IRCKitMessageBubbleCfg, IRCKitMessageLinkClick, IRCKitMessageMenuItem, IRCKitMessageMenuItemClick, IRCKitModalDeleteMessage, IRCKitModalDeleteMessageResult, IRCKitModalForwardingResult, IRCKitOverrideAbleComponentProps, IRCKitPushConfigHook, IRCKitRegisterMessageTypeOpts, IRCKitServiceHooks, IRCKitSystemProfile, IRCKitUserOnlineStatus, IRCKitUserProfile, RCKIT_COMMIT_VERSION, RCKIT_VERSION, RCKitApplication, RCKitBubbleLayout, RCKitChatEmojiLibraryID, RCKitCommand, RCKitConversationMenuID, RCKitEvent, RCKitEvents, RCKitInputMenuID, RCKitInputMenuPosition, RCKitInstaller, RCKitLanguageDirection, RCKitMentionedType, RCKitMessageMenuID, RCKitModalBtnType, RCKitModalForwardingType, RCKitOverrideAbleComponent, isMobileDevice };