Reference NutrientViewerComment

Class Comment

A text comment made by the user. A comment belongs to a thread by pointing its rootId to the id of a root annotation. The root annotation can be a NutrientViewer.Annotations.CommentMarkerAnnotation or an existing markup annotation with isCommentThreadRoot enabled.

Use NutrientViewer.Instance#create, NutrientViewer.Instance#getComments, NutrientViewer.Instance#update, and NutrientViewer.Instance#delete to create, read, update, and delete comments.

Class

Example

Create a comment thread with a marker annotation.

const rootId = NutrientViewer.generateInstantId();
const marker = new NutrientViewer.Annotations.CommentMarkerAnnotation({
  id: rootId,
  pageIndex: 0,
  boundingBox: new NutrientViewer.Geometry.Rect({
    top: 50,
    left: 50,
    width: 20,
    height: 20,
  }),
});
const comment = new NutrientViewer.Comment({
  pageIndex: 0,
  rootId,
  text: {
    format: "plain",
    value: "Please review this area.",
  },
});

await instance.create([marker, comment]);

Hierarchy

RecordComment

Constructors

new Comment(options)

Parameters
options
Partial<{ … }>Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
>
Optional
Overrides ImmutableRecord<CommentProps>(defaultValues).constructor

Properties

canSetGroup

OptionalReadonly

boolean

This property defines whether the user has permission to edit the group of this comment. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

createdAt

Readonly

Date

The time when the comment was created.

createdBy

Readonly

string | null

The ID of the user who created the comment, as determined by the authenticated user (the user_id claim of the JWT) that created it.

You cannot change who is recorded as the author: the value is assigned by the backend, and a locally set value is never sent. It is only available on Server-Backed deployments, and is null for comments created without an authenticated user, as well as when the server holds an author it can no longer resolve to an upstream user id.

creatorName

Readonly

string | null

The name of the person who created the comment.

customData

Readonly

Record<string, unknown> | null

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

group

OptionalReadonly

string | null

This property is used to define the permission scope for a particular comment.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

id

Readonly

string | null

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

isDeletable

OptionalReadonly

boolean

This property defines whether this comment can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

isEditable

OptionalReadonly

boolean

This property defines whether this comment can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

pageIndex

Readonly

number | null

The page index that this comment resides at.

pdfObjectId

Readonly

number | null

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

rootId

Readonly

string | null

The ID of the annotation that this comment stems from. In Nutrient Web SDK, this should be either a NutrientViewer.Annotations.MarkupAnnotation or a NutrientViewer.Annotations.CommentMarkerAnnotation.

text

Readonly

{ format: "xhtml" | "plain"; value: string | null }

The text of the comment in xhtml/plain text format.

In case of XHTML, we support the following tags:

: Bold
: Italic
: Font color, background color and underline using the style attribute (e.g. Hello)
p: Paragraph. You can use this to add a newline between paragraphs.
a: Link. You can use this to add a link to the comment. The href attribute is required.

Property	Description
format
value

updatedAt

Readonly

Date

The time when the comment was last updated.

Methods

getMentionedUserIds

getMentionedUserIds(): NutrientViewer.Immutable.Set<string>
A method that returns a set of user IDs that are mentioned in the comment.
Returns
NutrientViewer.Immutable.Set<string>
An immutable set of user IDs that are mentioned in the comment.
Example
const ids = comment.getMentionedUserIds()

fromSerializableObject

Static

fromSerializableObject(comment: CommentJSON): NutrientViewer.Comment
Comment deserializer. Converts a comment object to a NutrientViewer.Comment.

Parameters
commentCommentJSON
The comment to deserialize.

Returns
NutrientViewer.Comment
The deserialized comment.

toSerializableObject

Static

toSerializableObject(comment: NutrientViewer.Comment): CommentJSON
Comment serializer. Converts a comment to a InstantJSON compliant object.

Parameters
commentNutrientViewer.Comment
The comment to serialize.

Returns
CommentJSON
The serialized comment.

