Class: HighlightUpdateEvent

sync.api. HighlightUpdateEvent


new HighlightUpdateEvent(id, type)

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

Members


<static> EventType

The highlight update event types. Dispatched by sync.api.HighlightsManager
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

id :string

The ID of the highlight.
Type:
  • string

type :string

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