Interface: ExtensionPointReturnMap

Defined in: Extensions/ExtensionPointTypes.ts:189

Return type a subscriber may return for each extension point.

• For event points the value is void — the host ignores anything the subscriber returns.
• For filter points the value is the new payload (or undefined to pass through unchanged).
• For provider points the value is the contributed entry (the host collects every subscriber's contribution into a single array).

Properties

app.ready

app.ready: void

Defined in: Extensions/ExtensionPointTypes.ts:229

---

bible.referenceParsed

bible.referenceParsed: void

Defined in: Extensions/ExtensionPointTypes.ts:227

---

book.beforeShow

book.beforeShow: BookSectionDto | undefined

Defined in: Extensions/ExtensionPointTypes.ts:207

---

bookmarks.afterAdd

bookmarks.afterAdd: void

Defined in: Extensions/ExtensionPointTypes.ts:215

---

command.beforeExecute

command.beforeExecute: "continue" | "cancel"

Defined in: Extensions/ExtensionPointTypes.ts:228

---

commentary.beforeShow

commentary.beforeShow: CommentaryEntryDto | undefined

Defined in: Extensions/ExtensionPointTypes.ts:203

---

commentary.providerRegistered

commentary.providerRegistered: void

Defined in: Extensions/ExtensionPointTypes.ts:202

---

commentary.similarRequested

commentary.similarRequested: CommentaryEntryDto[]

Defined in: Extensions/ExtensionPointTypes.ts:204

---

crossReferences.requested

crossReferences.requested: CrossReferenceDto[]

Defined in: Extensions/ExtensionPointTypes.ts:208

---

dictionary.beforeShow

dictionary.beforeShow: DictionaryEntryDto | undefined

Defined in: Extensions/ExtensionPointTypes.ts:206

---

dictionary.lookupRequested

dictionary.lookupRequested: DictionaryEntryDto[]

Defined in: Extensions/ExtensionPointTypes.ts:205

---

extension.activated

extension.activated: void

Defined in: Extensions/ExtensionPointTypes.ts:240

---

extension.deactivated

extension.deactivated: void

Defined in: Extensions/ExtensionPointTypes.ts:241

---

highlights.afterChange

highlights.afterChange: void

Defined in: Extensions/ExtensionPointTypes.ts:214

---

layout.presetApplied

layout.presetApplied: void

Defined in: Extensions/ExtensionPointTypes.ts:226

---

locale.changed

locale.changed: void

Defined in: Extensions/ExtensionPointTypes.ts:232

---

module.installed

module.installed: void

Defined in: Extensions/ExtensionPointTypes.ts:237

---

module.removed

module.removed: void

Defined in: Extensions/ExtensionPointTypes.ts:239

---

module.updated

module.updated: void

Defined in: Extensions/ExtensionPointTypes.ts:238

---

notes.afterSave

notes.afterSave: void

Defined in: Extensions/ExtensionPointTypes.ts:212

---

notes.beforeDelete

notes.beforeDelete: "continue" | "cancel"

Defined in: Extensions/ExtensionPointTypes.ts:213

---

notes.beforeSave

notes.beforeSave: UserNoteDto | undefined

Defined in: Extensions/ExtensionPointTypes.ts:211

---

panel.closed

panel.closed: void

Defined in: Extensions/ExtensionPointTypes.ts:224

---

panel.focused

panel.focused: void

Defined in: Extensions/ExtensionPointTypes.ts:225

---

panel.opened

panel.opened: void

Defined in: Extensions/ExtensionPointTypes.ts:223

---

permissions.changed

permissions.changed: void

Defined in: Extensions/ExtensionPointTypes.ts:234

---

search.afterResults

search.afterResults: SearchResultsDto | undefined

Defined in: Extensions/ExtensionPointTypes.ts:219

---

search.beforeQuery

search.beforeQuery: SearchQueryDto | undefined

Defined in: Extensions/ExtensionPointTypes.ts:218

---

search.suggestionsRequested

search.suggestionsRequested: SearchSuggestionDto[]

Defined in: Extensions/ExtensionPointTypes.ts:220

---

session.restored

session.restored: void

Defined in: Extensions/ExtensionPointTypes.ts:230

---

settings.changed

settings.changed: void

Defined in: Extensions/ExtensionPointTypes.ts:233

---

theme.changed

theme.changed: void

Defined in: Extensions/ExtensionPointTypes.ts:231

---

verse.activeChanged

verse.activeChanged: void

Defined in: Extensions/ExtensionPointTypes.ts:197

---

verse.afterRender

verse.afterRender: void

Defined in: Extensions/ExtensionPointTypes.ts:192

---

verse.beforeFormat

verse.beforeFormat: FormatOverride | undefined

Defined in: Extensions/ExtensionPointTypes.ts:199

---

verse.beforeRender

verse.beforeRender: RenderOverride | undefined

Defined in: Extensions/ExtensionPointTypes.ts:191

---

verse.contextMenu

verse.contextMenu: ContextMenuItemDescriptor[]

Defined in: Extensions/ExtensionPointTypes.ts:194

---

verse.decorate

verse.decorate: DecorationDto[]

Defined in: Extensions/ExtensionPointTypes.ts:196

---

verse.hover

verse.hover: HoverContentDto[]

Defined in: Extensions/ExtensionPointTypes.ts:193

---

verse.word.contextMenu

verse.word.contextMenu: ContextMenuItemDescriptor[]

Defined in: Extensions/ExtensionPointTypes.ts:195

---

verse.wordSelected

verse.wordSelected: void

Defined in: Extensions/ExtensionPointTypes.ts:198