Function PluginsApiFactory

Returns {
    disablePlugin(requestParameters: PluginsApiDisablePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    enablePlugin(requestParameters: PluginsApiEnablePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    getPluginConfiguration(requestParameters: PluginsApiGetPluginConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
    getPluginImage(requestParameters: PluginsApiGetPluginImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    getPluginManifest(requestParameters: PluginsApiGetPluginManifestRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    getPlugins(options?: RawAxiosRequestConfig): AxiosPromise<PluginInfo[]>;
    uninstallPlugin(requestParameters: PluginsApiUninstallPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    uninstallPluginByVersion(requestParameters: PluginsApiUninstallPluginByVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    updatePluginConfiguration(requestParameters: PluginsApiUpdatePluginConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• disablePlugin:function

  • disablePlugin(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PluginsApiDisablePluginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Disable a plugin.

    Throws

• enablePlugin:function

  • enablePlugin(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PluginsApiEnablePluginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Enables a disabled plugin.

    Throws

• getPluginConfiguration:function

  • getPluginConfiguration(requestParameters, options?): AxiosPromise<object>

  • Parameters

    • requestParameters: PluginsApiGetPluginConfigurationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<object>

    Summary

    Gets plugin configuration.

    Throws

• getPluginImage:function

  • getPluginImage(requestParameters, options?): AxiosPromise<File>

  • Parameters

    • requestParameters: PluginsApiGetPluginImageRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Gets a plugin's image.

    Throws

• getPluginManifest:function

  • getPluginManifest(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PluginsApiGetPluginManifestRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Gets a plugin's manifest.

    Throws

• getPlugins:function

  • getPlugins(options?): AxiosPromise<PluginInfo[]>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PluginInfo[]>

    Summary

    Gets a list of currently installed plugins.

    Throws

• uninstallPlugin:function

  • uninstallPlugin(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PluginsApiUninstallPluginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Uninstalls a plugin.

    Deprecated

    Throws

• uninstallPluginByVersion:function

  • uninstallPluginByVersion(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PluginsApiUninstallPluginByVersionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Uninstalls a plugin by version.

    Throws

• updatePluginConfiguration:function

  • updatePluginConfiguration(requestParameters, options?): AxiosPromise<void>

  • Accepts plugin configuration as JSON body.

    Parameters

    • requestParameters: PluginsApiUpdatePluginConfigurationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates plugin configuration.

    Throws