Package ch.nevis.mobile.sdk.api.operation.outofband

Enum Class DispatchChannel

java.lang.Object

java.lang.Enum<DispatchChannel>

ch.nevis.mobile.sdk.api.operation.outofband.DispatchChannel

All Implemented Interfaces:

Serializable, Comparable<DispatchChannel>, Constable

public enum DispatchChannel
extends Enum<DispatchChannel>

The different dispatch channels (dispatchers in nevisFIDO terminology) that can be used with to transmit the out-of-band operation: the out-of-band operation reaches the application either through a QR code, a FCM push notification or a link.

See the nevisFIDO Dispatchers for Mobile Authentication section for details.

Note: in the context of Authentication Cloud, the QR code is rendered by Authentication Cloud itself. Authentication Cloud will use the nevisFIDO link dispatcher to generate the QR code. So, the dispatch channel returned by the SDK will be LINK for Authentication Cloud also in the case of QR code.

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
LINK	A link (Universal Link, App Links, etc.) was used for the out-of-band operation.
PUSH_NOTIFICATION	The Firebase Cloud Messaging (that is, a push notification) was used for the out-of-band operation.
QR_CODE	A QR code was used for the out-of-band operation.

Method Summary

Modifier and Type	Method	Description
String	dispatcherValue()	The dispatcher value for this channel as defined in nevisFIDO.
static DispatchChannel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DispatchChannel[]	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

LINK

public static final DispatchChannel LINK

A link (Universal Link, App Links, etc.) was used for the out-of-band operation.

PUSH_NOTIFICATION

public static final DispatchChannel PUSH_NOTIFICATION

The Firebase Cloud Messaging (that is, a push notification) was used for the out-of-band operation.

QR_CODE

public static final DispatchChannel QR_CODE

A QR code was used for the out-of-band operation.

Method Details

values

public static DispatchChannel[] 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 DispatchChannel 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

dispatcherValue

public String dispatcherValue()

The dispatcher value for this channel as defined in nevisFIDO.

Returns:

the dispatcher String value