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 

User  - AS3 ADEP Security

Packagecom.adobe.livecycle.ria.security.service
Classpublic class User
InheritanceUser Inheritance Object
Implements IUser

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 User class provides read-access to the user's attributes, and offers basic support for authorization checking.



Public Properties
 PropertyDefined By
  anonymous : Boolean
A flag that indicates whether the current user is anonymous.
User
  attributes : Object
[read-only] The other attributes of the user depending on available details on the server-side.
User
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  displayName : String
[read-only] The name that can be used for display purposes.
User
  email : String
[read-only] The email address of the user.
User
  firstName : String
[read-only] The first name of the user.
User
  groups : Array
[read-only] The groups to which a user belongs.
User
  lastName : String
[read-only] The last name of the user.
User
  session : ISession
[read-only] The session associated with the current user.
User
  userid : String
[read-only] The user's user identifier (ID).
User
Public Methods
 MethodDefined By
  
User(session:ISession, attributes:Object)
Constructor.
User
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Determines whether the current user is member of given group.
User
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

anonymous

property
anonymous:Boolean

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 current user is anonymous.

It can be used to control display at time of startup when user identity is not determined.



Implementation
    public function get anonymous():Boolean
    public function set anonymous(value:Boolean):void

attributes

property 
attributes:Object  [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 other attributes of the user depending on available details on the server-side.



Implementation
    public function get attributes():Object

displayName

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

The name that can be used for display purposes.



Implementation
    public function get displayName():String

email

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

The email address of the user.



Implementation
    public function get email():String

firstName

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

The first name of the user.



Implementation
    public function get firstName():String

groups

property 
groups:Array  [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 groups to which a user belongs.

The returned Array object contains Group names. By default all the groups to which the user belongs are returned. However in some cases the group names might be filtered. For example if a group has property UIEnabled set to false then such a group would not be sent to client.



Implementation
    public function get groups():Array

lastName

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

The last name of the user.



Implementation
    public function get lastName():String

session

property 
session:ISession  [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 session associated with the current user.



Implementation
    public function get session():ISession

userid

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

The user's user identifier (ID).



Implementation
    public function get userid():String
Constructor Detail

User

()Constructor
public function User(session:ISession, attributes: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

Constructor.

Parameters
session:ISession — Specifies the session associated with this user instance.
 
attributes:Object — Specifies the attributes of the user.
Method Detail

isMemberOf

()method
public function isMemberOf(name:String):Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Security 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Determines whether the current user is member of given group.

Parameters

name:String — Specifies the name of the group for which check is performed.

Returns
Boolean — A boolean value. A value of true indicates that the user is member of passed group.