Package com.vonage.client.messages.viber

Class ViberVideoRequest.Builder

java.lang.Object

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

com.vonage.client.messages.viber.ViberRequest.Builder<ViberVideoRequest,ViberVideoRequest.Builder>

com.vonage.client.messages.viber.ViberVideoRequest.Builder

All Implemented Interfaces:

CaptionMediaMessageRequest.Builder<ViberVideoRequest.Builder>, MediaMessageRequest.Builder<ViberVideoRequest.Builder>

Enclosing class:

ViberVideoRequest

public static final class ViberVideoRequest.Builder
extends ViberRequest.Builder<ViberVideoRequest,ViberVideoRequest.Builder>
implements CaptionMediaMessageRequest.Builder<ViberVideoRequest.Builder>

Field Summary

Fields inherited from class com.vonage.client.messages.viber.ViberRequest.Builder

actionText, actionUrl, category, duration, fileSize, ttl, viberType

Method Summary

Modifier and Type	Method	Description
ViberVideoRequest	build()	Builds the MessageRequest.
ViberVideoRequest.Builder	caption(String caption)	(OPTIONAL) Additional text to accompany the video.
ViberVideoRequest.Builder	duration(int duration)	(REQUIRED) Length of the video in seconds.
ViberVideoRequest.Builder	fileSize(int fileSize)	(REQUIRED) The video file size in megabytes.
ViberVideoRequest.Builder	thumbUrl(String thumbUrl)	(REQUIRED) URL to an image file (.jpg) for a thumbnail preview of the video.
ViberVideoRequest.Builder	url(String url)	(REQUIRED) Sets the URL of the video attachment.

Methods inherited from class com.vonage.client.messages.viber.ViberRequest.Builder

actionText, actionUrl, category, ttl, viberType

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 ViberVideoRequest.Builder url(String url)

(REQUIRED) Sets the URL of the video attachment. Supports only .mp4 and .3gpp file extensions. Note: Video codec must be H.264 and audio codec AAC.

Specified by:

url in interface MediaMessageRequest.Builder<ViberVideoRequest.Builder>

Overrides:

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

Parameters:

url - The video URL as a string.

Returns:

This builder.

thumbUrl

public ViberVideoRequest.Builder thumbUrl(String thumbUrl)

(REQUIRED) URL to an image file (.jpg) for a thumbnail preview of the video.

Parameters:

thumbUrl - The thumbnail image URL as a string.

Returns:

This builder.

duration

public ViberVideoRequest.Builder duration(int duration)

(REQUIRED) Length of the video in seconds. Must be between 1 and 600.

Parameters:

duration - The video duration as an integer.

Returns:

This builder.

fileSize

public ViberVideoRequest.Builder fileSize(int fileSize)

(REQUIRED) The video file size in megabytes. Must be between 1 and 200.

Parameters:

fileSize - The file size as an integer.

Returns:

This builder.

caption

public ViberVideoRequest.Builder caption(String caption)

(OPTIONAL) Additional text to accompany the video.

Specified by:

caption in interface CaptionMediaMessageRequest.Builder<ViberVideoRequest.Builder>

Overrides:

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

Parameters:

caption - The caption string.

Returns:

This builder.

build

public ViberVideoRequest build()

Description copied from class: MessageRequest.Builder

Builds the MessageRequest.

Specified by:

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

Returns:

A MessageRequest, populated with all fields from this builder.