Wapi.js Docs / ListInteractionEvent

​

Class: ListInteractionEvent

Represents a list interaction event.

​

Implements

​

Extends

• InteractionEvent

​

Implements

• ListInteractionMessageEventInterface

​

Constructors

​

new ListInteractionEvent()

new ListInteractionEvent(params): ListInteractionEvent

Creates a new instance of ListInteractionEvent.

​

Parameters

• params

The parameters for creating the ListInteractionEvent.

• params.client: Client

The client object.

• params.data

The data object.

• params.data.description: string

• params.data.from: string

• params.data.isForwarded: boolean

• params.data.listId: string

• params.data.messageId: string

• params.data.timestamp: string

• params.data.title: string

​

Returns

ListInteractionEvent

​

Overrides

InteractionEvent.constructor

​

Source

packages/wapi.js/src/webhook/events/interaction/index.ts:79

​

Properties

​

client

client: Client

The client instance associated with the event.

​

Implementation of

ListInteractionMessageEventInterface.client

​

Inherited from

InteractionEvent.client

​

Source

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

---

​

context

context: MessageContext

The context of the message.

​

Implementation of

ListInteractionMessageEventInterface.context

​

Inherited from

InteractionEvent.context

​

Source

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

---

​

description

description: string

​

Implementation of

ListInteractionMessageEventInterface.description

​

Source

packages/wapi.js/src/webhook/events/interaction/index.ts:64

---

​

isForwarded

isForwarded: boolean

​

Inherited from

InteractionEvent.isForwarded

​

Source

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

---

​

listId

listId: string

​

Implementation of

ListInteractionMessageEventInterface.listId

​

Source

packages/wapi.js/src/webhook/events/interaction/index.ts:63

---

​

messageId

messageId: string

The ID of the message.

​

Implementation of

ListInteractionMessageEventInterface.messageId

​

Inherited from

InteractionEvent.messageId

​

Source

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

---

​

timestamp

timestamp: number

The timestamp of the message.

​

Implementation of

ListInteractionMessageEventInterface.timestamp

​

Inherited from

InteractionEvent.timestamp

​

Source

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

---

​

title

title: string

​

Implementation of

ListInteractionMessageEventInterface.title

​

Source

packages/wapi.js/src/webhook/events/interaction/index.ts:62

​

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

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

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

InteractionEvent.reply

​

Throws

• If the context message ID is not found.

​

Source

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