whatsapp-web.js

https://docs.wwebjs.dev
Admin
A Node.js library that acts as a WhatsApp API client by connecting through the WhatsApp Web browser...
Tokens:126,644
Snippets:1,005
Trust Score:8.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install whatsapp-web.js

Source: https://docs.wwebjs.dev/index.html

Install the library using npm, yarn, or pnpm. Node.js v18.0.0 or higher is required.

```bash
npm install whatsapp-web.js
yarn add whatsapp-web.js
pnpm add whatsapp-web.js
```

--------------------------------

### Client Initialization

Source: https://docs.wwebjs.dev/Client.html

Initializes the WhatsApp Web client. This is the starting point for all interactions with the API.

```APIDOC
## new Client(options)

### Description
Initializes the WhatsApp Web client with the provided options.

### Parameters
#### Options
- **options** (object) - Optional - Configuration options for the client.
```

--------------------------------

### Start Pairing Code Session

Source: https://docs.wwebjs.dev/Client.js.html

Starts a session to receive pairing codes. It sets up an interval to periodically check the socket state and receive the code. Ensure `getCode` and `onCodeReceivedEvent` are defined.

```javascript
window.codeInterval = setInterval(async () => {
    const state =
        window.require('WAWebSocketModel').Socket.state;
    if (state != 'UNPAIRED' && state != 'UNPAIRED_IDLE') {
        clearInterval(window.codeInterval);
        return;
    }
    window.onCodeReceivedEvent(await getCode());
}, intervalMs);
return window.onCodeReceivedEvent(await getCode());
```

--------------------------------

### Get All Labels

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves all current labels from the client. It evaluates a function in the browser context to get the labels.

```javascript
const labels = await this.pupPage.evaluate(async () => {
    return window.WWebJS.getLabels();
});

return labels.map((data) => new Label(this, data));
```

--------------------------------

### Initialize WhatsApp Web Client

Source: https://docs.wwebjs.dev/Client.js.html

Demonstrates the basic setup for initializing the WhatsApp Web client. It shows how to import the Client class and create a new instance with default options.

```javascript
'use strict';

const EventEmitter = require('events');
const puppeteer = require('puppeteer');

const Util = require('./util/Util');
const InterfaceController = require('./util/InterfaceController');
const {
    WhatsWebURL,
    DefaultOptions,
    Events,
    WAState,
    MessageTypes,
} = require('./util/Constants');
const { ExposeAuthStore } = require('./util/Injected/AuthStore/AuthStore');
const { LoadUtils } = require('./util/Injected/Utils');
const ChatFactory = require('./factories/ChatFactory');
const ContactFactory = require('./factories/ContactFactory');
const WebCacheFactory = require('./webCache/WebCacheFactory');
const {
    ClientInfo,
    Message,
    MessageMedia,
    Contact,
    Location,
    Poll,
    PollVote,
    GroupNotification,
    Label,
    Call,
    Buttons,
    List,
    Reaction,
    Broadcast,
    ScheduledEvent,
} = require('./structures');
const NoAuth = require('./authStrategies/NoAuth');
const { exposeFunctionIfAbsent } = require('./util/Puppeteer');

/**
 * Starting point for interacting with the WhatsApp Web API
 * @extends {EventEmitter}
 * @param {object} options - Client options
 * @param {AuthStrategy} options.authStrategy - Determines how to save and restore sessions. If not set, NoAuth will be used.
 * @param {string} options.webVersion - The version of WhatsApp Web to use. Use options.webVersionCache to configure how the version is retrieved.
 * @param {object} options.webVersionCache - Determines how to retrieve the WhatsApp Web version. Defaults to a local cache (LocalWebCache) that falls back to latest if the requested version is not found.
 * @param {number} options.authTimeoutMs - Timeout for authentication selector in puppeteer
 * @param {function} options.evalOnNewDoc - function to eval on new doc
 * @param {object} options.puppeteer - Puppeteer launch options. View docs here: https://github.com/puppeteer/puppeteer/
 * @param {number} options.qrMaxRetries - How many times should the qrcode be refreshed before giving up
 * @param {number} options.takeoverOnConflict - If another whatsapp web session is detected (another browser), take over the session in the current browser
 * @param {number} options.takeoverTimeoutMs - How much time to wait before taking over the session
 * @param {string} options.userAgent - User agent to use in puppeteer
 * @param {string} options.ffmpegPath - Ffmpeg path to use when formatting videos to webp while sending stickers
 * @param {boolean} options.bypassCSP - Sets bypassing of page's Content-Security-Policy.
 * @param {string} options.deviceName - Sets the device name of a current linked device., i.e.: 'TEST'.
 * @param {string} options.browserName - Sets the browser name of a current linked device, i.e.: 'Firefox'.
 * @param {object} options.proxyAuthentication - Proxy Authentication object.
 *
 * @fires Client#qr
 * @fires Client#authenticated
 * @fires Client#auth_failure
 * @fires Client#ready
 * @fires Client#message
 * @fires Client#message_ack
 * @fires Client#message_create
 * @fires Client#message_revoke_me
 * @fires Client#message_revoke_everyone
 * @fires Client#message_ciphertext
 * @fires Client#message_edit
 * @fires Client#media_uploaded
 * @fires Client#group_join
 * @fires Client#group_leave
 * @fires Client#group_update
 * @fires Client#disconnected
 * @fires Client#change_state
 * @fires Client#contact_changed
 * @fires Client#group_admin_changed
 * @fires Client#group_membership_request
 * @fires Client#vote_update
 */
class Client extends EventEmitter {
    constructor(options = {}) {
        super();

        this.options = Util.mergeDefault(DefaultOptions, options);

        if (!this.options.authStrategy) {
            this.authStrategy = new NoAuth();
        } else {
            this.authStrategy = this.options.authStrategy;
        }

        this.authStrategy.setup(this);
        /**
         * @type {puppeteer.Browser}
         */
        this.pupBrowser = null;
        /**
         * @type {puppeteer.Page}
         */
        this.pupPage = null;

        this.currentIndexHtml = null;
        this.lastLoggedOut = false;

        Util.setFfmpegPath(this.options.ffmpegPath);
    }

    /**
     * Injection logic
     * Private function
     */
    async inject() {
        if (

```

