ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.rca.domain 

IUser  - AS3 Review, Commenting, and Approval
Packagecom.adobe.solutions.rca.domain
Interfacepublic interface IUser
Implementors User

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines a user such as a project or an asset owner, a team member, or a stage participant.


Public Properties
 PropertyDefined By
  canonicalName : String
[read-only] Canonical name for a user or a group, as defined in Document Server User Management.
IUser
  commonName : String
[read-only] Common name of a user, as defined in Document Server User Management.
IUser
  description : String
[read-only] Description for a user.
IUser
  domainCommonName : String
[read-only] Domain common name for a user.
IUser
  domainName : String
[read-only] Domain name for a user.
IUser
  email : String
[read-only] Email address of a user.
IUser
  familyName : String
[read-only] Family name of a user.
IUser
  givenName : String
[read-only] Given name of a user.
IUser
  initials : String
[read-only] Initials of a user.
IUser
  oid : String
[read-only] OID of a user or a group, as defined in Document Server User Management.
IUser
  org : String
[read-only] Organisation name of a user.
IUser
  principalName : String
The principal name of a user.
IUser
  principalType : String
[read-only] Principal type of a user, as defined in Document Server User Management.
IUser
  status : String
[read-only] Status of a user.
IUser
  type : String
[read-only] Type of a user.
IUser
  userid : String
[read-only] Unique identifier of a user.
IUser
  userManager : IUserManager
User manager service instance for a user.
IUser
  vo : PrincipalVO
The value object for this user.
IUser
Public Methods
 MethodDefined By
  
getPrincipalByDomainNameCanonicalName(domainName:String, canonicalName:String):void
Gets the principal for this tuple of domain name and canonical name.
IUser
  
getPrincipalByPrincipalName(principalName:String):void
Gets the principal for this principal name.
IUser
Property Detail

canonicalName

property
canonicalName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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.0
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

Related API Elements

com.adobe.solutions.rca.service.IUserManager

vo

property 
vo:PrincipalVO

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
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
Method Detail

getPrincipalByDomainNameCanonicalName

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

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
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.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Gets the principal for this principal name.

Parameters

principalName:String — Principal name of a user.



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

 

Legal Notices | Online Privacy Policy