Telephone

public final class Telephone

Group of attributes intended to hold information about phone number associated with the transaction. A user can have one to many phone numbers (home, work, mobile, etc.).

Parameters

countryAccessCode

Numeric digit between 1 to 3 characters used to represent the country code for international dialing. Does not include symbols, spaces, or leading zeros.

areaCode

A number prefixed to an individual telephone number: used in making long-distance calls. Does not include symbols, spaces, or leading zeros.

phoneNumber

A number that is dialed on a telephone, without the country or area codes, to reach a particular person, business, etc. Does not include symbols, spaces, or leading zeros.

type
platformType
extensionNumber

The number used to reach an individual once a phone connection is established. Does not include symbols, spaces, or leading zeros.

preferenceRank

Ranking of order of user preference for contact via text (if type is Mobile) or voice. 0 means no preference. 1 is the primary phone, 2 is the secondary phone, etc.

lastVerifiedDateTime

Local date and time user validated possession of their phone number via a text or voice multi factor authentication challenge, in ISO-8601 date and time format yyyy-MM-ddTHH:mm:ss.SSSZ.

verifiedFlag

Flag indicating whether user passed validation of possession of their phone number via a text or voice multi factor authentication challenge.

Constructors

Link copied to clipboard
public Telephone Telephone(String countryAccessCode, String areaCode, String phoneNumber, TelephoneType type, TelephonePlatformType platformType, String extensionNumber, BigDecimal preferenceRank, OffsetDateTime lastVerifiedDateTime, Boolean verifiedFlag)

Types

Link copied to clipboard
public final class Builder

Properties

Link copied to clipboard
@Pattern(regexp = "^[0-9]{1,20}$")
@Length(max = 20)
@NotNull()
@Valid()
private final String areaCode
Link copied to clipboard
@Pattern(regexp = "^[0-9]{1,3}$")
@Length(max = 3)
@NotNull()
@Valid()
private final String countryAccessCode
Link copied to clipboard
@Pattern(regexp = "^[0-9]{1,20}$")
@Length(max = 20)
@Valid()
private final String extensionNumber
Link copied to clipboard
Link copied to clipboard
@Pattern(regexp = "^[0-9]{1,50}$")
@Length(max = 50)
@NotNull()
@Valid()
private final String phoneNumber
Link copied to clipboard
@Valid()
private final TelephonePlatformType platformType
Link copied to clipboard
@Valid()
private final BigDecimal preferenceRank
Link copied to clipboard
@Valid()
private final TelephoneType type
Link copied to clipboard
@Valid()
private final Boolean verifiedFlag

Functions

Link copied to clipboard
public final static Telephone.Builder builder()
Link copied to clipboard
public final String getAreaCode()
Link copied to clipboard
Link copied to clipboard
public final String getExtensionNumber()
Link copied to clipboard
Link copied to clipboard
public final String getPhoneNumber()
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
public final TelephoneType getType()
Link copied to clipboard
public final Boolean getVerifiedFlag()
Link copied to clipboard