Namespace SessionAPI

Index

Variables

SESSION_SERVICE_URL

Functions

Variables

Const SESSION_SERVICE_URL

SESSION_SERVICE_URL: "api/sessions" = "api/sessions"

The url for the session service.

Functions

getSessionModel

getSessionModel(id: string, settings?: ISettings): Promise<IModel>

- Defined in packages/services/lib/session/restapi.d.ts:25
Get a full session model from the server by session id string.

Parameters
- id: string
- Optional settings: ISettings
Returns Promise<IModel>

getSessionUrl

getSessionUrl(baseUrl: string, id: string): string

- Defined in packages/services/lib/session/restapi.d.ts:17
Get a session url.

Parameters
- baseUrl: string
- id: string
Returns string

listRunning

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

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

Parameters
- Optional settings: ISettings
Returns Promise<IModel[]>

shutdownSession

shutdownSession(id: string, settings?: ISettings): Promise<void>

- Defined in packages/services/lib/session/restapi.d.ts:21
Shut down a session by id.

Parameters
- id: string
- Optional settings: ISettings
Returns Promise<void>

startSession

startSession(options: ISessionOptions, settings?: ISettings): Promise<IModel>

- Defined in packages/services/lib/session/restapi.d.ts:30
Create a new session, or return an existing session if the session path already exists.

Parameters
- options: ISessionOptions
- Optional settings: ISettings
Returns Promise<IModel>

updateSession

updateSession(model: Pick<IModel, "id"> & DeepPartial<Omit<IModel, "id">>, settings?: ISettings): Promise<IModel>

- Defined in packages/services/lib/session/restapi.d.ts:34
Send a PATCH to the server, updating the session path or the kernel.

Parameters
- model: Pick<IModel, "id"> & DeepPartial<Omit<IModel, "id">>
- Optional settings: ISettings
Returns Promise<IModel>

Generated using TypeDoc