Wapi.js Docs / AudioMessageEvent

Class: AudioMessageEvent

Represents an event for an audio message.

Implements

Extends

Implements

Constructors

new AudioMessageEvent()

new AudioMessageEvent(params): AudioMessageEvent

Creates a new instance of AudioMessageEvent.

Parameters

params

The parameters for creating the AudioMessageEvent.

params.client: Client

The client associated with the event.

params.data

The data associated with the event.

params.data.audio: AudioMessage

params.data.from: string

params.data.isForwarded: boolean

params.data.mediaId: string

params.data.messageId: string

params.data.mimeType: string

params.data.sha256: string

params.data.timestamp: string

Returns

AudioMessageEvent

Overrides

MediaMessageEvent.constructor

Memberof

AudioMessageEvent

Source

packages/wapi.js/src/webhook/events/audio/index.ts:34

Properties

audio

audio: AudioMessage

The audio message associated with the event.

Implementation of

AudioMessageEventInterface.audio

Source

packages/wapi.js/src/webhook/events/audio/index.ts:16


client

client: Client

The client instance associated with the event.

Implementation of

AudioMessageEventInterface.client

Inherited from

MediaMessageEvent.client

Source

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


context

context: MessageContext

The context of the message.

Implementation of

AudioMessageEventInterface.context

Inherited from

MediaMessageEvent.context

Source

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


isForwarded

isForwarded: boolean

Inherited from

MediaMessageEvent.isForwarded

Source

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


mediaId

mediaId: string

The ID of the media.

Implementation of

AudioMessageEventInterface.mediaId

Inherited from

MediaMessageEvent.mediaId

Source

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


messageId

messageId: string

The ID of the message.

Implementation of

AudioMessageEventInterface.messageId

Inherited from

MediaMessageEvent.messageId

Source

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


mimeType

mimeType: string

The MIME type of the media.

Implementation of

AudioMessageEventInterface.mimeType

Inherited from

MediaMessageEvent.mimeType

Source

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


sha256

sha256: string

The SHA256 hash of the media.

Implementation of

AudioMessageEventInterface.sha256

Inherited from

MediaMessageEvent.sha256

Source

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


timestamp

timestamp: number

The timestamp of the message.

Implementation of

AudioMessageEventInterface.timestamp

Inherited from

MediaMessageEvent.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

AudioMessageEventInterface.getUrl

Inherited from

MediaMessageEvent.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

MediaMessageEvent.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

MediaMessageEvent.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

MediaMessageEvent.reply

Throws

  • If the context message ID is not found.

Source

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