Packagecom.esri.tracking.connector.events
Classpublic class AuthenticateEvent
InheritanceAuthenticateEvent Inheritance flash.events.Event

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


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

The error message from a failed request.


Implementation
    public function get errorMessage():String
sessionIDproperty 
sessionID:int  [read-only]

The sessionID returned. On a failed request, this is -1.


Implementation
    public function get sessionID():int
succeededproperty 
succeeded:Boolean  [read-only]

Indicates whether the request was successful or not.


Implementation
    public function get succeeded():Boolean
Constructor Detail
AuthenticateEvent()Constructor
public function AuthenticateEvent(type:String, succeeded:Boolean, sessionID:int, errorMessage:String = null)

The constructor.

Parameters
type:String — The type of event.
 
succeeded:Boolean — Indicates success or failure.
 
sessionID:int — Session ID returned.
 
errorMessage:String (default = null) — Error message from a failed request.
Constant Detail
AUTHENTICATE_RESPONSEConstant
public static const AUTHENTICATE_RESPONSE:String = authenticateResponse

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





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