Class Plugin

Provides properties and methods for obtaining information about a server plugin on the Open Cloud Server and managing its data.

Hierarchy (View Summary)

Endpoint
- Plugin

Index

Constructors

Properties

Accessors

author data description enabled homepage id license name permissions pluginType version

Methods

checkout delete disable download enable executeCommand getManifest getSettings updateSettings

Constructors

constructor

new Plugin(data: any, httpClient: IHttpClient): Plugin
Parameters
- data: any
  Raw plugin data received from the server. For more information, see Open Cloud Plugins API.
- httpClient: IHttpClient
  HTTP client instance used to send requests to the REST API server.
Returns Plugin
Overrides Endpoint.constructor

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

author

get author(): any
Plugin author information. The author is an object with a name field and optionally url and email. Or it can be shorten that all into a single string.

Returns any

data

get data(): any
Raw plugin data received from the server. For more information, see Open Cloud Plugins API.

Returns any

description

get description(): string
Short description of the plugin.

Returns string

enabled

get enabled(): boolean
Plugin state.

Returns boolean

homepage

get homepage(): string
The URL to the plugin homepage.

Returns string

id

get id(): string
Unique plugin ID.

Returns string

license

get license(): string
A license for the plugin.

Returns string

name

get name(): string
Plugin name.

Returns string

permissions

get permissions(): string[]
API permissions required.

Returns string[]

pluginType

get pluginType(): string[]
Plugin type. Can be set of:
- app - Viewer plugin, the client‑side web app that the server hosts and serves as static content.
- server - Binary dll that extends server functionality.
- jobrunner - Binary dll that adds a new Job Runner on the server.
Returns string[]

version

get version(): number
SemVer compatible version of the plugin.

Returns number

Methods

checkout

checkout(): Promise<Plugin>
Reloads plugin data from the server.

Returns Promise<Plugin>

delete

delete(): Promise<any>
Uninstalls and deletes a plugin from the server.

Returns Promise<any>
Returns the raw data of a deleted plugin. For more information, see Open Cloud Plugins API.

Overrides Endpoint.delete

disable

disable(): Promise<Plugin>
Disables a plugin.

Returns Promise<Plugin>

download

download(
onProgress?: (progress: number) => void,
signal?: AbortSignal,
): Promise<ArrayBuffer>
Downloads the plugins package from the server.
Parameters
- OptionalonProgress: (progress: number) => void
  Download progress callback.
- Optionalsignal: AbortSignal
  An AbortController signal. Allows to communicate with a fetch request and abort it if desired.
Returns Promise<ArrayBuffer>

enable

enable(): Promise<Plugin>
Enables a plugin.

Returns Promise<Plugin>

executeCommand

executeCommand(command: string, parameters?: object | BodyInit): Promise<any>
Executes a plugin command.

This method executes the command for the current version of the plugin. To execute a command for the latest installed version of the plugin, use the Client.executePluginCommand.
Parameters
- command: string
  Command to execute.
- Optionalparameters: object | BodyInit
  Command parameters. Command-dependent.
Returns Promise<any>

getManifest

getManifest(): Promise<any>
Returns a plugin manfest.

Returns Promise<any>

getSettings

getSettings(): Promise<any>
Returns the plugin settings.

Returns Promise<any>
Returns an object with plugin settings.

updateSettings

updateSettings(settings: any): Promise<any>
Changes the plugin settings.
Parameters
- settings: any
  An object with the new plugin settings or part of the settings.
Returns Promise<any>
Returns an object with updated plugin settings.