User - Adobe ActionScript® 3 (AS3 ADEP Workspace) API Reference

Package	lc.foundation.domain
Class	public class User
Inheritance	User Principal DomainObject Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The User class represents a user on the Document Server and is used to retrieve the properties of a specific user.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		address : String Deprecated Since Workspace 10: Please use the postalAddress property.	User
		businessCalendarKey : String The user's BusinessCalendarKey.	User
		canonicalName : String The user's canonical name.	Principal
		commonName : String The user's common (display) name.	Principal
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		description : String A description of the user.	Principal
		directGroupMemberships : ArrayCollection The groups to which a user directly belongs.	Principal
		disabled : Boolean The user's isDisabled value.	User
		displayName : String Deprecated Since Workspace 10: Please use the commonName property.	User
		domain : String The domain to which a user belongs.	User
		domainCommonName : String The user's common domain main.	Principal
		domainName : String The user directory's domain name for which the user is defined.	Principal
		email : String The email address of the user.	Principal
		emailAlias : Array The email address of the user.	User
		emailAliases : Array The email aliases for the user.	Principal
		familyName : String The family name of the user.	User
		firstName : String The first name of the user.	User
		givenName : String The given name of the user.	User
		groupMemberships : ArrayCollection All groups to which a user belongs.	Principal
		groups : Array Deprecated Since Workspace 10: Please use the groupMemberships property.	User
		initials : String The middle initial(s) of the user.	User
		isOutOfOffice : Boolean The out of office indicator for the user.	User
		lastName : String The last name of the user.	User
		local : Boolean The user's local value.	Principal
		locale : String The locale used by the user.	User
		locked : Boolean Specifies whether the user is locked.	Principal
		oid : String The unique identifier for the user called a object identifier.	Principal
		org : String The user's organization name.	Principal
		postalAddress : String The postal address of the user.	User
		principalType : String The user's common domain main.	Principal
		roleMembership : ArrayCollection The roles to which a user belongs.	Principal
		session : SessionMap [read-only] A SessionMap object that stores information relating to the server session.	DomainObject
		status : String The user's common domain main.	Principal
		system : Boolean A flag value that specifies whether the principal is a system principal.	Principal
		telephone : String Deprecated Since Workspace 10: Please use the telephoneNumber property.	User
		telephoneNumber : String The telephone number for the user.	User
		timezone : String The name of the time zone.	User
		timeZone : String The name of the time zone.	User
		userid : String The user's user ID.	User
		visibility : Number The user's visibility value.	Principal

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	Principal
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Principal
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Principal
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Principal
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	Principal

Property Detail

address

property

address:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Deprecated Since Workspace 10: Please use the postalAddress property.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get address():String
public function set address(value:String):void

businessCalendarKey

property

businessCalendarKey:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The user's BusinessCalendarKey.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get businessCalendarKey():String
public function set businessCalendarKey(value:String):void

disabled

property

disabled:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The user's isDisabled value.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

displayName

property

displayName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Deprecated Since Workspace 10: Please use the commonName property.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get displayName():String
public function set displayName(value:String):void

domain

property

domain:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The domain to which a user belongs.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get domain():String
public function set domain(value:String):void

emailAlias

property

emailAlias:Array

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.2

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The email address of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

familyName

property

familyName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The family name of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get familyName():String
public function set familyName(value:String):void

firstName

property

firstName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The first name of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get firstName():String
public function set firstName(value:String):void

givenName

property

givenName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The given name of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get givenName():String
public function set givenName(value:String):void

groups

property

groups:Array

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Deprecated Since Workspace 10: Please use the groupMemberships property. Replaced by groupMemberships.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

Related API Elements

lc.domain.Group

initials

property

initials:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The middle initial(s) of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get initials():String
public function set initials(value:String):void

isOutOfOffice

property

isOutOfOffice:Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.2

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The out of office indicator for the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

lastName

property

lastName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The last name of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get lastName():String
public function set lastName(value:String):void

locale

property

locale:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The locale used by the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get locale():String
public function set locale(value:String):void

postalAddress

property

postalAddress:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The postal address of the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get postalAddress():String
public function set postalAddress(value:String):void

telephone

property

telephone:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Deprecated Since Workspace 10: Please use the telephoneNumber property.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get telephone():String
public function set telephone(value:String):void

telephoneNumber

property

telephoneNumber:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The telephone number for the user.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get telephoneNumber():String
public function set telephoneNumber(value:String):void

timezone

property

timezone:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The name of the time zone.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get timezone():String
public function set timezone(value:String):void

timeZone

property

timeZone:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The name of the time zone.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get timeZone():String
public function set timeZone(value:String):void

userid

property

userid:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The user's user ID.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get userid():String
public function set userid(value:String):void

User - AS3 ADEP Workspace

Classes x

address

businessCalendarKey

disabled

displayName

domain

emailAlias

familyName

firstName

givenName

groups

initials

isOutOfOffice

lastName

locale

postalAddress

telephone

telephoneNumber

timezone

timeZone

userid

lc.foundation.domain User - AS3 ADEP Workspace		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples