Class Comment

A text comment made by the user that stems from an existing root annotation.

Hierarchy

Record<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null
 | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
 },
 this,
> & Readonly<
 {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null
 | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
 },
>
- Comment

Constructors

constructor

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

Properties

`Optional` `Readonly`canSetGroup

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.

`Readonly`createdAt

createdAt: Date

The time when the comment was created.

`Readonly`creatorName

creatorName: null | string

The name of the person who created the comment.

`Readonly`customData

customData: null | Record<string, unknown>

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

`Optional` `Readonly`group

group?: null | string

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.

`Readonly`id

id: null | string

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

`Optional` `Readonly`isDeletable

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.

`Optional` `Readonly`isEditable

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.

`Readonly`pageIndex

pageIndex: null | number

The page index that this comment resides at.

`Readonly`pdfObjectId

pdfObjectId: null | number

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

`Readonly`rootId

rootId: null | string

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.

`Readonly`text

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

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.

`Readonly`updatedAt

updatedAt: Date

The time when the comment was last updated.

Methods

[iterator]

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

asImmutable

asImmutable(): this
Returns this
See
Map#asImmutable

Inherited from Immutable.Record<CommentProps>(defaultValues).asImmutable

asMutable

asMutable(): this
Returns this
See
Map#asMutable

Inherited from Immutable.Record<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 Immutable.Record<CommentProps>(defaultValues).clear

delete

delete<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null
 | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 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 {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
 }
Parameters
- key: K
Returns this
Alias
remove

Inherited from Immutable.Record<CommentProps>(defaultValues).delete

deleteIn

deleteIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Alias
removeIn

Inherited from Immutable.Record<CommentProps>(defaultValues).deleteIn

equals

equals(other: any): boolean
Parameters
- other: any
Returns boolean
Inherited from Immutable.Record<CommentProps>(defaultValues).equals

get

get<
 K extends
 keyof {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null
 | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
 },
>(
 key: K,
 notSetValue?: any,
): {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 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 {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
 }
Parameters
- key: K
- OptionalnotSetValue: any
Returns {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
}[K]
Inherited from Immutable.Record<CommentProps>(defaultValues).get
get<T>(key: string, notSetValue: T): T
Type Parameters
- T
Parameters
- key: string
- notSetValue: T
Returns T
Inherited from Immutable.Record<CommentProps>(defaultValues).get

getIn

getIn(keyPath: Iterable<any>): any
Parameters
- keyPath: Iterable<any>
Returns any
Inherited from Immutable.Record<CommentProps>(defaultValues).getIn

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()
```

has

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

hashCode

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

hasIn

hasIn(keyPath: Iterable<any>): boolean
Parameters
- keyPath: Iterable<any>
Returns boolean
Inherited from Immutable.Record<CommentProps>(defaultValues).hasIn

merge

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

mergeDeep

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

mergeDeepIn

mergeDeepIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from Immutable.Record<CommentProps>(defaultValues).mergeDeepIn

mergeDeepWith

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

mergeIn

mergeIn(keyPath: Iterable<any>, ...collections: any[]): this
Parameters
- keyPath: Iterable<any>
- ...collections: any[]
Returns this
Inherited from Immutable.Record<CommentProps>(defaultValues).mergeIn

mergeWith

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

remove

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

removeIn

removeIn(keyPath: Iterable<any>): this
Parameters
- keyPath: Iterable<any>
Returns this
Inherited from Immutable.Record<CommentProps>(defaultValues).removeIn

set

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

setIn

setIn(keyPath: Iterable<any>, value: any): this
Parameters
- keyPath: Iterable<any>
- value: any
Returns this
Inherited from Immutable.Record<CommentProps>(defaultValues).setIn

toJS

toJS(): {
 canSetGroup?: any;
 createdAt: any;
 creatorName: any;
 customData: any;
 group?: any;
 id: any;
 isDeletable?: any;
 isEditable?: any;
 pageIndex: any;
 pdfObjectId: any;
 rootId: any;
 text: any;
 updatedAt: any;
}
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?: any;
 createdAt: any;
 creatorName: any;
 customData: any;
 group?: any;
 id: any;
 isDeletable?: any;
 isEditable?: any;
 pageIndex: any;
 pdfObjectId: any;
 rootId: any;
 text: any;
 updatedAt: any;
}
- Optional ReadonlycanSetGroup?: any
 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: any
 The time when the comment was created.
- creatorName: any
 The name of the person who created the comment.
- customData: any
 Arbitrary JSON-serializable data the user can attach to the comment.
- Optionalgroup?: any
 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: any
 A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.
- Optional ReadonlyisDeletable?: any
 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.
- Optional ReadonlyisEditable?: any
 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: any
 The page index that this comment resides at.
- pdfObjectId: any
 If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.
- rootId: any
 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: any
 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: any
 The time when the comment was last updated.
Inherited from Immutable.Record<CommentProps>(defaultValues).toJS

toJSON

toJSON(): {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null
 | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
}
Shallowly converts this Record to equivalent native JavaScript Object.

Returns {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
}
- Optional ReadonlycanSetGroup?: 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.
- creatorName: null | string
 The name of the person who created the comment.
- customData: null | Record<string, unknown>
 Arbitrary JSON-serializable data the user can attach to the comment.
- Optionalgroup?: null | string
 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: null | string
 A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.
- Optional ReadonlyisDeletable?: 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.
- Optional ReadonlyisEditable?: 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: null | number
 The page index that this comment resides at.
- pdfObjectId: null | number
 If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.
- rootId: null | string
 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: null | string }
 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 Immutable.Record<CommentProps>(defaultValues).toJSON

toObject

toObject(): {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null
 | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
}
Shallowly converts this Record to equivalent JavaScript Object.

Returns {
 canSetGroup?: boolean;
 createdAt: Date;
 creatorName: null | string;
 customData: null | Record<string, unknown>;
 group?: null | string;
 id: null | string;
 isDeletable?: boolean;
 isEditable?: boolean;
 pageIndex: null | number;
 pdfObjectId: null | number;
 rootId: null | string;
 text: { format: "xhtml" | "plain"; value: null | string };
 updatedAt: Date;
}
- Optional ReadonlycanSetGroup?: 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.
- creatorName: null | string
 The name of the person who created the comment.
- customData: null | Record<string, unknown>
 Arbitrary JSON-serializable data the user can attach to the comment.
- Optionalgroup?: null | string
 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: null | string
 A unique identifier for the comment. When comment is created in the UI, the viewer has to generate a unique ID.
- Optional ReadonlyisDeletable?: 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.
- Optional ReadonlyisEditable?: 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: null | number
 The page index that this comment resides at.
- pdfObjectId: null | number
 If this comment is from the original PDF, then this ID is from that PDF note annotation that defined the comment.
- rootId: null | string
 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: null | string }
 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 Immutable.Record<CommentProps>(defaultValues).toObject

toSeq

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

update

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

updateIn

updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this
Parameters
- keyPath: Iterable<any>
- updater: (value: any) => any
Returns this
Inherited from Immutable.Record<CommentProps>(defaultValues).updateIn

wasAltered

wasAltered(): boolean
Returns boolean
See
Map#wasAltered

Inherited from Immutable.Record<CommentProps>(defaultValues).wasAltered

withMutations

withMutations(mutator: (mutable: this) => any): 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) => any
Returns this
See
Map#withMutations

Inherited from Immutable.Record<CommentProps>(defaultValues).withMutations

`Static`fromSerializableObject

fromSerializableObject(comment: CommentJSON): NutrientViewer.Comment
Comment deserializer. Converts a comment object to a NutrientViewer.Comment.
Parameters
- comment: CommentJSON
  The comment to deserialize.
Returns NutrientViewer.Comment
The deserialized comment.

`Static`toSerializableObject

toSerializableObject(comment: NutrientViewer.Comment): CommentJSON
Comment serializer. Converts a comment to a InstantJSON compliant object.
Parameters
- comment: NutrientViewer.Comment
  The comment to serialize.
Returns CommentJSON
The serialized comment.

Class Comment

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NutrientViewer.Comment

Properties

Optional ReadonlycanSetGroup

ReadonlycreatedAt

ReadonlycreatorName

ReadonlycustomData

Optional Readonlygroup

Readonlyid

Optional ReadonlyisDeletable

Optional ReadonlyisEditable

ReadonlypageIndex

ReadonlypdfObjectId

ReadonlyrootId

Readonlytext

ReadonlyupdatedAt

Methods

[iterator]

asImmutable

Returns this

See

asMutable

Returns this

See

clear

Returns this

delete

Type Parameters

Parameters

Returns this

Alias

deleteIn

Parameters

Returns this

Alias

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

Type Parameters

Parameters

Returns T

getIn

Parameters

Returns any

getMentionedUserIds

Returns NutrientViewer.Immutable.Set<string>

Example

has

Parameters

Returns key is | "id" | "pageIndex" | "pdfObjectId" | "createdAt" | "updatedAt" | "creatorName" | "customData" | "isAnonymous" | "group" | "text" | "isEditable" | "isDeletable" | "canSetGroup" | "rootId"

hashCode

Returns number

hasIn

Parameters

Returns boolean

merge

Parameters

Returns this

mergeDeep

Parameters

Returns this

mergeDeepIn

Parameters

Returns this

mergeDeepWith

Parameters

Returns this

mergeIn

Parameters

`Optional` `Readonly`canSetGroup

`Readonly`createdAt

`Readonly`creatorName

`Readonly`customData

`Optional` `Readonly`group

`Readonly`id

`Optional` `Readonly`isDeletable

`Optional` `Readonly`isEditable

`Readonly`pageIndex

`Readonly`pdfObjectId

`Readonly`rootId

`Readonly`text

`Readonly`updatedAt

Returns key is
| "id"
| "pageIndex"
| "pdfObjectId"
| "createdAt"
| "updatedAt"
| "creatorName"
| "customData"
| "isAnonymous"
| "group"
| "text"
| "isEditable"
| "isDeletable"
| "canSetGroup"
| "rootId"

Returns {
canSetGroup?: any;
createdAt: any;
creatorName: any;
customData: any;
group?: any;
id: any;
isDeletable?: any;
isEditable?: any;
pageIndex: any;
pdfObjectId: any;
rootId: any;
text: any;
updatedAt: any;
}

`Optional` `Readonly`canSetGroup?: any

`Optional`group?: any

`Optional` `Readonly`isDeletable?: any

`Optional` `Readonly`isEditable?: any

`Optional` `Readonly`canSetGroup?: boolean

`Optional`group?: null | string

`Optional` `Readonly`isDeletable?: boolean

`Optional` `Readonly`isEditable?: boolean

`Optional` `Readonly`canSetGroup?: boolean

`Optional`group?: null | string

`Optional` `Readonly`isDeletable?: boolean

`Optional` `Readonly`isEditable?: boolean