Module dev.eidentification.bankid

Package dev.eidentification.bankid.client.request

Record Class PhoneAuthenticationRequest

java.lang.Object

java.lang.Record

dev.eidentification.bankid.client.request.PhoneAuthenticationRequest

Record Components:

personalNumber - The 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.

callInitiator - Indicate if the user or the RP initiated the phone call.

requirement - Requirements on how the auth or sign order must be performed.

userVisibleData - The text to be displayed and signed. The text can be formatted using CR, LF and CRLF for new lines. 1--40 000 characters after base 64 encoding.

userNonVisibleData - Data not displayed for the user. 1-200 000 characters after base 64-encoding.

userVisibleDataFormat - This parameter indicates that userVisibleData holds formatting characters which, will potentially make the text displayed to the user nicer to look at.

All Implemented Interfaces:

Request

public record PhoneAuthenticationRequest(String personalNumber, CallInitiator callInitiator, @Nullable PhoneRequirement requirement, @Nullable UserVisibleData userVisibleData, @Nullable UserNonVisibleData userNonVisibleData, @Nullable VisibleDataFormat userVisibleDataFormat)
extends Record
implements Request

Request to initiates an authentication order when the user is talking to the RP over the phone.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	PhoneAuthenticationRequestBuilder is a builder class for creating instances of PhoneAuthenticationRequest.

Constructor Summary

Constructors

Constructor	Description
PhoneAuthenticationRequest(String personalNumber, CallInitiator callInitiator, @Nullable PhoneRequirement requirement, @Nullable UserVisibleData userVisibleData, @Nullable UserNonVisibleData userNonVisibleData, @Nullable VisibleDataFormat userVisibleDataFormat)	PhoneAuthenticationRequest constructor.

Method Summary

Modifier and Type	Method	Description
static PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder	builder()
CallInitiator	callInitiator()	Returns the value of the callInitiator record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getUri()	Returns the URI associated with the request.
final int	hashCode()	Returns a hash code value for this object.
String	personalNumber()	Returns the value of the personalNumber record component.
@Nullable PhoneRequirement	requirement()	Returns the value of the requirement record component.
final String	toString()	Returns a string representation of this record class.
@Nullable UserNonVisibleData	userNonVisibleData()	Returns the value of the userNonVisibleData record component.
@Nullable UserVisibleData	userVisibleData()	Returns the value of the userVisibleData record component.
@Nullable VisibleDataFormat	userVisibleDataFormat()	Returns the value of the userVisibleDataFormat record component.

Methods inherited from class java.lang.Object

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

Constructor Details

PhoneAuthenticationRequest

public PhoneAuthenticationRequest(String personalNumber,
 CallInitiator callInitiator,
 @Nullable PhoneRequirement requirement,
 @Nullable UserVisibleData userVisibleData,
 @Nullable UserNonVisibleData userNonVisibleData,
 @Nullable VisibleDataFormat userVisibleDataFormat)

PhoneAuthenticationRequest constructor.

Throws:

NullPointerException - if personalNumber or callInitiator is null

Method Details

builder

public static PhoneAuthenticationRequest.PhoneAuthenticationRequestBuilder builder()

getUri

public String getUri()

Description copied from interface: Request

Returns the URI associated with the request.

Specified by:

getUri in interface Request

Returns:

The URI of the request.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

personalNumber

public String personalNumber()

Returns the value of the personalNumber record component.

Returns:

the value of the personalNumber record component

callInitiator

public CallInitiator callInitiator()

Returns the value of the callInitiator record component.

Returns:

the value of the callInitiator record component

requirement

public @Nullable PhoneRequirement requirement()

Returns the value of the requirement record component.

Returns:

the value of the requirement record component

userVisibleData

public @Nullable UserVisibleData userVisibleData()

Returns the value of the userVisibleData record component.

Returns:

the value of the userVisibleData record component

userNonVisibleData

public @Nullable UserNonVisibleData userNonVisibleData()

Returns the value of the userNonVisibleData record component.

Returns:

the value of the userNonVisibleData record component

userVisibleDataFormat

public @Nullable VisibleDataFormat userVisibleDataFormat()

Returns the value of the userVisibleDataFormat record component.

Returns:

the value of the userVisibleDataFormat record component