Package com.vonage.client.messages.whatsapp

Class WhatsappImageRequest.Builder

java.lang.Object

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

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

com.vonage.client.messages.whatsapp.WhatsappImageRequest.Builder

All Implemented Interfaces:

CaptionMediaMessageRequest.Builder<WhatsappImageRequest.Builder>, MediaMessageRequest.Builder<WhatsappImageRequest.Builder>

Enclosing class:

WhatsappImageRequest

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

Method Summary

Modifier and Type	Method	Description
WhatsappImageRequest	build()	Builds the MessageRequest.
WhatsappImageRequest.Builder	caption(String caption)	(OPTIONAL) Additional text to accompany the image.
WhatsappImageRequest.Builder	url(String url)	(REQUIRED) Sets the URL of the image 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, name, 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 WhatsappImageRequest.Builder url(String url)

(REQUIRED) Sets the URL of the image attachment. Supports only .jpg, .jpeg and .png file extensions.

Specified by:

url in interface MediaMessageRequest.Builder<WhatsappImageRequest.Builder>

Overrides:

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

Parameters:

url - The URL as a string.

Returns:

This builder.

caption

public WhatsappImageRequest.Builder caption(String caption)

(OPTIONAL) Additional text to accompany the image. Must be between 1 and 3000 characters.

Specified by:

caption in interface CaptionMediaMessageRequest.Builder<WhatsappImageRequest.Builder>

Overrides:

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

Parameters:

caption - The caption string.

Returns:

This builder.

build

public WhatsappImageRequest build()

Description copied from class: MessageRequest.Builder

Builds the MessageRequest.

Specified by:

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

Returns:

A MessageRequest, populated with all fields from this builder.