com.authy.api

Class ApprovalRequestParams.Builder

java.lang.Object

com.authy.api.ApprovalRequestParams.Builder

Enclosing class:

ApprovalRequestParams

public static class ApprovalRequestParams.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHYID_ERROR
static String	DETAIL_ERROR
static String	HIDDEN_DETAIL_ERROR
static String	LOGO_ERROR_DEFAULT
static String	LOGO_ERROR_RES
static String	LOGO_ERROR_URL
static String	MESSAGE_ERROR

Constructor Summary

Constructors

Constructor and Description
Builder(Integer authyId, String message) This will create a valid builder with the initial required params.

Method Summary

Modifier and Type	Method and Description
ApprovalRequestParams.Builder	addDetail(String key, String value) Adds a key,value pair into the details which is a Dictionary containing the [ApprovalRequest] details that will be shown to user.
ApprovalRequestParams.Builder	addHiddenDetail(String key, String value) Adds a key,value pair into the hidden_details which is a Dictionary containing the approval request details hidden to user.
ApprovalRequestParams.Builder	addLogo(ApprovalRequestParams.Resolution resolution, String url) Adds a new logo item to the Logos array.
ApprovalRequestParams	build() Compiles and creates the provided set of parameters to have a ready to use ApprovalRequestParams object.
ApprovalRequestParams.Builder	setSecondsToExpire(Long secondsToExpire) Defines the second to expire parameter

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_ERROR

public static final String MESSAGE_ERROR

See Also:

Constant Field Values

AUTHYID_ERROR

public static final String AUTHYID_ERROR

See Also:

Constant Field Values

DETAIL_ERROR

public static final String DETAIL_ERROR

See Also:

Constant Field Values

HIDDEN_DETAIL_ERROR

public static final String HIDDEN_DETAIL_ERROR

See Also:

Constant Field Values

LOGO_ERROR_RES

public static final String LOGO_ERROR_RES

See Also:

Constant Field Values

LOGO_ERROR_URL

public static final String LOGO_ERROR_URL

See Also:

Constant Field Values

LOGO_ERROR_DEFAULT

public static final String LOGO_ERROR_DEFAULT

See Also:

Constant Field Values

Constructor Detail

Builder

public Builder(Integer authyId,
               String message)
        throws OneTouchException

This will create a valid builder with the initial required params. See: https://www.twilio.com/docs/api/authy/authy-onetouch-api#parameters

Parameters:

authyId - The id of the user that will be authorized using OneTouch

message - The message to show to the user, cannot be null or empty and it's length needs to be less than 200 max characters.

Throws:

OneTouchException - If any of the params doesn't match the required/length rules.

Method Detail

setSecondsToExpire

public ApprovalRequestParams.Builder setSecondsToExpire(Long secondsToExpire)

Defines the second to expire parameter

See: https://www.twilio.com/docs/api/authy/authy-onetouch-api#parameters

Parameters:

secondsToExpire - Number of seconds that the approval request will be available for being responded.

addDetail

public ApprovalRequestParams.Builder addDetail(String key,
                                               String value)
                                        throws OneTouchException

Adds a key,value pair into the details which is a Dictionary containing the [ApprovalRequest] details that will be shown to user.

See: https://www.twilio.com/docs/api/authy/authy-onetouch-api#parameters

Parameters:

key - The label of the detail that will be shown to the user, cannot be null or empty and it's length needs to be less than 200 max characters.

value - The value of the detail that will be shown to the user, cannot be null or empty and it's length needs to be less than 200 max characters.

Throws:

OneTouchException - If any of the params doesn't match the required/length rules.

addHiddenDetail

public ApprovalRequestParams.Builder addHiddenDetail(String key,
                                                     String value)
                                              throws OneTouchException

Adds a key,value pair into the hidden_details which is a Dictionary containing the approval request details hidden to user.

See: https://www.twilio.com/docs/api/authy/authy-onetouch-api#parameters

Parameters:

key - The label of the hidden detail that will be not shown to the user, cannot be null or empty and it's length needs to be less than 200 max characters.

value - The value of the hidden detail that will be not shown to the user, cannot be null or empty and it's length needs to be less than 200 max characters.

Throws:

OneTouchException - If any of the params doesn't match the required/length rules.

addLogo

public ApprovalRequestParams.Builder addLogo(ApprovalRequestParams.Resolution resolution,
                                             String url)
                                      throws OneTouchException

Adds a new logo item to the Logos array.

Parameters:

resolution - The Resolution wanted for the given logo(Default, log,med,high)

url - The url to be used to load the logo.

Throws:

OneTouchException - If any of the params doesn't match the required/length rules.

build

public ApprovalRequestParams build()
                            throws OneTouchException

Compiles and creates the provided set of parameters to have a ready to use ApprovalRequestParams object.

Returns:

The bean containing all the properties required to send a valid OneTouch request to Authy.

Throws:

OneTouchException - If any of the params doesn't match the required/length rules.