Packagecom.esri.tracking.connector.events
Classpublic class SubscribeEvent
InheritanceSubscribeEvent Inheritance flash.events.Event

Represents event objects dispatched when a response to a subscribe request is received.


Public Properties
 PropertyDefined By
  errorMessage : String
[read-only] The error message from a failed request.
SubscribeEvent
  serviceNames : Array
[read-only] The Array of service names associated with this response.
SubscribeEvent
  succeeded : Boolean
[read-only] Indicates whether the request was successful or not.
SubscribeEvent
Public Methods
 MethodDefined By
  
SubscribeEvent(type:String, succeeded:Boolean, serviceNames:Array, errorMessage:String = null)
The constructor.
SubscribeEvent
Public Constants
 ConstantDefined By
  SUBSCRIBE_RESPONSE : String = subscribeResponse
[static] Defines the value of the type property of an subscribeResponse event.
SubscribeEvent
Property Detail
errorMessageproperty
errorMessage:String  [read-only]

The error message from a failed request.


Implementation
    public function get errorMessage():String
serviceNamesproperty 
serviceNames:Array  [read-only]

The Array of service names associated with this response.


Implementation
    public function get serviceNames():Array
succeededproperty 
succeeded:Boolean  [read-only]

Indicates whether the request was successful or not.


Implementation
    public function get succeeded():Boolean
Constructor Detail
SubscribeEvent()Constructor
public function SubscribeEvent(type:String, succeeded:Boolean, serviceNames:Array, errorMessage:String = null)

The constructor.

Parameters
type:String — The type of event.
 
succeeded:Boolean — Indicates success or failure.
 
serviceNames:Array — The Array of service names associated with this response.
 
errorMessage:String (default = null) — Error message from a failed request.
Constant Detail
SUBSCRIBE_RESPONSEConstant
public static const SUBSCRIBE_RESPONSE:String = subscribeResponse

Defines the value of the type property of an subscribeResponse event.





Thu Apr 5 2012, 09:40 AM -07:00