Packagelc.domain
Classpublic class User
InheritanceUser Inheritance Object
Implements IWorkspaceManaged

The User class represents a user in LiveCycle ES and is used to retrieve the properties of a specific user.


Public Properties
 PropertyDefined By
  address : String
The address of the user.
User
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
A description of the user.
User
  displayName : String
The name that can be used for display purposes.
User
  domain : String
The domain to which a user belongs.
User
  email : String
The email address of the user.
User
  emailAliases : Array
The additional email aliases for the user, in addition to the main email address contained in the email property.
User
  firstName : String
The first name of the user.
User
  groups : Array
The groups to which a user belongs.
User
  initials : String
The middle initial(s) of the user.
User
  lastName : String
The last name of the user.
User
  locale : Locale
The locale used by the user.
User
  oid : String
The unique identifier for the user.
User
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  session : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
User
  telephone : String
The telephone number for the user.
User
  timezone : String
The name of the time zone.
User
  userid : String
The user's user ID.
User
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
  
setSession(session:SessionMap):void
Sets a SessionMap object that stores the information relating to the server session.
User
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
addressproperty
address:String  [read-write]

The address of the user.


Implementation
    public function get address():String
    public function set address(value:String):void
descriptionproperty 
description:String  [read-write]

A description of the user.


Implementation
    public function get description():String
    public function set description(value:String):void
displayNameproperty 
displayName:String  [read-write]

The name that can be used for display purposes.


Implementation
    public function get displayName():String
    public function set displayName(value:String):void
domainproperty 
domain:String  [read-write]

The domain to which a user belongs.


Implementation
    public function get domain():String
    public function set domain(value:String):void
emailproperty 
email:String  [read-write]

The email address of the user.


Implementation
    public function get email():String
    public function set email(value:String):void
emailAliasesproperty 
emailAliases:Array  [read-write]

The additional email aliases for the user, in addition to the main email address contained in the email property.


Implementation
    public function get emailAliases():Array
    public function set emailAliases(value:Array):void
firstNameproperty 
firstName:String  [read-write]

The first name of the user.


Implementation
    public function get firstName():String
    public function set firstName(value:String):void
groupsproperty 
groups:Array  [read-write]

The groups to which a user belongs. The returned Array object contains Group objects.


Implementation
    public function get groups():Array
    public function set groups(value:Array):void

See also

lc.domain.Group
initialsproperty 
initials:String  [read-write]

The middle initial(s) of the user.


Implementation
    public function get initials():String
    public function set initials(value:String):void
lastNameproperty 
lastName:String  [read-write]

The last name of the user.


Implementation
    public function get lastName():String
    public function set lastName(value:String):void
localeproperty 
locale:Locale  [read-write]

The locale used by the user.


Implementation
    public function get locale():Locale
    public function set locale(value:Locale):void
oidproperty 
oid:String  [read-write]

The unique identifier for the user.


Implementation
    public function get oid():String
    public function set oid(value:String):void
sessionproperty 
session:SessionMap  [read-only]

A SessionMap object that stores information relating to the server session.


Implementation
    public function get session():SessionMap
telephoneproperty 
telephone:String  [read-write]

The telephone number for the user.


Implementation
    public function get telephone():String
    public function set telephone(value:String):void
timezoneproperty 
timezone:String  [read-write]

The name of the time zone.


Implementation
    public function get timezone():String
    public function set timezone(value:String):void
useridproperty 
userid:String  [read-write]

The user's user ID.


Implementation
    public function get userid():String
    public function set userid(value:String):void
Method Detail
setSession()method
public function setSession(session:SessionMap):void

Sets a SessionMap object that stores the information relating to the server session.

Parameters

session:SessionMap — Specifies the information relating to the server session.




© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/domain/User.html