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.api 

IAuthResult  - AS3 ADEP Security
Packagecom.adobe.livecycle.ria.security.api
Interfacepublic interface IAuthResult
Implementors AuthResult

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.
IAuthResult
  failureCode : String
[read-only] In case of Authentication failure it would indicate the failure code.
IAuthResult
  status : AuthStatus
[read-only] The status of the authentication related call.
IAuthResult
  user : IUser
[read-only] The current user instance when authentication is successful.
IAuthResult
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

Related API Elements

AuthFailureCode.TOKEN_EXPIRED
AuthFailureCode.WRONG_CREDENTIALS

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



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

 

Legal Notices | Online Privacy Policy