@wppconnect/wa-js - v4.6.0
    Preparing search index...

    Interface ChatEventTypes

    interface ChatEventTypes {
        "chat.active_chat": ChatModel | null;
        "chat.active_filter": Required<ChatFilter>;
        "chat.live_location_end": { chat: Wid; id: Wid; seq: number };
        "chat.live_location_start": {
            accuracy?: number;
            chat: Wid;
            degrees?: number;
            id: Wid;
            lat: number;
            lng: number;
            msgId: MsgKey;
            shareDuration: number;
            speed?: number;
        };
        "chat.live_location_update": {
            accuracy?: number;
            comment: string;
            degrees?: number;
            elapsed: number;
            id: Wid;
            lastUpdated: number;
            lat: number;
            lng: number;
            speed?: number;
        };
        "chat.msg_ack_change": {
            ack: number;
            chat: Wid;
            ids: MsgKey[];
            sender?: Wid;
        };
        "chat.msg_edited": { chat: Wid; id: string; msg: MsgModel };
        "chat.msg_revoke": {
            author?: Wid;
            from: Wid;
            id: MsgKey;
            refId: MsgKey;
            to: Wid;
            type: "revoke" | "sender_revoke" | "admin_revoke";
        };
        "chat.new_chat": ChatModel;
        "chat.new_message": MsgModel;
        "chat.new_reaction": {
            id: MsgKey;
            msgId: MsgKey;
            orphan: number;
            orphanReason: any;
            reactionText: string;
            read: boolean;
            sender: Wid;
            timestamp: number;
        };
        "chat.poll_response": {
            chatId: Wid;
            msgId: MsgKey;
            selectedOptions: number[];
            sender: Wid;
            timestamp: number;
        };
        "chat.presence_change": {
            id: Wid;
            isContact?: boolean;
            isGroup: boolean;
            isOnline: boolean;
            isUser: boolean;
            participants?: { id: string; shortName: string; state: string }[];
            shortName: string;
            state: string;
            t: number;
        };
        "chat.unread_count_changed": {
            chat: ChatModel;
            previousUnreadCount: number;
            unreadCount: number;
        };
        "chat.update_label": {
            chat: ChatModel;
            ids: string[];
            labels: Label[];
            type: "add"
            | "remove";
        };
    }
    Index
    chat.active_chat chat.active_filter chat.live_location_end chat.live_location_start chat.live_location_update chat.msg_ack_change chat.msg_edited chat.msg_revoke chat.new_chat chat.new_message chat.new_reaction chat.poll_response chat.presence_change chat.unread_count_changed chat.update_label
    "chat.active_chat": ChatModel | null

    Triggered when change the active chat

    WPP.on('chat.active_chat', (chat) => {
      // Your code
    });
    "chat.active_filter": Required<ChatFilter>

    Triggered when the active native chat-list filter changes.

    kind and label are always present, null when there is no filter, so the All filter is { kind: null, label: null }. WhatsApp label lists use kind: 'labels' and expose their label id in label.

    Note: the list of setChatList custom type is not a native filter, WhatsApp stays on the All filter for it.

    WPP.on('chat.active_filter', ({ kind, label }) => {
      // Your code
    });
    "chat.live_location_end": { chat: Wid; id: Wid; seq: number }

    Temporary unsuported by WhatsApp Web Multi-Device

    "chat.live_location_start": {
        accuracy?: number;
        chat: Wid;
        degrees?: number;
        id: Wid;
        lat: number;
        lng: number;
        msgId: MsgKey;
        shareDuration: number;
        speed?: number;
    }
    "chat.live_location_update": {
        accuracy?: number;
        comment: string;
        degrees?: number;
        elapsed: number;
        id: Wid;
        lastUpdated: number;
        lat: number;
        lng: number;
        speed?: number;
    }

    Temporary unsuported by WhatsApp Web Multi-Device

    "chat.msg_ack_change": { ack: number; chat: Wid; ids: MsgKey[]; sender?: Wid }

    Type Declaration

    • ack: number
    • chat: Wid

      The chat that sended the messeage

    • ids: MsgKey[]

      Message id of revoke event

    • Optionalsender?: Wid

      Who sended the ack, only for groups, broadcast and status

    "chat.msg_edited": { chat: Wid; id: string; msg: MsgModel }

    On Message edit

    "chat.msg_revoke": {
        author?: Wid;
        from: Wid;
        id: MsgKey;
        refId: MsgKey;
        to: Wid;
        type: "revoke" | "sender_revoke" | "admin_revoke";
    }

    Type Declaration

    • Optionalauthor?: Wid

      Author of message, only for groups

    • from: Wid
    • id: MsgKey

      Message id of revoke event

    • refId: MsgKey

      Message id of revoked message

    • to: Wid
    • type: "revoke" | "sender_revoke" | "admin_revoke"

      Type of revoke

    "chat.new_chat": ChatModel

    Triggered when a new chat is created

    WPP.on('chat.new_chat', (chat) => {
      // Your code
    });
    "chat.new_message": MsgModel

    Triggered when new message is received

    WPP.on('chat.new_message', (msg) => {
      // Your code
    });
    "chat.new_reaction": {
        id: MsgKey;
        msgId: MsgKey;
        orphan: number;
        orphanReason: any;
        reactionText: string;
        read: boolean;
        sender: Wid;
        timestamp: number;
    }

    Triggered when a new reaction is received

    Type Declaration

    • id: MsgKey

      Reaction ID

    • msgId: MsgKey

      Message ID that received the reaction

    • orphan: number
    • orphanReason: any
    • reactionText: string

      The reaction emoji or empty if removed

    • read: boolean
    • sender: Wid
    • timestamp: number
    WPP.on('chat.new_reaction', (msg) => {
      // Your code
    });
    "chat.poll_response": {
        chatId: Wid;
        msgId: MsgKey;
        selectedOptions: number[];
        sender: Wid;
        timestamp: number;
    }

    On Poll response

    "chat.presence_change": {
        id: Wid;
        isContact?: boolean;
        isGroup: boolean;
        isOnline: boolean;
        isUser: boolean;
        participants?: { id: string; shortName: string; state: string }[];
        shortName: string;
        state: string;
        t: number;
    }

    On presence change

    "chat.unread_count_changed": {
        chat: ChatModel;
        previousUnreadCount: number;
        unreadCount: number;
    }

    Type Declaration

    • chat: ChatModel

      Chat that changed the unread count

    • previousUnreadCount: number

      Previous unread messages count

    • unreadCount: number

      Current unread messages count

    "chat.update_label": {
        chat: ChatModel;
        ids: string[];
        labels: Label[];
        type: "add" | "remove";
    }

    On Labels update

    Settings
    Member Visibility

    On This Page
    Properties