Class ListModel

Model for an extension list.

Hierarchy

Constructors

constructor

Properties

_debouncedSearch _installed _isDisclaimed _isEnabled _isLoadingInstalledExtensions _isSearching _lastPage _lastSearchResult _page _pagination _pendingActions _query actionError canInstall installPath installedError name promptReload searchError serviceManager stateChanged translator

Accessors

installed isDisclaimed isDisposed isEnabled isLoadingInstalledExtensions isSearching lastPage page pagination query searchResult

Methods

addPendingAction disable dispose enable hasPendingActions install performAction refreshInstalled search uninstall update

Constructors

constructor

Properties

Private _debouncedSearch

_debouncedSearch: any

Private _installed

_installed: any

Private _isDisclaimed

_isDisclaimed: any

Private _isEnabled

_isEnabled: any

Private _isLoadingInstalledExtensions

_isLoadingInstalledExtensions: any

Private _isSearching

_isSearching: any

Private _lastPage

_lastPage: any

Private _lastSearchResult

_lastSearchResult: any

Private _page

_page: any

Private _pagination

_pagination: any

Private _pendingActions

_pendingActions: any

Private _query

_query: any

actionError

actionError: string

Readonly canInstall

canInstall: boolean

Whether the extension manager support installation methods or not.

installPath

installPath: string

Extensions installation path.

installedError

installedError: string

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

Readonly name

name: string

Extension manager name.

promptReload

promptReload: boolean

Whether a reload should be considered due to actions taken.

searchError

searchError: string

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[]

isDisclaimed

  • get isDisclaimed(): boolean

  • Whether the warning is disclaimed or not.

    Returns boolean

  • set isDisclaimed(v): void

  • Parameters

    • v: boolean

    Returns void

isDisposed

  • get isDisposed(): boolean

  • Test whether the model is disposed.

    Returns boolean

isEnabled

  • get isEnabled(): boolean

  • Whether the extension manager is enabled or not.

    Returns boolean

  • set isEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isLoadingInstalledExtensions

  • get isLoadingInstalledExtensions(): boolean

  • Returns boolean

isSearching

  • get isSearching(): boolean

  • Returns boolean

lastPage

  • get lastPage(): number

  • The last page of results in the current search.

    Returns number

page

  • get page(): number

  • The current search page.

    Setting its value triggers a new search.

    Note

    First page is 1.

    Returns number

  • set page(value): void

  • Parameters

    • value: number

    Returns void

pagination

  • get pagination(): number

  • The search pagination.

    Setting its value triggers a new search.

    Returns number

  • set pagination(value): void

  • Parameters

    • value: number

    Returns void

query

  • get query(): string

  • The search query.

    Setting its value triggers a new search.

    Returns string

  • set query(value): void

  • Parameters

    • value: string

    Returns void

searchResult

  • get searchResult(): readonly IEntry[]

  • A readonly array containing the latest search result

    Returns readonly IEntry[]

Methods

Protected addPendingAction

  • Add a pending action.

    Parameters

    • pending: Promise<any>

      A promise that resolves when the action is completed.

    Returns void

disable

  • Disable an extension.

    Parameters

    • entry: IEntry

      An entry indicating which extension to disable.

    Returns Promise<void>

dispose

  • Dispose the extensions list model.

    Returns void

enable

  • Enable an extension.

    Parameters

    • entry: IEntry

      An entry indicating which extension to enable.

    Returns Promise<void>

hasPendingActions

  • Whether there are currently any actions pending.

    Returns boolean

install

  • Install an extension.

    Parameters

    • entry: IEntry

      An entry indicating which extension to install.

    • Optional options: {
          useVersion?: string;
      }

      Additional options for the action.

      • Optional useVersion?: string

    Returns Promise<void>

Protected performAction

  • 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.

    • Optional actionOptions: IActionOptions

      Additional options for the action.

    Returns Promise<IActionReply>

refreshInstalled

  • Refresh installed packages

    Parameters

    • Optional force: boolean

      Force refreshing the list of installed packages

    Returns Promise<void>

Protected search

  • Search with current query.

    Sets searchError and totalEntries as appropriate.

    Parameters

    • Optional force: boolean

    Returns Promise<void>

    The extensions matching the current query.

uninstall

  • Uninstall an extension.

    Parameters

    • entry: IEntry

      An entry indicating which extension to uninstall.

    Returns Promise<void>

Protected update

  • Update the current model.

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

    Emits the stateChanged signal on successful completion.

    Parameters

    • Optional force: boolean

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc