Class: ProductListInteractionMessage
Represents a product list interaction message.Implements
Extends
InteractiveMessage
Implements
Constructors
new ProductListInteractionMessage()
new ProductListInteractionMessage(Creates an instance of ProductListInteractionMessage.params):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: object[]
The sections of the message.
Returns
ProductListInteractionMessage
Overrides
InteractiveMessage.constructor
Memberof
ProductListInteractionMessageSource
packages/wapi.js/src/structures/interaction/index.ts:482Properties
data
data: object
catalogId
catalogId: string
productRetailerId
productRetailerId: string
sections
sections: object[]
Implementation of
ProductListInteractionMessageInterface.data
Source
packages/wapi.js/src/structures/interaction/index.ts:463interactiveMessageData
readonlyinteractiveMessageData:object
bodyText
bodyText: string
footerText?
optionalfooterText:string
header?
optionalheader:object|object|object|object
type
type: InteractiveMessageTypeEnum
Implementation of
ProductListInteractionMessageInterface.interactiveMessageData
Inherited from
InteractiveMessage.interactiveMessageData
Source
packages/wapi.js/src/structures/interaction/index.ts:36messaging_product
messaging_product: "whatsapp"
The messaging product.
Implementation of
ProductListInteractionMessageInterface.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
ProductListInteractionMessageInterface.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
ProductListInteractionMessageInterface.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/interaction/index.ts:516addSection()
addSection(Adds a section to the messagesection):void
Parameters
• section The section to be added. • section.product_items:object[]= undefined
• section.title: string= undefined
Returns
void
Memberof
ProductListInteractionMessageSource
packages/wapi.js/src/structures/interaction/index.ts:508parseConstructorPayload()
Parses the constructor payload using the provided schema.protectedparseConstructorPayload(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