Table of Contents

- Description

- Related Issues

- Usage Example

- I Want to Test this PR

- I Got an Error While Testing This PR ❌

- How Has the PR Been Tested (latest test on 22.04.2024)

• The environment the PR was tested on

- Types of Changes

Special thanks to @tuyuribr for his help

Description

The PR adds an event that will be triggered when users vote or unvote in a poll.
Each time the event is fired, it shows a user's current selected option(s) on the poll.

Related Issues

The PR closes #2494, closes #2626

Usage Example

client.on('vote_update', (vote) => {
    /**
     * The {@link vote} that was affected:
     * 
     * {
     *   voter: '[email protected]',
     *   selectedOptions: [ { name: 'B', localId: 1 } ],
     *   interractedAtTs: 1698195555555,
     *   parentMessage: {
     *     ...,
     *     pollName: 'PollName',
     *     pollOptions: [
     *       { name: 'A', localId: 0 },
     *       { name: 'B', localId: 1 }
     *     ],
     *     allowMultipleAnswers: true,
     *     messageSecret: [
     *        1, 2, 3, 0, 0, 0, 0, 0,
     *        0, 0, 0, 0, 0, 0, 0, 0,
     *        0, 0, 0, 0, 0, 0, 0, 0,
     *        0, 0, 0, 0, 0, 0, 0, 0
     *     ]
     *   }
     * }
     */
    console.log(vote);
});

To test this PR by yourself you should do two steps:

1. Install the PR by running one of the following commands:

• NPM

npm install github:alechkos/whatsapp-web.js#polls-ext

• YARN

yarn add github:alechkos/whatsapp-web.js#polls-ext

2. Lock your WWeb version on 2.2412.54:

const wwebVersion = '2.2412.54';

const client = new Client({
    authStrategy: new LocalAuth(), // your authstrategy here
    puppeteer: {
        // puppeteer args here
    },
    // locking the wweb version
    webVersionCache: {
        type: 'remote',
        remotePath: `https://raw.githubusercontent.com/wppconnect-team/wa-version/main/html/${wwebVersion}.html`,
    },
});

If you encounter any errors while testing this PR, please provide in a comment:

1. The code you've used without any sensitive information (use syntax highlighting for more readability)
2. The error you got
3. The library version
4. The WWeb version: console.log(await client.getWWebVersion());
5. The browser (Chrome/Chromium)

How Has The PR Been Tested (latest test on 22.04.2024)

Tested by selecting and deselecting poll options in both single-option and multiple-option polls.

Tested On:

Types of accounts:

• Personal
• Buisness

Environment:

• Android 10:
  • WhatsApp: latest
  • WA Business: latest
• Windows 10:
  • WWebJS: v1.23.1-alpha.5
  • WWeb: v2.2412.54
  • Puppeteer: v18.2.1
  • Node: v18.17.1
  • Chrome: latest

Types of Changes

• Dependency change
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix/feature that would cause existing functionality to change)

Checklist

• My code follows the code style of this project
• I have updated the usage example accordingly (example.js)
• I have updated the documentation accordingly (index.d.ts)