Skip to content

CommandPalettePluginInstance

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:11

Extends

Properties

app

app: App

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:12


defaultOn

defaultOn: true

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


description

description: string

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

Inherited from

InternalPluginInstance.description


id

id: string

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

Inherited from

InternalPluginInstance.id


modal: CommandPaletteModal

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:14


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

CommandPalettePlugin

Returns

void

Inherited from

InternalPluginInstance.onDisable


onEnable()?

optional onEnable: (app, plugin) => Promise<void>

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

Parameters

app

App

plugin

CommandPalettePlugin

Returns

Promise<void>

Inherited from

InternalPluginInstance.onEnable


onUserDisable()?

optional onUserDisable: (app) => void

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

Parameters

app

App

Returns

void

Inherited from

InternalPluginInstance.onUserDisable


onUserEnable()?

optional onUserEnable: (app) => void

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

Parameters

app

App

Returns

void

Inherited from

InternalPluginInstance.onUserEnable


options

options: CommandPaletteOptions

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:15


plugin

plugin: CommandPalettePlugin

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:16


recentCommands

recentCommands: string[]

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:17

Methods

getCommands()

getCommands(): Command[]

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:19

Returns

Command[]


init()

init(app, plugin): void

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

Parameters

app

App

plugin

CommandPalettePlugin

Returns

void

Inherited from

InternalPluginInstance.init


onExternalSettingsChange()

onExternalSettingsChange(): Promise<void>

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:20

Returns

Promise<void>


onOpen()

onOpen(): boolean

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:21

Returns

boolean


openCallback()

openCallback(): boolean

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:22

Returns

boolean


saveSettings()

saveSettings(plugin): void

Defined in: src/obsidian/internals/InternalPlugins/CommandPalette/CommandPalettePluginInstance.d.ts:23

Parameters

plugin

CommandPalettePlugin

Returns

void