com.microstrategy.ushersdk

Enum OtpPurpose

java.lang.Object

java.lang.Enum<OtpPurpose>

com.microstrategy.ushersdk.OtpPurpose

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OtpPurpose>

public enum OtpPurpose
extends java.lang.Enum<OtpPurpose>

Enumerations of the one-time password (OTP) purposes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
REGISTER_ACCOUNT Register account
RESET_PASSWORD Reset a password
UPDATE_PHONE Update phone number
VERIFY_EMAIL Verify an email address
VERIFY_PHONE Verify a mobile phone number
VERIFY_VEHICLE Verify a vehicle

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() Returns a String of the OTP purpose.
static OtpPurpose	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OtpPurpose[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERIFY_PHONE

public static final OtpPurpose VERIFY_PHONE

Verify a mobile phone number

VERIFY_EMAIL

public static final OtpPurpose VERIFY_EMAIL

Verify an email address

VERIFY_VEHICLE

public static final OtpPurpose VERIFY_VEHICLE

Verify a vehicle

RESET_PASSWORD

public static final OtpPurpose RESET_PASSWORD

Reset a password

REGISTER_ACCOUNT

public static final OtpPurpose REGISTER_ACCOUNT

Register account

UPDATE_PHONE

public static final OtpPurpose UPDATE_PHONE

Update phone number

Method Detail

values

public static OtpPurpose[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OtpPurpose c : OtpPurpose.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OtpPurpose valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns a String of the OTP purpose.

Overrides:

toString in class java.lang.Enum<OtpPurpose>

Returns:

the OTP purpose.