eddy/whatsapp-web.js
Watch
1
0
Fork
You've already forked whatsapp-web.js
 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

docs: add jsdoc strings for group events

Browse source
This commit is contained in:
Pedro Lopez 2020-03-01 14:58:06 -04:00
commit 6e76fece91
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/Client.js
View file

@ -19,9 +19,13 @@ const { ClientInfo, Message, MessageMedia, Location, GroupNotification } = requi
* @fires Client#auth_failure * @fires Client#auth_failure
* @fires Client#ready * @fires Client#ready
* @fires Client#message * @fires Client#message
* @fires Client#message_ack
* @fires Client#message_create * @fires Client#message_create
* @fires Client#message_revoke_me * @fires Client#message_revoke_me
* @fires Client#message_revoke_everyone * @fires Client#message_revoke_everyone
* @fires Client#group_join
* @fires Client#group_leave
* @fires Client#group_update
* @fires Client#disconnected * @fires Client#disconnected
* @fires Client#change_state * @fires Client#change_state
*/ */
@ -148,10 +152,25 @@ class Client extends EventEmitter {
if (msg.type === 'gp2') { if (msg.type === 'gp2') {
const notification = new GroupNotification(this, msg); const notification = new GroupNotification(this, msg);
if (msg.subtype === 'add' || msg.subtype === 'invite') { if (msg.subtype === 'add' || msg.subtype === 'invite') {
/**
* Emitted when a user joins the chat via invite link or is added by an admin.
* @event Client#group_join
* @param {GroupNotification} notification GroupNotification with more information about the action
*/
this.emit(Events.GROUP_JOIN, notification); this.emit(Events.GROUP_JOIN, notification);
} else if (msg.subtype === 'remove' || msg.subtype === 'leave') { } else if (msg.subtype === 'remove' || msg.subtype === 'leave') {
/**
* Emitted when a user leaves the chat or is removed by an admin.
* @event Client#group_leave
* @param {GroupNotification} notification GroupNotification with more information about the action
*/
this.emit(Events.GROUP_LEAVE, notification); this.emit(Events.GROUP_LEAVE, notification);
} else { } else {
/**
* Emitted when group settings are updated, such as subject, description or picture.
* @event Client#group_update
* @param {GroupNotification} notification GroupNotification with more information about the action
*/
this.emit(Events.GROUP_UPDATE, notification); this.emit(Events.GROUP_UPDATE, notification);
} }
return; return;