ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.ria.security.service 

AuthResult  - AS3 ADEP Security
Packagecom.adobe.livecycle.ria.security.service
Classpublic class AuthResult
InheritanceAuthResult Inheritance 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

The 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
 PropertyDefined By
  authenticated : Boolean
[read-only] A flag that indicates whether the user authentication is complete.
AuthResult
 Inheritedconstructor : 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
  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
 MethodDefined By
  
AuthResult(status:AuthStatus, user:IUser = null, failureCode:String)
Constructor.
AuthResult
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():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():Boolean

failureCode

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():String

status

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():AuthStatus

user

property 
user:IUser  [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 current user instance when authentication is successful.



Implementation
    public function get user():IUser
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.

Parameters
status:AuthStatus — Specifies the authentication status.
 
user:IUser (default = null) — Specifies whether the user is associated with current result.
 
failureCode:String (default = NaN) — failureCode Specifies the code when authentication fails.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy