Oxygen XML Web Author

Class: PersistentHighlightUpdateEvent

sync.api. PersistentHighlightUpdateEvent

new PersistentHighlightUpdateEvent(id, type)

The event triggered by a custom highlight update.
Parameters:
Name Type Description
id string The id of the highlight.
type sync.api.PersistentHighlightUpdateEvent.EventType | string The type of the change.

Members

<static> EventType

The custom persistent highlight update event types. Dispatched by sync.api.PersistentHighlightsManager
Properties:
Name Type Default Description
HIGHLIGHT_ADDED highlight_added Triggered when a highlight is added on server side
HIGHLIGHT_REMOVED highlight_deleted Triggered when a highlight is removed on server side
HIGHLIGHT_CHANGED highlight_changed Triggered when a highlight is rchanged on server side

id :string

The ID of the highlight.
Type:
  • string

type :string

The type of the event: sync.api.PersistentHighlightsManager.EventType.
Type:
  • string