Feature: Message Collector (wait for reply)

[tcortega]

A feature similar to discord's message collector, that can collect the message based on conditions and for a specified time, that way you can keep a dialog alive with certain users, expecting for issues.

Discord documentation about MessageCollector for reference:
https://discord.js.org/#/docs/main/stable/class/MessageCollector

[joedutra]

I come to apologize and say that we have nothing against this, only that they accuse us of copying and we never copied anything, if someone copied it was when someone changed our lib, I apologize and the intention was not to be slandered anymore of copying something we worked on every day. just like you, we will not do that anymore.

[jotaerrec]

any example in code form?

[smashah]

TODO:

• Config property to bundle all client listeners in an event emitter.

[smashah]

@Urbaeexyz if you keep spamming unrelated issues then I'm going to have to block you from this repo. Do not do this again. If you have a quick question, use the discord.

You need to use this to decrypt sticker messages: https://docs.openwa.dev/classes/client.html#getstickerdecryptable

[smashah]

@github-actions run

⚡ Release! ⚡

(async () => {
function exec(cmd) {
  console.log(execSync(cmd).toString());
}

// Config
const gitUserEmail = "github-actions[bot]@users.noreply.github.com";
const gitUserName = "github-actions[bot]";

exec(`echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc`);
exec(`git config --global user.email "${gitUserEmail}"`);
exec(`git config --global user.name "${gitUserName}"`);
exec(`npm i -D`);
exec(`npm run release-ci`);

//comment on the issue
var result = execSync(`npx auto-changelog -o ./tempchangelog.txt --commit-limit false --template ./compact-keepachangelog.hbs --stdout`).toString();

    await postComment(result);

//create changelog image
exec(`npm run release-image`);
exec(`git commit -a -m 'updated release-image'`);
exec(`git push --force`);
  })();

[smashah]

Changelog

🚀 Release 3.9.13 (2021-03-21)

• 📝 collector docs Feature: Message Collector (wait for reply) #1042 02ddbf6
• ✨ implemented client.createMessageCollector Feature: Message Collector (wait for reply) #1042 bed4c4b
• Release 3.9.13 6178f8c
• ✨ feat: implemented onChatDeleted feat: onChatDeleted #1504 8b05581
• 📝 added docs for getChatsByLabel 606df4e
• 🥚 labels patch 3c66c15
• 🥚 patch update 0a8254a
• 🚸 added GROUP_FULL error status code 272d81a

[smashah]

@tcortega @Dargon-dev @shubham0804 @lxndr-rl you can now use client.createaMessageCollector to make a discord-like message collector

Example 1: I want maximum 2 images over the next 15 seconds with at least 1 every 5 seconds.

const collector = client.createMessageCollector(message, (m: Message) => m.type === MessageTypes.IMAGE, {
    /**
     * Only collect for 15 seconds.
     */
    time: 15000,
    /**
     * If 2 messages are collected then end the collector
     */
    max: 2,
    /**
     * If 5000ms goes by without an answer then end the collector
     */
    idle: 5000
});

collector.on('collect', async message => {
    await client.sendText(message.from, `Got a message ${i++}, ${message.type}`)
})

collector.on('end', async (collected, reason) => {
    console.log(`Collected ${collected.size} items`);
    await client.sendText(message.from, `Collected ${collected.size} items ${reason}`)
})

Example 2: Give me the next 5 replies over the next 30 seconds

const questionId = await client.send('Reply to this with your name. First 5 win.');
const collector = client.createMessageCollector(message, (m: Message) => m?.quotedMsgId === questionId, {
    /**
     * Only collect for 30 seconds.
     */
    time: 30000,
    /**
     * If 5 messages are collected then end the collector
     */
    max: 5,
});

collector.on('collect', async message => {
    await client.sendText(message.from, `Hello ${message.body}`)
})

collector.on('end', async (collected, reason) => {
	if(reason == 'time') {
		await client.sendText(message.from, 'timeout. Here are the winners ....');
	}
	if(reason == 'limit') {
		await client.sendText(message.from, 'Got 5, the winners are...');
	}
})

You can learn more about the inspiration (read, source) of this feature here: https://discordjs.guide/popular-topics/collectors.html#basic-message-collector

Here are the docs:

https://docs.openwa.dev/classes/structures_messagecollector.messagecollector.html

Since this issue only refers to the implementation of this feature I will be closing the issue.

If you have problems with the message collector or need implementation help then please use the discord.

Thanks for your patience.