AnnotationsApi.setStatus()
Sets a reviewer's (
options.author) status on the comment with that id. The entry's text is Acrobat's "Accepted set by Ann", or the status alone without an author. update() and delete() act on a status entry as on any annotation, rewriting that reviewer's history. Needs the annotations feature.methodCommentssince 1.0.0
Signature
setStatus(id: string, status: ReviewStatus, options?: StatusOptions): Promise<string>
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The comment's id. |
| status | ReviewStatus | 'accepted', 'rejected', 'cancelled', 'completed', or 'none' to clear theirs. |
| options? | StatusOptions | author (the reviewer; omitted, '') and invalidateSignatures. |
Returns
Promise<string> The status entry's id.
Throws
INVALID_ARGUMENT— an id no annotation has, a status not inReviewStatus, or the annotation is not a comment.PAGE_ERROR— the status could not be written.FEATURE_NOT_LICENSED— the license lacksannotations.DOCUMENT_CLOSED— the document has been closed.INVALID_STATE— a certified document whose certification forbids it, unlessoptions.invalidateSignaturesbesideoptions.author; or a progressive document still downloading.
Example
TypeScript
await doc.annotations.setStatus(id, 'accepted', { author: 'Ann' });