| Package | com.adobe.livecycle.ria.security.service |
| Class | public class AuthResult |
| Inheritance | AuthResult  Object |
| Implements | IAuthResult |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
AuthResult object is returned as part of calls to perform Single Sign On (SSO) and login methods of
ISecurityManager service. Using the status property the further flow can be decided.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| authenticated : Boolean [read-only]
A flag that indicates whether the user authentication is complete. | AuthResult | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| failureCode : String [read-only]
In case of Authentication failure it would indicate the failure code. | AuthResult | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| status : AuthStatus [read-only]
The status of the authentication related call. | AuthResult | ||
| user : IUser [read-only]
The current user instance when authentication is successful. | AuthResult | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AuthResult | ||
|
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 | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
Property Detail
authenticated | property |
authenticated:Boolean [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 |
A flag that indicates whether the user authentication is complete.
Implementation
public function get authenticated():BooleanfailureCode | property |
failureCode:String [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 |
In case of Authentication failure it would indicate the failure code.
Implementation
public function get failureCode():Stringstatus | property |
status:AuthStatus [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 status of the authentication related call.
Implementation
public function get status():AuthStatususer | property |
Constructor Detail
AuthResult | () | Constructor |
public function AuthResult(status:AuthStatus, user:IUser = null, failureCode: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 |
Constructor.
Parametersstatus:AuthStatus — Specifies the authentication status.
| |
user:IUser (default = null) | |
failureCode:String (default = NaN) |
Mon Nov 28 2011, 06:48 AM -08:00