Wapi.js Docs / ProductListMessage

​

Class: ProductListMessage

Represents a product list interaction message.

​

Implements

​

Extends

• InteractiveMessage

​

Implements

• ProductListMessageInterface

​

Constructors

​

new ProductListMessage()

new ProductListMessage(params): ProductListMessage

Creates an instance of ProductListInteractionMessage.

​

Parameters

• params The parameters for creating the product list interaction message. • params.bodyText: string The body text of the message. • params.buttonText: string The button text of the message. • params.catalogId: string The catalog ID of the product. • params.footerText?: string The footer text of the message. • params.header: object | object | object | object The header of the message. • params.productRetailerId: string The product retailer ID of the product. • params.sections: ProductListSection[] The sections of the product list.

​

Returns

ProductListMessage

​

Overrides

InteractiveMessage.constructor

​

Memberof

ProductListInteractionMessage

​

Source

packages/wapi.js/src/structures/multi-product/index.ts:78

​

Properties

​

data

data: object

​

catalogId

catalogId: string

​

productRetailerId

productRetailerId: string

​

sections

sections: ProductListSection[]

​

Implementation of

ProductListMessageInterface.data

​

Source

packages/wapi.js/src/structures/multi-product/index.ts:59

---

​

interactiveMessageData

readonly interactiveMessageData: object

​

bodyText

bodyText: string

​

footerText?

optional footerText: string

​

header?

optional header: object | object | object | object

​

type

type: InteractiveMessageTypeEnum

​

Implementation of

ProductListMessageInterface.interactiveMessageData

​

Inherited from

InteractiveMessage.interactiveMessageData

​

Source

packages/wapi.js/src/structures/interaction/index.ts:31

---

​

messaging_product

messaging_product: "whatsapp"

The messaging product.

​

Implementation of

ProductListMessageInterface.messaging_product

​

Inherited from

InteractiveMessage.messaging_product

​

Source

packages/wapi.js/src/structures/message/index.ts:17

---

​

recipient_type

recipient_type: "individual"

The recipient type.

​

Implementation of

ProductListMessageInterface.recipient_type

​

Inherited from

InteractiveMessage.recipient_type

​

Source

packages/wapi.js/src/structures/message/index.ts:18

---

​

type

type: MessageTypeEnum

The type of the message.

​

Implementation of

ProductListMessageInterface.type

​

Inherited from

InteractiveMessage.type

​

Source

packages/wapi.js/src/structures/message/index.ts:16

​

Methods

​

addFooter()

addFooter(footerText): void

Adds a footer to the message.

​

Parameters

• footerText: string The footer text to be added.

​

Returns

void

​

Source

packages/wapi.js/src/structures/multi-product/index.ts:111

---

​

addSection()

addSection(section): void

Adds a section to the message.

​

Parameters

• section: ProductListSection The section to be added.

​

Returns

void

​

Implementation of

ProductListMessageInterface.addSection

​

Source

packages/wapi.js/src/structures/multi-product/index.ts:103

---

​

parseConstructorPayload()

protected parseConstructorPayload(schema, payload): any

Parses the constructor payload using the provided schema.

​

Parameters

• schema: ZodType<any, ZodTypeDef, any> The Zod schema used for parsing the payload. • payload: any The payload to be parsed.

​

Returns

any The parsed data.

​

Inherited from

InteractiveMessage.parseConstructorPayload

​

Throws

An error if the parsing fails.

​

Source

packages/wapi.js/src/structures/message/index.ts:42

---

​

toJson()

toJson(params): object & object

Converts the message to JSON format.

​

Parameters

• params The parameters for converting the message to JSON. • params.replyToMessageId?: string The ID of the message to reply to. • params.to: string The recipient of the message.

​

Returns

object & object The JSON representation of the message.

​

Overrides

InteractiveMessage.toJson

​

Memberof

ProductListInteractionMessage

​

Source

packages/wapi.js/src/structures/multi-product/index.ts:123