Package com.vonage.client.verify2

Class SmsWorkflow.Builder

java.lang.Object

com.vonage.client.verify2.Workflow.Builder<SmsWorkflow,SmsWorkflow.Builder>

com.vonage.client.verify2.SmsWorkflow.Builder

Enclosing class:

SmsWorkflow

public static final class SmsWorkflow.Builder
extends Workflow.Builder<SmsWorkflow,SmsWorkflow.Builder>

Builder class for an SMS workflow.

Since:

8.2.0

Field Summary

Fields inherited from class com.vonage.client.verify2.Workflow.Builder

channel, to

Method Summary

Modifier and Type	Method	Description
SmsWorkflow.Builder	appHash(String appHash)	(OPTIONAL) Android Application Hash Key for automatic code detection on a user's device.
SmsWorkflow	build()	Builds the workflow.
SmsWorkflow.Builder	contentId(String contentId)	(OPTIONAL) The TemplateID for SMS delivery using Indian Carriers.
SmsWorkflow.Builder	entityId(String entityId)	(OPTIONAL) PEID field required for SMS delivery using Indian Carriers.
SmsWorkflow.Builder	from(String from)	(OPTIONAL) The number or ID to send the SMS from.

Methods inherited from class com.vonage.client.verify2.Workflow.Builder

to

Methods inherited from class java.lang.Object

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

Method Details

from

public SmsWorkflow.Builder from(String from)

(OPTIONAL) The number or ID to send the SMS from.

Overrides:

from in class Workflow.Builder<SmsWorkflow,SmsWorkflow.Builder>

Parameters:

from - The sender number in E.164 format, or an alphanumeric ID (50 characters max).

Returns:

This builder.

appHash

public SmsWorkflow.Builder appHash(String appHash)

(OPTIONAL) Android Application Hash Key for automatic code detection on a user's device.

Parameters:

appHash - The 11 character Android app hash.

Returns:

This builder.

contentId

public SmsWorkflow.Builder contentId(String contentId)

(OPTIONAL) The TemplateID for SMS delivery using Indian Carriers.

Parameters:

contentId - The template ID (maximum 20 characters).

Returns:

This builder.

entityId

public SmsWorkflow.Builder entityId(String entityId)

(OPTIONAL) PEID field required for SMS delivery using Indian Carriers.

Parameters:

entityId - The PEID (maximum 20 characters).

Returns:

This builder.

build

public SmsWorkflow build()

Description copied from class: Workflow.Builder

Builds the workflow.

Specified by:

build in class Workflow.Builder<SmsWorkflow,SmsWorkflow.Builder>

Returns:

A new instance of the workflow with this builder's fields.