Wapi.js Docs / MediaMessageEvent

Class: abstract MediaMessageEvent

Represents the media message event for webhook events.

Implements

Extends

Extended by

Implements

Constructors

new MediaMessageEvent()

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

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

MediaMessageEvent

Source

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

Properties

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:20

context

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:37

isForwarded

isForwarded: boolean

Inherited from

MessageEvent.isForwarded

Source

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

mediaId

mediaId: string
The ID of the media.

Implementation of

MediaMessageEventInterface.mediaId

Source

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

messageId

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:36

mimeType

mimeType: string
The MIME type of the media.

Implementation of

MediaMessageEventInterface.mimeType

Source

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

sha256

sha256: string
The SHA256 hash of the media.

Implementation of

MediaMessageEventInterface.sha256

Source

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

timestamp

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:38

Methods

getUrl()

getUrl(): Promise<string>
Gets the URL of the media.

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:191

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.

Inherited from

MessageEvent.react

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.

Inherited from

MessageEvent.read

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.

Inherited from

MessageEvent.reply

Throws

  • If the context message ID is not found.

Source

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