Class: TextMessageEvent
Represents a text message event.Implements
Extends
Implements
Constructors
new TextMessageEvent()
new TextMessageEvent(Creates a new instance of TextMessageEvent.params
):TextMessageEvent
Parameters
• params The parameters for creating the event. • params.client:Client
The client associated with the event.
• params.data
The data associated with the event.
• params.data.from: string
• params.data.isForwarded: boolean
• params.data.messageId: string
• params.data.text: TextMessage
• params.data.timestamp: string
Returns
TextMessageEvent
Overrides
MessageEvent
.constructor
Source
packages/wapi.js/src/webhook/events/text/index.ts:33Properties
client
client: Client
The client instance associated with the event.
Implementation of
TextMessageEventInterface
.client
Inherited from
MessageEvent
.client
Source
packages/wapi.js/src/webhook/events/base/index.ts:20context
context: MessageContext
The context of the message.
Implementation of
TextMessageEventInterface
.context
Inherited from
MessageEvent
.context
Source
packages/wapi.js/src/webhook/events/base/index.ts:37isForwarded
isForwarded: boolean
Inherited from
MessageEvent
.isForwarded
Source
packages/wapi.js/src/webhook/events/base/index.ts:39messageId
messageId: string
The ID of the message.
Implementation of
TextMessageEventInterface
.messageId
Inherited from
MessageEvent
.messageId
Source
packages/wapi.js/src/webhook/events/base/index.ts:36text
text: TextMessage
The text message associated with the event.
Implementation of
TextMessageEventInterface
.text
Source
packages/wapi.js/src/webhook/events/text/index.ts:20timestamp
timestamp: number
The timestamp of the message.
Implementation of
TextMessageEventInterface
.timestamp
Inherited from
MessageEvent
.timestamp
Source
packages/wapi.js/src/webhook/events/base/index.ts:38Methods
react()
react(Reacts to the message with an emoji.params
):Promise
<object
|object
>
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.
Inherited from
MessageEvent
.react
Source
packages/wapi.js/src/webhook/events/base/index.ts:100read()
read():Marks the message as read.Promise
<object
|object
|object
|object
|object
>
Returns
Promise
<object
| object
| object
| object
| object
>
- A promise that resolves with the read response.
Inherited from
MessageEvent
.read
Memberof
MessageEventSource
packages/wapi.js/src/webhook/events/base/index.ts:121reply()
reply<Sends a reply to the message.T
>(props
):Promise
<object
|object
>
Type parameters
• T extendsBaseMessage
<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.
Inherited from
MessageEvent
.reply
Throws
- If the context message ID is not found.