Interface IDialogs

An interface for a session context dialog provider.

interface IDialogs {
    restart(
        session: ISessionContext,
        restartOptions?: IRestartOptions,
    ): Promise<boolean>;
    selectKernel(session: ISessionContext): Promise<void>;
}

Hierarchy (View Summary)

IDialogs
- ISessionContextDialogs

Implemented by

SessionContextDialogs

Index

Methods

restart selectKernel

Methods

restart

restart(
session: ISessionContext,
restartOptions?: IRestartOptions,
): Promise<boolean>
Restart the session context.
Parameters
- session: ISessionContext
- OptionalrestartOptions: IRestartOptions
Returns Promise<boolean>
A promise that resolves with whether the kernel has restarted.

Notes
If there is a running kernel, present a dialog. If there is no kernel, we start a kernel with the last run kernel name and resolves with true. If no kernel has been started, this is a no-op, and resolves with false.
- Defined in packages/apputils/src/sessioncontext.tsx:337

selectKernel

selectKernel(session: ISessionContext): Promise<void>
Select a kernel for the session.
Parameters
- session: ISessionContext
Returns Promise<void>
- Defined in packages/apputils/src/sessioncontext.tsx:324