Immutable Record API

displayName

Static

string

The name provided to Record(values, name) can be accessed with displayName.

[iterator]

"[iterator]"(): IterableIterator<
 [
 keyof { … },
 | string
 | number
 | boolean
 | Date
 | Record<string, unknown>
 | { format: "xhtml" | "plain"; value: string | null }
 | null
 | undefined,
 ],
>"[iterator]"(): IterableIterator<
 [
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 | string
 | number
 | boolean
 | Date
 | Record<string, unknown>
 | { format: "xhtml" | "plain"; value: string | null }
 | null
 | undefined,
 ],
>
Returns
IterableIterator<
[
keyof { … },
| string
| number
| boolean
| Date
| Record<string, unknown>
| { format: "xhtml" | "plain"; value: string | null }
| null
| undefined
]
>IterableIterator<
 [
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 | string
 | number
 | boolean
 | Date
 | Record<string, unknown>
 | { format: "xhtml" | "plain"; value: string | null }
 | null
 | undefined,
 ],
>
Inherited from ImmutableRecord<CommentProps>(defaultValues).[iterator]

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable
Inherited from ImmutableRecord<CommentProps>(defaultValues).asImmutable

asMutable

asMutable(): this
Returns
this
See Also
Map#asMutable
Inherited from ImmutableRecord<CommentProps>(defaultValues).asMutable

clear

clear(): this
Returns a new instance of this Record type with all values set to their default values.

Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).clear

delete

delete<K extends keyof { … }>(key: K): thisdelete<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
>(
 key: K,
): this
Returns a new instance of this Record type with the value for the specific key set to its default value.

Type Parameters
K
extends keyof { … }extends keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).delete

deleteIn

deleteIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).deleteIn

equals

equals(other: unknown): boolean
Parameters
otherunknown
Returns
boolean
Inherited from ImmutableRecord<CommentProps>(defaultValues).equals

get

get<K extends keyof { … }>(key: K, notSetValue?: unknown): { … }[K]get<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
>(
 key: K,
 notSetValue?: unknown,
): {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}[K]
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.

If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.

Type Parameters
K
extends keyof { … }extends keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Parameters
keyK
notSetValueunknown
Optional
Returns
{ … }[K]{
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}[K]
Inherited from ImmutableRecord<CommentProps>(defaultValues).get
get<T>(key: string, notSetValue: T): T
Type Parameters
T
Parameters
keystring
notSetValueT
Returns
T
Inherited from ImmutableRecord<CommentProps>(defaultValues).get

getIn

getIn(keyPath: Iterable<unknown>): unknown
Parameters
keyPathIterable<unknown>
Returns
unknown
Inherited from ImmutableRecord<CommentProps>(defaultValues).getIn

has

has(
 key: string,
): key is
 | "id"
 | "pageIndex"
 | "pdfObjectId"
 | "createdAt"
 | "updatedAt"
 | "creatorName"
 | "customData"
 | "isAnonymous"
 | "group"
 | "text"
 | "createdBy"
 | "isEditable"
 | "isDeletable"
 | "canSetGroup"
 | "rootId"
Parameters
keystring
Returns
key is
| "id"
| "pageIndex"
| "pdfObjectId"
| "createdAt"
| "updatedAt"
| "creatorName"
| "customData"
| "isAnonymous"
| "group"
| "text"
| "createdBy"
| "isEditable"
| "isDeletable"
| "canSetGroup"
| "rootId"
Inherited from ImmutableRecord<CommentProps>(defaultValues).has

hashCode

hashCode(): number
Returns
number
Inherited from ImmutableRecord<CommentProps>(defaultValues).hashCode

hasIn

hasIn(keyPath: Iterable<unknown>): boolean
Parameters
keyPathIterable<unknown>
Returns
boolean
Inherited from ImmutableRecord<CommentProps>(defaultValues).hasIn

merge

