Skip to main content

Interface: IHighlightsApi

Defined in: Extensions/ExtensionApiTypes.ts:293

Properties​

onDidChange​

onDidChange: IEventApi<{ verseId: number; }>

Defined in: Extensions/ExtensionApiTypes.ts:309

Methods​

create()​

create(highlight): Promise<UserHighlightDto>

Defined in: Extensions/ExtensionApiTypes.ts:295

Parameters​

highlight​

NewHighlightDto

Returns​

Promise<UserHighlightDto>

delete()​

delete(id): Promise<void>

Defined in: Extensions/ExtensionApiTypes.ts:297

Parameters​

id​

string

Returns​

Promise<void>

list()​

list(verseId?): Promise<UserHighlightDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:294

Parameters​

verseId?​

number

Returns​

Promise<UserHighlightDto[]>

listStyles()​

listStyles(): Promise<HighlightStyleDescriptor[]>

Defined in: Extensions/ExtensionApiTypes.ts:307

List all registered highlight styles (built-in + extension-contributed).

Returns​

Promise<HighlightStyleDescriptor[]>

registerStyle()​

registerStyle(style): Promise<DisposableHandle>

Defined in: Extensions/ExtensionApiTypes.ts:304

Register a custom highlight style. The style appears in the user's highlight picker and persists across sessions. Styles can target whole verses, ranges, or sub-verse word ranges.

Parameters​

style​

HighlightStyleDescriptor

Returns​

Promise<DisposableHandle>

update()​

update(id, patch): Promise<UserHighlightDto>

Defined in: Extensions/ExtensionApiTypes.ts:296

Parameters​

id​

string

patch​

Partial<NewHighlightDto>

Returns​

Promise<UserHighlightDto>