Package com.vonage.client.verify2

Class SilentAuthWorkflow

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.verify2.Workflow

com.vonage.client.verify2.SilentAuthWorkflow

All Implemented Interfaces:

Jsonable

public final class SilentAuthWorkflow
extends Workflow

Defines properties for mobile network-based authentication. See the Silent Auth guide for an overview of how this works.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SilentAuthWorkflow.Builder	Builder for constructing a Silent Authentication workflow.

Field Summary

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

channel, from, to

Constructor Summary

Constructors

Constructor	Description
SilentAuthWorkflow(String to)	Constructs a new Silent Auth verification workflow.
SilentAuthWorkflow(String to, boolean sandbox)	Constructs a new Silent Auth verification workflow.
SilentAuthWorkflow(String to, boolean sandbox, String redirectUrl)	Constructs a new Silent Auth verification workflow.

Method Summary

Modifier and Type	Method	Description
static SilentAuthWorkflow.Builder	builder(String to)	Entrypoint for constructing an instance of this class.
URI	getRedirectUrl()	Final redirect after VerificationResponse.getCheckUrl().
Boolean	getSandbox()	Optional parameter if using the Vonage Sandbox to test Silent Auth integrations.
protected String	validateTo(String to)

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

getChannel, getTo, validateFrom

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

SilentAuthWorkflow

public SilentAuthWorkflow(String to)

Constructs a new Silent Auth verification workflow.

Parameters:

to - The number to registered to the device on the network to authenticate.

SilentAuthWorkflow

public SilentAuthWorkflow(String to,
 boolean sandbox)

Constructs a new Silent Auth verification workflow.

Parameters:

to - The number to registered to the device on the network to authenticate.

sandbox - Whether the Vonage Sandbox should be used (for testing purposes).

Since:

7.10.0

SilentAuthWorkflow

public SilentAuthWorkflow(String to,
 boolean sandbox,
 String redirectUrl)

Constructs a new Silent Auth verification workflow.

Parameters:

to - The number to registered to the device on the network to authenticate.

sandbox - Whether the Vonage Sandbox should be used (for testing purposes).

redirectUrl - Optional final redirect added at the end of the check_url request/response lifecycle. Will contain the request_id and code as a URL fragment after the URL.

Since:

8.0.0

Method Details

getSandbox

public Boolean getSandbox()

Optional parameter if using the Vonage Sandbox to test Silent Auth integrations.

Returns:

Whether the Vonage Sandbox will be used, or null if not specified (the default).

Since:

7.10.0

getRedirectUrl

public URI getRedirectUrl()

Final redirect after VerificationResponse.getCheckUrl(). See the documentation for integrations.

Returns:

The optional redirect_url, or null if not set (the default).

Since:

8.0.0

builder

public static SilentAuthWorkflow.Builder builder(String to)

Entrypoint for constructing an instance of this class.

Parameters:

to - (REQUIRED) The number to registered to the device on the network to authenticate.

Returns:

A new Builder.

Since:

8.2.0

validateTo

protected String validateTo(String to)

Overrides:

validateTo in class Workflow