--------------------------------

### getState

Source: https://docs.wwebjs.dev/Client.html

Gets the current connection state for the client.

```APIDOC
## getState()

### Description
Gets the current connection state for the client.

### Method
`async`

### Returns
`WAState`
```

--------------------------------

### Setup WebSocket State and Command Event Listeners

Source: https://docs.wwebjs.dev/Client.js.html

Sets up event listeners within the browser context for WebSocket state changes and various command events from the bridge.

```javascript
window
    .require('WAWebSocketModel')
    .Socket.on('change:state', (_AppState, state) => {
        window.onAuthAppStateChangedEvent(state);
    });
window
    .require('WAWebSocketModel')
    .Socket.on('change:hasSynced', () => {
        window.onAppStateHasSyncedEvent();
    });
const Cmd = window.require('WAWebCmd').Cmd;
Cmd.on('offline_progress_update_from_bridge', () => {
    window.onOfflineProgressUpdateEvent(
        window.AuthStore.OfflineMessageHandler.getOfflineDeliveryProgress(),
    );
});
Cmd.on('logout', async () => {
    await window.onLogoutEvent();
});
Cmd.on('logout_from_bridge', async () => {
    await window.onLogoutEvent();
});
```

--------------------------------

### Inject Functionality into Module

Source: https://docs.wwebjs.dev/Client.js.html

Demonstrates injecting custom functionality into a specific module and function within the WhatsApp Web client. This example targets 'WAWebAddonReactionTableMode.reactionTableMode.bulkUpsert'.

```javascript
window.WWebJS.injectToFunction(
    {
        module: 'WAWebAddonReactionTableMode',
        function: 'reactionTableMode.bulkUpsert',
    },

```

--------------------------------

### Get Invite Info - JavaScript

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves information about a group invite code. Requires the invite code as a string parameter.

```javascript
async getInviteInfo(inviteCode) {
            return await this.pupPage.evaluate((inviteCode) => {
                return window
                    .require('WAWebGroupQueryJob')
                    .queryGroupInvite(inviteCode);
            }, inviteCode);
        }
```

--------------------------------

### Get Channel by Invite Code

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves a channel instance using its invite code. Handles potential server errors by returning null.

```javascript
async getChannelByInviteCode(inviteCode) {
        const channel = await this.pupPage.evaluate(async (inviteCode) => {
            let channelMetadata;
            try {
                channelMetadata =
                    await window.WWebJS.getChannelMetadata(inviteCode);
            } catch (err) {
                if (err.name === 'ServerStatusCodeError') return null;
                throw err;
            }
            return await window.WWebJS.getChat(channelMetadata.id);
        }, inviteCode);
  
        return channel ? ChatFactory.create(this, channel) : undefined;
    }
```

--------------------------------

### initialize

Source: https://docs.wwebjs.dev/Client.html

Sets up events and requirements, kicks off authentication request.

```APIDOC
## initialize()

### Description
Sets up events and requirements, kicks off authentication request.

### Method
`async`
```

--------------------------------

### Get Label by ID

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves a specific label using its ID. It evaluates a function in the browser to get the label data.

```javascript
const label = await this.pupPage.evaluate(async (labelId) => {
    return window.WWebJS.getLabel(labelId);
}, labelId);

return new Label(this, label);
```

--------------------------------

### Get Broadcast by ID

Source: https://docs.wwebjs.dev/Client.js.html

Fetches a broadcast instance using the provided contact ID. It attempts to get the status directly or by finding it.

```javascript
const broadcast = await this.pupPage.evaluate(async (userId) => {
    let status;
    try {
        status = window.require('WAWebCollections').Status.get(userId);
        if (!status) {
            status = await window
                .require('WAWebCollections')
                .Status.find(userId);
        }
    } catch {
        status = null;
    }

    if (status) return window.WWebJS.getStatusModel(status);
}, contactId);
return new Broadcast(this, broadcast);
```

--------------------------------

### Basic Client Initialization and Event Handling

Source: https://docs.wwebjs.dev/index.html

This snippet demonstrates how to initialize a WhatsApp client, handle the QR code generation for authentication, and respond to incoming messages. It requires the 'qrcode-terminal' package for displaying the QR code.

```javascript
const { Client } = require('whatsapp-web.js');
const qrcode = require('qrcode-terminal');

const client = new Client();

client.on('qr', (qr) => {
    qrcode.generate(qr, { small: true });
});

client.on('ready', () => {
    console.log('Client is ready!');
});

client.on('message', (msg) => {
    if (msg.body == '!ping') {
        msg.reply('pong');
    }
});

client.initialize();
```

--------------------------------

### Get Chats by Label ID

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves all chats associated with a given label ID. It evaluates a function in the browser to get label items and then reduces them.

```javascript
const chatIds = await this.pupPage.evaluate(async (labelId) => {
    const label = window.require('WAWebCollections').Label.get(labelId);
    const labelItems = label.labelItemCollection.getModelsArray();
    return labelItems.reduce((result, item) => {

```

--------------------------------

### Client Constructor Options

Source: https://docs.wwebjs.dev/Client.html

Configuration options for initializing the Client. These options allow customization of authentication, session management, versioning, timeouts, and other operational aspects.

