Class: abstract
MediaMessageEvent
Represents the media message event for webhook events.
Implements
Extends
Extended by
Implements
Constructors
new MediaMessageEvent()
new MediaMessageEvent(Creates a new instance of the MediaMessageEvent class.params
):MediaMessageEvent
Parameters
• params The parameters for creating the MediaMessageEvent. • params.client:Client
The client instance.
• params.from: string
The sender’s phone number.
• params.isForwarded: boolean
Indicates if the message is forwarded.
• params.mediaId: string
The ID of the media.
• params.messageId: string
The message ID.
• params.mimeType: string
The MIME type of the media.
• params.sha256: string
The SHA256 hash of the media.
• params.timestamp: string
The timestamp of the message.
Returns
MediaMessageEvent
Overrides
MessageEvent
.constructor
Memberof
MediaMessageEventSource
packages/wapi.js/src/webhook/events/base/index.ts:165Properties
client
client: Client
The client instance associated with the event.
Implementation of
MediaMessageEventInterface
.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
MediaMessageEventInterface
.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:39mediaId
mediaId: string
The ID of the media.
Implementation of
MediaMessageEventInterface
.mediaId
Source
packages/wapi.js/src/webhook/events/base/index.ts:147messageId
messageId: string
The ID of the message.
Implementation of
MediaMessageEventInterface
.messageId
Inherited from
MessageEvent
.messageId
Source
packages/wapi.js/src/webhook/events/base/index.ts:36mimeType
mimeType: string
The MIME type of the media.
Implementation of
MediaMessageEventInterface
.mimeType
Source
packages/wapi.js/src/webhook/events/base/index.ts:148sha256
sha256: string
The SHA256 hash of the media.
Implementation of
MediaMessageEventInterface
.sha256
Source
packages/wapi.js/src/webhook/events/base/index.ts:149timestamp
timestamp: number
The timestamp of the message.
Implementation of
MediaMessageEventInterface
.timestamp
Inherited from
MessageEvent
.timestamp
Source
packages/wapi.js/src/webhook/events/base/index.ts:38Methods
getUrl()
getUrl():Gets the URL of the media.Promise
<string
>
Returns
Promise
<string
>
- A promise that resolves with the URL of the media.
Implementation of
MediaMessageEventInterface
.getUrl
Source
packages/wapi.js/src/webhook/events/base/index.ts:191react()
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.