Package com.vonage.client.messages.whatsapp

Class WhatsappTemplateRequest.Builder

java.lang.Object

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

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

com.vonage.client.messages.whatsapp.WhatsappTemplateRequest.Builder

Enclosing class:

WhatsappTemplateRequest

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

Method Summary

Modifier and Type	Method	Description
WhatsappTemplateRequest	build()	Builds the MessageRequest.
WhatsappTemplateRequest.Builder	locale(Locale locale)	(REQUIRED) The BCP 47 language of the template.
WhatsappTemplateRequest.Builder	name(String name)	(REQUIRED) The name of the template.
WhatsappTemplateRequest.Builder	parameters(List<String> parameters)	(OPTIONAL) The parameters are an array of strings, with the first being substituted for {{1}} in the template, the second being {{2}} etc.
WhatsappTemplateRequest.Builder	policy(Policy policy)	(OPTIONAL) Policy for resolving what language template to use.

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, 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

name

public WhatsappTemplateRequest.Builder name(String name)

(REQUIRED) The name of the template. For WhatsApp use your WhatsApp namespace (available via Facebook Business Manager), followed by a colon : and the name of the template to use.

Overrides:

name in class MessageRequest.Builder<WhatsappTemplateRequest,WhatsappTemplateRequest.Builder>

Parameters:

name - The template name.

Returns:

This builder.

parameters

public WhatsappTemplateRequest.Builder parameters(List<String> parameters)

(OPTIONAL) The parameters are an array of strings, with the first being substituted for {{1}} in the template, the second being {{2}} etc. You can find the full list of supported parameters on WhatsApp's messages parameters documentation.

Parameters:

parameters - The list of template parameters.

Returns:

This builder.

policy

public WhatsappTemplateRequest.Builder policy(Policy policy)

(OPTIONAL) Policy for resolving what language template to use.

Parameters:

policy - The policy field.

Returns:

This builder.

locale

public WhatsappTemplateRequest.Builder locale(Locale locale)

(REQUIRED) The BCP 47 language of the template. Defaults to Locale.ENGLISH if not set.

Parameters:

locale - The Locale.

Returns:

This builder.

build

public WhatsappTemplateRequest build()

Description copied from class: MessageRequest.Builder

Builds the MessageRequest.

Specified by:

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

Returns:

A MessageRequest, populated with all fields from this builder.