ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.ria.security.api 

AuthenticationEvent  - AS3 ADEP Security

Packagecom.adobe.livecycle.ria.security.api
Classpublic class AuthenticationEvent
InheritanceAuthenticationEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

AuthenticationEvent objects are dispatched by the ISecurityManager class when an authentication related operation is performed.



Public Properties
 PropertyDefined By
  authResult : IAuthResult
[read-only] The authentication result associated with the event.
AuthenticationEvent
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AuthenticationEvent(type:String, authResult:IAuthResult = null, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
AuthenticationEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  AUTHENTICATION_FAILED : String = "FAILED"
[static] A special value that indicates the type of event that is dispatched when authentication fails using the username and password.
AuthenticationEvent
  AUTHENTICATION_REQUIRED : String = "CREDENTIAL_CHALLENGE"
[static] A special value that indicates the type of event that is dispatched when authentication using single sign-on (SSO) fails.
AuthenticationEvent
  AUTHENTICATION_SUCCESS : String = "COMPLETE"
[static] A special value that indicates that the authentication process was successful.
AuthenticationEvent
  LOGOUT_COMPLETE : String = "LOGGED_OUT"
[static] A special value that indicates the type of event that is dispatched a user logs off.
AuthenticationEvent
Property Detail

authResult

property
authResult:IAuthResult  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The authentication result associated with the event. Depending on the event type, it can provide more details.



Implementation
    public function get authResult():IAuthResult
Constructor Detail

AuthenticationEvent

()Constructor
public function AuthenticationEvent(type:String, authResult:IAuthResult = null, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Constructor.

Creates a new AuthenticationEvent object. The appropriate dynamic properties are created depending on the event type specified.

Parameters
type:String — Specifies the event type.
 
authResult:IAuthResult (default = null) — Specifies the IAuthResult data related to the event.
 
bubbles:Boolean (default = false) — Specifies whether the event object participates in the bubbling stage of the event flow.
 
cancelable:Boolean (default = false) — Specifies whether the event object can be canceled.
Constant Detail

AUTHENTICATION_FAILED

Constant
public static const AUTHENTICATION_FAILED:String = "FAILED"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that indicates the type of event that is dispatched when authentication fails using the username and password. As a response to this type of event, an application can show an error message to the user. This event would only happen when authentication is done using username and password and NOT in single sign-on scenario.

AUTHENTICATION_REQUIRED

Constant 
public static const AUTHENTICATION_REQUIRED:String = "CREDENTIAL_CHALLENGE"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that indicates the type of event that is dispatched when authentication using single sign-on (SSO) fails. When SSO fails, the user's username and password is required for authentication. As a response to this event, an application can display the login page to the user.

AUTHENTICATION_SUCCESS

Constant 
public static const AUTHENTICATION_SUCCESS:String = "COMPLETE"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that indicates that the authentication process was successful. Authentication can be completed using single sign-on (SSO) or a username and password. As a response to this event the application can show the welcome page to the user. An application can validate for permissions and roles to further verify the user is allowed access. As a response to this event, an application would do complete the validation and then display the welcome page.

LOGOUT_COMPLETE

Constant 
public static const LOGOUT_COMPLETE:String = "LOGGED_OUT"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

A special value that indicates the type of event that is dispatched a user logs off. As a response to this event, an application can display the logout page. The logout page can inform the user that he has been logged out. Alternatively, an application can display the login page to the user.