Package com.vonage.client.messages.mms

Class MmsImageRequest.Builder

java.lang.Object

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

com.vonage.client.messages.mms.MmsRequest.Builder<MmsImageRequest,MmsImageRequest.Builder>

com.vonage.client.messages.mms.MmsImageRequest.Builder

All Implemented Interfaces:

CaptionMediaMessageRequest.Builder<MmsImageRequest.Builder>, MediaMessageRequest.Builder<MmsImageRequest.Builder>

Enclosing class:

MmsImageRequest

public static final class MmsImageRequest.Builder
extends MmsRequest.Builder<MmsImageRequest,MmsImageRequest.Builder>
implements CaptionMediaMessageRequest.Builder<MmsImageRequest.Builder>

Method Summary

Modifier and Type	Method	Description
MmsImageRequest	build()	Builds the MessageRequest.
MmsImageRequest.Builder	caption(String caption)	(OPTIONAL) Additional text to accompany the image.
MmsImageRequest.Builder	url(String url)	(REQUIRED) Sets the URL of the image attachment.

Methods inherited from class com.vonage.client.messages.mms.MmsRequest.Builder

ttl

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

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

Methods inherited from class java.lang.Object

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

Method Details

url

public MmsImageRequest.Builder url(String url)

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

Specified by:

url in interface MediaMessageRequest.Builder<MmsImageRequest.Builder>

Overrides:

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

Parameters:

url - The URL as a string.

Returns:

This builder.

caption

public MmsImageRequest.Builder caption(String caption)

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

Specified by:

caption in interface CaptionMediaMessageRequest.Builder<MmsImageRequest.Builder>

Overrides:

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

Parameters:

caption - The caption string.

Returns:

This builder.

build

public MmsImageRequest build()

Description copied from class: MessageRequest.Builder

Builds the MessageRequest.

Specified by:

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

Returns:

A MessageRequest, populated with all fields from this builder.