Namespace TerminalAPI

Index

Interfaces

IModel

Variables

TERMINAL_SERVICE_URL

Functions

Variables

Const TERMINAL_SERVICE_URL

TERMINAL_SERVICE_URL: "api/terminals" = "api/terminals"

The url for the terminal service.

Functions

isAvailable

isAvailable(): boolean

- Defined in packages/services/lib/terminal/restapi.d.ts:9
Whether the terminal service is available.

Returns boolean

listRunning

listRunning(settings?: ISettings): Promise<IModel[]>

- Defined in packages/services/lib/terminal/restapi.d.ts:34
List the running terminal sessions.

Parameters
- Optional settings: ISettings
  
  The server settings to use.
Returns Promise<IModel[]>

A promise that resolves with the list of running session models.

shutdownTerminal

shutdownTerminal(name: string, settings?: ISettings): Promise<void>

- Defined in packages/services/lib/terminal/restapi.d.ts:44
Shut down a terminal session by name.

Parameters
- name: string
  
  The name of the target session.
- Optional settings: ISettings
  
  The server settings to use.
Returns Promise<void>

A promise that resolves when the session is shut down.

startNew

startNew(settings?: ISettings): Promise<IModel>

- Defined in packages/services/lib/terminal/restapi.d.ts:26
Start a new terminal session.

Parameters
- Optional settings: ISettings
Returns Promise<IModel>

A promise that resolves with the session instance.

Generated using TypeDoc