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

    Interface PrivateEvent

    私聊事件

    interface PrivateEvent {
        adapter_id: string;
        adapter_name: string;
        at?: string | number;
        atBot?: true;
        auto_reply: boolean;
        bot: Client;
        div: number;
        file?: FileElem;
        font: string;
        friend: icqq.Friend;
        from_id: number;
        getReply?: any;
        hasAlias?: true;
        img?: string[];
        index: number;
        isGroup: false;
        isMaster?: true;
        isPrivate: true;
        logFnc: string;
        logText: string;
        message: MessageElem[];
        message_id: string;
        message_type: "private";
        msg: string;
        parsed: Parser;
        pktnum: number;
        post_type: "message";
        proto: Proto;
        rand: number;
        raw_message: 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;
        sender: {
            discuss_id: number;
            group_id: number;
            nickname: string;
            user_id: number;
        };
        seq: number;
        source?: Quotable;
        sub_type: "friend"
        | "group"
        | "other"
        | "self";
        time: number;
        to_id: number;
        user?: any;
        user_id: string | number;
        get nickname(): string;
        reply(
            msg: Sendable,
            quote?: boolean,
            data?: { at?: boolean; recallMsg?: number },
        ): Promise<MessageRet & { error?: any[] }>;
        serialize(): Buffer;
        toCqcode(): string;
        toJSON(keys: string[]): Record<string, any>;
        toString(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    adapter_id adapter_name at? atBot? auto_reply bot div file? font friend from_id getReply? hasAlias? img? index isGroup isMaster? isPrivate logFnc logText message message_id message_type msg parsed pktnum post_type proto rand raw_message recall? reply_id? runtime? self_id sender seq source? sub_type time to_id user? user_id

    Accessors

    nickname

    Methods

    reply serialize toCqcode toJSON toString

    Properties

    adapter_id: string

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

    adapter_name: string

    适配器名称

    at?: string | number

    被艾特者id

    atBot?: true

    是否at机器人

    auto_reply: boolean

    是否为自动回复

    bot: Client

    收到事件的Bot对象

    div: number
    file?: FileElem

    接收到的文件

    font: string
    friend: icqq.Friend

    好友对象

    from_id: number

    发送方账号

    getReply?: any

    获取引用消息

    hasAlias?: true

    是否包含别名

    img?: string[]

    图片消息数组

    index: number
    isGroup: false

    是否为群聊

    isMaster?: true

    触发者是否为主人

    isPrivate: true

    是否为私聊

    logFnc: string

    日志方法字符串

    logText: string

    日志用户字符串

    message: MessageElem[]

    消息元素数组

    message_id: string

    cqhttp方法用

    message_type: "private"
    msg: string

    文本消息内容

    parsed: Parser
    pktnum: number

    post_type

    post_type: "message"
    proto: Proto
    rand: number

    消息随机数

    raw_message: 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

    sender: {
        discuss_id: number;
        group_id: number;
        nickname: string;
        user_id: number;
    }

    发送方信息

    Type Declaration

    • discuss_id: number

      讨论组号，当消息来自讨论组时有效

    • group_id: number

      群号，当消息来自群聊时有效

    • nickname: string

      昵称

    • user_id: number

      账号

    seq: number

    消息编号，在群消息中是唯一的 (私聊消息建议至少使用time,seq,rand中的两个判断唯一性)

    source?: Quotable

    引用回复

    sub_type: "friend" | "group" | "other" | "self"
    time: number

    消息时间

    to_id: number

    接收方账号

    user?: any
    user_id: string | number

    发送者id

    Accessors

    • get nickname(): string

      发送方昵称，仅供内部转发消息时使用

      Returns string

    Methods

    • 回复消息

      Parameters

      • msg: Sendable

        支持字符串或 segment

      • Optionalquote: boolean

        是否引用回复

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

        额外配置

        • Optionalat?: boolean

          是否提及用户

        • OptionalrecallMsg?: number

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

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

    • 将消息序列化保存

      Returns Buffer

    • Returns string

      转换为CQ码

    • Parameters

      • keys: string[]

      Returns Record<string, any>

    • 以适合人类阅读的形式输出

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods