(Beta)
| Package | com.adobe.icc.services.user |
| Interface | public interface ISSOManager extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
UserEvent handlers prior
to calling any of the following operations.
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| assertionId : String [read-only]
Retrieves the assertionId for the user that is logged in. | ISSOManager | ||
| currentUser : User [read-only] Specifies the current logged in user. | ISSOManager | ||
| flexConfig : FlexConfiguration
Specifies the Flex configuration. | ISSOManager | ||
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Loads the user based on the session. | ISSOManager | ||
Authenticates the user using a username and password. | ISSOManager | ||
Terminates the current session and logs out the user. | ISSOManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Renews the session identifier of the current logged-in user. | ISSOManager | ||
Tries to validate whether the user already has an existing session. | ISSOManager | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Property Detail
assertionId | property |
currentUser | property |
currentUser:User [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the current logged in user.
This property can be used as the source for data binding. When this property is modified, it dispatches the currentUserChange event.
Implementation
public function get currentUser():UserflexConfig | property |
flexConfig:FlexConfiguration| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the Flex configuration.
Implementation
public function get flexConfig():FlexConfiguration public function set flexConfig(value:FlexConfiguration):voidMethod Detail
loadUser | () | method |
public function loadUser():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Loads the user based on the session. Generates one of the following events:
- UserEvent.LOAD_USER_COMPLETE - The
currentUserproperty is loaded with information on the user that established the session. - userLoadError (FaultEvent) - Failed to load user information.
login | () | method |
public function login(username:String, password:String, domain:String = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Authenticates the user using a username and password. It can generate one of the following events:
- UserEvent.AUTHENTICATION_SUCCESS - Authentication succeeded and a session is established.
- UserEvent.AUTHENTICATION_FAILED - Authentication failed.
Parameters
username:String — The username of the user to log in.
| |
password:String — The password of the user to log in.
| |
domain:String (default = null) |
logout | () | method |
public function logout():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Terminates the current session and logs out the user. Generates the following event:
- UserEvent.LOGOUT_COMPLETE - User session has been terminated.
renewSession | () | method |
public function renewSession():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Renews the session identifier of the current logged-in user. Generates one of the following events:
- UserEvent.RENEW_SESSION_COMPLETE - User session has been renewed.
- renewSessionError (FaultEvent) - Failed to renew session.
singleSignOn | () | method |
public function singleSignOn():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Tries to validate whether the user already has an existing session. The application can call this method during the initialization. In general, this call leads to the dispatch of one of the following events:
- UserEvent.AUTHENTICATION_SUCCESS - If a SSO session was found and is valid.
- UserEvent.AUTHENTICATION_REQUIRED - No SSO session was found. Authentication is required in the form of a username and password.
- UserEvent.AUTHENTICATION_FAILED - An error occurred while connecting to the server.
Wed Nov 21 2018, 06:34 AM -08:00