Package com.vonage.client.messages.whatsapp

Class WhatsappFileRequest.Builder

java.lang.Object

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

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

com.vonage.client.messages.whatsapp.WhatsappFileRequest.Builder

All Implemented Interfaces:

CaptionMediaMessageRequest.Builder<WhatsappFileRequest.Builder>, MediaMessageRequest.Builder<WhatsappFileRequest.Builder>

Enclosing class:

WhatsappFileRequest

public static final class WhatsappFileRequest.Builder
extends WhatsappRequest.Builder<WhatsappFileRequest,WhatsappFileRequest.Builder>
implements CaptionMediaMessageRequest.Builder<WhatsappFileRequest.Builder>

Method Summary

Modifier and Type	Method	Description
WhatsappFileRequest	build()	Builds the MessageRequest.
WhatsappFileRequest.Builder	caption(String caption)	(OPTIONAL) Additional text to accompany the file.
WhatsappFileRequest.Builder	name(String name)	(OPTIONAL) Specifies the name of the file being sent.
WhatsappFileRequest.Builder	url(String url)	(REQUIRED) Sets the URL of the file attachment.

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

contextMessageId

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

clientRef, custom, from, text, to, ttl, webhookUrl, webhookVersion

Methods inherited from class java.lang.Object

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

Method Details

url

public WhatsappFileRequest.Builder url(String url)

(REQUIRED) Sets the URL of the file attachment. Supports a wide range of attachments including .zip, .csv and .pdf..

Specified by:

url in interface MediaMessageRequest.Builder<WhatsappFileRequest.Builder>

Overrides:

url in class MessageRequest.Builder<WhatsappFileRequest,WhatsappFileRequest.Builder>

Parameters:

url - The URL as a string.

Returns:

This builder.

caption

public WhatsappFileRequest.Builder caption(String caption)

(OPTIONAL) Additional text to accompany the file.

Specified by:

caption in interface CaptionMediaMessageRequest.Builder<WhatsappFileRequest.Builder>

Overrides:

caption in class MessageRequest.Builder<WhatsappFileRequest,WhatsappFileRequest.Builder>

Parameters:

caption - The caption string.

Returns:

This builder.

name

public WhatsappFileRequest.Builder name(String name)

(OPTIONAL) Specifies the name of the file being sent. If not included, the value for caption will be used as the file name. If neither name nor caption are included, the file name will be parsed from the url.

Overrides:

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

Parameters:

name - The file name.

Returns:

This builder.

Since:

8.1.0

build

public WhatsappFileRequest build()

Description copied from class: MessageRequest.Builder

Builds the MessageRequest.

Specified by:

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

Returns:

A MessageRequest, populated with all fields from this builder.