| Package | com.adobe.livecycle.rca.service.core.delegate |
| Class | public class ReviewCommentingAndApprovalService |
| Inheritance | ReviewCommentingAndApprovalService  ServiceDelegate Object |
| Implements | IReviewCommentingAndApprovalService |
| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Hide Inherited Public Properties
Show Inherited Public Properties| Method | Defined By | ||
|---|---|---|---|
ReviewCommentingAndApprovalService(channelSet:ChannelSet)
Review Commenting amd Approval Core service. | ReviewCommentingAndApprovalService | ||
addApprover(reviewId:String, stageNo:int, domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken
Adds an approver to an approval stage of an ongoing review. | ReviewCommentingAndApprovalService | ||
addReviewer(reviewId:String, stageNo:int, domain:String, canonicalName:String, isOptional:Boolean = false):com.adobe.livecycle.rca.token:IAsyncToken
Adds a reviewer to a stage of an ongoing review. | ReviewCommentingAndApprovalService | ||
This operation permanently deletes a review template. | ReviewCommentingAndApprovalService | ||
getDocument(reviewId:String, revision:int, documentPath:String):com.adobe.livecycle.rca.token:IAsyncToken
Retrieves a document from the review zone. | ReviewCommentingAndApprovalService | ||
Gets the context of a review for a specified revision. | ReviewCommentingAndApprovalService | ||
Returns the original document, which is the document that was submitted for review when the review was initiated. | ReviewCommentingAndApprovalService | ||
getReviewStageDocument(reviewId:String, revision:int, stageNo:int):com.adobe.livecycle.rca.token:IAsyncToken
Returns the review document for a particular stage in a review. | ReviewCommentingAndApprovalService | ||
Retrieves a review template. | ReviewCommentingAndApprovalService | ||
This operation is the second level of the search API. | ReviewCommentingAndApprovalService | ||
Retrieves the preferences of a user. | ReviewCommentingAndApprovalService | ||
 |
Indicates whether an object has a specified property defined. | Object | |
initiateReview(reviewContext:ReviewContext, reviewDocument:DocumentReference, supportingDocs:ArrayCollection = null):com.adobe.livecycle.rca.token:IAsyncToken
Initiates a review based on a specified review context. | ReviewCommentingAndApprovalService | ||
initiateReviewLongLived(reviewContext:ReviewContext, reviewDocument:DocumentReference, supportingDocs:ArrayCollection = null):com.adobe.livecycle.rca.token:IAsyncToken
Initiates a review based on a review context. | ReviewCommentingAndApprovalService | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
purgeReviews(listOfReviewIDs:Array, clearReviewZone:Boolean = false):com.adobe.livecycle.rca.token:IAsyncToken
Purges the review data using a specified list of review IDs. | ReviewCommentingAndApprovalService | ||
removeApprover(reviewId:String, stageNo:int, domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken
Removes an approver from an approval stage of an ongoing review. | ReviewCommentingAndApprovalService | ||
removeReviewer(reviewId:String, stageNo:int, domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken
Removes a reviewer from a stage of an ongoing review. | ReviewCommentingAndApprovalService | ||
This operation retrieves the audit configuration for the Review Commenting and Approval building block. | ReviewCommentingAndApprovalService | ||
reviseReview(reviewId:String, stageNo:int, reviewDocument:DocumentReference, changeDescription:String):com.adobe.livecycle.rca.token:IAsyncToken
Revises either all or part of a review. | ReviewCommentingAndApprovalService | ||
Revokes an ongoing review. | ReviewCommentingAndApprovalService | ||
This operation searches the Review Commenting and Approval building block for reviews using a search filter. | ReviewCommentingAndApprovalService | ||
searchReviewTemplates(templateSearchFilter:com.adobe.livecycle.rca.model:TemplateSearchFilter):com.adobe.livecycle.rca.token:IAsyncToken
This operation searches for review templates in the system. | ReviewCommentingAndApprovalService | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
setUserPreference(domain:String, canonicalName:String, userPreference:UserPreference):com.adobe.livecycle.rca.token:IAsyncToken
Saves the user preferences. | ReviewCommentingAndApprovalService | ||
storeReviewTemplate(reviewContext:ReviewContext, supportingDocList:Array = null, overWrite:Boolean = true):com.adobe.livecycle.rca.token:IAsyncToken
Stores a review template in the storage space provided by the Review Zone Provider service. | ReviewCommentingAndApprovalService | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
updateCustomAttributes(reviewId:String, revision:int, customAttributes:ArrayCollection, discardOld:Boolean = false):com.adobe.livecycle.rca.token:IAsyncToken
Updates the custom attributes of a review that can be searched. | ReviewCommentingAndApprovalService | ||
updateReviewStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String = "DAYS"):com.adobe.livecycle.rca.token:IAsyncToken
Updates the duration of an ongoing or future review stage. | ReviewCommentingAndApprovalService | ||
|
Returns the primitive value of the specified object. | Object | |
ReviewCommentingAndApprovalService | () | Constructor |
public function ReviewCommentingAndApprovalService(channelSet:ChannelSet)| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Review Commenting amd Approval Core service.
ParameterschannelSet:ChannelSet — The set of channels used for Adobe Flex remoting calls.
|
addApprover | () | method |
public function addApprover(reviewId:String, stageNo:int, domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Adds an approver to an approval stage of an ongoing review. The approver is identified by domain name and canonical name.
Parameters
reviewId:String — The unique identifier of the review to add a new approver to. This operation works on the current revision of a review only.
| |
stageNo:int — Stage number to add the approver to. Initial value is 1.
| |
domain:String — Adobe User Management domain of the approver to add.
| |
canonicalName:String — Adobe User Management canonical name of the approver to add.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent to detect if the
call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
addReviewer | () | method |
public function addReviewer(reviewId:String, stageNo:int, domain:String, canonicalName:String, isOptional:Boolean = false):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Adds a reviewer to a stage of an ongoing review. The reviewer is identified by domain name and canonical name.
Parameters
reviewId:String — The unique identifier of the review process to add a new reviewer to. This operation works on the current revision of the review only.
| |
stageNo:int — The number of the review stage to add the reviewer to. Initial value is 1.
| |
domain:String — Adobe User Management domain of the reviewer to add.
| |
canonicalName:String — Adobe User Management canonical name of the reviewer to add.
| |
isOptional:Boolean (default = false)true, the added reviewer is an optional reviewer.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent to detect if
the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
deleteReviewTemplate | () | method |
public function deleteReviewTemplate(templateName:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
This operation permanently deletes a review template.
That is, the template cannot be used to initiate reviews in the system. Also, any ongoing review that was initiated using
this template may fail and is not supported.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.success.
The response is true if the operation is successful. If it not successful, it is false.
Parameters
templateName:String — Name of the review template to delete.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the success flag from the ResultEvent object.
For example, use event.result.success.
|
getDocument | () | method |
public function getDocument(reviewId:String, revision:int, documentPath:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Retrieves a document from the review zone.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.document.
The response is a DocumentReference object.
Parameters
reviewId:String — The unique identifier of the review.
| |
revision:int — The revision number of the review.
| |
documentPath:String — The path of the document to retrieve. It begins with a forward slash, that is, "/", and uses UNIX format.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the success flag from the ResultEvent object.
For example, use event.result.success.
|
getReviewContext | () | method |
public function getReviewContext(reviewId:String, revision:int):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Gets the context of a review for a specified revision. The context specifies the basic structure of the review.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewContext.
The response is a ReviewContext object.
Parameters
reviewId:String — The unique identifier of the review.
| |
revision:int — The revision number of the review.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the ReviewContext
object from ResultEvent. For example, use event.result.reviewContext.
|
getReviewDocument | () | method |
public function getReviewDocument(reviewId:String, revision:int):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Returns the original document, which is the document that was submitted for review when the review was initiated.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewDocument.
The response is a DocumentReference object.
Parameters
reviewId:String — The unique identifier of the review.
| |
revision:int — The revision number of the review.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. You can extract the DocumentReference
object from ResultEvent. For example, use event.result.reviewDocument.
|
getReviewStageDocument | () | method |
public function getReviewStageDocument(reviewId:String, revision:int, stageNo:int):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Returns the review document for a particular stage in a review.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewStageDocument.
The response is a DocumentReference object.
Parameters
reviewId:String — The unique identifier of the review to which the review document and stage belong.
| |
revision:int — The revision number of the review to which the review document and stage belong.
| |
stageNo:int — The number of the stage of the review to which the review document belongs.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the DocumentReference
object from ResultEvent. For example, use event.result.reviewStageDocument.
|
getReviewTemplate | () | method |
public function getReviewTemplate(templateName:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Retrieves a review template.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewTemplate.
The response is a ReviewContext object.
Parameters
templateName:String — Name of the review template to retrieve.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. You can extract the ReviewContext
object from ResultEvent. For example, use event.result.reviewTemplate.
|
getRevisions | () | method |
public function getRevisions(reviewId:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
This operation is the second level of the search API. It returns the details of a single review.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewList.
The response is a Review object that contains all the revisions for a specified review ID.
Parameters
reviewId:String — The unique identifier of the review process.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the Review
object from ResultEvent. For example, use event.result.review.
|
getUserPreference | () | method |
public function getUserPreference(domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Retrieves the preferences of a user. The user is identified by its domain name and canonical name.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.userPreference.
The response is a UserPreference object.
Parameters
domain:String — Adobe User Management domain of the user.
| |
canonicalName:String — Adobe User Management canonical name of the user.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the UserPreference
object from ResultEvent. For example, use event.result.userPreference.
|
initiateReview | () | method |
public function initiateReview(reviewContext:ReviewContext, reviewDocument:DocumentReference, supportingDocs:ArrayCollection = null):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Initiates a review based on a specified review context.
The review ID of the review that is initiated can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewId.
Parameters
reviewContext:ReviewContext — The review context object.
| |
reviewDocument:DocumentReference — The document to review.
| |
supportingDocs:ArrayCollection (default = null) |
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. Add a listener for ResultEvent to detect
if the call to the server is successful. The value of event.result.reviewId holds the identifier for the review.
|
initiateReviewLongLived | () | method |
public function initiateReviewLongLived(reviewContext:ReviewContext, reviewDocument:DocumentReference, supportingDocs:ArrayCollection = null):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Initiates a review based on a review context. To initiate the review, call a long-lived operation and include the context as a parameter. This is an asynchronous invocation. The response is the invocation ID only. The invocation ID of the process can be extracted from ResultEvent using a result handler or responder.
Parameters
reviewContext:ReviewContext — Review context object.
| |
reviewDocument:DocumentReference — Document for review.
| |
supportingDocs:ArrayCollection (default = null) |
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. Add a listener for ResultEvent to detect
if the call to the server is successful. The value of event.result holds the identifer for the invocation.
|
purgeReviews | () | method |
public function purgeReviews(listOfReviewIDs:Array, clearReviewZone:Boolean = false):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Purges the review data using a specified list of review IDs. Only a user who is assigned the
Review Commenting and Approval administrator role can call this API.
If this API fails to purge any review with a particular review ID, a warning is printed in server logs and the API returns a list of
the review IDs that were not purged.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.listOfFailedReviewIDs.
The response is a collection of strings.
Parameters
listOfReviewIDs:Array — List of review IDs.
| |
clearReviewZone:Boolean (default = false) |
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the list of review identifiers
that could not be purged from ResultEvent. For example, use event.result.listOfFailedReviewIDs.
|
removeApprover | () | method |
public function removeApprover(reviewId:String, stageNo:int, domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Removes an approver from an approval stage of an ongoing review. The approver is identified by domain name and canonical name.
Parameters
reviewId:String — The unique identifier of the review to add a new approver to. This operation works on the current revision of a review only.
| |
stageNo:int — Number of the review stage to add the new approver to. Initial value is 1.
| |
domain:String — Adobe User Management domain of the approver to add.
| |
canonicalName:String — Adobe User Management canonical name of the approver to add.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
removeReviewer | () | method |
public function removeReviewer(reviewId:String, stageNo:int, domain:String, canonicalName:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Removes a reviewer from a stage of an ongoing review. The reviewer is identified by domain name and canonical name.
Parameters
reviewId:String — The unique identifier of the review to remove the reviewer from.This operation works on the current revision of the review only.
| |
stageNo:int — The number of the review stage to remove the reviewer from. Initial value is 1.
| |
domain:String — Adobe User Management domain of the reviewer to remove.
| |
canonicalName:String — Adobe User Management canonical name of the reviewer to remove.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
retrieveAuditConfig | () | method |
public function retrieveAuditConfig():com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
This operation retrieves the audit configuration for the Review Commenting and Approval building block.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.auditLevelList.
The response is a collection of AuditLevel objects.
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract the collection of audit levels
from ResultEvent. For example, use event.result.auditLevelList.
|
reviseReview | () | method |
public function reviseReview(reviewId:String, stageNo:int, reviewDocument:DocumentReference, changeDescription:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Revises either all or part of a review.
Parameters
reviewId:String — The unique identifier of the review.
| |
stageNo:int — The number of the review stage where the revision starts. The initial value is 1. If blank, the entire review is revised.
| |
reviewDocument:DocumentReference — The document to use as the review document for the revised review.
| |
changeDescription:String — Text that describes how the review has changed or the reason for the revision.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
revokeReview | () | method |
public function revokeReview(reviewId:String):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Revokes an ongoing review. It also recalls all the Workspace tasks for this review. For example, it recalls all review and approval tasks.
Parameters
reviewId:String — The unique identifier of the review.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
searchReviews | () | method |
public function searchReviews(reviewSearchFilter:ReviewSearchFilter):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
This operation searches the Review Commenting and Approval building block for reviews using a search filter.
The filter is an object of type com.adobe.livecycle.rca.model.ReviewSearchFilter.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.reviewList.
The response is a collection of review objects that meet the criteria that are specified in the search filter.
Parameters
reviewSearchFilter:ReviewSearchFilter — An object of type com.adobe.livecycle.rca.model.ReviewSearchFilter.
It filters the results of a search based on the attributes that are set in the object.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. You can extract a collection of Review
objects from ResultEvent. For example, use event.result.reviewList.
|
searchReviewTemplates | () | method |
public function searchReviewTemplates(templateSearchFilter:com.adobe.livecycle.rca.model:TemplateSearchFilter):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
This operation searches for review templates in the system. It returns a list of template objects.
The response of the call can be extracted from ResultEvent using a result handler or responder.
The format of ResultEvent is event.result.templates.
The response is a collection of ReviewTemplateReference objects.
Parameters
templateSearchFilter:com.adobe.livecycle.rca.model:TemplateSearchFilter — An object of type com.adobe.livecycle.rca.model.TemplateSearchFilter.
It filters the result of the search based on the attributes that are set in the object.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract a collection of
ReviewTemplateReference objects from ResultEvent. For example, use event.result.templates.
|
setUserPreference | () | method |
public function setUserPreference(domain:String, canonicalName:String, userPreference:UserPreference):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Saves the user preferences.
Parameters
domain:String — Adobe User Management domain of the user.
| |
canonicalName:String — Adobe User Management canonical name of the user.
| |
userPreference:UserPreference — User preference to save.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
storeReviewTemplate | () | method |
public function storeReviewTemplate(reviewContext:ReviewContext, supportingDocList:Array = null, overWrite:Boolean = true):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Stores a review template in the storage space provided by the Review Zone Provider service.
Parameters
reviewContext:ReviewContext — Specifies the review template to store.
| |
supportingDocList:Array (default = null) | |
overWrite:Boolean (default = true) |
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
updateCustomAttributes | () | method |
public function updateCustomAttributes(reviewId:String, revision:int, customAttributes:ArrayCollection, discardOld:Boolean = false):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Updates the custom attributes of a review that can be searched.
Parameters
reviewId:String — The unique identifier of the review to update.
| |
revision:int — The revision number of the review to update.
| |
customAttributes:ArrayCollection — List of CustomAttribute objects.
| |
discardOld:Boolean (default = false)true, old custom attributes are discarded.
|
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
updateReviewStageDuration | () | method |
public function updateReviewStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String = "DAYS"):com.adobe.livecycle.rca.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 9.5 |
| Runtime Versions: | Flash Player 9, Flash Player 10, AIR (unsupported) |
Updates the duration of an ongoing or future review stage.
Parameters
reviewId:String — The unique identifier of the review that the stage duration to update belongs to. This operation works on the current revision of the review only.
| |
stageNo:int — The number of the stage for which the duration is updated. The initial value is 1.
| |
duration:int — New duration of the stage. For example, in days. The initial value is 1.
| |
durationUnit:String (default = "DAYS") |
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you register for the event. Add a listener for ResultEvent
to detect if the call to the server is successful. The value of event.result is null, that is, it does not hold any information.
|
Mon Nov 28 2011, 06:48 AM -08:00