com.adobe.solutions.rca.domain

# IParticipant - AS3 Review, Commenting, and Approval

Package | com.adobe.solutions.rca.domain
Interface | public interface IParticipant extends IMember
Implementors | Participant

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 participant in review. A participant can be an initiator, a reviewer, a moderator, or an approver.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | additionalMetadata : String This property can be used to store additional metadata, while extending the application. | IParticipant
|  | assignedTo : IMemberCollection [read-only] Reference to the member collection to which this member is assigned. | IMember
|  | canonicalName : String [read-only] CanonicalName of the member as defined in Document Server User Management. | IMember
|  | completedBy : String This property stores the reference to the user who completed the task assigned to a participant. | IParticipant
|  | completedFromIP : String This property holds the IP from which a task assigned to a participant is completed. | IParticipant
|  | disposition : String Current disposition of a participant, if any. | IParticipant
|  | domainName : String [read-only] Domain name of the member as defined in Document Server User Management. | IMember
|  | email : String [read-only] Email of the member. | IMember
|  | finalComments : String The final comments made by the participant after reviewing or approving a document. | IParticipant
|  | id : String [read-only] Unique identifier for a participant. | IParticipant
|  | name : String [read-only] Name of the member. | IMember
|  | reviewContext : IReviewContext The details of the review version of which a participant is a part. | IParticipant
|  | role : String [read-only] Role of the member in the workflow. | IMember
|  | status : String Current status of a participant. | IParticipant
|  | title : String [read-only] Title of the member in the workflow. | IMember
|  | user : IUser The user object for a participant. | IParticipant
|  | vo : ParticipantVO The Value Object for a participant. | IParticipant

Property Detail

### additionalMetadata

property

`additionalMetadata:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This property can be used to store additional metadata, while extending the application.

Implementation
`public function get additionalMetadata():String`
`public function set additionalMetadata(value:String):void`

### completedBy

property

`completedBy:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This property stores the reference to the user who completed the task assigned to a participant.

Implementation
`public function get completedBy():String`
`public function set completedBy(value:String):void`

### completedFromIP

property

`completedFromIP:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This property holds the IP from which a task assigned to a participant is completed.

Implementation
`public function get completedFromIP():String`
`public function set completedFromIP(value:String):void`

### disposition

property

`disposition:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Current disposition of a participant, if any.

Implementation
`public function get disposition():String`
`public function set disposition(value:String):void`

### finalComments

property

`finalComments: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 final comments made by the participant after reviewing or approving a document.

Implementation
`public function get finalComments():String`
`public function set finalComments(value:String):void`

### id

property

`id: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 for a participant.

Implementation
`public function get id():String`

### reviewContext

property

`reviewContext:IReviewContext`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

The details of the review version of which a participant is a part.

Implementation
`public function get reviewContext():IReviewContext`
`public function set reviewContext(value:IReviewContext):void`

### status

property

`status:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Current status of a participant.

Implementation
`public function get status():String`
`public function set status(value:String):void`

### user

property

`user:IUser`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

The user object for a participant.

Implementation
`public function get user():IUser`
`public function set user(value:IUser):void`

Related API Elements

IUser

### vo

property

`vo:ParticipantVO`

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 a participant.

Implementation
`public function get vo():ParticipantVO`
`public function set vo(value:ParticipantVO):void`

Related API Elements

ParticipantVO

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00