Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.


 ClassPackageDescription
 AbstractAIRProxyComponent
com.ucompass.ucompos.sdk.client AbstractAIRProxyComponent is a class that should be extended by classes that are Proxy Components that are specifically designed to communicate with AIR applications.
 AbstractProxyComponent
com.ucompass.ucompos.sdk.client This class is an abstract base class for any class that implements IProxyComponent.
 AbstractServerHandler
com.ucompass.ucompos.sdk.server This is the abstract super class for any ServerHandler class and provides necessary data used by the individual implementing subclasses.
 AbstractServicesDictionary
com.ucompass.ucompos.sdk.server A Services Dictionary is a directory of public API methods that the SDKServer being contacted sponsors.
 BroadcastEvent
com.ucompass.ucompos.sdk.client This class broadcasts an EventObject as part of a DataPackage to a specific remote SDKServer.
 CommandObject
com.ucompass.ucompos.sdk.dto This class represents the data model for a command that is sent from the SDKClient on a player to the SDKServer on a remote player.
 CommandObjectHandler
com.ucompass.ucompos.sdk.server This class handles a CommandObject on behalf of the server.
 DataPackage
com.ucompass.ucompos.sdk.dto This class serves as the model for data packages that are sent between clients and servers in the UcompOS API request/response cycle.
 DataPackageObject
com.ucompass.ucompos.sdk.dto Any class used as a data package object as part of a DataPackage should extend this abstract class.
 EventObject
com.ucompass.ucompos.sdk.dto This class represents an Event Object that can be part of a DataPackage object that is sent between client and server in the response phase of the request/response cycle of an UcompOS transaction or it could be an asynchronous point-of-origin transmission that is broadcast to numerous (or single) connected players simultaneusly.
 EventObjectHandler
com.ucompass.ucompos.sdk.server This class handles EventObject transmissions on behalf of the server.
 IDataPackageObject
com.ucompass.ucompos.sdk.dto This interface must be implemented by any class that acts as a DataPackageObject.
 IProxyComponent
com.ucompass.ucompos.sdk.client All ProxyComponent classes must implement this interface, and by strict convention, all ProxyComponent classes must extend AbstractProxyComponent which implements IProxyComponent thus all ProxyComponent instances must be instances of IProxyComponent.
 IServerHandler
com.ucompass.ucompos.sdk.server All servers handlers must implement this interface (CommandObjectHandler, ErrorObjectHandler, EventObjectHandler, etc.).
 IServicesDictionary
com.ucompass.ucompos.sdk.server All Service Dictionaries must implement this interface and they do this, by strict convention, by extending AbstractServicesDictionary.
 JavaScriptAPI
com.ucompass.ucompos.sdk.javascript The JavaScriptAPI class furnishes the infrastructure that enables JavaScript-based players.
 JavaScriptCommand
com.ucompass.ucompos.sdk.javascript The JavaScriptCommand class essentially can be thought of a Proxy-Proxy Component.
 SDKClient
com.ucompass.ucompos.sdk This class is a Singleton that implements the infrastructure for the client in an UcompOS client/server request/response transmission.
 SDKEvent
com.ucompass.ucompos.sdk.events This is class that provides a basis for event objects that may be dispatched by the SDKServer, or one of its disciples.
 SDKEventDispatcher
com.ucompass.ucompos.sdk.events 
 SDKModel
com.ucompass.ucompos.sdk.model This class serves as the data warehouse for data that is used exclusively for purposes of the SDK and client-server transmissions as part of the UcompOS request-response cycle.
 SDKServer
com.ucompass.ucompos.sdk This is the server infrastructure in the UcompOS implementation model.
 SDKSocket
com.ucompass.ucompos.sdk.utils SDKSocket is a custom class used in instances where SDK transactions are sent to AIR Applications that are part of the UcompOS Continuum.
 ServerHandler
com.ucompass.ucompos.sdk.server This is a factory class to handle a DataPackage that is passed from an SDKClient in one player to a remote SDKServer implementation.
 SharedObjectAPIKit
com.ucompass.ucompos.sdk.model 
 SharedObjectAPIKitEvent
com.ucompass.ucompos.sdk.events 
 UcompOSAIRProxy
com.ucompass.ucompos.sdk.proxycomponents UcompOSAIRProxy instances represent AIR Applications that are launched and quit by the UcompOS Main Container.
 UcompOSAlertProxy
com.ucompass.ucompos.sdk.proxycomponents Provides an API for the creation of Alert dialogues on the UcompOS Portal.
 UcompOSArtifactContainerProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSArtifactContainerProxy class is a Proxy Component that enables an UcompOSArtifactContainer instance to be added to the UcompOS Main Container via an SDK transaction.
 UcompOSArtifactProxy
com.ucompass.ucompos.sdk.proxycomponents UcompOSArtifactProxy enables for the implementation of an 'artifact' on the UcompOS Portal where the artifact can be an image or flash-based piece of content that can have specific behavior and functionality attached to it.
 UcompOSBrowserWindowProxy
com.ucompass.ucompos.sdk.proxycomponents UcompOSBrowserWindowProxy is a ProxyComponent that enables a player to spawn a new browser window off of the UcompOS Main Container and load content to said window.
 UcompOSDialogueProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSDialogueProxy is a class that enables virtual representations of UcompOSDialogue instances on the UcompOS Main Container.
 UcompOSDockProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSDockProxy class is a Singleton class that represents the application dock on the UcompOS Main Container.
 UcompOSGlobalManagerProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSGlobalManagerProxy class is designed to facilitate user session and global session settings on the UcompOS Main Container.
 UcompOSHTMLProxy
com.ucompass.ucompos.sdk.proxycomponents UcompOSHTMLProxy is a Proxy Component class that provides an interface to executing JavaScript in the HTML wrapper that the UcompOS Main Container is embedded into.
 UcompOSKeyboardProxy
com.ucompass.ucompos.sdk.proxycomponents Enables keyboard listeners to listen for keyboard events on the UcompOS Portal.
 UcompOSMenuBarProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSMenuBarProxy is a Singleton class that enables a player to manage the UcompOS Menu Bar on the UcompOS Main Container.
 UcompOSStyleProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSStyleProxy class is a Singleton class that provides a means to manage the style properties of the UcompOS Main Container as well as styles that can cascade to any WindowApplications loaded on the UcompOS Main Container.
 UcompOSWindowProxy
com.ucompass.ucompos.sdk.proxycomponents The UcompOSWindowProxy is a class that enables virtual representations of UcompOSWindow instances on the UcompOS Main Container to exist on an application or WindowApplication and to be manipulated and managed remotely.
 Utilities
com.ucompass.ucompos.sdk.utils This is a class of methods used by the UcompOS SDK.