| Package | com.adobe.livecycle.ria.security.api |
| Class | public class AuthStatus |
| Inheritance | AuthStatus  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 |
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| value : String [read-only]
A string value representing the AuthStatus value. | AuthStatus | ||
| Method | Defined By | ||
|---|---|---|---|
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
The String representation of an AuthStatus object. | AuthStatus | ||
[static]
A factory method that creates an AuthStatus object based on the string value. | AuthStatus | ||
| Constant | Defined By | ||
|---|---|---|---|
| AUTHENTICATION_FAILED : AuthStatus [static]
A special value that indicates the type of event dispatched when authentication fails using the username and password. | AuthStatus | ||
| AUTHENTICATION_REQUIRED : AuthStatus [static]
A special value that indicates the type of event that is dispatched when authentication using single sign-on (SSO) fails. | AuthStatus | ||
| AUTHENTICATION_SUCCESS : AuthStatus [static]
A special value that indicates that the authentication process was successful. | AuthStatus | ||
| LOGOUT_COMPLETE : AuthStatus [static]
A special value that indicates the type of event is dispatched when a user logs off. | AuthStatus | ||
value | property |
toString | () | method |
public function toString():String| 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 String representation of an AuthStatus object.
String — An authStatus value as a string value.
|
valueOf | () | method |
public static function valueOf(value:String):AuthStatus| 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 factory method that creates an AuthStatus object based on the string value.
Parameters
value:String — Specifies the status value as a string value.
|
AuthStatus — AuthStatus Specifies the instance corresponding to the passed string value.
|
AUTHENTICATION_FAILED | Constant |
public static const AUTHENTICATION_FAILED:AuthStatus| 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 dispatched when authentication fails using the username and password. As a response to this type of event, an application can display an error message to the user. This event only occurs when authentication is attempted using a username and password. This event does not occur when single sign-on is used..
AUTHENTICATION_REQUIRED | Constant |
public static const AUTHENTICATION_REQUIRED:AuthStatus| 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 to authenticate. As a response to this event, the application can display a login page to the user.
AUTHENTICATION_SUCCESS | Constant |
public static const AUTHENTICATION_SUCCESS:AuthStatus| 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 using a username and password. As a response to this event, an application can display the welcome page to the user. Application can perform specific validation for permissions and roles to verify the user has access. In a response to this event, the application completes the user validation, and then display the welcome page.
LOGOUT_COMPLETE | Constant |
public static const LOGOUT_COMPLETE:AuthStatus| 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 is dispatched when a user logs off. As a response to this event, ab application can display logout page to inform the user that he has been logged out. Alternatively, the application can display the login page.
Thu Dec 6 2018, 01:12 PM -08:00