```APIDOC
## Client Options

### Description
Options to configure the client. These options have the following properties:

### Properties
- **authStrategy** (object) - Optional - Determines how to save and restore sessions. If not set, NoAuth will be used.
- **webVersion** (string) - Optional - The version of WhatsApp Web to use. Use options.webVersionCache to configure how the version is retrieved.
- **webVersionCache** (object) - Optional - Determines how to retrieve the WhatsApp Web version. Defaults to a local cache (LocalWebCache) that falls back to latest if the requested version is not found.
- **authTimeoutMs** (number) - Optional - Timeout for authentication selector in puppeteer.
- **evalOnNewDoc** (function) - Optional - Function to evaluate on new document.
- **puppeteer** (object) - Optional - Puppeteer launch options. View docs here: https://github.com/puppeteer/puppeteer/
- **qrMaxRetries** (number) - Optional - How many times should the qrcode be refreshed before giving up.
- **takeoverOnConflict** (boolean) - Optional - If another whatsapp web session is detected (another browser), take over the session in the current browser.
- **takeoverTimeoutMs** (number) - Optional - How much time to wait before taking over the session.
- **userAgent** (string) - Optional - User agent to use in puppeteer.
- **ffmpegPath** (string) - Optional - Ffmpeg path to use when formatting videos to webp while sending stickers.
- **bypassCSP** (boolean) - Optional - Sets bypassing of page's Content-Security-Policy.
- **deviceName** (string) - Optional - Sets the device name of a current linked device., i.e.: 'TEST'.
- **browserName** (string) - Optional - Sets the browser name of a current linked device, i.e.: 'Firefox'.
- **proxyAuthentication** (object) - Optional - Proxy Authentication object.
```

--------------------------------

### ready

Source: https://docs.wwebjs.dev/Client.html

Emitted when the client has initialized and is ready to receive messages.

```APIDOC
## ready

### Description
Emitted when the client has initialized and is ready to receive messages.
```

--------------------------------

### Get Message by ID

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves a message instance by its ID. It first attempts to get the message directly, then by fetching messages by ID if the direct method fails. Returns null if the message is not found.

```javascript
async getMessageById(messageId) {
        const msg = await this.pupPage.evaluate(async (messageId) => {
            let msg = window.require('WAWebCollections').Msg.get(messageId);
            if (msg) return window.WWebJS.getMessageModel(msg);
  
            const params = messageId.split('_');
            if (params.length !== 3 && params.length !== 4)
                throw new Error('Invalid serialized message id specified');
  
            let messagesObject = await window
                .require('WAWebCollections')
                .Msg.getMessagesById([messageId]);
            if (messagesObject && messagesObject.messages.length)
                msg = messagesObject.messages[0];
  
            if (msg) return window.WWebJS.getMessageModel(msg);
        }, messageId);
  
        if (msg) return new Message(this, msg);
        return null;
    }
```

--------------------------------

### MessageMedia Constructor

Source: https://docs.wwebjs.dev/MessageMedia.html

Initializes a new MessageMedia instance with attachment details.

```APIDOC
## new MessageMedia(mimetype, data, filename, filesize)

### Description
Initializes a new MessageMedia instance with attachment details.

### Parameters
Name | Type | Optional | Description
---|---|---|---
mimetype | | | MIME type of the attachment
data | | | Base64-encoded data of the file
filename | | | Document file name. Value can be null.
filesize | | | Document file size in bytes. Value can be null.
```

--------------------------------

### getBroadcasts

Source: https://docs.wwebjs.dev/Client.html

Get all current Broadcast.

```APIDOC
## getBroadcasts()

### Description
Get all current Broadcast.

### Method
`async`

### Returns
`Promise containing Array of Broadcast`
```

--------------------------------

### getChannels

Source: https://docs.wwebjs.dev/Client.html

Gets all cached `Channel` instance.

```APIDOC
## getChannels()

### Description
Gets all cached `Channel` instance.

### Method
`async`

### Returns
`Promise containing Array of Channel`
```

--------------------------------

### Initialize Browser and Page

Source: https://docs.wwebjs.dev/Client.js.html

Initializes the browser and page instances. It supports connecting to an existing browser instance via WebSocket endpoint or URL, or launching a new browser instance with custom arguments and user agent.

```javascript
browser = null;
page = null;
await this.authStrategy.beforeBrowserInitialized();
const puppeteerOpts = this.options.puppeteer;
if (
    puppeteerOpts &&
    (puppeteerOpts.browserWSEndpoint || puppeteerOpts.browserURL)
) {
    browser = await puppeteer.connect(puppeteerOpts);
    page = await browser.newPage();
} else {
    const browserArgs = [...(puppeteerOpts.args || [])];
    if (
        this.options.userAgent !== false &&
        !browserArgs.find((arg) => arg.includes('--user-agent'))
    ) {
        browserArgs.push(`--user-agent=${this.options.userAgent}`);
    }
    // navigator.webdriver fix
    browserArgs.push('--disable-blink-features=AutomationControlled');

    browser = await puppeteer.launch({
        ...puppeteerOpts,
        args: browserArgs,
    });
    page = (await browser.pages())[0];
}

if (this.options.proxyAuthentication !== undefined) {
    await page.authenticate(this.options.proxyAuthentication);
}
if (this.options.userAgent !== false) {
    await page.setUserAgent(this.options.userAgent);
}
if (this.options.bypassCSP) await page.setBypassCSP(true);

this.pupBrowser = browser;
this.pupPage = page;

await this.authStrategy.afterBrowserInitialized();
await this.initWebVersionCache();

if (this.options.evalOnNewDoc !== undefined) {
    await page.evaluateOnNewDocument(this.options.evalOnNewDoc);
}

await page.goto(WhatsWebURL, {
    waitUntil: 'load',
    timeout: 0,
    referer: 'https://whatsapp.com/',
});

await this.inject();

this.pupPage.on('framenavigated', async (frame) => {
    if (frame.url().includes('post_logout=1') || this.lastLoggedOut) {
        this.emit(Events.DISCONNECTED, 'LOGOUT');
        await this.authStrategy.logout();
        await this.authStrategy.beforeBrowserInitialized();
        await this.authStrategy.afterBrowserInitialized();
        this.lastLoggedOut = false;
    }
    await this.inject();
});
```

--------------------------------

### getPollVotes

Source: https://docs.wwebjs.dev/Client.html

Get Poll Votes for a given message.

```APIDOC
## getPollVotes(messageId)

### Description
Get Poll Votes.

### Method
`async`

### Parameters
#### Path Parameters
- **messageId** (string) - Required - 

### Returns
`Promise containing Array of PollVote`
```

--------------------------------

### RemoteWebCache Constructor

Source: https://docs.wwebjs.dev/index.html

Initializes a RemoteWebCache instance with options.

```APIDOC
## RemoteWebCache

### Description
Manages remote web cache options.

### Constructor
- **RemoteWebCache(options)**: Initializes a new instance of RemoteWebCache with the provided options.
```

--------------------------------

### Message Initialization and Properties

Source: https://docs.wwebjs.dev/structures_Message.js.html

This snippet shows how a Message object is initialized with data, including various optional properties like businessOwnerJid, productId, and protocolMessageKey. It also demonstrates handling of dynamic reply buttons, selected button IDs, and list responses.

```javascript
/**
 * @param {import('../Client')} client
 * @param {object} data 
 */
_patch(data) {
    const chat = this.client.chats.get(data.wid?._serialized || data.chatId);
    if (chat) {
        this.chat = chat;
    }

    /** @type {import('../structures/Contact')}*/
    this.fromMe = data.fromMe;
    /** @type {import('../structures/Contact')}*/
    this.author = data.author || data.from;
    /** @type {string}*/
    this.from = data.from;
    /** @type {string}*/
    this.to = data.to;
    /** @type {string}*/
    this.messageId = data.id._serialized;
    /** @type {string}*/
    this.messageෲ = data.id.remote;
    /** @type {string}*/
    this.pushname = data.pushname;
    /** @type {string}*/
    this.sender = data.sender;
    /** @type {string}*/
    this.capability = data.capability;
    /** @type {string}*/
    this.status = data.status;
    /** @type {string}*/
    this.t = data.t;
    /** @type {string}*/
    this.epoch = data.epoch;
    /** @type {string}*/
    this.notifyName = data.notifyName;
    /** @type {string}*/
    this.isForwarded = data.isForwarded;
    /** @type {string}*/
    this.forwardingScore = data.forwardingScore;
    /** @type {string}*/
    this.isStatus = data.isStatus;
    /** @type {string}*/
    this.isStarred = data.isStarred;
    /** @type {string}*/
    this.url = data.url;
    /** @type {string}*/
    this.body = data.body;
    /** @type {string}*/
    this.type = data.type;
    /** @type {string}*/
    this.timestamp = data.timestamp;
    /** @type {string}*/
    this.id = data.id;
    /** @type {string}*/
    this.hasMedia = data.hasMedia;
    /** @type {string}*/
    this.mediaKey = data.mediaKey;
    /** @type {string}*/
    this.mediaCiphertext = data.mediaCiphertext;
    /** @type {string}*/
    this.filehash = data.filehash;
    /** @type {string}*/
    this.size = data.size;
    /** @type {string}*/
    this.totalDuration = data.totalDuration;
    /** @type {string}*/
    this.seconds = data.seconds;
    /** @type {string}*/
    this.filename = data.filename;
    /** @type {string}*/
    this.mimetype = data.mimetype;
    /** @type {string}*/
    this.width = data.width;
    /** @type {string}*/
    this.height = data.height;
    /** @type {string}*/
    this.isGif = data.isGif;
    /** @type {string}*/
    this.streamingSideBarColor = data.streamingSideBarColor;
    /** @type {string}*/
    this.viewOnce = data.viewOnce;
    /** @type {string}*/
    this.requiresDirectPath = data.requiresDirectPath;
    /** @type {string}*/
    this.quotedMsg = data.quotedMsg;
    /** @type {string}*/
    this.quotedMsgSid = data.quotedMsgSid;
    /** @type {string}*/
    this.quotedMsgType = data.quotedMsgType;
    /** @type {string}*/
    this.quotedMsgServerId = data.quotedMsgServerId;
    /** @type {string}*/
    this.quotedMsgFromMe = data.quotedMsgFromMe;
    /** @type {string}*/
    this.quotedMsgIsFromMe = data.quotedMsgIsFromMe;
    /** @type {string}*/
    this.quotedParticipant = data.quotedParticipant;
    /** @type {string}*/
    this.mentionedIds = data.mentionedIds;
    /** @type {string}*/
    this.groupMentions = data.groupMentions;
    /** @type {string}*/
    this.isGroup = data.isGroup;
    /** @type {string}*/
    this.isUser = data.isUser;
    /** @type {string}*/
    this.isMe = data.isMe;
    /** @type {string}*/
    this.isWAContact = data.isWAContact;
    /** @type {string}*/
    this.isBroadcast = data.isBroadcast;
    /** @type {string}*/
    this.isOffline = data.isOffline;
    /** @type {string}*/
    this.isForwardedSticker = data.isForwardedSticker;
    /** @type {string}*/
    this.stickerSentTs = data.stickerSentTs;
    /** @type {string}*/
    this.isAnimated = data.isAnimated;
    /** @type {string}*/
    this.orderId = data.orderId;
    /** @type {string}*/
    this.token = data.token;
    /** @type {string}*/
    this.conversation = data.conversation;
    /** @type {string}*/
    this.name = data.name;
    /** @type {string}*/
    this.inviteLink = data.inviteLink;
    /** @type {string}*/
    this.call = data.call;
    /** @type {string}*/
    this.lat = data.lat;
    /** @type {string}*/
    this.lng = data.lng;
    /** @type {string}*/
    this.address = data.address;
    /** @type {string}*/
    this.iosStickerSize = data.iosStickerSize;
    /** @type {string}*/
    this.directPath = data.directPath;
    /** @type {string}*/
    this.webpSticker = data.webpSticker;
    /** @type {string}*/
    this.isPlayed = data.isPlayed;
    /** @type {string}*/
    this.lastPlayed = data.lastPlayed;
    /** @type {string}*/
    this.duration = data.duration;
    /** @type {string}*/
    this.caption = data.caption;
    /** @type {string}*/
    this.ptt = data.ptt;
    /** @type {string}*/
    this.urlMedia = data.urlMedia;
    /** @type {string}*/
    this.vcard = data.vcard;
    /** @type {string}*/
    this.formattedTitle = data.formattedTitle;
    /** @type {string}*/
    this.title = data.title;
    /** @type {string}*/
    this.description = data.description;
    /** @type {string}*/
    this.footer = data.footer;
    /** @type {string}*/
    this.location = data.location;
    /** @type {string}*/
    this.businessOwnerJid = data.businessOwnerJid;
    /** @type {string}*/
    this.productId = data.productId;
    /** @type {string}*/
    this.latestEditSenderTimestampMs = data.latestEditSenderTimestampMs;
    /** @type {string}*/
    this.latestEditMsgKey = data.latestEditMsgKey;
    /** @type {string}*/
    this.protocolMessageKey = data.protocolMessageKey;
    /** @type {string}*/
    this.links = data.links;
    /** @type {string}*/
    this.dynamicReplyButtons = data.dynamicReplyButtons;
    /** @type {string}*/
    this.selectedButtonId = data.selectedButtonId;
    /** @type {string}*/
    this.selectedRowId = data.listResponse && data.listResponse.singleSelectReply.selectedRowId;
    /** @type {string}*/
    this.pollName = data.pollName;
    /** @type {string}*/
    this.pollOptions = data.pollOptions;
    /** @type {string}*/
    this.allowMultipleAnswers = Boolean(!data.pollSelectableOptionsCount);
    /** @type {string}*/
    this.pollInvalidated = data.pollInvalidated;
    /** @type {string}*/
    this.isSentCagPollCreation = data.isSentCagPollCreation;
    /** @type {string}*/
    this.messageSecret = data.messageSecret ? Object.keys(data.messageSecret).map((key) => data.messageSecret[key]) : [];

    return super._patch(data);
}

```

--------------------------------

### getChatById

Source: https://docs.wwebjs.dev/Client.html

Gets a chat or channel instance by its ID.

```APIDOC
## getChatById(chatId)

### Description
Gets chat or channel instance by ID.

### Method
`async`

### Parameters
#### Path Parameters
- **chatId** (string) - Required - The ID of the chat or channel.

### Returns
`Promise containing (Chat or Channel)`
```

--------------------------------

### List _format Method Example

Source: https://docs.wwebjs.dev/List.html

Demonstrates how to use the _format method to convert a simple array into the required section array format for List messages. The method handles mapping input properties to the expected output structure, including generating row IDs and default values.

```javascript
Input: [{title:'sectionTitle',rows:[{id:'customId', title:'ListItem2', description: 'desc'},{title:'ListItem2'}}]}}]
Returns: [{'title':'sectionTitle','rows':[{'rowId':'customId','title':'ListItem1','description':'desc'},{'rowId':'oGSRoD','title':'ListItem2','description':''}]}]
```

--------------------------------

### getChannelByInviteCode

Source: https://docs.wwebjs.dev/Client.html

Gets a `Channel` instance by invite code.

```APIDOC
## getChannelByInviteCode(inviteCode)

### Description
Gets a `Channel` instance by invite code.

### Method
`async`

### Parameters
#### Path Parameters
- **inviteCode** (string) - Required - The code that comes after the 'https://whatsapp.com/channel/'

### Returns
`Promise containing Channel`
```

--------------------------------

### List Constructor

Source: https://docs.wwebjs.dev/List.html

Initializes a new List object. It takes the message body, button text, sections, title, and footer as parameters.

```APIDOC
## new List(body, buttonText, sections, title, footer)

### Description
Initializes a new List object.

### Parameters
- **body** (any) - Description not specified.
- **buttonText** (any) - Description not specified.
- **sections** (any) - Description not specified.
- **title** (any) - Optional - Value can be null.
- **footer** (any) - Optional - Value can be null.
```

--------------------------------

### getBlockedContacts

Source: https://docs.wwebjs.dev/Client.html

Gets all blocked contacts by host account.

```APIDOC
## getBlockedContacts()

### Description
Gets all blocked contacts by host account.

### Method
`async`

### Returns
`Promise containing Array of Contact`
```

--------------------------------

### getInviteCode()

Source: https://docs.wwebjs.dev/GroupChat.html

Gets the invite code for a specific group.

```APIDOC
## getInviteCode()

### Description
Gets the invite code for a specific group.

### Returns
`Promise<string>`
Group's invite code
```

--------------------------------

### WebCache Constructor

Source: https://docs.wwebjs.dev/index.html

Initializes a WebCache instance.

```APIDOC
## WebCache

### Description
Manages web cache settings.

### Constructor
- **WebCache()**: Initializes a new instance of WebCache.
```

--------------------------------

### Initialize Client Information

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves and initializes client connection information, including serialization of connection state and user ID.

```javascript
this.info = new ClientInfo(
    this,
    await this.pupPage.evaluate(() => {
        return {
            ...window
                .require('WAWebConnModel')
                .Conn.serialize(),
            wid:
                window
                    .require('WAWebUserPrefsMeUser')
                    .getMaybeMePnUser() ||
                window
                    .require('WAWebUserPrefsMeUser')
                    .getMaybeMeLidUser(),
        };
    }),
);
```

--------------------------------

### getGroupMembershipRequests()

Source: https://docs.wwebjs.dev/GroupChat.html

Gets an array of membership requests for the group.

```APIDOC
## getGroupMembershipRequests()

### Description
Gets an array of membership requests.

### Returns
`Promise<Array<GroupMembershipRequest>>`
An array of membership requests
```

--------------------------------

### List Constructor

Source: https://docs.wwebjs.dev/structures_List.js.html

Initializes a new List object with the provided message body, button text, sections, and optional title and footer.

```APIDOC
## Constructor List(body, buttonText, sections, title?, footer?)

### Description
Initializes a new List object.

### Parameters
#### Path Parameters
- **body** (string) - Required - The main message body of the list.
- **buttonText** (string) - Required - The text displayed on the list button.
- **sections** (Array<any>) - Required - An array of section objects that make up the list.
- **title** (string?) - Optional - The title of the list message.
- **footer** (string?) - Optional - The footer text of the list message.
```

--------------------------------

### getBroadcastById

Source: https://docs.wwebjs.dev/Client.html

Get broadcast instance by current user ID.

```APIDOC
## getBroadcastById(contactId)

### Description
Get broadcast instance by current user ID.

### Method
`async`

### Parameters
#### Path Parameters
- **contactId** (string) - Required - 

### Returns
`Promise containing Broadcast`
```

--------------------------------

### getBroadcast

Source: https://docs.wwebjs.dev/structures_Contact.js.html

Gets the Contact's current status broadcast.

```APIDOC
## getBroadcast

### Description
Gets the Contact's current status broadcast.

### Method
Not applicable (method on Contact object)

### Parameters
None

### Response
- **Broadcast** - The contact's broadcast information.

### Response Example
```
{
  "type": "status",
  "data": "Some broadcast message"
}
```
```

--------------------------------

### MessageMedia.fromFilePath

Source: https://docs.wwebjs.dev/MessageMedia.html

Creates a MessageMedia instance from a local file path.

```APIDOC
## static fromFilePath(filePath)

### Description
Creates a MessageMedia instance from a local file path.

### Method
static

### Parameters
Name | Type | Optional | Description
---|---|---|---
filePath | string | | 

### Returns
`MessageMedia`
```

--------------------------------

### Get All Contacts

Source: https://docs.wwebjs.dev/Client.js.html

Fetches all current contact instances. Each contact is then processed by ContactFactory.

```javascript
async getContacts() {
        let contacts = await this.pupPage.evaluate(() => {
            return window.WWebJS.getContacts();
        });
  
        return contacts.map((contact) => ContactFactory.create(this, contact));
    }
```

--------------------------------

### Util Methods

Source: https://docs.wwebjs.dev/index.html

Provides utility functions for media conversion and other helper operations.

```APIDOC
## Util

### Description
Provides utility functions for media manipulation and other helper operations.

### Methods
- **formatImageToWebpSticker(media)**: Formats an image into a WebP sticker.
- **formatToWebpSticker(media, metadata)**: Formats media into a WebP sticker with metadata.
- **formatVideoToWebpSticker(media)**: Formats a video into a WebP sticker.
- **setFfmpegPath(path)**: Sets the path to the FFmpeg executable.
```

--------------------------------

### getPinnedMessages()

Source: https://docs.wwebjs.dev/GroupChat.html

Gets instances of all pinned messages in a chat. Inherited from Chat#getPinnedMessages.

```APIDOC
## getPinnedMessages()

### Description
Gets instances of all pinned messages in a chat.

### Inherited From
`Chat#getPinnedMessages`

### Returns
`Promise<Array<Message>>`
```

--------------------------------

### Create MessageMedia from File Path

Source: https://docs.wwebjs.dev/structures_MessageMedia.js.html

Creates a MessageMedia instance by reading a local file. It determines the MIME type and filename automatically.

```javascript
static fromFilePath(filePath) {
        const b64data = fs.readFileSync(filePath, { encoding: 'base64' });
        const mimetype = mime.getType(filePath);
        const filename = path.basename(filePath);
  
        return new MessageMedia(mimetype, b64data, filename);
    }

```

--------------------------------

### ScheduledEvent Constructor

Source: https://docs.wwebjs.dev/index.html

Initializes a ScheduledEvent instance with a name, start time, and options.

```APIDOC
## ScheduledEvent

### Description
Represents a scheduled event.

### Constructor
- **ScheduledEvent(name, startTime, options)**: Initializes a new instance of ScheduledEvent.

### Properties
- **eventSendOptions**: object - Options for sending the event.
- **name**: string - The name of the event.
- **startTimeTs**: number - The start time of the event in Unix timestamp format.
```

--------------------------------

### MessageMedia.fromUrl

Source: https://docs.wwebjs.dev/structures_MessageMedia.js.html

Creates a MessageMedia instance from a URL. Downloads the content from the URL, determines its MIME type, and extracts filename and size.

```APIDOC
## MessageMedia.fromUrl

### Description
Creates a MessageMedia instance from a URL. Downloads the content from the URL, determines its MIME type, and extracts filename and size.

### Method
static async

### Parameters
- **url** (string) - Required - The URL of the media file.
- **options** (Object) - Optional - Additional options for fetching the media.
  - **unsafeMime** (boolean) - Optional - If true, allows downloading even if MIME type cannot be determined. Defaults to false.
  - **filename** (string) - Optional - A specific filename to use for the media.
  - **client** (object) - Optional - A client object, potentially used for evaluating the fetch in a browser context.
  - **reqOptions** (object) - Optional - Options to pass to the fetch request.
    - **size** (number) - Optional - Expected size of the content (defaults to 0).

### Returns
- **Promise<MessageMedia>** - A Promise that resolves to a new MessageMedia instance representing the media from the URL.
```

--------------------------------

### Get All Broadcasts

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves all current broadcasts. It uses pupPage.evaluate to execute window.WWebJS.getAllStatuses() in the browser.

```javascript
const broadcasts = await this.pupPage.evaluate(async () => {
    return window.WWebJS.getAllStatuses();
});
return broadcasts.map((data) => new Broadcast(this, data));
```

--------------------------------

### formatToWebpSticker

Source: https://docs.wwebjs.dev/Util.html

Formats media to webp format with optional metadata.

```APIDOC
## formatToWebpSticker(media, metadata)

### Description
Formats a media to webp.

### Method
`async static`

### Parameters
#### Path Parameters
- **media** (MessageMedia) - Required - The media to format.
- **metadata** (StickerMetadata) - Required - Metadata for the sticker.

### Returns
`Promise containing MessageMedia` - The media in webp format.
```

--------------------------------

### getReactions

Source: https://docs.wwebjs.dev/structures_Message.js.html

Gets the reactions associated with the given message. Returns undefined if the message has no reactions.

```APIDOC
## getReactions

### Description
Gets the reactions associated with the given message. Returns undefined if the message has no reactions.

### Method
```javascript
async getReactions()
```

### Parameters
None

### Response
#### Success Response
- **ReactionList[]** - An array of ReactionList objects, each representing a reaction to the message.

### Request Example
```javascript
// Assuming 'message' is an instance of Message
const reactions = await message.getReactions();
if (reactions) {
    console.log('Reactions:', reactions);
}
```

### Response Example
```json
[
  {
    "id": "👍",
    "aggregateEmoji": "👍",
    "hasReactionByMe": true,
    "senders": [
      {
        "timestamp": 1678886400,
        "senderId": "..."
      }
    ]
  }
]
```
```

--------------------------------

### MessageMedia.fromUrl

Source: https://docs.wwebjs.dev/MessageMedia.html

Creates a MessageMedia instance from a URL.

```APIDOC
## async static fromUrl(url[, options])

### Description
Creates a MessageMedia instance from a URL.

### Method
async static

### Parameters
Name | Type | Optional | Description
---|---|---|---
url | string | | 
options | Object | Yes | Values in `options` have the following properties:
Name | Type | Optional | Description
---|---|---|---
unsafeMime | boolean | Yes | Defaults to `false`.
filename | string | Yes | 
client | object | Yes | 
reqOptions | object | Yes | 
reqOptions.size | number | Yes | Defaults to `0`.

### Returns
`Promise containing MessageMedia`
```

--------------------------------

### RemoteAuth Constructor

Source: https://docs.wwebjs.dev/index.html

Initializes a RemoteAuth instance with options.

```APIDOC
## RemoteAuth

### Description
Manages remote authentication options.

### Constructor
- **RemoteAuth(options)**: Initializes a new instance of RemoteAuth with the provided options.
```

--------------------------------

### getOrder

Source: https://docs.wwebjs.dev/structures_Message.js.html

Gets the order associated with a given message. Returns undefined if the message is not an order type.

```APIDOC
## getOrder

### Description
Gets the order associated with a given message. Returns undefined if the message is not an order type.

### Method
```javascript
async getOrder()
```

### Parameters
None

### Response
#### Success Response
- **Order** - The Order object associated with the message, or undefined if the message is not an order.

### Request Example
```javascript
// Assuming 'message' is an instance of Message
const order = await message.getOrder();
if (order) {
    console.log('Order details:', order);
}
```

### Response Example
```json
{
  "order": "..."
}
```
```

--------------------------------

### Buttons Constructor

Source: https://docs.wwebjs.dev/Buttons.html

Initializes a new Buttons object with optional body, buttons, title, and footer.

```APIDOC
## new Buttons(body, buttons, title, footer)

### Parameters
Name | Type | Optional | Description
---|---|---|---
body |  |  | 
buttons |  |  | See `ButtonSpec`
title |  |  | Value can be null.
footer |  |  | Value can be null.
```

--------------------------------

### Get Connection State

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves the current connection state of the client. Returns a WAState value or null.

```javascript
async getState() {
            return await this.pupPage.evaluate(() => {
                return window.require('WAWebSocketModel').Socket.state ?? null;
            });
        }
```

--------------------------------

### Set Channel Reaction Settings

Source: https://docs.wwebjs.dev/structures_Channel.js.html

Configures the available reactions for the channel. Accepts 0 (NONE), 1 (BASIC), or 2 (ALL). Invalid inputs return false.

```javascript
async setReactionSetting(reactionCode) {
            if (![0, 1, 2].includes(reactionCode)) return false;
            const reactionMapper = {
                0: 3,
                1: 1,
                2: 0,
            };
            const success = await this._setChannelMetadata(
                { reactionCodesSetting: reactionMapper[reactionCode] },
                { editReactionCodesSetting: true },
            );
            success && (this.channelMetadata.reactionCodesSetting = reactionCode);
            return success;
        }
```

--------------------------------

### Get All Channels

Source: https://docs.wwebjs.dev/Client.js.html

Retrieves all cached channel instances. Returns a Promise that resolves to an array of Channel objects.

```javascript
async getChannels() {
        const channels = await this.pupPage.evaluate(async () => {
            return await window.WWebJS.getChannels();
        });

        return channels.map((channel) => ChatFactory.create(this, channel));
    }
