BacklinkPluginInstance

Extends

• InternalPluginInstance<BacklinkPlugin>

Properties

app

app: App

---

defaultOn

defaultOn: boolean

---

description

description: string

Inherited from

InternalPluginInstance.description

---

file?

optional file: null | TFile

---

id

id: string

Inherited from

InternalPluginInstance.id

---

name

name: string

Inherited from

InternalPluginInstance.name

---

options

options: object

backlinkInDocument?

optional backlinkInDocument: boolean

---

plugin

plugin: BacklinkPlugin

Methods

init()

init(app, plugin): void

Parameters

• app: App

• plugin: BacklinkPlugin

Returns

void

Inherited from

InternalPluginInstance.init

---

initLeaf()

initLeaf(): void

Returns

void

---

onEnable()

onEnable(app, plugin): Promise<void>

Parameters

• app: App

• plugin: BacklinkPlugin

Returns

Promise<void>

---

onExternalSettingsChange()

onExternalSettingsChange(): Promise<void>

Returns

Promise<void>

---

onFileMenu()

onFileMenu(menu, file, title, leaf?): Menu

Parameters

• menu: Menu

• file: TAbstractFile

• title: string

• leaf?: WorkspaceLeaf

Returns

Menu

---

onFileOpen()

onFileOpen(file): void

Parameters

• file: TAbstractFile

Returns

void

---

onUserDisable()

onUserDisable(app): void

Parameters

• app: App

Returns

void

---

onUserEnable()

onUserEnable(): void

Returns

void

---

openBacklinksForActiveFile()

openBacklinksForActiveFile(skipSplit): undefined | boolean

Parameters

• skipSplit: boolean

Returns

undefined | boolean

---

toggleBacklinksInDocument()

toggleBacklinksInDocument(skip): undefined | boolean

Parameters

• skip: boolean

Returns

undefined | boolean

---

updateBacklinks()

updateBacklinks(): void

Returns

void