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 

IUser  - AS3 ADEP Security
Packagecom.adobe.livecycle.ria.security.api
Interfacepublic 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

The IUser interface provides read-access to a user's attributes, and offers basic support for authorization checking.


Public Properties
 PropertyDefined 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
 MethodDefined By
  
isMemberOf(groupName:String):Boolean
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():Boolean

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

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



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

 

Legal Notices | Online Privacy Policy