Package | com.adobe.csxs.events |
Class | public class CSXSEvent |
Inheritance | CSXSEvent ![]() |
CSXSInterface.addEventListener()
.
See also
Property | Defined by | ||
---|---|---|---|
appId : String [read-only]
Retrieves the unique identifier of the application from which this event was dispatched.
| CSXSEvent | ||
data : XML
Retrieves the XML payload of this event.
| CSXSEvent | ||
extensionId : String [read-only]
Retrieves the unique identifier of the extension from which this event was dispatched.
| CSXSEvent | ||
scope : String
Retrieves the scope of this event.
| CSXSEvent |
Method | Defined by | ||
---|---|---|---|
CSXSEvent(type:String, scope:String, data:XML = null)
Constructor.
| CSXSEvent | ||
clone():Event
Duplicates this event object.
| CSXSEvent |
Constant | Defined by | ||
---|---|---|---|
APP_OFFLINE : String [static] Type constant for the event sent when the host application has gone offline.
| CSXSEvent | ||
APP_ONLINE : String [static] Type constant for the event sent when the host application has gone online.
| CSXSEvent | ||
EXECUTABLE_EXIT : String [static] Type constant for the event sent when the executable is exited.
| CSXSEvent | ||
EXTENSION_LOADED : String [static] Type constant for the event sent when the extension has been loaded.
| CSXSEvent | ||
EXTENSION_UNLOADED : String [static] Type constant for the event sent when the extension has been unloaded.
| CSXSEvent | ||
GONE_ONLINE : String [static] Type constant for the event sent when a component has gone online.
| CSXSEvent | ||
USER_OFFLINE : String [static] Type constant for the event sent when the user has gone offline.
| CSXSEvent | ||
USER_ONLINE : String [static] Type constant for the event sent when the user has gone online.
| CSXSEvent |
appId | property |
appId:String
[read-only]Retrieves the unique identifier of the application from which this event was dispatched.
This property can be used as the source for data binding.
Implementation public function get appId():String
data | property |
data:XML
[read-write]Retrieves the XML payload of this event.
This property can be used as the source for data binding.
Implementation public function get data():XML
public function set data(value:XML):void
extensionId | property |
extensionId:String
[read-only]Retrieves the unique identifier of the extension from which this event was dispatched.
This property can be used as the source for data binding.
Implementation public function get extensionId():String
scope | property |
scope:String
[read-write]Retrieves the scope of this event. The scope determines which listeners receive notification of the CSXS event.
This property can be used as the source for data binding.
Implementation public function get scope():String
public function set scope(value:String):void
See also
CSXSEvent | () | constructor |
public function CSXSEvent(type:String, scope:String, data:XML = null)
Constructor. Creates an event object of a given type.
Parameterstype:String — The name of the event type.
|
|
scope:String — The scope of the event, "APPLICATION" or "GLOBAL".
|
|
data:XML (default = null )
|
See also
clone | () | method |
public override function clone():Event
Duplicates this event object.
See flash.events.Event
.
Event |
setAppId | () | method |
csxs_internal function setAppId(appId:String):void
Sets the application ID for this event. This method is declared to belong to the csxs_internal namespace, and shall not be accessed by extension developers. This appId property is set internally by the CSXS SWC when a CSXS event is dispatched.
ParametersappId:String |
setExtensionId | () | method |
csxs_internal function setExtensionId(extensionId:String):void
Setter of the extensionId property. This method is declared to belong to the csxs_internal namespace, and shall not be accessed by extension developers. This extensionId property is set internally by the CSXS SWC when a CSXS event is dispatched.
ParametersextensionId:String |
APP_OFFLINE | constant |
public static const APP_OFFLINE:String
Type constant for the event sent when the host application has gone offline.
APP_ONLINE | constant |
public static const APP_ONLINE:String
Type constant for the event sent when the host application has gone online.
EXECUTABLE_EXIT | constant |
public static const EXECUTABLE_EXIT:String
Type constant for the event sent when the executable is exited.
EXTENSION_LOADED | constant |
public static const EXTENSION_LOADED:String
Type constant for the event sent when the extension has been loaded. The loaded extension is part of the payload.
EXTENSION_UNLOADED | constant |
public static const EXTENSION_UNLOADED:String
Type constant for the event sent when the extension has been unloaded. The unloaded extension is part of the payload.
GONE_ONLINE | constant |
public static const GONE_ONLINE:String
Type constant for the event sent when a component has gone online.
USER_OFFLINE | constant |
public static const USER_OFFLINE:String
Type constant for the event sent when the user has gone offline.
USER_ONLINE | constant |
public static const USER_ONLINE:String
Type constant for the event sent when the user has gone online.