Class: GroupNotification

GroupNotification()

Represents a GroupNotification on WhatsApp

Constructor

new GroupNotification()

Source:

Extends

Members

author :string

ContactId for the user that produced the GroupNotification.

Type:
  • string
Source:

body :string

Extra content

Type:
  • string
Source:

chatId :string

ID for the Chat that this groupNotification was sent for.

Type:
  • string
Source:

id :object

ID that represents the groupNotification

Type:
  • object
Source:

recipientIds :Array.<string>

Contact IDs for the users that were affected by this GroupNotification.

Type:
  • Array.<string>
Source:

timestamp :number

Unix timestamp for when the groupNotification was created

Type:
  • number
Source:

type :GroupNotificationTypes

GroupNotification type

Type:
Source:

Methods

getChat() → {Promise.<Chat>}

Returns the Chat this groupNotification was sent in

Source:
Returns:
Type
Promise.<Chat>

getContact() → {Promise.<Contact>}

Returns the Contact this GroupNotification was produced by

Source:
Returns:
Type
Promise.<Contact>

(async) getRecipients() → {Promise.<Array.<Contact>>}

Returns the Contacts affected by this GroupNotification.

Source:
Returns:
Type
Promise.<Array.<Contact>>

(async) reply(content, options) → {Promise.<(Message|null|undefined)>}

Sends a message to the same chat this GroupNotification was produced in.

Parameters:
Name Type Description
content string | MessageMedia | Location
options object
Source:
Returns:
Type
Promise.<(Message|null|undefined)>