Class NoopManager

A no-op terminal manager to be used when starting terminals is not supported.

Hierarchy

TerminalManager
- NoopManager

Index

Constructors

Properties

_readyPromise serverSettings

Accessors

_models connectionFailure disposed isActive isDisposed isReady parentReady ready runningChanged

Methods

connectTo dispose isAvailable refreshRunning requestRunning running shutdown shutdownAll startNew

Constructors

constructor

new NoopManager(options?): TerminalManager.NoopManager
Construct a new terminal manager.
Parameters
- Optional options: TerminalManager.IOptions
Returns TerminalManager.NoopManager
Inherited from TerminalManager.constructor
- Defined in packages/services/lib/terminal/manager.d.ts:13

Properties

`Private` _readyPromise

_readyPromise: any

`Readonly` serverSettings

serverSettings: ServerConnection.ISettings

The server settings of the manager.

Accessors

`Private` _models

get _models(): any
Returns any
Inherited from TerminalManager._models
- Defined in packages/services/lib/terminal/manager.d.ts:95

connectionFailure

get connectionFailure(): ISignal<this, Error>
A signal emitted when there is a connection failure.

Returns ISignal<this, Error>
Inherited from TerminalManager.connectionFailure
- Defined in packages/services/lib/terminal/manager.d.ts:33

disposed

get disposed(): ISignal<this, void>
A signal emitted when the delegate is disposed.

Returns ISignal<this, void>
Inherited from TerminalManager.disposed
- Defined in packages/services/lib/basemanager.d.ts:37

isActive

get isActive(): boolean
Whether the manager is active.

Returns boolean
Overrides TerminalManager.isActive
- Defined in packages/services/lib/terminal/manager.d.ts:122

isDisposed

get isDisposed(): boolean
Test whether the delegate has been disposed.

Returns boolean
Inherited from TerminalManager.isDisposed
- Defined in packages/services/lib/basemanager.d.ts:45

isReady

get isReady(): boolean
Test whether the manager is ready.

Returns boolean
Inherited from TerminalManager.isReady
- Defined in packages/services/lib/terminal/manager.d.ts:21

parentReady

get parentReady(): Promise<void>
Used for testing.

Returns Promise<void>
- Defined in packages/services/lib/terminal/manager.d.ts:126

ready

get ready(): Promise<void>
A promise that fulfills when the manager is ready (never).

Returns Promise<void>
Overrides TerminalManager.ready
- Defined in packages/services/lib/terminal/manager.d.ts:130

runningChanged

get runningChanged(): ISignal<this, Terminal.IModel[]>
A signal emitted when the running terminals change.

Returns ISignal<this, Terminal.IModel[]>
Inherited from TerminalManager.runningChanged
- Defined in packages/services/lib/terminal/manager.d.ts:29

Methods

connectTo

connectTo(options): ITerminalConnection
Parameters
- options: Omit<Terminal.ITerminalConnection.IOptions, "serverSettings">
Returns ITerminalConnection
Overrides TerminalManager.connectTo
- Defined in packages/services/lib/terminal/manager.d.ts:136

dispose

dispose(): void
Dispose of the resources used by the manager.

Returns void
Inherited from TerminalManager.dispose
- Defined in packages/services/lib/terminal/manager.d.ts:37

isAvailable

isAvailable(): boolean
Whether the terminal service is available.

Returns boolean
Inherited from TerminalManager.isAvailable
- Defined in packages/services/lib/terminal/manager.d.ts:41

refreshRunning

refreshRunning(): Promise<void>
Force a refresh of the running terminals.

Returns Promise<void>
A promise that with the list of running terminals.

Notes
This is intended to be called only in response to a user action, since the manager maintains its internal state.
Inherited from TerminalManager.refreshRunning
- Defined in packages/services/lib/terminal/manager.d.ts:58

`Protected` requestRunning

requestRunning(): Promise<void>
Execute a request to the server to poll running sessions and update state.

Returns Promise<void>
Overrides TerminalManager.requestRunning
- Defined in packages/services/lib/terminal/manager.d.ts:144

running

running(): IterableIterator<Terminal.IModel>
Create an iterator over the most recent running terminals.

Returns IterableIterator<Terminal.IModel>
A new iterator over the running terminals.
Inherited from TerminalManager.running
- Defined in packages/services/lib/terminal/manager.d.ts:48

shutdown

shutdown(id): Promise<void>
Shut down a session by id - throw an error since it is not supported.
Parameters
- id: string
Returns Promise<void>
Overrides TerminalManager.shutdown
- Defined in packages/services/lib/terminal/manager.d.ts:140

shutdownAll

shutdownAll(): Promise<void>
Shut down all terminal sessions.

Returns Promise<void>
A promise that resolves when all of the sessions are shut down.
Inherited from TerminalManager.shutdownAll
- Defined in packages/services/lib/terminal/manager.d.ts:80

startNew

startNew(options?): Promise<ITerminalConnection>
Create a new terminal session - throw an error since it is not supported.
Parameters
- Optional options: Terminal.ITerminal.IOptions
Returns Promise<ITerminalConnection>
Overrides TerminalManager.startNew
- Defined in packages/services/lib/terminal/manager.d.ts:135

Generated using TypeDoc