Package com.inductiveautomation.perspective.gateway.api

Interface Summary

Interface	Description
Action	An action is something the user configures to respond in some way to an event being fired.
ActionContext
ActionFactory	Factory to create instances of Actions based on saved configuration
ActionRegistry
AuditingContext	Context in which an audit log record may be written
AuthChallengeCompleteEvent	This event is fired when an authentication challenge is completed by the user.
AuthChallengeCompleteEvent.Result	Representation of the result of an authentication challenge.
AuthChallengeCompleteEvent.Result.Error	Representation of a failed authentication challenge result.
AuthChallengeCompleteEvent.Result.Error.Cancelled	Representation of the result of an authentication challenge which failed due to the user cancelling the authentication challenge.
AuthChallengeCompleteEvent.Result.Error.Generic	Representation of the result of an authentication challenge which failed due to a generic error.
AuthChallengeCompleteEvent.Result.Error.Timeout	Representation of the result of an authentication challenge which failed due to a timeout.
AuthChallengeCompleteEvent.Result.Success	Representation of a successful authentication challenge result.
Binding	A binding is associated with a target property and shares the lifecycle of the component (or shorter, in the designer-scope sessions).
BindingContext
BindingFactory	Created by carlg on 1/26/2017.
BindingRegistry
CompiledScriptCache
Component	Interface for component instances.
ComponentModelDelegateFactory	Functional interface for a factory method which creates ComponentModelDelegates
ComponentModelDelegateRegistry	A Registry for ComponentModelDelegateFactories
EventManager	Manages subscriptions to and delivery of events.
EventManager.ListenerExceptionHandler	Handler that will be called in a listener throws any Throwable while receiving an event.
EventManager.Subscription	Represents a subscription of a listener that has been subscribed to an event.
ExtensionFunction
FetchableCache	The FetchableCache is a place for perspective component model delegates to place downloadable data (named "fetch"-able after the	FetchableCache.Fetchable
FontManager	Interface which exposes methods for retrieving fonts and information about the fonts (such as the font name, font style, and font type)
IconManager	Interface which exposes methods for retrieving Icon Libraries (as SVG Strings) and information about the Icon Libraries (such as the icon names within an Icon Library)
LoggingContext
Page
PerspectiveContext	Provides a way to find resources shared by all Perspective sessions.
PerspectiveElement
PerspectiveProjectCache	The PerspectiveProjectCache manages a cache of the latest ProjectConfig and concatenated css classes compiled from the style resource JSON sources on a per project version basis.
PropertyTreeOwner	A PropertyTreeOwner manages a set of PropertyTrees for the various PropertyTypes
Session
Session.WebAuthStatusChangeEvent	Sent on the Session's EventManager when the user's WebAuthStatus changes.
ThemeManager
Transform	Created by carlg on 1/26/2017.
TransformFactory	A way to create transform instances of a certain transform type.
View

Class Summary

Class	Description
AuthChallengeRequest	Immutable representation of an authentication challenge request
AuthChallengeRequest.Builder	Provides a fluent-API (builder-style) pattern for creating new AuthChallengeRequest objects
AuthChallengeRequest.GsonAdapter	A JsonSerializer and JsonDeserializer implementation for serializing and de-serializing AuthChallengeRequest objects to / from JSON using GSON APIs.
ComponentModelDelegate	A ComponentModelDelegate is created when its ComponentModel owner is created.
PerspectiveProject	A PerspectiveProject is a simple container of a ProjectConfig, concatenated compiled CSS style resources, and the Map of all style resource IDs to their compiled CSS in the Project.
PerspectiveProject.SimplifiedGsonEncoder	Used to provide scripting access to some metadata about the project
PerspectiveProjectDisplayData
PerspectiveProjectDisplayData.Builder
ViewInstanceId	A class used to specify a specific instance of a running DesignerViewModel, where the resourcepath designates a specific view's path in the ProjectResource hierarchy as seen in the designer's resource browser tree.
WebAuthDiagnostics	Encapsulates useful information for diagnosing authorization decisions
WebAuthDiagnostics.GsonAdapter
WebAuthStatus	Encapsulates a snapshot of authentication and authorization state
WebAuthStatus.Builder
WebAuthStatus.Diff
WebAuthStatus.GsonAdapter
WebAuthStatus.PrivateGsonAdapter

Enum Summary

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

Annotation Types Summary

Annotation Type	Description
ScriptCallable	Used to mark public methods on a ComponentModelDelegate that should be accessible to users in the script system.