Interface IContext<T>

The document context object.

interface IContext<T extends DocumentRegistry.IModel> {
    contentsModel: null | Omit<Contents.IModel, "content">;
    disposed: ISignal<IContext<T>, void>;
    fileChanged: ISignal<IContext<T>, Omit<Contents.IModel, "content">>;
    isDisposed: boolean;
    isReady: boolean;
    lastModifiedCheckMargin: number;
    localPath: string;
    model: T;
    path: string;
    pathChanged: ISignal<IContext<T>, string>;
    ready: Promise<void>;
    saveState: ISignal<IContext<T>, DocumentRegistry.SaveState>;
    sessionContext: ISessionContext;
    urlResolver: IRenderMime.IResolver;
    addSibling(widget: Widget, options?: IOpenOptions): IDisposable;
    createCheckpoint(): Promise<ICheckpointModel>;
    deleteCheckpoint(checkpointID: string): Promise<void>;
    dispose(): void;
    download(): Promise<void>;
    listCheckpoints(): Promise<ICheckpointModel[]>;
    rename(newName: string): Promise<void>;
    restoreCheckpoint(checkpointID?: string): Promise<void>;
    revert(): Promise<void>;
    save(): Promise<void>;
    saveAs(): Promise<void>;
}

Type Parameters

Hierarchy

Implemented by

Properties

contentsModel disposed fileChanged isDisposed isReady lastModifiedCheckMargin localPath model path pathChanged ready saveState sessionContext urlResolver

Methods

addSibling createCheckpoint deleteCheckpoint dispose download listCheckpoints rename restoreCheckpoint revert save saveAs

Properties

ReadonlycontentsModel

contentsModel: null | Omit<Contents.IModel, "content">

The document metadata, stored as a services contents model.

Notes

This will be null until the context is 'ready'. Since we only store metadata here, the content attribute is removed.

disposed

disposed: ISignal<IContext<T>, void>

A signal emitted when the context is disposed.

fileChanged

fileChanged: ISignal<IContext<T>, Omit<Contents.IModel, "content">>

A signal emitted when the contentsModel changes.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

ReadonlyisReady

isReady: boolean

Whether the context is ready.

lastModifiedCheckMargin

lastModifiedCheckMargin: number

Configurable margin used to detect document modification conflicts, in milliseconds

ReadonlylocalPath

localPath: string

The current local path associated with the document. If the document is in the default notebook file browser, this is the same as the path.

Readonlymodel

model: T

The data model for the document.

Readonlypath

path: string

The current path associated with the document.

pathChanged

pathChanged: ISignal<IContext<T>, string>

A signal emitted when the path changes.

Readonlyready

ready: Promise<void>

A promise that is fulfilled when the context is ready.

saveState

saveState: ISignal<IContext<T>, DocumentRegistry.SaveState>

A signal emitted on the start and end of a saving operation.

ReadonlysessionContext

sessionContext: ISessionContext

The session context object associated with the context.

ReadonlyurlResolver

urlResolver: IRenderMime.IResolver

The url resolver for the context.

Methods

addSibling

createCheckpoint

deleteCheckpoint

  • deleteCheckpoint(checkpointID: string): Promise<void>

  • Delete a checkpoint for the file.

    Parameters

    • checkpointID: string

      The id of the checkpoint to delete.

    Returns Promise<void>

    A promise which resolves when the checkpoint is deleted.

dispose

  • dispose(): void

  • 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

download

listCheckpoints

rename

restoreCheckpoint

  • restoreCheckpoint(checkpointID?: string): Promise<void>

  • Restore the file to a known checkpoint state.

    Parameters

    • OptionalcheckpointID: string

      The optional id of the checkpoint to restore, defaults to the most recent checkpoint.

    Returns Promise<void>

    A promise which resolves when the checkpoint is restored.

revert

save

saveAs

Settings

Member Visibility

On This Page

Properties
Methods