Package com.bandwidth.multifactorauth.models

Class TwoFactorVerifyRequestSchema

java.lang.Object

com.bandwidth.multifactorauth.models.TwoFactorVerifyRequestSchema

public class TwoFactorVerifyRequestSchema
extends Object

This is a model class for TwoFactorVerifyRequestSchema type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TwoFactorVerifyRequestSchema.Builder	Class to build instances of TwoFactorVerifyRequestSchema.

Constructor Summary

Constructors

Constructor	Description
TwoFactorVerifyRequestSchema()	Default constructor.
TwoFactorVerifyRequestSchema(String to, String applicationId, double expirationTimeInMinutes, String code, String scope)	Initialization constructor.

Method Summary

Modifier and Type	Method	Description
String	getApplicationId()	Getter for ApplicationId.
String	getCode()	Getter for Code.
double	getExpirationTimeInMinutes()	Getter for ExpirationTimeInMinutes.
String	getScope()	Getter for Scope.
String	getTo()	Getter for To.
void	setApplicationId(String applicationId)	Setter for ApplicationId.
void	setCode(String code)	Setter for Code.
void	setExpirationTimeInMinutes(double expirationTimeInMinutes)	Setter for ExpirationTimeInMinutes.
void	setScope(String scope)	Setter for Scope.
void	setTo(String to)	Setter for To.
TwoFactorVerifyRequestSchema.Builder	toBuilder()	Builds a new TwoFactorVerifyRequestSchema.Builder object.
String	toString()	Converts this TwoFactorVerifyRequestSchema into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

TwoFactorVerifyRequestSchema

public TwoFactorVerifyRequestSchema()

Default constructor.

TwoFactorVerifyRequestSchema

public TwoFactorVerifyRequestSchema(String to,
                                    String applicationId,
                                    double expirationTimeInMinutes,
                                    String code,
                                    String scope)

Initialization constructor.

Parameters:

to - String value for to.

applicationId - String value for applicationId.

expirationTimeInMinutes - double value for expirationTimeInMinutes.

code - String value for code.

scope - String value for scope.

Method Detail

getTo

public String getTo()

Getter for To. The phone number to send the 2fa code to.

Returns:

Returns the String

setTo

public void setTo(String to)

Setter for To. The phone number to send the 2fa code to.

Parameters:

to - Value for String

getApplicationId

public String getApplicationId()

Getter for ApplicationId. The application unique ID, obtained from Bandwidth.

Returns:

Returns the String

setApplicationId

public void setApplicationId(String applicationId)

Setter for ApplicationId. The application unique ID, obtained from Bandwidth.

Parameters:

applicationId - Value for String

getScope

public String getScope()

Getter for Scope. An optional field to denote what scope or action the 2fa code is addressing. If not supplied, defaults to "2FA".

Returns:

Returns the String

setScope

public void setScope(String scope)

Setter for Scope. An optional field to denote what scope or action the 2fa code is addressing. If not supplied, defaults to "2FA".

Parameters:

scope - Value for String

getExpirationTimeInMinutes

public double getExpirationTimeInMinutes()

Getter for ExpirationTimeInMinutes. The time period, in minutes, to validate the 2fa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively.

Returns:

Returns the double

setExpirationTimeInMinutes

public void setExpirationTimeInMinutes(double expirationTimeInMinutes)

Setter for ExpirationTimeInMinutes. The time period, in minutes, to validate the 2fa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively.

Parameters:

expirationTimeInMinutes - Value for double

getCode

public String getCode()

Getter for Code. The generated 2fa code to check if valid

Returns:

Returns the String

setCode

public void setCode(String code)

Setter for Code. The generated 2fa code to check if valid

Parameters:

code - Value for String

toString

public String toString()

Converts this TwoFactorVerifyRequestSchema into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public TwoFactorVerifyRequestSchema.Builder toBuilder()

Builds a new TwoFactorVerifyRequestSchema.Builder object. Creates the instance with the state of the current model.

Returns:

a new TwoFactorVerifyRequestSchema.Builder object