| Package | com.adobe.livecycle.ria.security.service |
| Class | public class User |
| Inheritance | User  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 |
User class provides read-access to the user's attributes, and offers basic support for authorization checking.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined 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 | ||
 | constructor : 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 | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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
| Method | Defined By | ||
|---|---|---|---|
Constructor. | User | ||
|
Indicates whether an object has a specified property defined. | Object | |
Determines whether the current user is member of given group. | User | ||
|
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
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):voidattributes | 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():ObjectdisplayName | property |
| property |
firstName | property |
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():ArraylastName | property |
session | property |
userid | property |
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.
Parameterssession: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.
|
Boolean — A boolean value. A value of true indicates that the user is member of passed group.
|
Mon Nov 28 2011, 06:48 AM -08:00