Wapi.js Docs / OrderMessageEvent

​

Class: OrderMessageEvent

Represents an event that occurs when a message related to an order is received.

​

Implements

​

Extends

• MessageEvent

​

Implements

• OrderMessageEventInterface

​

Constructors

​

new OrderMessageEvent()

new OrderMessageEvent(params): OrderMessageEvent

​

Parameters

• params • params.client: Client • params.data • params.data.from: string • params.data.isForwarded: boolean • params.data.messageId: string • params.data.order: Order • params.data.timestamp: string

​

Returns

OrderMessageEvent

​

Overrides

MessageEvent.constructor

​

Source

packages/wapi.js/src/webhook/events/order/index.ts:17

​

Properties

​

client

client: Client

The client instance associated with the event.

​

Implementation of

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

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

---

​

messageId

messageId: string

The ID of the message.

​

Implementation of

OrderMessageEventInterface.messageId

​

Inherited from

MessageEvent.messageId

​

Source

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

---

​

order

order: Order

The order associated with the event.

​

Implementation of

OrderMessageEventInterface.order

​

Source

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

---

​

timestamp

timestamp: number

The timestamp of the message.

​

Implementation of

OrderMessageEventInterface.timestamp

​

Inherited from

MessageEvent.timestamp

​

Source

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

​

Methods

​

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