Package com.inductiveautomation.perspective.gateway.api

Interface AuthChallengeCompleteEvent.Result.Error.Timeout

All Superinterfaces:

AuthChallengeCompleteEvent.Result, AuthChallengeCompleteEvent.Result.Error

Enclosing interface:

AuthChallengeCompleteEvent.Result.Error

public static interface AuthChallengeCompleteEvent.Result.Error.Timeout
extends AuthChallengeCompleteEvent.Result.Error

Representation of the result of an authentication challenge which failed due to a timeout.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.perspective.gateway.api.AuthChallengeCompleteEvent.Result

AuthChallengeCompleteEvent.Result.Error, AuthChallengeCompleteEvent.Result.Success

Nested classes/interfaces inherited from interface com.inductiveautomation.perspective.gateway.api.AuthChallengeCompleteEvent.Result.Error

AuthChallengeCompleteEvent.Result.Error.Cancelled, AuthChallengeCompleteEvent.Result.Error.Generic, AuthChallengeCompleteEvent.Result.Error.Timeout

Method Summary

Modifier and Type	Method	Description
default AuthChallengeCompleteEvent.Result.Error.Cancelled	getAsCancelled()	Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Timeout error result
default AuthChallengeCompleteEvent.Result.Error.Generic	getAsGeneric()	Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Timeout error result
default AuthChallengeCompleteEvent.Result.Error.Timeout	getAsTimeout()
int	getTimeout()
default boolean	isCancelled()
default boolean	isGeneric()
default boolean	isTimeout()

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuthChallengeCompleteEvent.Result.Error

getAsError, getAsSuccess, isError, isSuccess

Method Details

isGeneric

default boolean isGeneric()

Specified by:

isGeneric in interface AuthChallengeCompleteEvent.Result.Error

Returns:

false since this AuthChallengeCompleteEvent.Result.Error result is due to a timeout

isTimeout

default boolean isTimeout()

Specified by:

isTimeout in interface AuthChallengeCompleteEvent.Result.Error

Returns:

true since this AuthChallengeCompleteEvent.Result.Error result is due to a timeout

isCancelled

default boolean isCancelled()

Specified by:

isCancelled in interface AuthChallengeCompleteEvent.Result.Error

Returns:

false since this AuthChallengeCompleteEvent.Result.Error result is due to a timeout

getAsGeneric

default AuthChallengeCompleteEvent.Result.Error.Generic getAsGeneric()

Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Timeout error result

Specified by:

getAsGeneric in interface AuthChallengeCompleteEvent.Result.Error

Returns:

this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Generic object if this error is generic, otherwise throws an UnsupportedOperationException if this error is not generic. Check AuthChallengeCompleteEvent.Result.Error.isGeneric() before calling this method to ensure you get the correct result type.

getAsTimeout

default AuthChallengeCompleteEvent.Result.Error.Timeout getAsTimeout()

Specified by:

getAsTimeout in interface AuthChallengeCompleteEvent.Result.Error

Returns:

this AuthChallengeCompleteEvent.Result.Error result typed as AuthChallengeCompleteEvent.Result.Error.Timeout

getAsCancelled

default AuthChallengeCompleteEvent.Result.Error.Cancelled getAsCancelled()

Always throws an UnsupportedOperationException since this is a AuthChallengeCompleteEvent.Result.Error.Timeout error result

Specified by:

getAsCancelled in interface AuthChallengeCompleteEvent.Result.Error

Returns:

this AuthChallengeCompleteEvent.Result.Error object typed as a AuthChallengeCompleteEvent.Result.Error.Cancelled object if this error is due to the user cancelling the authentication challenge, otherwise throws an UnsupportedOperationException if this error is not due to the user cancelling the authentication challenge. Check AuthChallengeCompleteEvent.Result.Error.isCancelled() before calling this method to ensure you get the correct result type.

getTimeout

int getTimeout()

Returns:

the timeout value in minutes that was used to configure the timeout which got triggered