@kaguyajs/trss-yunzai-types
    Preparing search index...

    Interface BaseEvent

    interface BaseEvent {
        adapter_id: string;
        adapter_name: string;
        at?: string | number;
        atBot?: true;
        bot: Client;
        file?: FileElem;
        getReply?: any;
        hasAlias?: true;
        img?: string[];
        isGroup?: true;
        isMaster?: true;
        isPrivate?: true;
        logFnc: string;
        logText: string;
        msg: string;
        recall?:
            | {
                (msg: PrivateMessage): Promise<boolean>;
                (msgid: string): Promise<boolean>;
                (seq: number, rand: number, time: number): Promise<boolean>;
                (param: number, rand: number, time: number): Promise<boolean>;
                (message_id: string): Promise<boolean>;
                (message: PrivateMessage): Promise<boolean>;
            }
            | {
                (msg: GroupMessage): Promise<boolean>;
                (msgid: string): Promise<boolean>;
                (seq: number, rand: number, pktnum?: number): Promise<boolean>;
                (param: number, rand: number, pktnum: number): Promise<boolean>;
                (message_id: string): Promise<boolean>;
                (message: GroupMessage): Promise<boolean>;
            };
        reply_id?: string;
        runtime?: any;
        self_id: string
        | number;
        user?: any;
        user_id: string | number;
        reply(
            msg: Sendable,
            quote?: boolean,
            data?: { at?: boolean; recallMsg?: number },
        ): Promise<MessageRet & { error?: any[] }>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adapter_id adapter_name at? atBot? bot file? getReply? hasAlias? img? isGroup? isMaster? isPrivate? logFnc logText msg recall? reply_id? runtime? self_id user? user_id

    Methods

    reply

    Properties

    adapter_id: string

    聊天平台名称，同一个平台唯一

    adapter_name: string

    适配器名称

    at?: string | number

    被艾特者id

    atBot?: true

    是否at机器人

    bot: Client

    收到事件的Bot对象

    file?: FileElem

    接收到的文件

    getReply?: any

    获取引用消息

    hasAlias?: true

    是否包含别名

    img?: string[]

    图片消息数组

    isGroup?: true

    是否为群聊

    isMaster?: true

    触发者是否为主人

    isPrivate?: true

    是否为私聊

    logFnc: string

    日志方法字符串

    logText: string

    日志用户字符串

    msg: string

    文本消息内容

    recall?:
        | {
            (msg: PrivateMessage): Promise<boolean>;
            (msgid: string): Promise<boolean>;
            (seq: number, rand: number, time: number): Promise<boolean>;
            (param: number, rand: number, time: number): Promise<boolean>;
            (message_id: string): Promise<boolean>;
            (message: PrivateMessage): Promise<boolean>;
        }
        | {
            (msg: GroupMessage): Promise<boolean>;
            (msgid: string): Promise<boolean>;
            (seq: number, rand: number, pktnum?: number): Promise<boolean>;
            (param: number, rand: number, pktnum: number): Promise<boolean>;
            (message_id: string): Promise<boolean>;
            (message: GroupMessage): Promise<boolean>;
        }

    撤回消息

    Type Declaration

    • {
          (msg: PrivateMessage): Promise<boolean>;
          (msgid: string): Promise<boolean>;
          (seq: number, rand: number, time: number): Promise<boolean>;
          (param: number, rand: number, time: number): Promise<boolean>;
          (message_id: string): Promise<boolean>;
          (message: PrivateMessage): Promise<boolean>;
      }
        • (msg: PrivateMessage): Promise<boolean>

        • 撤回消息

          Parameters

          Returns Promise<boolean>

        • (msgid: string): Promise<boolean>

        • Parameters

          • msgid: string

          Returns Promise<boolean>

        • (seq: number, rand: number, time: number): Promise<boolean>

        • Parameters

          • seq: number
          • rand: number
          • time: number

          Returns Promise<boolean>

        • (param: number, rand: number, time: number): Promise<boolean>

        • 撤回消息，cqhttp方法用

          Parameters

          • param: number
          • rand: number
          • time: number

          Returns Promise<boolean>

        • (message_id: string): Promise<boolean>

        • 撤回消息

          Parameters

          • message_id: string

            消息id

          Returns Promise<boolean>

        • (message: PrivateMessage): Promise<boolean>

        • 撤回消息

          Parameters

          Returns Promise<boolean>

    • {
          (msg: GroupMessage): Promise<boolean>;
          (msgid: string): Promise<boolean>;
          (seq: number, rand: number, pktnum?: number): Promise<boolean>;
          (param: number, rand: number, pktnum: number): Promise<boolean>;
          (message_id: string): Promise<boolean>;
          (message: GroupMessage): Promise<boolean>;
      }
        • (msg: GroupMessage): Promise<boolean>

        • 撤回消息

          Parameters

          Returns Promise<boolean>

        • (msgid: string): Promise<boolean>

        • Parameters

          • msgid: string

          Returns Promise<boolean>

        • (seq: number, rand: number, pktnum?: number): Promise<boolean>

        • Parameters

          • seq: number
          • rand: number
          • Optionalpktnum: number

          Returns Promise<boolean>

        • (param: number, rand: number, pktnum: number): Promise<boolean>

        • 撤回消息，cqhttp方法用

          Parameters

          • param: number
          • rand: number
          • pktnum: number

          Returns Promise<boolean>

        • (message_id: string): Promise<boolean>

        • 撤回消息

          Parameters

          • message_id: string

            消息id

          Returns Promise<boolean>

        • (message: GroupMessage): Promise<boolean>

        • 撤回消息

          Parameters

          Returns Promise<boolean>

    reply_id?: string

    引用消息ID

    runtime?: any
    self_id: string | number

    收到事件的机器人id

    user?: any
    user_id: string | number

    发送者id

    Methods

    • 回复消息

      Parameters

      • msg: Sendable

        支持字符串或 segment

      • Optionalquote: boolean

        是否引用回复

      • Optionaldata: { at?: boolean; recallMsg?: number }

        额外配置

        • Optionalat?: boolean

          是否提及用户

        • OptionalrecallMsg?: number

          多久之后撤回消息，0-120秒，0不撤回

      Returns Promise<MessageRet & { error?: any[] }>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods