Class PluginsApi

PluginsApi - object-oriented interface

Export

PluginsApi

Hierarchy

BaseAPI
- PluginsApi

Index

Constructors

constructor

new PluginsApi(configuration?, basePath?, axios?): PluginsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PluginsApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

disablePlugin

disablePlugin(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PluginsApiDisablePluginRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Disable a plugin.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:768

enablePlugin

enablePlugin(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PluginsApiEnablePluginRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Enables a disabled plugin.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:780

getPluginConfiguration

getPluginConfiguration(requestParameters, options?): Promise<AxiosResponse<object, any>>
Parameters
- requestParameters: PluginsApiGetPluginConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<object, any>>
Summary
Gets plugin configuration.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:792

getPluginImage

getPluginImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: PluginsApiGetPluginImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a plugin's image.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:804

getPluginManifest

getPluginManifest(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PluginsApiGetPluginManifestRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Gets a plugin's manifest.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:816

getPlugins

getPlugins(options?): Promise<AxiosResponse<PluginInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PluginInfo[], any>>
Summary
Gets a list of currently installed plugins.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:827

uninstallPlugin

uninstallPlugin(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PluginsApiUninstallPluginRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Uninstalls a plugin.

Deprecated
Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:840

uninstallPluginByVersion

uninstallPluginByVersion(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PluginsApiUninstallPluginByVersionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Uninstalls a plugin by version.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:852

updatePluginConfiguration

updatePluginConfiguration(requestParameters, options?): Promise<AxiosResponse<void, any>>
Accepts plugin configuration as JSON body.
Parameters
- requestParameters: PluginsApiUpdatePluginConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates plugin configuration.

Throws
Memberof
PluginsApi
- Defined in generated-client/api/plugins-api.ts:864

Class PluginsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PluginsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

disablePlugin

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

enablePlugin

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

getPluginConfiguration

Parameters

Returns Promise<AxiosResponse<object, any>>

Summary

Throws

Memberof

getPluginImage

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getPluginManifest

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

getPlugins

Parameters

Returns Promise<AxiosResponse<PluginInfo[], any>>

Summary

Throws

Memberof

uninstallPlugin

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Deprecated

Throws

Memberof

uninstallPluginByVersion

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

updatePluginConfiguration

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration