Skip to content

BacklinkPluginInstance

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:12

Extends

Properties

app

app: App

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:13


defaultOn

defaultOn: true

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:14


description

description: string

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:5

Inherited from

InternalPluginInstance.description


file?

optional file: null | TFile

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:15


id

id: string

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:6

Inherited from

InternalPluginInstance.id


name

name: string

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:7

Inherited from

InternalPluginInstance.name


onDisable()?

optional onDisable: (app, plugin) => void

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:8

Parameters

app

App

plugin

BacklinkPlugin

Returns

void

Inherited from

InternalPluginInstance.onDisable


options

options: object

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:16

backlinkInDocument?

optional backlinkInDocument: boolean


plugin

plugin: BacklinkPlugin

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:19

Methods

init()

init(app, plugin): void

Defined in: src/obsidian/internals/InternalPlugins/InternalPluginInstance.d.ts:13

Parameters

app

App

plugin

BacklinkPlugin

Returns

void

Inherited from

InternalPluginInstance.init


initLeaf()

initLeaf(): void

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:21

Returns

void


onEnable()

onEnable(app, plugin): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:22

Parameters

app

App

plugin

BacklinkPlugin

Returns

Promise<void>

Overrides

InternalPluginInstance.onEnable


onExternalSettingsChange()

onExternalSettingsChange(): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:23

Returns

Promise<void>


onFileMenu()

onFileMenu(menu, file, source, leaf?): void

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:24

Parameters

Menu

file

TAbstractFile

source

string

leaf?

WorkspaceLeaf

Returns

void


onFileOpen()

onFileOpen(file): void

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:25

Parameters

file

TAbstractFile

Returns

void


onUserDisable()

onUserDisable(app): void

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:26

Parameters

app

App

Returns

void

Overrides

InternalPluginInstance.onUserDisable


onUserEnable()

onUserEnable(): void

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:27

Returns

void

Overrides

InternalPluginInstance.onUserEnable


openBacklinksForActiveFile()

openBacklinksForActiveFile(skipSplit): undefined | boolean

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:28

Parameters

skipSplit

boolean

Returns

undefined | boolean


toggleBacklinksInDocument()

toggleBacklinksInDocument(skip): undefined | boolean

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:29

Parameters

skip

boolean

Returns

undefined | boolean


updateBacklinks(): void

Defined in: src/obsidian/internals/InternalPlugins/Backlink/BacklinkPluginInstance.d.ts:30

Returns

void