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 

AuthStatus  - AS3 ADEP Security
Packagecom.adobe.livecycle.ria.security.api
Classpublic class AuthStatus
InheritanceAuthStatus Inheritance 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

Defines the constants for various types of authentication status.

Related API Elements

IAuthResult.status

Public Properties
 PropertyDefined By
 Inheritedconstructor : 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
Public Methods
 MethodDefined By
 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
  
toString():String
The String representation of an AuthStatus object.
AuthStatus
  
valueOf(value:String):AuthStatus
[static] A factory method that creates an AuthStatus object based on the string value.
AuthStatus
Public Constants
 ConstantDefined 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
Property Detail

value

property
value: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

A string value representing the AuthStatus value.



Implementation
    public function get value():String
Method Detail

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.

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

Returns
AuthStatus — AuthStatus Specifies the instance corresponding to the passed string value.
Constant Detail

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.




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

 

Legal Notices | Online Privacy Policy