Nutrient Web SDK

ReferenceContentEditingSession

Interface Session

This describes the content editor session returned by Instance#beginContentEditingSession.

It is independent of the content editor UI session, which is used to display the content editor UI. At one time, only one content editing session can be active, either this session or a UI session. Starting the UI session will deactivate this session. Also, if the contents of an opened document are modified while this session is active, the session will be deactivated.

Using this requires a license that includes the Content Editor component.

Interface

Properties

active

boolean

Indicates whether the session is currently active.

commit

() => Promise<void>

Completes the current editing session and saves all changes. Document will reload.

discard

() => Promise<void>

Completes the current editing session without persisting any changes.

getTextBlocks

(pageIndex: number) => Promise<ContentEditing.TextBlock[]>

Retrieves all text blocks for a specific page.

Errors

If the page index is out of bounds.

updateTextBlocks

(textBlocks: UpdatedTextBlock[]) => Promise<void>

Updates an array of text blocks with partial data.

Errors

If the ID of any text block is missing or doesn't exist.