| Package | com.adobe.icc.services.user |
| Class | public class UserEvent |
| Inheritance | UserEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
| Property | Defined By | ||
|---|---|---|---|
 | 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 | ||
|---|---|---|---|
Constructor. | UserEvent | ||
[override]
Duplicates an instance of an Event subclass. | UserEvent | ||
|
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 = "authenticationFailed" [static]
This type of event would be dispatched when authentication fails using the username, password. | UserEvent | ||
| AUTHENTICATION_REQUIRED : String = "authenticationRequired" [static]
This type of event would be dispatched when authentication using SSO is not achieved. | UserEvent | ||
| AUTHENTICATION_SUCCESS : String = "authenticationSuccess" [static]
This type of event would be dispatched when the Authentication process is successful. | UserEvent | ||
| LOAD_USER_COMPLETE : String = "loadUserComplete" [static]
This type of event would be dispatched when load User is complete. | UserEvent | ||
| LOGOUT_COMPLETE : String = "logoutComplete" [static]
This type of event would be dispatched when logout is complete. | UserEvent | ||
| RENEW_SESSION_COMPLETE : String = "renewSessionComplete" [static]
This type of event would be dispatched when renew Session is complete. | UserEvent | ||
UserEvent | () | Constructor |
public function UserEvent(type:String)| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor. Accepts an event type and instantiates the corresponding UserEvent.
type:String — One of the event type constants.
|
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Duplicates an instance of an Event subclass.
Returns a new Event object that is a copy of the original instance of the Event object.
You do not normally call clone(); the EventDispatcher class calls it automatically
when you redispatch an event—that is, when you call dispatchEvent(event) from a handler
that is handling event.
The new Event object includes all the properties of the original.
When creating your own custom Event class, you must override the
inherited Event.clone() method in order for it to duplicate the
properties of your custom class. If you do not set all the properties that you add
in your event subclass, those properties will not have the correct values when listeners
handle the redispatched event.
In this example, PingEvent is a subclass of Event
and therefore implements its own version of clone().
class PingEvent extends Event {
var URL:String;
public override function clone():Event {
return new PingEvent(type, bubbles, cancelable, URL);
}
}
Event — A new Event object that is identical to the original.
|
AUTHENTICATION_FAILED | Constant |
public static const AUTHENTICATION_FAILED:String = "authenticationFailed"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This type of event would be dispatched when authentication fails using the username, 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 SSO case.
AUTHENTICATION_REQUIRED | Constant |
public static const AUTHENTICATION_REQUIRED:String = "authenticationRequired"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This type of event would be dispatched when authentication using SSO is not achieved. And due to that we require the user's username and password for authentication. As a response to this event the application can show the login page to the user.
AUTHENTICATION_SUCCESS | Constant |
public static const AUTHENTICATION_SUCCESS:String = "authenticationSuccess"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This type of event would be dispatched when the Authentication process is successful. Authentication might have been done with SSO or username and password. As a response to this event the application can show the welcome page to the user The application may want to perform specific check for permission/role so as to verify the user is allowed. So as a response to this event the application would do those checks and then only show the welcome page
LOAD_USER_COMPLETE | Constant |
public static const LOAD_USER_COMPLETE:String = "loadUserComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This type of event would be dispatched when load User is complete.
LOGOUT_COMPLETE | Constant |
public static const LOGOUT_COMPLETE:String = "logoutComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This type of event would be dispatched when logout is complete. As a response to this event the application may show a logout page informing the user that he has been logged out. Or the application can take the user back to login page
RENEW_SESSION_COMPLETE | Constant |
public static const RENEW_SESSION_COMPLETE:String = "renewSessionComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This type of event would be dispatched when renew Session is complete.
Thu Dec 4 2014, 05:50 PM -08:00