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 01.05.2024)

• The environment the PR was tested on

- Types of Changes

Description

The PR introduces functionality that allows to forward media and attachment messages with their captions,
along with the ability to disable the Forwarded tag above a forwarded message.

❗ Breaking Changes:

• Now media and attachment messages are forwarded with their captions by default
• The method returns a boolean value that indicates the success of forwarding the message

You can forward a message without a caption by setting an optional property withCaption to false within Message.forward method.
Also you can turn off the Forwarded tag above a fowarded message by setting an optional property displayAsForwarded to false.

Related Issues

The PR closes #1650, closes #2426, closes #2435, closes #2629

Usage Example

client.on('message', async (message) => {
    if (message.author) {
        /**
         * Let's say the message was sent in a group
         * and you want to forward it to its author:
         */

        // 1. By default the message will be forwarded with a caption (if provided):
        await message.forward(message.author);

        // 2. To forward without a caption text, use { withCaption: false }:
        await message.forward(message.author, { withCaption: false });

        // 3. To forward without a 'Forwarded' title, use { displayAsForwarded: false }:
        await message.forward(message.author, { displayAsForwarded: false });
    }
});

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#forward-with-caption

• YARN

yarn add github:alechkos/whatsapp-web.js#forward-with-caption

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 01.05.2024)

The functionality has been tested by sending different types of messages:

• regular text messages
• view once messages (are forwarded also)
• messages with link preview
• messages with mentions
• media messages (photo/video/gif/sticker/animated sticker/audio/voice)
• attachment messages (document)
• messages with contact card/s
• polls

Tested On:

Types of accounts:

• Personal
• Buisness

Environment:

• Android 10:
  • WhatsApp: latest
  • WA Business: latest
• Windows 10:
  • WWebJS: 1.23.1-alpha.6
  • 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 (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)