Package eu.webtoolkit.jwt.auth
Enum EmailTokenResult.Result
java.lang.Object
java.lang.Enum<EmailTokenResult.Result>
eu.webtoolkit.jwt.auth.EmailTokenResult.Result
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<EmailTokenResult.Result>
,java.lang.constant.Constable
- Enclosing class:
- EmailTokenResult
public static enum EmailTokenResult.Result extends java.lang.Enum<EmailTokenResult.Result>
Enumeration that describes the result.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
-
Enum Constant Summary
Enum Constants Enum Constant Description EmailConfirmed
A The token was presented which verifies the email address.Expired
The token has expired.Invalid
The token was invalid.UpdatePassword
A token was presented which requires the user to enter a new password. -
Method Summary
Modifier and Type Method Description int
getValue()
Returns the numerical representation of this enum.static EmailTokenResult.Result
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static EmailTokenResult.Result[]
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, 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
-
Invalid
The token was invalid. -
Expired
The token has expired. -
UpdatePassword
A token was presented which requires the user to enter a new password.The presented token was a token sent by the
AuthService#lostPassword()
function. When this is returned as result ofAuthService#processEmailToken()
, you should present the user with a dialog where he can enter a new password. -
EmailConfirmed
A The token was presented which verifies the email address.The presented token was a token sent by the
AuthService#verifyEmailAddress()
function. When this is returned as result of processEmailToken(), you can indicate to the user that his email address is now confirmed.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 namejava.lang.NullPointerException
- if the argument is null
-
getValue
public int getValue()Returns the numerical representation of this enum.
-