| Package | com.adobe.livecycle.ria.security.api |
| Interface | public interface IUser |
| Implementors | User |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
IUser interface provides read-access to a user's attributes,
and offers basic support for authorization checking.
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| anonymous : Boolean [read-only]
A flag that indicates whether the current user is anonymous. | IUser | ||
| attributes : Object [read-only]
The other attributes of the user depending on available details on the server-side. | IUser | ||
| displayName : String [read-only]
The name that can be used for display purposes. | IUser | ||
| email : String [read-only]
The email address of the user. | IUser | ||
| firstName : String [read-only]
The first name of the user. | IUser | ||
| groups : Array [read-only]
The groups to which a user belongs. | IUser | ||
| lastName : String [read-only]
The last name of the user. | IUser | ||
| session : ISession [read-only]
The session associated with the current user. | IUser | ||
| userid : String [read-only]
The user's user identifier (ID). | IUser | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Determines whether the current user is member of given group. | IUser | ||
Property Detail
anonymous | property |
anonymous: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 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():Booleanattributes | 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 |
Method Detail
isMemberOf | () | method |
public function isMemberOf(groupName: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
groupName: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