Class SettingManager

The settings API service manager.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

serverSettings: ServerConnection.ISettings

The server settings used to make API requests.

Methods

  • Fetch a plugin's settings.

    Parameters

    • id: string

      The plugin's ID.

    Returns Promise<IPlugin>

    A promise that resolves if successful.

  • Fetch the list of all plugin setting bundles.

    Parameters

    • Optional query: "ids"

    Returns Promise<{
        ids: string[];
        values: IPlugin[];
    }>

    A promise that resolves if successful.

  • Remove a value using the data connector.

    Parameters

    • id: string

      The identifier for the data being removed.

    Returns Promise<any>

    A promise that always rejects with an error.

    Notes

    Subclasses should reimplement if they support a back-end that can remove.

  • Save a plugin's settings.

    Parameters

    • id: string

      The plugin's ID.

    • raw: string

      The user setting values as a raw string of JSON with comments.

    Returns Promise<void>

    A promise that resolves if successful.

Generated using TypeDoc