Class: ProductListMessage
Represents a product list interaction message.Implements
Extends
Implements
Constructors
new ProductListMessage()
new ProductListMessage(Creates an instance of ProductListInteractionMessage.params
):ProductListMessage
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
ProductListInteractionMessageSource
packages/wapi.js/src/structures/multi-product/index.ts:78Properties
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:59interactiveMessageData
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:31messaging_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:17recipient_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:18type
type: MessageTypeEnum
The type of the message.
Implementation of
ProductListMessageInterface
.type
Inherited from
InteractiveMessage
.type
Source
packages/wapi.js/src/structures/message/index.ts:16Methods
addFooter()
addFooter(Adds a footer to the message.footerText
):void
Parameters
• footerText:string
The footer text to be added.
Returns
void
Source
packages/wapi.js/src/structures/multi-product/index.ts:111addSection()
addSection(Adds a section to the message.section
):void
Parameters
• section:ProductListSection
The section to be added.
Returns
void
Implementation of
ProductListMessageInterface
.addSection
Source
packages/wapi.js/src/structures/multi-product/index.ts:103parseConstructorPayload()
Parses the constructor payload using the provided schema.protected
parseConstructorPayload(schema
,payload
):any
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:42toJson()
toJson(Converts the message to JSON format.params
):object
&object
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