merge(
 ...collections: (Partial<{ … }> | Iterable<[string, unknown], any, any>)[],
): thismerge(
 ...collections: (
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
 )[],
): this
Parameters
...collections
(Partial<{ … }> | Iterable<[string, unknown], any, any>)[](
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
)[]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).merge

mergeDeep

mergeDeep(
 ...collections: (Partial<{ … }> | Iterable<[string, unknown], any, any>)[],
): thismergeDeep(
 ...collections: (
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
 )[],
): this
Parameters
...collections
(Partial<{ … }> | Iterable<[string, unknown], any, any>)[](
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
)[]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).mergeDeep

mergeDeepIn

mergeDeepIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).mergeDeepIn

mergeDeepWith

mergeDeepWith(
 merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
 ...collections: (Partial<{ … }> | Iterable<[string, unknown], any, any>)[],
): thismergeDeepWith(
 merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
 ...collections: (
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
 )[],
): this
Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
...collections
(Partial<{ … }> | Iterable<[string, unknown], any, any>)[](
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
)[]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).mergeDeepWith

mergeIn

mergeIn(keyPath: Iterable<unknown>, ...collections: unknown[]): this
Parameters
keyPathIterable<unknown>
...collectionsunknown[]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).mergeIn

mergeWith

mergeWith(
 merger: (oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown,
 ...collections: (Partial<{ … }> | Iterable<[string, unknown], any, any>)[],
): thismergeWith(
 merger: (
 oldVal: unknown,
 newVal: unknown,
 key: keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 ) => unknown,
 ...collections: (
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
 )[],
): this
Parameters
merger
(oldVal: unknown, newVal: unknown, key: keyof { … }) => unknown(
 oldVal: unknown,
 newVal: unknown,
 key: keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
) => unknown
...collections
(Partial<{ … }> | Iterable<[string, unknown], any, any>)[](
 | Partial<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 >
 | Iterable<[string, unknown], any, any>
)[]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).mergeWith

remove

remove<K extends keyof { … }>(key: K): thisremove<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
>(
 key: K,
): this
Type Parameters
K
extends keyof { … }extends keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Parameters
keyK
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).remove

removeIn

removeIn(keyPath: Iterable<unknown>): this
Parameters
keyPathIterable<unknown>
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).removeIn

set

set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
>(
 key: K,
 value: {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Parameters
keyK
value
{ … }[K]{
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}[K]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).set

setIn

setIn(keyPath: Iterable<unknown>, value: unknown): this
Parameters
keyPathIterable<unknown>
valueunknown
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).setIn

toJS

toJS(): { … }toJS(): {
 canSetGroup?: boolean;
 createdAt: unknown;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: unknown;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: unknown;
 updatedAt: unknown;
}
Deeply converts this Record to equivalent native JavaScript Object.

Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.
Returns
{ … }{
 canSetGroup?: boolean;
 createdAt: unknown;
 createdBy: string | null;
 creatorName: string | null;
 customData: unknown;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: unknown;
 updatedAt: unknown;
}
OptionalReadonly
canSetGroup?: boolean
This property defines whether the user has permission to edit the group of this comment. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

createdAt: unknown
The time when the comment was created.

Readonly
createdBy: string | null
The ID of the user who created the comment, as determined by the authenticated user (the user_id claim of the JWT) that created it.

You cannot change who is recorded as the author: the value is assigned by the backend, and a locally set value is never sent. It is only available on Server-Backed deployments, and is null for comments created without an authenticated user, as well as when the server holds an author it can no longer resolve to an upstream user id.

creatorName: string | null
The name of the person who created the comment.

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

Optional
group?: string | null
This property is used to define the permission scope for a particular comment.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

id: string | null
A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.

OptionalReadonly
isDeletable?: boolean
This property defines whether this comment can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

OptionalReadonly
isEditable?: boolean
This property defines whether this comment can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

pageIndex: number | null
The page index that this comment resides at.

pdfObjectId: number | null
If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.

rootId: string | null
The ID of the annotation that this comment stems from. In Nutrient Web SDK, this should be either a NutrientViewer.Annotations.MarkupAnnotation or a NutrientViewer.Annotations.CommentMarkerAnnotation.

