Applies to Collaborator 13.0, last modified on July 29, 2020

Description

The ccollab pinCoordinates command returns a list of pushpin coordinates and numbers for the particular file revision of the specified review. Pushpins are used to indicate comments and defects that relate to specific coordinates within an image, Word document or PDF file.

Command Line Syntax

ccollab [global-options] pinCoordinates <review> <version-id> [--pin-number <value>] [--page <value>]

Command Options

Option

Required?

Description

<review>

Yes

Identifier of the desired review (an integer number), or an ask, or last keyword. Where keywords define the following behaviour:

  • ask - the command will pause execution and prompt for the identifier of the desired review,
  • last - the command will use the last review that was created on the current machine via Command-Line Client (that is, it does not know about reviews created elsewhere).

<version-id>

Yes

Version ID of file revision

--pin-number <value>

No

List coordinates only for the particular pushpin specified by its pin number.

--page <value>

No

List pushpin coordinates only for the particular page specified by its page number.

Remarks

If the specified review, file revision, page or pushpin is not found the method returns an error.

Examples

To list pushpin coordinates for file revision #987 of review #123:

ccollab pinCoordinates 123 987

To list pushpin coordinates for page #2 of file revision #1234 of review #698:

ccollab pinCoordinates 698 1234 --page 2

To list coordinates for pushpin #1 of file revision #1234 of review #698:

ccollab pinCoordinates 698 1234 --pin-number 1

See Also

ccollab
Types of Review Comments and Defects

Highlight search results