ImageMessageEvent
Wapi.js Docs / ImageMessageEvent
Class: ImageMessageEvent
Represents an event for receiving an image message.
Implements
Extends
Implements
Constructors
new ImageMessageEvent()
new ImageMessageEvent(
params):ImageMessageEvent
Creates a new instance of ImageMessageEvent.
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.image: ImageMessage
• 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
Overrides
Source
packages/wapi.js/src/webhook/events/image/index.ts:35
Properties
client
client:
Client
The client instance associated with the event.
Implementation of
ImageMessageEventInterface.client
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:20
context
context:
MessageContext
The context of the message.
Implementation of
ImageMessageEventInterface.context
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:37
image
image:
ImageMessage
The image message received in the event.
Implementation of
ImageMessageEventInterface.image
Source
packages/wapi.js/src/webhook/events/image/index.ts:19
isForwarded
isForwarded:
boolean
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:39
mediaId
mediaId:
string
The ID of the media.
Implementation of
ImageMessageEventInterface.mediaId
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:147
messageId
messageId:
string
The ID of the message.
Implementation of
ImageMessageEventInterface.messageId
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:36
mimeType
mimeType:
string
The MIME type of the media.
Implementation of
ImageMessageEventInterface.mimeType
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:148
sha256
sha256:
string
The SHA256 hash of the media.
Implementation of
ImageMessageEventInterface.sha256
Inherited from
Source
packages/wapi.js/src/webhook/events/base/index.ts:149
timestamp
timestamp:
number
The timestamp of the message.
Implementation of
ImageMessageEventInterface.timestamp
Inherited from
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
ImageMessageEventInterface.getUrl
Inherited from
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
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
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
Throws
- If the context message ID is not found.
Source
Was this page helpful?