Class: Comment

PSPDFKit.Comment

Extends

  • Immutable.Record

Members




Members

createdAt: Date

The time when the comment was created.

Type:
  • Date

creatorName: string

The name of the person who created the comment.

Type:
  • string

customData: object

Arbitrary JSON-serializable data the user can attach to the comment.

Type:
  • object

id: InstantID

A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.

Type:
  • InstantID

pageIndex: number

The page index that this comment resides at.

Type:
  • number

pdfObjectId: number

If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.

Type:
  • number

rootId: InstantID

The ID of the annotation that this comment stems from. In PSPDFKit for Web, this should be either a PSPDFKit.Annotations.TextMarkupAnnotation or a PSPDFKit.Annotations.CommentMarkerAnnotation.

Type:
  • InstantID

text: string

The text of the comment.

Type:
  • string

updatedAt: Date

The time when the comment was last updated.

Type:
  • Date