Class PluginListModel

The model representing plugin list.

Hierarchy (View Summary)

VDomModel
- PluginListModel

Index

Constructors

Properties

actionError stateChanged statusError

Accessors

available isDisclaimed isDisposed isLoading query ready trackerDataChanged

Methods

disable dispose enable getDependants hasPendingActions refresh

Constructors

constructor

new PluginListModel(options: PluginListModel.IOptions): PluginListModel
Parameters
- options: PluginListModel.IOptions
Returns PluginListModel
Overrides VDomModel.constructor
- Defined in packages/pluginmanager/src/model.ts:128

Properties

actionError

actionError: null | string = null

Contains an error message if an error occurred when enabling/disabling plugin.

`Readonly`stateChanged

stateChanged: Signal<PluginListModel, void>

A signal emitted when any model state changes.

statusError

statusError: null | string = null

Contains an error message if an error occurred when querying plugin status.

Accessors

available

get available(): readonly IEntry[]
Returns readonly IEntry[]
- Defined in packages/pluginmanager/src/model.ts:142

isDisclaimed

get isDisclaimed(): boolean
Whether the warning is disclaimed or not.

Returns boolean
- Defined in packages/pluginmanager/src/model.ts:165
set isDisclaimed(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pluginmanager/src/model.ts:168

isDisposed

get isDisposed(): boolean
Test whether the model is disposed.

Returns boolean
Inherited from VDomModel.isDisposed
- Defined in packages/ui-components/lib/components/vdom.d.ts:184

isLoading

get isLoading(): boolean
Whether plugin data is still getting loaded.

Returns boolean
- Defined in packages/pluginmanager/src/model.ts:158

query

get query(): string
The search query.

Setting its value triggers a new search.

Returns string
- Defined in packages/pluginmanager/src/model.ts:181
set query(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/pluginmanager/src/model.ts:184

ready

get ready(): Promise<void>
A promise that resolves when the plugins were fetched from the server

Returns Promise<void>
- Defined in packages/pluginmanager/src/model.ts:202

trackerDataChanged

get trackerDataChanged(): ISignal<PluginListModel, void>
A promise that resolves when the trackable data changes

Returns ISignal<PluginListModel, void>
- Defined in packages/pluginmanager/src/model.ts:195

Methods

disable

disable(entry: IEntry): Promise<void>
Disable a plugin.
Parameters
- entry: IEntry
  An entry indicating which plugin to disable.
Returns Promise<void>
Whether the plugin was disabled
- Defined in packages/pluginmanager/src/model.ts:225

dispose

dispose(): void
Dispose the model.

Returns void
Inherited from VDomModel.dispose
- Defined in packages/ui-components/lib/components/vdom.d.ts:188

enable

enable(entry: IEntry): Promise<void>
Enable a plugin.
Parameters
- entry: IEntry
  An entry indicating which plugin to enable.
Returns Promise<void>
- Defined in packages/pluginmanager/src/model.ts:211

`Protected`getDependants

getDependants(
entry: IEntry,
): { dependants: IEntry[]; optionalDependants: IEntry[] }
Parameters
- entry: IEntry
Returns { dependants: IEntry[]; optionalDependants: IEntry[] }
- Defined in packages/pluginmanager/src/model.ts:270

hasPendingActions

hasPendingActions(): boolean
Whether there are currently any actions pending.

Returns boolean
- Defined in packages/pluginmanager/src/model.ts:307

refresh

refresh(): Promise<void>
Refresh plugin lock statuses

Returns Promise<void>
- Defined in packages/pluginmanager/src/model.ts:363