Package com.inductiveautomation.perspective.gateway.api

Enum Class SessionScope

java.lang.Object

java.lang.Enum<SessionScope>

com.inductiveautomation.perspective.gateway.api.SessionScope

All Implemented Interfaces:

Serializable, Comparable<SessionScope>, Constable

public enum SessionScope
extends Enum<SessionScope>

Represents the two "scopes" that a perspective webpage can represent - client or designer

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
Client
Designer

Method Summary

Modifier and Type	Method	Description
static SessionScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SessionScope[]	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

Client

public static final SessionScope Client

Designer

public static final SessionScope Designer

Method Details

values

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