Interface AuthChallengeCompleteEvent.Result
- All Known Subinterfaces:
AuthChallengeCompleteEvent.Result.Error
,AuthChallengeCompleteEvent.Result.Error.Cancelled
,AuthChallengeCompleteEvent.Result.Error.Generic
,AuthChallengeCompleteEvent.Result.Error.Timeout
,AuthChallengeCompleteEvent.Result.Success
- Enclosing interface:
- AuthChallengeCompleteEvent
public static interface AuthChallengeCompleteEvent.Result
Representation of the result of an authentication challenge.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Representation of a failed authentication challenge result.static interface
Representation of a successful authentication challenge result. -
Method Summary
-
Method Details
-
isSuccess
boolean isSuccess()- Returns:
- true if the authentication challenge was a success, otherwise returns false. If true, call
getAsSuccess()
to get thisAuthChallengeCompleteEvent.Result
object typed as aAuthChallengeCompleteEvent.Result.Success
object for access to methods which provide specific details pertaining to the successful result, such as the authenticated user's identity attributes and security levels. If false, callgetAsError()
to get thisAuthChallengeCompleteEvent.Result
object typed as anAuthChallengeCompleteEvent.Result.Error
object for access to methods which provide specific details pertaining to the error result, such as the type of error which occurred.
-
isError
default boolean isError()- Returns:
- true if the authentication challenge failed due to an error, otherwise returns false. If true, call
getAsError()
to get thisAuthChallengeCompleteEvent.Result
object typed as anAuthChallengeCompleteEvent.Result.Error
object for access to methods which provide specific details pertaining to the error result, such as the type of error which occurred. If false, callgetAsSuccess()
to get thisAuthChallengeCompleteEvent.Result
object typed as aAuthChallengeCompleteEvent.Result.Success
object for access to methods which provide specific details pertaining to the successful result, such as the authenticated user's identity attributes and security levels.
-
getAsSuccess
AuthChallengeCompleteEvent.Result.Success getAsSuccess()- Returns:
- the result as a
AuthChallengeCompleteEvent.Result.Success
object if the result is successful, otherwise throws anUnsupportedOperationException
if the result is an error. CheckisSuccess()
orisError()
before calling this method to ensure you get the correct result type.
-
getAsError
AuthChallengeCompleteEvent.Result.Error getAsError()- Returns:
- the result as an
AuthChallengeCompleteEvent.Result.Error
object if the result is an error, otherwise throws anUnsupportedOperationException
if the result is successful. CheckisSuccess()
orisError()
before calling this method to ensure you get the correct result type.
-