Wapi.js Docs / MessageEvent

Class: abstract MessageEvent

Represents the message event for webhook events.

Implements

Extends

Extended by

Implements

Constructors

new MessageEvent()

new MessageEvent(params): MessageEvent
Creates a new instance of the MessageEvent class.

Parameters

params The parameters for creating the MessageEvent. params.client: Client The client instance. params.from: string The sender’s phone number. params.id: string The message ID. params.isForwarded: boolean Indicates if the message is forwarded. params.timestamp: string The timestamp of the message.

Returns

MessageEvent

Overrides

BaseEvent.constructor

Memberof

MessageEvent

Source

packages/wapi.js/src/webhook/events/base/index.ts:52

Properties

client

client: Client
The client instance associated with the event.

Implementation of

MessageEventInterface.client

Inherited from

BaseEvent.client

Source

packages/wapi.js/src/webhook/events/base/index.ts:20

context

context: MessageContext
The context of the message.

Implementation of

MessageEventInterface.context

Source

packages/wapi.js/src/webhook/events/base/index.ts:37

isForwarded

isForwarded: boolean

Source

packages/wapi.js/src/webhook/events/base/index.ts:39

messageId

messageId: string
The ID of the message.

Implementation of

MessageEventInterface.messageId

Source

packages/wapi.js/src/webhook/events/base/index.ts:36

timestamp

timestamp: number
The timestamp of the message.

Implementation of

MessageEventInterface.timestamp

Source

packages/wapi.js/src/webhook/events/base/index.ts:38

Methods

react()

react(params): Promise<object | object>
Reacts to the message with an emoji.

Parameters

params The parameters for the reaction. params.emoji: string The emoji to react with. params.phoneNumber: string The phone number of the sender.

Returns

Promise<object | object>
  • A promise that resolves with the reaction response.

Source

packages/wapi.js/src/webhook/events/base/index.ts:100

read()

read(): Promise<object | object | object | object | object>
Marks the message as read.

Returns

Promise<object | object | object | object | object>
  • A promise that resolves with the read response.

Memberof

MessageEvent

Source

packages/wapi.js/src/webhook/events/base/index.ts:121

reply()

reply<T>(props): Promise<object | object>
Sends a reply to the message.

Type parameters

T extends BaseMessage<string>

Parameters

props The properties for the reply. props.message: T The message to send as a reply.

Returns

Promise<object | object>
  • A promise that resolves when the reply is sent.

Throws

  • If the context message ID is not found.

Source

packages/wapi.js/src/webhook/events/base/index.ts:75