text: unknown
The text of the comment in xhtml/plain text format.

In case of XHTML, we support the following tags:

: Bold

: Italic

: Font color, background color and underline using the style attribute (e.g. Hello)

p: Paragraph. You can use this to add a newline between paragraphs.

a: Link. You can use this to add a link to the comment. The href attribute is required.

updatedAt: unknown
The time when the comment was last updated.
Inherited from ImmutableRecord<CommentProps>(defaultValues).toJS

toJSON

toJSON(): { … }toJSON(): {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Shallowly converts this Record to equivalent native JavaScript Object.
Returns
{ … }{
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
OptionalReadonly
canSetGroup?: boolean
This property defines whether the user has permission to edit the group of this comment. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

createdAt: Date
The time when the comment was created.

Readonly
createdBy: string | null
The ID of the user who created the comment, as determined by the authenticated user (the user_id claim of the JWT) that created it.

You cannot change who is recorded as the author: the value is assigned by the backend, and a locally set value is never sent. It is only available on Server-Backed deployments, and is null for comments created without an authenticated user, as well as when the server holds an author it can no longer resolve to an upstream user id.

creatorName: string | null
The name of the person who created the comment.

customData: Record<string, unknown> | null
Arbitrary JSON-serializable data the user can attach to the comment.

Optional
group?: string | null
This property is used to define the permission scope for a particular comment.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

id: string | null
A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.

OptionalReadonly
isDeletable?: boolean
This property defines whether this comment can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

OptionalReadonly
isEditable?: boolean
This property defines whether this comment can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

pageIndex: number | null
The page index that this comment resides at.

pdfObjectId: number | null
If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.

rootId: string | null
The ID of the annotation that this comment stems from. In Nutrient Web SDK, this should be either a NutrientViewer.Annotations.MarkupAnnotation or a NutrientViewer.Annotations.CommentMarkerAnnotation.

text: { format: "xhtml" | "plain"; value: string | null }
The text of the comment in xhtml/plain text format.

In case of XHTML, we support the following tags:

: Bold

: Italic

: Font color, background color and underline using the style attribute (e.g. Hello)

p: Paragraph. You can use this to add a newline between paragraphs.

a: Link. You can use this to add a link to the comment. The href attribute is required.

updatedAt: Date
The time when the comment was last updated.
Inherited from ImmutableRecord<CommentProps>(defaultValues).toJSON

toObject

toObject(): { … }toObject(): {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Shallowly converts this Record to equivalent JavaScript Object.
Returns
{ … }{
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
OptionalReadonly
canSetGroup?: boolean
This property defines whether the user has permission to edit the group of this comment. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

createdAt: Date
The time when the comment was created.

Readonly
createdBy: string | null
The ID of the user who created the comment, as determined by the authenticated user (the user_id claim of the JWT) that created it.

You cannot change who is recorded as the author: the value is assigned by the backend, and a locally set value is never sent. It is only available on Server-Backed deployments, and is null for comments created without an authenticated user, as well as when the server holds an author it can no longer resolve to an upstream user id.

creatorName: string | null
The name of the person who created the comment.

customData: Record<string, unknown> | null
Arbitrary JSON-serializable data the user can attach to the comment.

Optional
group?: string | null
This property is used to define the permission scope for a particular comment.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

id: string | null
A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.

OptionalReadonly
isDeletable?: boolean
This property defines whether this comment can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

OptionalReadonly
isEditable?: boolean
This property defines whether this comment can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.

It is only available when collaboration permissions is enabled on Server-Backed deployments.

pageIndex: number | null
The page index that this comment resides at.

pdfObjectId: number | null
If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.

rootId: string | null
The ID of the annotation that this comment stems from. In Nutrient Web SDK, this should be either a NutrientViewer.Annotations.MarkupAnnotation or a NutrientViewer.Annotations.CommentMarkerAnnotation.

text: { format: "xhtml" | "plain"; value: string | null }
The text of the comment in xhtml/plain text format.

In case of XHTML, we support the following tags:

: Bold

: Italic

: Font color, background color and underline using the style attribute (e.g. Hello)

p: Paragraph. You can use this to add a newline between paragraphs.

a: Link. You can use this to add a link to the comment. The href attribute is required.

updatedAt: Date
The time when the comment was last updated.
Inherited from ImmutableRecord<CommentProps>(defaultValues).toObject

toSeq

toSeq(): Keyed<
 keyof { … },
 | string
 | number
 | boolean
 | Date
 | Record<string, unknown>
 | { format: "xhtml" | "plain"; value: string | null }
 | null
 | undefined,
>toSeq(): Keyed<
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 | string
 | number
 | boolean
 | Date
 | Record<string, unknown>
 | { format: "xhtml" | "plain"; value: string | null }
 | null
 | undefined,
>
Returns
Keyed<
keyof { … },
| string
| number
| boolean
| Date
| Record<string, unknown>
| { format: "xhtml" | "plain"; value: string | null }
| null
| undefined
>Keyed<
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
 | string
 | number
 | boolean
 | Date
 | Record<string, unknown>
 | { format: "xhtml" | "plain"; value: string | null }
 | null
 | undefined,
>
Inherited from ImmutableRecord<CommentProps>(defaultValues).toSeq

update

update<K extends keyof { … }>(
 key: K,
 updater: (value: { … }[K]) => { … }[K],
): thisupdate<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 },
>(
 key: K,
 updater: (
 value: {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 }[K],
 ) => {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 }[K],
): this
Type Parameters
K
extends keyof { … }extends keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}
Parameters
keyK
updater
(value: { … }[K]) => { … }[K](
 value: {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
 }[K],
) => {
 canSetGroup?: boolean;
 createdAt: Date;
 createdBy: string
 | null;
 creatorName: string | null;
 customData: Record<string, unknown> | null;
 group?: string | null;
 id: string | null;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: number | null;
 pdfObjectId: number | null;
 rootId: string | null;
 text: { format: "xhtml" | "plain"; value: string | null };
 updatedAt: Date;
}[K]
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).update

updateIn

updateIn(keyPath: Iterable<unknown>, updater: (value: unknown) => unknown): this
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
this
Inherited from ImmutableRecord<CommentProps>(defaultValues).updateIn

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered
Inherited from ImmutableRecord<CommentProps>(defaultValues).wasAltered

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Only set may be used mutatively.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations
Inherited from ImmutableRecord<CommentProps>(defaultValues).withMutations

Class Comment

Example

Hierarchy

Constructors

Parameters

Properties

Methods

Returns

Example

Parameters

Returns

Parameters

Returns

Immutable Record API

Returns

Returns

See Also

Returns

See Also

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

OptionalReadonlycanSetGroup?: boolean

createdAt: unknown

ReadonlycreatedBy: string | null

creatorName: string | null

customData: unknown

Optionalgroup?: string | null

id: string | null

OptionalReadonlyisDeletable?: boolean

OptionalReadonlyisEditable?: boolean

pageIndex: number | null

pdfObjectId: number | null

rootId: string | null

text: unknown

updatedAt: unknown

Returns

OptionalReadonlycanSetGroup?: boolean

createdAt: Date

OptionalReadonly
canSetGroup?: boolean

Readonly
createdBy: string | null

Optional
group?: string | null

OptionalReadonly
isDeletable?: boolean

OptionalReadonly
isEditable?: boolean

OptionalReadonly
canSetGroup?: boolean

Readonly
createdBy: string | null

Optional
group?: string | null

OptionalReadonly
isDeletable?: boolean

OptionalReadonly
isEditable?: boolean

OptionalReadonly
canSetGroup?: boolean

Readonly
createdBy: string | null

Optional
group?: string | null

OptionalReadonly
isDeletable?: boolean

OptionalReadonly
isEditable?: boolean