Packagecom.esri.tracking.connector.events
Classpublic dynamic class SymbolEvent
InheritanceSymbolEvent Inheritance flash.events.Event

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



Public Properties
 PropertyDefined By
  errorMessage : String
[read-only] The error message from a failed request.
SymbolEvent
  succeeded : Boolean
[read-only] Indicates whether the request was successful or not.
SymbolEvent
  symbol : TmsSymbol
[read-only] The symbol returned.
SymbolEvent
Public Methods
 MethodDefined By
  
SymbolEvent(type:String, succeeded:Boolean, symbol:TmsSymbol = null, errorMessage:String = null)
The constructor.
SymbolEvent
Public Constants
 ConstantDefined By
  SYMBOL_RESPONSE : String = symbolResponse
[static] Defines the value of the type property of an symbolResponse event.
SymbolEvent
Property Detail
errorMessageproperty
errorMessage:String  [read-only]

The error message from a failed request.


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

Indicates whether the request was successful or not.


Implementation
    public function get succeeded():Boolean
symbolproperty 
symbol:TmsSymbol  [read-only]

The symbol returned.


Implementation
    public function get symbol():TmsSymbol

See also

Constructor Detail
SymbolEvent()Constructor
public function SymbolEvent(type:String, succeeded:Boolean, symbol:TmsSymbol = null, errorMessage:String = null)

The constructor.

Parameters
type:String — The type of event.
 
succeeded:Boolean — Indicates success or failure.
 
symbol:TmsSymbol (default = null) — The symbol returned.
 
errorMessage:String (default = null) — Error message from a failed request.
Constant Detail
SYMBOL_RESPONSEConstant
public static const SYMBOL_RESPONSE:String = symbolResponse

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