Package com.okta.sdk.resource.model

Enum Channel

java.lang.Object

java.lang.Enum<Channel>

com.okta.sdk.resource.model.Channel

All Implemented Interfaces:

Serializable, Comparable<Channel>, java.lang.constant.Constable

public enum Channel
extends Enum<Channel>

The out-of-band channel for use with authentication. Required for all `/oob-authenticate` requests and any `/challenge` request with an out-of-band authenticator.

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
PUSH
SMS
UNKNOWN_DEFAULT_OPEN_API
VOICE

Method Summary

Modifier and Type	Method	Description
static Channel	fromValue(String value)
String	getValue()
String	toString()
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
static Channel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Channel[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PUSH

public static final Channel PUSH

SMS

public static final Channel SMS

VOICE

public static final Channel VOICE

UNKNOWN_DEFAULT_OPEN_API

public static final Channel UNKNOWN_DEFAULT_OPEN_API

Method Details

values

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

public static Channel valueOf(String name)

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:

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

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<Channel>

fromValue

public static Channel fromValue(String value)

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string