Package com.inductiveautomation.perspective.common.auth

Enum Class FramingOption

java.lang.Object

java.lang.Enum<FramingOption>

com.inductiveautomation.perspective.common.auth.FramingOption

All Implemented Interfaces:

Serializable, Comparable<FramingOption>, Constable

public enum FramingOption
extends Enum<FramingOption>

An enumeration of the supported methods for presenting the authentication challenge UI

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FramingOption.GsonAdapter	A JsonSerializer and JsonDeserializer implementation for serializing and de-serializing FramingOption objects to / from JSON using GSON APIs.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMBEDDED	Open the authentication UI within an embedded iframe
NEW	Open the authentication UI in a new tab / window
SELF	Open the authentication UI using the current tab / window

Method Summary

Modifier and Type	Method	Description
static FramingOption	fromJsonTree(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement)	Attempts to parse a FramingOption from a JsonElement
static Optional<FramingOption>	parse(String str)
com.inductiveautomation.ignition.common.gson.JsonElement	toJsonTree()
static FramingOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FramingOption[]	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

SELF

public static final FramingOption SELF

Open the authentication UI using the current tab / window

NEW

public static final FramingOption NEW

Open the authentication UI in a new tab / window

EMBEDDED

public static final FramingOption EMBEDDED

Open the authentication UI within an embedded iframe

Method Details

values

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

parse

public static Optional<FramingOption> parse(@Nullable
 String str)

Parameters:

str - a string to parse into a FramingOption

Returns:

an Optional containing the FramingOption parsed from the provided string, or an empty Optional if the string is null or if the string could not be parsed into one of the FramingOptions

fromJsonTree

public static FramingOption fromJsonTree(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement)

Attempts to parse a FramingOption from a JsonElement

Parameters:

jsonElement - the JsonElement to parse

Returns:

the FramingOption parsed from the provided JsonElement

Throws:

com.inductiveautomation.ignition.common.gson.JsonParseException - if a FramingOption cannot be parsed from the provided JsonElement

See Also:

• parse(String)

toJsonTree

public com.inductiveautomation.ignition.common.gson.JsonElement toJsonTree()

Returns:

this FramingOption as a JsonElement