Package com.thalesgroup.gemalto.fido2.authenticator.passcode

Enum Class KeyboardUsage

java.lang.Object

java.lang.Enum<KeyboardUsage>

com.thalesgroup.gemalto.fido2.authenticator.passcode.KeyboardUsage

All Implemented Interfaces:

Serializable, Comparable<KeyboardUsage>, Constable

public enum KeyboardUsage
extends Enum<KeyboardUsage>

Describes the current purpose of the secure keyboard.

The application should use this enum to update its UI, for example, by changing prompt messages.

Since:

1.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANGE_PASSCODE_CONFIRM	Indicates the keyboard is for confirming the new passcode during a change passcode operation.
CHANGE_PASSCODE_NEW	Indicates the keyboard is for entering a new passcode during a change passcode operation.
CHANGE_PASSCODE_OLD	Indicates the keyboard is for entering the old passcode during a change passcode operation.
ENROLL_CONFIRM	Indicates the keyboard is for confirming a new passcode during enrollment.
ENROLL_NEW	Indicates the keyboard is for entering a new passcode during enrollment.
FIDO_OPERATION	Indicates the keyboard is for authenticating the user for a FIDO operation.
UNENROLL	Indicates the keyboard is for authenticating the user before deleting their passcode.

Method Summary

Modifier and Type	Method	Description
static KeyboardUsage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyboardUsage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENROLL_NEW

public static final KeyboardUsage ENROLL_NEW

Indicates the keyboard is for entering a new passcode during enrollment.

ENROLL_CONFIRM

public static final KeyboardUsage ENROLL_CONFIRM

Indicates the keyboard is for confirming a new passcode during enrollment.

FIDO_OPERATION

public static final KeyboardUsage FIDO_OPERATION

Indicates the keyboard is for authenticating the user for a FIDO operation.

CHANGE_PASSCODE_OLD

public static final KeyboardUsage CHANGE_PASSCODE_OLD

Indicates the keyboard is for entering the old passcode during a change passcode operation.

CHANGE_PASSCODE_NEW

public static final KeyboardUsage CHANGE_PASSCODE_NEW

Indicates the keyboard is for entering a new passcode during a change passcode operation.

CHANGE_PASSCODE_CONFIRM

public static final KeyboardUsage CHANGE_PASSCODE_CONFIRM

Indicates the keyboard is for confirming the new passcode during a change passcode operation.

UNENROLL

public static final KeyboardUsage UNENROLL

Indicates the keyboard is for authenticating the user before deleting their passcode.

Method Details

values

public static KeyboardUsage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static KeyboardUsage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null