Class CPDFReplyAnnotation

A reply attached to a PDF annotation.

The reply model includes the reply content and the current mark/review state exposed by the native SDK. Native mark/review state reply nodes are still implementation details and are not exposed through a public replyType field.

Hierarchy (View Summary)

CPDFAnnotation
- CPDFReplyAnnotation

Index

Constructors

constructor

new CPDFReplyAnnotation(
params: Partial<CPDFReplyAnnotation>,
): CPDFReplyAnnotation
Parameters
- params: Partial<CPDFReplyAnnotation>
Returns CPDFReplyAnnotation
Overrides CPDFAnnotation.constructor

Methods

`Static`fromJson

fromJson<T extends CPDFAnnotation>(
this: new (params: Partial<T>) => T,
json: any,
): T
Type Parameters
- T extends CPDFAnnotation
Parameters
- this: new (params: Partial<T>) => T
- json: any
Returns T
Inherited from CPDFAnnotation.fromJson

`Static`fromJsonArray

fromJsonArray<T extends CPDFAnnotation>(
this: new (params: Partial<T>) => T,
jsonArray: any[],
): T[]
Type Parameters
- T extends CPDFAnnotation
Parameters
- this: new (params: Partial<T>) => T
- jsonArray: any[]
Returns T[]
Inherited from CPDFAnnotation.fromJsonArray

update

update(
    updates: Partial<
        Omit<this, "_viewerRef" | "page" | "uuid" | "createDate">,
    >,
): this
Update annotation properties in a type-safe way
Parameters
- updates: Partial<Omit<this, "_viewerRef" | "page" | "uuid" | "createDate">>
  Partial object containing properties to update
Returns this
this instance for chaining
Example
```
annotation.update({ title: 'New Title', content: 'New Content' });
await document.updateAnnotation(annotation);
```
Inherited from CPDFAnnotation.update

toJSON

toJSON(): Omit<CPDFReplyAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    modifyDate?: number;
    markState: CPDFAnnotationMarkState;
    reviewState: CPDFAnnotationReviewState;
}
Returns Omit<CPDFReplyAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    modifyDate?: number;
    markState: CPDFAnnotationMarkState;
    reviewState: CPDFAnnotationReviewState;
}
Overrides CPDFAnnotation.toJSON

Properties

type

type: CPDFAnnotationType

Annotation type identifier

title

title: string

Annotation title

`Readonly`page

page: number

The page number where the note is located

content

content: string

annotation content.

`Readonly`uuid

uuid: string

annotation uuid.

createDate

createDate: Date | null = null

annotation create date.

markState

markState: CPDFAnnotationMarkState = CPDFAnnotationMarkState.UNMARKED

annotation mark state.

reviewState

reviewState: CPDFAnnotationReviewState = CPDFAnnotationReviewState.NONE

annotation review state.

rect

rect: CPDFRectF | null = null

annotation rect.

modifyDate

modifyDate: Date | null = null

Class CPDFReplyAnnotation

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns CPDFReplyAnnotation

Methods

`Static`fromJson

Type Parameters

Parameters

Returns T

`Static`fromJsonArray

Type Parameters

Parameters

Returns T[]

update

Parameters

Returns this

Example

toJSON

Returns Omit<CPDFReplyAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    modifyDate?: number;
    markState: CPDFAnnotationMarkState;
    reviewState: CPDFAnnotationReviewState;
}

Properties

type

title

`Readonly`page

content

`Readonly`uuid

createDate

markState

reviewState

rect

modifyDate

Settings

On This Page

Class CPDFReplyAnnotation

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns CPDFReplyAnnotation

Methods

StaticfromJson

Type Parameters

Parameters

Returns T

StaticfromJsonArray

Type Parameters

Parameters

Returns T[]

update

Parameters

Returns this

Example

toJSON

Returns Omit<CPDFReplyAnnotation, "createDate" | "update" | "toJSON"> & { createDate?: number; modifyDate?: number; markState: CPDFAnnotationMarkState; reviewState: CPDFAnnotationReviewState;}

Properties

type

title

Readonlypage

content

Readonlyuuid

createDate

markState

reviewState

rect

modifyDate

Settings

On This Page

`Static`fromJson

`Static`fromJsonArray

Returns Omit<CPDFReplyAnnotation, "createDate" | "update" | "toJSON"> & {
createDate?: number;
modifyDate?: number;
markState: CPDFAnnotationMarkState;
reviewState: CPDFAnnotationReviewState;
}

`Readonly`page

`Readonly`uuid