ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
com.adobe.solutions.rca.domain.impl 

User  - AS3 Review, Commenting, and Approval

Paketcom.adobe.solutions.rca.domain.impl
Klassepublic class User
VererbungUser Inheritance Object
Implementiert IUser, IEventDispatcher

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10.0
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

This class defines an user.



Öffentliche Eigenschaften
 EigenschaftDefiniert von
  canonicalName : String
[schreibgeschützt] Canonical name for a user or a group, as defined in Document Server User Management.
User
  commonName : String
[schreibgeschützt] Common name of a user, as defined in Document Server User Management.
User
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  description : String
[schreibgeschützt] Description for a user.
User
  domainCommonName : String
[schreibgeschützt] Domain common name for a user.
User
  domainName : String
[schreibgeschützt] Domain name for a user.
User
  email : String
[schreibgeschützt] Email address of a user.
User
  familyName : String
[schreibgeschützt] Family name of a user.
User
  givenName : String
[schreibgeschützt] Given name of a user.
User
  initials : String
[schreibgeschützt] Initials of a user.
User
  oid : String
[schreibgeschützt] OID of a user or a group, as defined in Document Server User Management.
User
  org : String
[schreibgeschützt] Organisation name of a user.
User
  principalName : String
The principal name of a user.
User
  principalType : String
[schreibgeschützt] Principal type of a user, as defined in Document Server User Management.
User
  status : String
[schreibgeschützt] Status of a user.
User
  type : String
[schreibgeschützt] Type of a user.
User
  userid : String
[schreibgeschützt] 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
Öffentliche Methoden
 MethodeDefiniert von
  
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
  
Dispatches an event into the event flow.
User
  
Gets the principal for this tuple of domain name and canonical name.
User
  
Gets the principal for this principal name.
User
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
User
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
User
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
User
Eigenschaftendetails

canonicalName

Eigenschaft
canonicalName:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

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



Implementierung
    public function get canonicalName():String

commonName

Eigenschaft 
commonName:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

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



Implementierung
    public function get commonName():String

description

Eigenschaft 
description:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Description for a user.



Implementierung
    public function get description():String

domainCommonName

Eigenschaft 
domainCommonName:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Domain common name for a user.



Implementierung
    public function get domainCommonName():String

domainName

Eigenschaft 
domainName:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Domain name for a user.



Implementierung
    public function get domainName():String

email

Eigenschaft 
email:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Email address of a user.



Implementierung
    public function get email():String

familyName

Eigenschaft 
familyName:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Family name of a user.



Implementierung
    public function get familyName():String

givenName

Eigenschaft 
givenName:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Given name of a user.



Implementierung
    public function get givenName():String

initials

Eigenschaft 
initials:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Initials of a user.



Implementierung
    public function get initials():String

oid

Eigenschaft 
oid:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

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



Implementierung
    public function get oid():String

org

Eigenschaft 
org:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Organisation name of a user.



Implementierung
    public function get org():String

principalName

Eigenschaft 
principalName:String

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

The principal name of a user.



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

principalType

Eigenschaft 
principalType:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

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



Implementierung
    public function get principalType():String

status

Eigenschaft 
status:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Status of a user.



Implementierung
    public function get status():String

type

Eigenschaft 
type:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Type of a user.



Implementierung
    public function get type():String

userid

Eigenschaft 
userid:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Unique identifier of a user.



Implementierung
    public function get userid():String

userManager

Eigenschaft 
userManager:IUserManager

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

User manager service instance for a user.



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

vo

Eigenschaft 
vo:PrincipalVO

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

The value object for this user.



Implementierung
    public function get vo():PrincipalVO
    public function set vo(value:PrincipalVO):void
Konstruktordetails

User

()Konstruktor
public function User(principalName:String = null)

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10.0
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

The constructor for User class.

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

addEventListener

()Methode
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).

Parameter

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

()Methode 
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.

Parameter

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

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

getPrincipalByDomainNameCanonicalName

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

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

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

Parameter

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

()Methode 
public function getPrincipalByPrincipalName(principalName:String):void

Sprachversion: ActionScript 3.0
Produktversion: Baustein „Review, Commenting, and Approval“ 10
Laufzeitversionen: Flash Player 10.2, AIR (unsupported)

Gets the principal for this principal name.

Parameter

principalName:String — Principal name of a user.

hasEventListener

()Methode 
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.

Parameter

type:String — The type of event.

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

removeEventListener

()Methode 
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.

Parameter

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

()Methode 
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.

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.

Parameter

type:String — The type of event.

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




[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.