Package com.vonage.client.messages.whatsapp

Class WhatsappMultiProductRequest.Builder

java.lang.Object

com.vonage.client.messages.MessageRequest.Builder<WhatsappMultiProductRequest,WhatsappMultiProductRequest.Builder>

com.vonage.client.messages.whatsapp.WhatsappRequest.Builder<WhatsappMultiProductRequest,WhatsappMultiProductRequest.Builder>

com.vonage.client.messages.whatsapp.WhatsappMultiProductRequest.Builder

Enclosing class:

WhatsappMultiProductRequest

public static final class WhatsappMultiProductRequest.Builder
extends WhatsappRequest.Builder<WhatsappMultiProductRequest,WhatsappMultiProductRequest.Builder>

Method Summary

Modifier and Type	Method	Description
WhatsappMultiProductRequest.Builder	addProductsSection(String title, String... skus)	(REQUIRED) Adds a grouping of products using their unique retail identifiers.
WhatsappMultiProductRequest.Builder	addProductsSection(String title, List<String> skus)	(REQUIRED) Adds a grouping of products using their unique retail identifiers.
WhatsappMultiProductRequest.Builder	bodyText(String bodyText)	(REQUIRED) The main message text.
WhatsappMultiProductRequest	build()	Builds the MessageRequest.
WhatsappMultiProductRequest.Builder	catalogId(String catalogId)	(REQUIRED) ID for the catalog you want to use for this message.
WhatsappMultiProductRequest.Builder	footerText(String footerText)	(OPTIONAL) The text which appears at the end of the message.
WhatsappMultiProductRequest.Builder	headerText(String headerText)	(OPTIONAL) Sets the message header's text field.

Methods inherited from class com.vonage.client.messages.whatsapp.WhatsappRequest.Builder

contextMessageId

Methods inherited from class com.vonage.client.messages.MessageRequest.Builder

caption, clientRef, custom, from, name, text, to, ttl, url, webhookUrl, webhookVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

catalogId

public WhatsappMultiProductRequest.Builder catalogId(String catalogId)

(REQUIRED) ID for the catalog you want to use for this message. Retrieve this ID via Commerce Manager.

Parameters:

catalogId - The catalog ID.

Returns:

This builder.

addProductsSection

public WhatsappMultiProductRequest.Builder addProductsSection(String title,
 List<String> skus)

(REQUIRED) Adds a grouping of products using their unique retail identifiers. You must specify at least one section and at least one product per section.

Parameters:

title - The section title.

skus - The list of product IDs in the catalog to include in the section.

Returns:

This builder.

addProductsSection

public WhatsappMultiProductRequest.Builder addProductsSection(String title,
 String... skus)

(REQUIRED) Adds a grouping of products using their unique retail identifiers. You must specify at least one section and at least one product per section.

Parameters:

title - The section title.

skus - The list of product IDs in the catalog to include in the section.

Returns:

This builder.

headerText

public WhatsappMultiProductRequest.Builder headerText(String headerText)

(OPTIONAL) Sets the message header's text field.

Parameters:

headerText - The header text.

Returns:

This builder.

bodyText

public WhatsappMultiProductRequest.Builder bodyText(String bodyText)

(REQUIRED) The main message text.

Parameters:

bodyText - The body text.

Returns:

This builder.

footerText

public WhatsappMultiProductRequest.Builder footerText(String footerText)

(OPTIONAL) The text which appears at the end of the message.

Parameters:

footerText - The footer text.

Returns:

This builder.

build

public WhatsappMultiProductRequest build()

Description copied from class: MessageRequest.Builder

Builds the MessageRequest.

Specified by:

build in class MessageRequest.Builder<WhatsappMultiProductRequest,WhatsappMultiProductRequest.Builder>

Returns:

A MessageRequest, populated with all fields from this builder.