com.nexmo.client.verify

Class VerifyRequest

java.lang.Object

com.nexmo.client.verify.BaseRequest

com.nexmo.client.verify.VerifyRequest

public class VerifyRequest
extends BaseRequest

Describes a Verify request when passed to VerifyEndpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerifyRequest.Builder Builder to create a Two Factor Authentication request
static class	VerifyRequest.LineType Types of phone line to be specified for type.
static class	VerifyRequest.Workflow Enumeration representing different verification workflows.

Constructor Summary

Constructors

Constructor and Description
VerifyRequest(java.lang.String number, java.lang.String brand) Deprecated. this construtor is deprecated use VerifyRequest.Builder to contruct a 2FA verify request
VerifyRequest(java.lang.String number, java.lang.String brand, java.lang.String from) Deprecated. this construtor is deprecated use VerifyRequest.Builder to contruct a 2FA verify request
VerifyRequest(java.lang.String number, java.lang.String brand, java.lang.String from, int length, java.util.Locale locale) Deprecated. this construtor is deprecated use VerifyRequest.Builder instead
VerifyRequest(java.lang.String number, java.lang.String brand, java.lang.String from, int length, java.util.Locale locale, VerifyRequest.LineType type) Deprecated.
VerifyRequest(VerifyRequest.Builder builder)

Method Summary

Modifier and Type	Method and Description
static VerifyRequest.Builder	builder(java.lang.String number, java.lang.String brand)
java.lang.String	getBrand()
java.lang.String	getFrom()
VerifyRequest.LineType	getType()
VerifyRequest.Workflow	getWorkflow()
void	setFrom(java.lang.String from) Deprecated. since 5.5.0 use VerifyRequest.Builder to create a 2FA verification request
void	setType(VerifyRequest.LineType type) Deprecated. since 5.5.0 use VerifyRequest.Builder to create a 2FA verification request
void	setWorkflow(VerifyRequest.Workflow workflow) Deprecated. since 5.5.0 use VerifyRequest.Builder to create a 2FA verification request
java.lang.String	toString()

Methods inherited from class com.nexmo.client.verify.BaseRequest

getCountry, getDashedLocale, getLength, getLocale, getNextEventWait, getNumber, getPinExpiry, setCountry, setLength, setLocale, setNextEventWait, setPinExpiry

Methods inherited from class java.lang.Object

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

Constructor Detail

VerifyRequest

@Deprecated
public VerifyRequest(java.lang.String number,
                                 java.lang.String brand)

Deprecated. this construtor is deprecated use VerifyRequest.Builder to contruct a 2FA verify request

Constructor.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app to be verified for. Must not be longer than 18 characters.

VerifyRequest

@Deprecated
public VerifyRequest(java.lang.String number,
                                 java.lang.String brand,
                                 java.lang.String from)

Deprecated. this construtor is deprecated use VerifyRequest.Builder to contruct a 2FA verify request

Constructor.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app you are verifying for. Must not be longer than 18 characters.

from - (optional The Nexmo number to use as the sender for the verification SMS message and calls, in E.164 format.

VerifyRequest

@Deprecated
public VerifyRequest(java.lang.String number,
                                 java.lang.String brand,
                                 java.lang.String from,
                                 int length,
                                 java.util.Locale locale)

Deprecated. this construtor is deprecated use VerifyRequest.Builder instead

Constructor.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app you are verifying for. Must not be longer than 18 characters.

from - (optional The Nexmo number to use as the sender for the verification SMS message and calls, in E.164 format.

length - (optional) The length of the verification code to be sent to the user. Must be either 4 or 6. Use -1 to use the default value.

locale - (optional) Override the default locale used for verification. By default the locale is determined from the country code included in number

VerifyRequest

@Deprecated
public VerifyRequest(java.lang.String number,
                                 java.lang.String brand,
                                 java.lang.String from,
                                 int length,
                                 java.util.Locale locale,
                                 VerifyRequest.LineType type)

Deprecated.

Constructor.

Parameters:

number - (required) The recipient's phone number in E.164 format.

brand - (required) The name of the company or app you are verifying for. Must not be longer than 18 characters.

from - (optional A short alphanumeric string to specify the SenderID for SMS sent by Verify. Depending on the destination of the phone number you are applying, restrictions may apply. By default, sender_id is VERIFY. Must be 11 characters or fewer.

length - (optional) The length of the verification code to be sent to the user. Must be either 4 or 6. Use -1 to use the default value.

locale - (optional) Override the default locale used for verification. By default the locale is determined from the country code included in number

type - (optional) If provided, restrict the verification to the specified network type. Contact support@nexmo.com to enable this feature.

VerifyRequest

public VerifyRequest(VerifyRequest.Builder builder)

Method Detail

getBrand

public java.lang.String getBrand()

Returns:

the name of the company or app to be verified for.

getType

public VerifyRequest.LineType getType()

Returns:

the type of network the verification will be restricted to. This value has no effect unless it has been enabled by contacting support@nexmo.com.

setType

public void setType(VerifyRequest.LineType type)

Deprecated. since 5.5.0 use VerifyRequest.Builder to create a 2FA verification request

Parameters:

type - the type of network the verification will be restricted to. This value has no effect unless it has been enabled by contacting support@nexmo.com.

See Also:

Builder#type(LineType)

getFrom

public java.lang.String getFrom()

Returns:

the short alphanumeric string to specify the SenderID for SMS sent by Verify, or null if one was not provided. This value is specified in some BaseRequest sub-class constructors.

If this value is null</tt>, the sender_id used will be <tt>VERIFY.

setFrom

public void setFrom(java.lang.String from)

Deprecated. since 5.5.0 use VerifyRequest.Builder to create a 2FA verification request

Parameters:

from - the short alphanumeric string to specify the SenderID for SMS sent by Verify.

See Also:

VerifyRequest.Builder.senderId(String)

getWorkflow

public VerifyRequest.Workflow getWorkflow()

Returns:

The predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.

setWorkflow

public void setWorkflow(VerifyRequest.Workflow workflow)

Deprecated. since 5.5.0 use VerifyRequest.Builder to create a 2FA verification request

Parameters:

workflow - The workflow to use for conveying the PIN to your user.

See Also:

Builder#workflow(Workflow)

toString

public java.lang.String toString()

Overrides:

toString in class BaseRequest

builder

public static VerifyRequest.Builder builder(java.lang.String number,
                                            java.lang.String brand)

Returns:

A new Builder to start building.