Function PluginsApiFp

Returns {
    disablePlugin(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    enablePlugin(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getPluginConfiguration(pluginId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>)>;
    getPluginImage(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getPluginManifest(pluginId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getPlugins(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>)>;
    uninstallPlugin(pluginId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    uninstallPluginByVersion(pluginId: string, version: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    updatePluginConfiguration(pluginId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• disablePlugin:function

  • disablePlugin(pluginId, version, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • version: string

      Plugin version.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Disable a plugin.

    Throws

• enablePlugin:function

  • enablePlugin(pluginId, version, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • version: string

      Plugin version.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Enables a disabled plugin.

    Throws

• getPluginConfiguration:function

  • getPluginConfiguration(pluginId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>)>

    Summary

    Gets plugin configuration.

    Throws

• getPluginImage:function

  • getPluginImage(pluginId, version, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • version: string

      Plugin version.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Gets a plugin's image.

    Throws

• getPluginManifest:function

  • getPluginManifest(pluginId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Gets a plugin's manifest.

    Throws

• getPlugins:function

  • getPlugins(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>)>

    Summary

    Gets a list of currently installed plugins.

    Throws

• uninstallPlugin:function

  • uninstallPlugin(pluginId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Uninstalls a plugin.

    Deprecated

    Throws

• uninstallPluginByVersion:function

  • uninstallPluginByVersion(pluginId, version, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • pluginId: string

      Plugin id.
    • version: string

      Plugin version.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Uninstalls a plugin by version.

    Throws

• updatePluginConfiguration:function

  • updatePluginConfiguration(pluginId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Accepts plugin configuration as JSON body.

    Parameters

    • pluginId: string

      Plugin id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Updates plugin configuration.

    Throws