| Package | com.adobe.livecycle.ria.security.api |
| Class | public class AuthenticationEvent |
| Inheritance | AuthenticationEvent  Event 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.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| authResult : IAuthResult [read-only]
The authentication result associated with the event. | AuthenticationEvent | ||
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
AuthenticationEvent(type:String, authResult:IAuthResult = null, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor. | AuthenticationEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined 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 | ||
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():IAuthResultAuthenticationEvent | () | 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.
type:String — Specifies the event type.
| |
authResult:IAuthResult (default = null)IAuthResult data related to the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) |
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.
Mon Apr 10 2017, 12:28 PM -07:00