User

Package	com.adobe.solutions.rca.domain.impl
Class	public class User
Inheritance	User Object
Implements	IUser, IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This class defines an user.

Public Properties

	Property		Defined By
		canonicalName : String [read-only] Canonical name for a user or a group, as defined in Document Server User Management.	User
		commonName : String [read-only] Common name of a user, as defined in Document Server User Management.	User
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		description : String [read-only] Description for a user.	User
		domainCommonName : String [read-only] Domain common name for a user.	User
		domainName : String [read-only] Domain name for a user.	User
		email : String [read-only] Email address of a user.	User
		familyName : String [read-only] Family name of a user.	User
		givenName : String [read-only] Given name of a user.	User
		initials : String [read-only] Initials of a user.	User
		oid : String [read-only] OID of a user or a group, as defined in Document Server User Management.	User
		org : String [read-only] Organisation name of a user.	User
		principalName : String The principal name of a user.	User
		principalType : String [read-only] Principal type of a user, as defined in Document Server User Management.	User
		status : String [read-only] Status of a user.	User
		type : String [read-only] Type of a user.	User
		userid : String [read-only] Unique identifier of a user.	User
		userManager : IUserManager User manager service instance for a user.	User
		vo : PrincipalVO The value object for this user.	User

Public Methods

	Method		Defined By
		User(principalName:String = null) The constructor for User class.	User
		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.	User
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	User
		getPrincipalByDomainNameCanonicalName(domainName:String, canonicalName:String):void Gets the principal for this tuple of domain name and canonical name.	User
		getPrincipalByPrincipalName(principalName:String):void Gets the principal for this principal name.	User
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	User
		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.	User
		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.	User

Property Detail

canonicalName

property

canonicalName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Canonical name for a user or a group, as defined in Document Server User Management.

Implementation
public function get canonicalName():String

commonName

property

commonName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Common name of a user, as defined in Document Server User Management.

Implementation
public function get commonName():String

description

property

description:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Description for a user.

Implementation
public function get description():String

domainCommonName

property

domainCommonName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Domain common name for a user.

Implementation
public function get domainCommonName():String

domainName

property

domainName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Domain name for a user.

Implementation
public function get domainName():String

email

property

email:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Email address of a user.

Implementation
public function get email():String

familyName

property

familyName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Family name of a user.

Implementation
public function get familyName():String

givenName

property

givenName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Given name of a user.

Implementation
public function get givenName():String

initials

property

initials:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Initials of a user.

Implementation
public function get initials():String

oid

property

oid:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

OID of a user or a group, as defined in Document Server User Management.

Implementation
public function get oid():String

org

property

org:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Organisation name of a user.

Implementation
public function get org():String

principalName

property

principalName:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The principal name of a user.

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

principalType

property

principalType:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Principal type of a user, as defined in Document Server User Management.

Implementation
public function get principalType():String

status

property

status:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Status of a user.

Implementation
public function get status():String

type

property

type:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Type of a user.

Implementation
public function get type():String

userid

property

userid:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Unique identifier of a user.

Implementation
public function get userid():String

userManager

property

userManager:IUserManager

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

User manager service instance for a user.

Implementation
public function get userManager():IUserManager
public function set userManager(value:IUserManager):void

vo

property

vo:PrincipalVO

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The value object for this user.

Implementation
public function get vo():PrincipalVO
public function set vo(value:PrincipalVO):void

Constructor Detail

User

()

Constructor

public function User(principalName:String = null)

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The constructor for User class.

Parameters

principalName:String (default = null) — User's principal name.

Method Detail

addEventListener

()

method

 public function 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. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

getPrincipalByDomainNameCanonicalName

()

method

public function getPrincipalByDomainNameCanonicalName(domainName:String, canonicalName:String):void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Gets the principal for this tuple of domain name and canonical name.

Parameters

	`domainName:String` — Domain name of the principal in Document Server User Management.

	`canonicalName:String` — Canonical name of the principal in Document Server User Management.

getPrincipalByPrincipalName

()

method

public function getPrincipalByPrincipalName(principalName:String):void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Gets the principal for this principal name.

Parameters

principalName:String — Principal name of a user.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

willTrigger

()

method

public function 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. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Legal Notices | Online Privacy Policy

User - AS3 Review, Commenting, and Approval

Classes x

canonicalName

commonName

description

domainCommonName

domainName

email

familyName

givenName

initials

oid

org

principalName

principalType

status

type

userid

userManager

vo

User

addEventListener

dispatchEvent

getPrincipalByDomainNameCanonicalName

getPrincipalByPrincipalName

hasEventListener

removeEventListener

willTrigger