Class ListModel

Model for an extension list.

Hierarchy (View Summary)

VDomModel
- ListModel

Constructors

constructor

new ListModel(
serviceManager: ServiceManager.IManager,
translator?: ITranslator,
): ListModel
Parameters
- serviceManager: ServiceManager.IManager
- Optionaltranslator: ITranslator
Returns ListModel
Overrides VDomModel.constructor
- Defined in packages/extensionmanager/src/model.ts:196

Properties

actionError

actionError: null | string = null

`Readonly`canInstall

canInstall: boolean

Whether the extension manager support installation methods or not.

installedError

installedError: null | string = null

Contains an error message if an error occurred when querying installed extensions.

installPath

installPath: null | string

Extensions installation path.

`Readonly`name

name: string

Extension manager name.

promptReload

promptReload: boolean = false

Whether a reload should be considered due to actions taken.

searchError

searchError: null | string = null

Contains an error message if an error occurred when searching for extensions.

`Protected`serviceManager

serviceManager: ServiceManager.IManager

The service manager to use for building.

`Readonly`stateChanged

stateChanged: Signal<ListModel, void>

A signal emitted when any model state changes.

`Protected`translator

translator: ITranslator

Accessors

installed

get installed(): readonly IEntry[]
A readonly array of the installed extensions.

Returns readonly IEntry[]
- Defined in packages/extensionmanager/src/model.ts:235

isDisclaimed

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

Returns boolean
- Defined in packages/extensionmanager/src/model.ts:242
set isDisclaimed(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/extensionmanager/src/model.ts:245

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

isEnabled

get isEnabled(): boolean
Whether the extension manager is enabled or not.

Returns boolean
- Defined in packages/extensionmanager/src/model.ts:256
set isEnabled(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/extensionmanager/src/model.ts:259

isLoadingInstalledExtensions

get isLoadingInstalledExtensions(): boolean
Returns boolean
- Defined in packages/extensionmanager/src/model.ts:266

isSearching

get isSearching(): boolean
Returns boolean
- Defined in packages/extensionmanager/src/model.ts:270

lastPage

get lastPage(): number
The last page of results in the current search.

Returns number
- Defined in packages/extensionmanager/src/model.ts:333

pagination

get pagination(): number
The search pagination.

Setting its value triggers a new search.

Returns number
- Defined in packages/extensionmanager/src/model.ts:320
set pagination(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/extensionmanager/src/model.ts:323

query

get query(): string
The search query.

Setting its value triggers a new search.

Returns string
- Defined in packages/extensionmanager/src/model.ts:286
set query(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/extensionmanager/src/model.ts:289

searchResult

get searchResult(): readonly IEntry[]
A readonly array containing the latest search result

Returns readonly IEntry[]
- Defined in packages/extensionmanager/src/model.ts:277

Methods

`Protected`addPendingAction

addPendingAction(pending: Promise<any>): void
Add a pending action.
Parameters
- pending: Promise<any>
  A promise that resolves when the action is completed.
Returns void
- Defined in packages/extensionmanager/src/model.ts:574

disable

disable(entry: IEntry): Promise<void>
Disable an extension.
Parameters
- entry: IEntry
  An entry indicating which extension to disable.
Returns Promise<void>
- Defined in packages/extensionmanager/src/model.ts:404

dispose

dispose(): void
Dispose the extensions list model.

Returns void
Overrides VDomModel.dispose
- Defined in packages/extensionmanager/src/model.ts:340

enable

enable(entry: IEntry): Promise<void>
Enable an extension.
Parameters
- entry: IEntry
  An entry indicating which extension to enable.
Returns Promise<void>
- Defined in packages/extensionmanager/src/model.ts:391

hasPendingActions

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

Returns boolean
- Defined in packages/extensionmanager/src/model.ts:351

install

install(entry: IEntry, options?: { useVersion?: string }): Promise<void>
Install an extension.
Parameters
- entry: IEntry
  An entry indicating which extension to install.
- options: { useVersion?: string } = {}
  Additional options for the action.
Returns Promise<void>
- Defined in packages/extensionmanager/src/model.ts:361

`Protected`performAction

performAction(
    action: string,
    entry: IEntry,
    actionOptions?: IActionOptions,
): Promise<IActionReply>
Send a request to the server to perform an action on an extension.
Parameters
- action: string
  A valid action to perform.
- entry: IEntry
  The extension to perform the action on.
- actionOptions: IActionOptions = {}
  Additional options for the action.
Returns Promise<IActionReply>
- Defined in packages/extensionmanager/src/model.ts:502

refreshInstalled

refreshInstalled(force?: boolean): Promise<void>
Refresh installed packages
Parameters
- force: boolean = false
  Force refreshing the list of installed packages
Returns Promise<void>
- Defined in packages/extensionmanager/src/model.ts:417

`Protected`search

search(force?: boolean): Promise<void>
Search with current query.

Sets searchError and totalEntries as appropriate.
Parameters
- force: boolean = false
Returns Promise<void>
The extensions matching the current query.
- Defined in packages/extensionmanager/src/model.ts:441

uninstall

uninstall(entry: IEntry): Promise<void>
Uninstall an extension.
Parameters
- entry: IEntry
  An entry indicating which extension to uninstall.
Returns Promise<void>
- Defined in packages/extensionmanager/src/model.ts:378

`Protected`update

update(force?: boolean): Promise<void>
Update the current model.

This will query the packages repository, and the notebook server.

Emits the stateChanged signal on successful completion.
Parameters
- force: boolean = false
Returns Promise<void>
- Defined in packages/extensionmanager/src/model.ts:487

Class ListModel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ListModel

Properties

actionError

ReadonlycanInstall

installedError

installPath

Readonlyname

promptReload

searchError

ProtectedserviceManager

ReadonlystateChanged

Protectedtranslator

Accessors

installed

Returns readonly IEntry[]

isDisclaimed

Returns boolean

Parameters

Returns void

isDisposed

Returns boolean

isEnabled

Returns boolean

Parameters

Returns void

isLoadingInstalledExtensions

Returns boolean

isSearching

Returns boolean

lastPage

Returns number

page

Note

Returns number

Parameters

Returns void

pagination

Returns number

Parameters

Returns void

query

Returns string

Parameters

Returns void

searchResult

Returns readonly IEntry[]

Methods

ProtectedaddPendingAction

Parameters

Returns void

disable

Parameters

Returns Promise<void>

dispose

Returns void

enable

Parameters

Returns Promise<void>

hasPendingActions

Returns boolean

install

Parameters

Returns Promise<void>

ProtectedperformAction

Parameters

Returns Promise<IActionReply>

refreshInstalled

Parameters

Returns Promise<void>

Protectedsearch

`Readonly`canInstall

`Readonly`name

`Protected`serviceManager

`Readonly`stateChanged

`Protected`translator

`Protected`addPendingAction

`Protected`performAction

`Protected`search

`Protected`update