Module dev.eidentification.bankid

Package dev.eidentification.bankid.client.request

Class PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder

java.lang.Object

dev.eidentification.bankid.client.request.PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder

Enclosing class:

PhoneAuthenticationRequest

public static class PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder
extends Object

PhoneAuthenticationRequestBuilder is a builder class for creating instances of PhoneAuthenticationRequest.

Method Summary

Modifier and Type	Method	Description
PhoneAuthenticationRequest	build()	Builds a PhoneAuthenticationRequest.
PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	callInitiator(CallInitiator callInitiator)	Sets the call initiator for the PhoneAuthenticationRequestBuilder.
PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	personalNumber(String personalNumber)	Sets the personal number for the PhoneAuthenticationRequestBuilder.
PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	requirement(@Nullable PhoneRequirement requirement)	Sets the requirement for phone authentication.
String	toString()
PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	userNonVisibleData(@Nullable UserNonVisibleData userNonVisibleData)	Sets the non-visible data for the user in the PhoneAuthenticationRequestBuilder.
PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	userVisibleData(@Nullable UserVisibleData userVisibleData)	Sets the user visible data for the PhoneAuthenticationRequestBuilder.
PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	userVisibleDataFormat(@Nullable VisibleDataFormat userVisibleDataFormat)	Sets the user visible data format for the PhoneAuthenticationRequestBuilder.

Methods inherited from class java.lang.Object

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

Method Details

personalNumber

public PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder personalNumber(String personalNumber)

Sets the personal number for the PhoneAuthenticationRequestBuilder.

Parameters:

personalNumber - the non-null personal number of the user. String 12 digits. Century must be included. If the personal number is excluded, the client must be started with the autoStartToken returned in the response.

Returns:

the updated PhoneAuthenticationRequestBuilder object.

Throws:

NullPointerException - if personalNumber is null

callInitiator

public PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder callInitiator(CallInitiator callInitiator)

Sets the call initiator for the PhoneAuthenticationRequestBuilder.

Parameters:

callInitiator - the non-null CallInitiator representing the initiator of the phone call.

Returns:

the updated PhoneAuthenticationRequestBuilder object.

Throws:

NullPointerException - if callInitiator is null

requirement

public PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder requirement(@Nullable PhoneRequirement requirement)

Sets the requirement for phone authentication.

Parameters:

requirement - the PhoneRequirement object representing the required conditions for authentication. Can be null.

Returns:

the updated PhoneAuthenticationRequestBuilder object.

userVisibleData

public PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder userVisibleData(@Nullable UserVisibleData userVisibleData)

Sets the user visible data for the PhoneAuthenticationRequestBuilder.

Parameters:

userVisibleData - the nullable UserVisibleData object representing the visible data for authentication.

Returns:

the updated PhoneAuthenticationRequestBuilder object.

userNonVisibleData

public PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder userNonVisibleData(@Nullable UserNonVisibleData userNonVisibleData)

Sets the non-visible data for the user in the PhoneAuthenticationRequestBuilder.

Parameters:

userNonVisibleData - the nullable UserNonVisibleData object representing the non-visible data for authentication.

Returns:

the updated PhoneAuthenticationRequestBuilder object.

See Also:

• UserNonVisibleData

userVisibleDataFormat

public PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder userVisibleDataFormat(@Nullable VisibleDataFormat userVisibleDataFormat)

Sets the user visible data format for the PhoneAuthenticationRequestBuilder.

Parameters:

userVisibleDataFormat - the nullable VisibleDataFormat object representing the format of visible data for authentication.

Returns:

the updated PhoneAuthenticationRequestBuilder object.

build

public PhoneAuthenticationRequest build()

Builds a PhoneAuthenticationRequest.

Returns:

the PhoneAuthenticationRequest object

Throws:

NullPointerException - if personalNumber or callInitiator is null

toString

public String toString()

Overrides:

toString in class Object