Packagecom.esri.tracking.connector.events
Classpublic class SetAOIEvent
InheritanceSetAOIEvent Inheritance flash.events.Event

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



Public Properties
 PropertyDefined By
  aoiType : SetAOIType
[read-only] The Area of Interset type.
SetAOIEvent
  aoiXML : String
[read-only] The Area of Interset in XML format.
SetAOIEvent
  errorMessage : String
[read-only] The error message from a failed request.
SetAOIEvent
  service : String
[read-only] The service name.
SetAOIEvent
  succeeded : Boolean
[read-only] Indicates whether the request was successful or not.
SetAOIEvent
Public Methods
 MethodDefined By
  
SetAOIEvent(type:String, succeeded:Boolean, service:String, aoiXML:String, aoiType:SetAOIType, errorMessage:String = null)
The constructor.
SetAOIEvent
Public Constants
 ConstantDefined By
  AOI_RESPONSE : String = aoiResponse
[static] Defines the value of the type property of an setAOIResponse event.
SetAOIEvent
Property Detail
aoiTypeproperty
aoiType:SetAOIType  [read-only]

The Area of Interset type.


Implementation
    public function get aoiType():SetAOIType
aoiXMLproperty 
aoiXML:String  [read-only]

The Area of Interset in XML format.


Implementation
    public function get aoiXML():String
errorMessageproperty 
errorMessage:String  [read-only]

The error message from a failed request.


Implementation
    public function get errorMessage():String
serviceproperty 
service:String  [read-only]

The service name.


Implementation
    public function get service():String
succeededproperty 
succeeded:Boolean  [read-only]

Indicates whether the request was successful or not.


Implementation
    public function get succeeded():Boolean
Constructor Detail
SetAOIEvent()Constructor
public function SetAOIEvent(type:String, succeeded:Boolean, service:String, aoiXML:String, aoiType:SetAOIType, errorMessage:String = null)

The constructor.

Parameters
type:String — The type of event.
 
succeeded:Boolean — Indicates success or failure.
 
service:String — Service name.
 
aoiXML:String — Area of Interset in XML format.
 
aoiType:SetAOIType — Area of Interset Type
 
errorMessage:String (default = null) — Error message from a failed request.
Constant Detail
AOI_RESPONSEConstant
public static const AOI_RESPONSE:String = aoiResponse

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