Interface IContext<T>

The document context object.

interface IContext<T extends DocumentRegistry.IModel> {
    canSave?: boolean;
    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>;
}

Properties

`Optional`canSave

canSave?: boolean

Whether the document can be saved via the Contents API.

`Readonly`contentsModel

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.

`Readonly`isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly`isReady

isReady: boolean

Whether the context is ready.

lastModifiedCheckMargin

lastModifiedCheckMargin: number

Configurable margin used to detect document modification conflicts, in milliseconds

`Readonly`localPath

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.

`Readonly`model

model: T

The data model for the document.

`Readonly`path

path: string

The current path associated with the document.

pathChanged

pathChanged: ISignal<IContext<T>, string>

A signal emitted when the path changes.

`Readonly`ready

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.

`Readonly`sessionContext

sessionContext: ISessionContext

The session context object associated with the context.

`Readonly`urlResolver

urlResolver: IRenderMime.IResolver

The url resolver for the context.

Methods

addSibling

addSibling(widget: Widget, options?: IOpenOptions): IDisposable
Add a sibling widget to the document manager.
Parameters
- widget: Widget
  The widget to add to the document manager.
- Optionaloptions: IOpenOptions
  The desired options for adding the sibling.
Returns IDisposable
A disposable used to remove the sibling if desired.

Notes
It is assumed that the widget has the same model and context as the original widget.
- Defined in packages/docregistry/src/registry.ts:1032

createCheckpoint

createCheckpoint(): Promise<ICheckpointModel>
Create a checkpoint for the file.

Returns Promise<ICheckpointModel>
A promise which resolves with the new checkpoint model when the checkpoint is created.
- Defined in packages/docregistry/src/registry.ts:990

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.
- Defined in packages/docregistry/src/registry.ts:999

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
Inherited from IDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

download

download(): Promise<void>
Save the document to a different path chosen by the user.

Returns Promise<void>
- Defined in packages/docregistry/src/registry.ts:977

listCheckpoints

listCheckpoints(): Promise<ICheckpointModel[]>
List available checkpoints for the file.

Returns Promise<ICheckpointModel[]>
A promise which resolves with a list of checkpoint models for the file.
- Defined in packages/docregistry/src/registry.ts:1017

rename

rename(newName: string): Promise<void>
Rename the document.
Parameters
- newName: string
Returns Promise<void>
- Defined in packages/docregistry/src/registry.ts:962

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.
- Defined in packages/docregistry/src/registry.ts:1009

revert

revert(): Promise<void>
Revert the document contents to disk contents.

Returns Promise<void>
- Defined in packages/docregistry/src/registry.ts:982

save

save(): Promise<void>
Save the document contents to disk.

Returns Promise<void>
- Defined in packages/docregistry/src/registry.ts:967

saveAs

saveAs(): Promise<void>
Save the document to a different path chosen by the user.

Returns Promise<void>
- Defined in packages/docregistry/src/registry.ts:972

Interface IContext<T>

Type Parameters

Hierarchy

Implemented by

Index

Properties

Methods

Properties

OptionalcanSave

ReadonlycontentsModel

Notes

disposed

fileChanged

ReadonlyisDisposed

Notes

ReadonlyisReady

lastModifiedCheckMargin

ReadonlylocalPath

Readonlymodel

Readonlypath

pathChanged

Readonlyready

saveState

ReadonlysessionContext

ReadonlyurlResolver

Methods

addSibling

Parameters

Returns IDisposable

Notes

createCheckpoint

Returns Promise<ICheckpointModel>

deleteCheckpoint

Parameters

Returns Promise<void>

dispose

Notes

Undefined Behavior

Returns void

download

Returns Promise<void>

listCheckpoints

Returns Promise<ICheckpointModel[]>

rename

Parameters

Returns Promise<void>

restoreCheckpoint

Parameters

Returns Promise<void>

revert

Returns Promise<void>

save

Returns Promise<void>

saveAs

Returns Promise<void>

Settings

On This Page

`Optional`canSave

`Readonly`contentsModel

`Readonly`isDisposed

`Readonly`isReady

`Readonly`localPath

`Readonly`model

`Readonly`path

`Readonly`ready

`Readonly`sessionContext

`Readonly`urlResolver