Skip to main content

IEnvironmentsManager

Datalayer Core

Datalayer Core / IEnvironmentsManager

Interface: IEnvironmentsManager

Defined in: src/stateful/runtimes/apis.ts:64

Interface for the Environments Manager

Extends​

  • IDisposable

Properties​

changed​

readonly changed: ISignal<IEnvironmentsManager, readonly IDatalayerEnvironment[]>

Defined in: src/stateful/runtimes/apis.ts:68

Signal emitted when the environments changes.

connectionFailure​

readonly connectionFailure: ISignal<IEnvironmentsManager, Error>

Defined in: src/stateful/runtimes/apis.ts:76

A signal emitted when there is a connection failure.

isDisposed​

readonly isDisposed: boolean

Defined in: node_modules/@lumino/disposable/types/index.d.ts:16

Test whether the object has been disposed.

Notes​

This property is always safe to access.

Inherited from​

IDisposable.isDisposed

isReady​

readonly isReady: boolean

Defined in: src/stateful/runtimes/apis.ts:81

Test whether the manager is ready.

ready​

readonly ready: Promise<void>

Defined in: src/stateful/runtimes/apis.ts:86

A promise that fulfills when the manager is ready.

Methods​

dispose()​

dispose(): void

Defined in: node_modules/@lumino/disposable/types/index.d.ts:28

Dispose of the resources held by the object.

Notes​

If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior​

It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns​

void

Inherited from​

IDisposable.dispose

get()​

get(): readonly IDatalayerEnvironment[]

Defined in: src/stateful/runtimes/apis.ts:91

Get the list of environments.

Returns​

readonly IDatalayerEnvironment[]

refresh()​

refresh(): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:96

Refresh the environment list.

Returns​

Promise<void>

refreshEnvironments()​

refreshEnvironments(): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:101

Refresh the environments.

Returns​

Promise<void>