Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A JSON object that represents a comment of a segment or document.

PROPERTIES

ctyEither "d" for a comment attached to a document or "s" for a comment attached to a segment. string
cmid

Unique Numeric identifier of the comment. The identifier is of format "s{number}" for segment comments and "d{number}" for document comments

Note that the combination of cty + cmid represents a unique comment identifier.

int

txt

The comment text. Plain text.

string
locThe locale to which the comment is attached. This can be a source or target locale.string
dt

Date when comment was added or updated.

datetime
pidThe person ID who created or last updated the comment.int
tskOptional task code. If the comment was added in the framework of a job, then this includes the task code of the job. Otherwise null.string
   
catThe comments category. Defines the category (a name) as well as visual style.int
froInformation only. If true then the comment is flagged as read-only and cannot be edited under no circumstances. This is typically a comment exported from the original file and to be maintained in its current state.bool
fpdInformation only. If true, then the comment is embedded in the actual original file. Used with some file formats such as PO or XLIFF. Typically the comment is then saved back to the translated file.bool
   
editTrue if the user is allowed to edit or delete the comment. False, if no change is permitted.bool

...