```

--------------------------------

### Create MessageMedia from URL

Source: https://docs.wwebjs.dev/structures_MessageMedia.js.html

Creates a MessageMedia instance by fetching data from a URL. Handles MIME type detection, content retrieval, and optional filename specification. Throws an error if MIME type cannot be determined and unsafeMime is not set.

```javascript
static async fromUrl(url, options = {}) {
        const pUrl = new URL(url);
        let mimetype = mime.getType(pUrl.pathname);
  
        if (!mimetype && !options.unsafeMime)
            throw new Error(
                'Unable to determine MIME type using URL. Set unsafeMime to true to download it anyway.',
            );
  
        async function fetchData(url, options) {
            const reqOptions = Object.assign(
                { headers: { accept: 'image/* video/* text/* audio/*' } },
                options,
            );
            const response = await fetch(url, reqOptions);
            const mime = response.headers.get('Content-Type');
            const size = response.headers.get('Content-Length');
  
            const contentDisposition = response.headers.get(
                'Content-Disposition',
            );
            const name = contentDisposition
                ? contentDisposition.match(/((?<=filename=")(.*)(?="))/)
                : null;
  
            let data = '';
            if (response.buffer) {
                data = (await response.buffer()).toString('base64');
            } else {
                const bArray = new Uint8Array(await response.arrayBuffer());
                bArray.forEach((b) => {
                    data += String.fromCharCode(b);
                });
                data = btoa(data);
            }
  
            return { data, mime, name, size };
        }
  
        const res = options.client
            ? await options.client.pupPage.evaluate(
                  fetchData,
                  url,
                  options.reqOptions,
              )
            : await fetchData(url, options.reqOptions);
  
        const filename =
            options.filename ||
            (res.name ? res.name[0] : pUrl.pathname.split('/').pop() || 'file');
  
        if (!mimetype) mimetype = res.mime;
  
        return new MessageMedia(mimetype, res.data, filename, res.size || null);
    }
}

module.exports = MessageMedia;

```

--------------------------------

### Get Poll Votes

Source: https://docs.wwebjs.dev/structures_Message.js.html

Retrieves all votes for a poll message. This method is asynchronous and requires the message ID.

```javascript
async getPollVotes() {
        return await this.client.getPollVotes(this.id._serialized);
    }
```

--------------------------------

### getPayment

Source: https://docs.wwebjs.dev/structures_Message.js.html

Gets the payment details associated with a given message. Returns undefined if the message is not a payment type.

```APIDOC
## getPayment

### Description
Gets the payment details associated with a given message. Returns undefined if the message is not a payment type.

### Method
```javascript
async getPayment()
```

### Parameters
None

### Response
#### Success Response
- **Payment** - The Payment object associated with the message, or undefined if the message is not a payment.

### Request Example
```javascript
// Assuming 'message' is an instance of Message
const payment = await message.getPayment();
if (payment) {
    console.log('Payment details:', payment);
}
```

### Response Example
```json
{
  "payment": "..."
}
```
```

--------------------------------

### Product Class Definition

Source: https://docs.wwebjs.dev/structures_Product.js.html

Defines the Product class, extending the Base class. It initializes product properties and includes a method to fetch product metadata.

```javascript
'use strict';

const Base = require('./Base');
const ProductMetadata = require('./ProductMetadata');

/**
 * Represents a Product on WhatsAppBusiness
 * @extends {Base}
 */
class Product extends Base {
    constructor(client, data) {
        super(client);

        if (data) this._patch(data);
    }

    _patch(data) {
        /**
         * Product ID
         * @type {string}
         */
        this.id = data.id;
        /**
         * Price
         * @type {string}
         */
        this.price = data.price ? data.price : '';
        /**
         * Product Thumbnail
         * @type {string}
         */
        this.thumbnailUrl = data.thumbnailUrl;
        /**
         * Currency
         * @type {string}
         */
        this.currency = data.currency;
        /**
         * Product Name
         * @type {string}
         */
        this.name = data.name;
        /**
         * Product Quantity
         * @type {number}
         */
        this.quantity = data.quantity;
        /** Product metadata */
        this.data = null;
        return super._patch(data);
    }

    async getData() {
        if (this.data === null) {
            let result = await this.client.pupPage.evaluate((productId) => {
                return window.WWebJS.getProductMetadata(productId);
            }, this.id);
            if (!result) {
                this.data = undefined;
            } else {
                this.data = new ProductMetadata(this.client, result);
            }
        }
        return this.data;
    }
}

module.exports = Product;

```

--------------------------------

### MessageMedia.fromFilePath

Source: https://docs.wwebjs.dev/structures_MessageMedia.js.html

Creates a MessageMedia instance from a local file path. Reads the file, determines its MIME type, and extracts the filename.

```APIDOC
## MessageMedia.fromFilePath

### Description
Creates a MessageMedia instance from a local file path. Reads the file, determines its MIME type, and extracts the filename.

### Method
static

### Parameters
- **filePath** (string) - Required - The path to the local file.

### Returns
- **MessageMedia** - A new MessageMedia instance representing the file.
```

--------------------------------

### getCommonGroups

Source: https://docs.wwebjs.dev/structures_Contact.js.html

Gets the Contact's common groups with you. Returns an empty array if you don't have any common groups.

```APIDOC
## getCommonGroups

### Description
Gets the Contact's common groups with you. Returns an empty array if you don't have any common groups.

### Method
Not applicable (method on Contact object)

### Parameters
None

### Response
- **WAWebJS.ChatId[]** - An array of chat IDs representing common groups.

### Response Example
```
["1234567890@g.us", "0987654321@g.us"]
```
```
Tokens:
Raw