Class Context<T>

constructor

• new Context<T extends DocumentRegistry.IModel = DocumentRegistry.IModel>(
      options: Context.IOptions<T>,
  ): Context<T>

• Construct a new document context.

  Type Parameters

  • T extends DocumentRegistry.IModel = DocumentRegistry.IModel

  Parameters

  • options: Context.IOptions<T>

  Returns Context<T>

ReadonlysessionContext

canSave

• get canSave(): boolean

• Whether the document can be saved via the Contents API.

  Returns boolean

contentsModel

• get contentsModel(): null | Omit<Contents.IModel, "content">

• The document metadata, stored as a services contents model.

  Notes

  The contents model will be null until the context is populated. It will not have a content field.

  Returns null | Omit<Contents.IModel, "content">

disposed

• get disposed(): ISignal<this, void>

• A signal emitted when the context is disposed.

  Returns ISignal<this, void>

factoryName

• get factoryName(): string

• Get the model factory name.

  Notes

  This is not part of the IContext API.

  Returns string

fileChanged

• get fileChanged(): ISignal<this, Omit<Contents.IModel, "content">>

• A signal emitted when the model is saved or reverted.

  Returns ISignal<this, Omit<Contents.IModel, "content">>

isDisposed

• get isDisposed(): boolean

• Test whether the context is disposed.

  Returns boolean

isReady

• get isReady(): boolean

• Whether the context is ready.

  Returns boolean

lastModifiedCheckMargin

• get lastModifiedCheckMargin(): number

• Configurable margin used to detect document modification conflicts, in milliseconds

  Returns number
• set lastModifiedCheckMargin(value: number): void

• Configurable margin used to detect document modification conflicts, in milliseconds

  Parameters

  • value: number

  Returns void

localPath

• get 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.

  Returns string

model

• get model(): T

• Get the model associated with the document.

  Returns T

path

• get path(): string

• The current path associated with the document.

  Returns string

pathChanged

• get pathChanged(): ISignal<this, string>

• A signal emitted when the path changes.

  Returns ISignal<this, string>

ready

• get ready(): Promise<void>

• A promise that is fulfilled when the context is ready.

  Returns Promise<void>

saveState

• get saveState(): ISignal<this, DocumentRegistry.SaveState>

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

  Returns ISignal<this, DocumentRegistry.SaveState>

urlResolver

• get urlResolver(): IRenderMime.IResolver

• The url resolver for the context.

  Returns IRenderMime.IResolver

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.
  • options: 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.

createCheckpoint

• createCheckpoint(): Promise<ICheckpointModel>

• Create a checkpoint for the file.

  Returns Promise<ICheckpointModel>

deleteCheckpoint

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

• Delete a checkpoint for the file.

  Parameters

  • checkpointId: string

  Returns Promise<void>

dispose

• dispose(): void

• Dispose of the resources held by the context.

  Returns void

download

• download(): Promise<void>

• Download a file.

  Returns Promise<void>

  A promise which resolves when the file has begun downloading.

initialize

• initialize(isNew: boolean): Promise<void>

• Initialize the context.

  Parameters

  • isNew: boolean

    Whether it is a new file.

  Returns Promise<void>

  a promise that resolves upon initialization.

listCheckpoints

• listCheckpoints(): Promise<ICheckpointModel[]>

• List available checkpoints for a file.

  Returns Promise<ICheckpointModel[]>

rename

• rename(newName: string): Promise<void>

• Rename the document.

  Parameters

  • newName: string

    the new name for the document.

  Returns Promise<void>

restoreCheckpoint

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

• Restore the file to a known checkpoint state.

  Parameters

  • OptionalcheckpointId: string

  Returns Promise<void>

revert

• revert(): Promise<void>

• Revert the document contents to disk contents.

  Returns Promise<void>

save

• save(): Promise<void>

• Save the document contents to disk.

  Returns Promise<void>

saveAs

• saveAs(): Promise<boolean>

• Save the document to a different path chosen by the user.

  Returns Promise<boolean>

  A promise that resolves to true if the save operation was initiated. Returns false if the user cancelled the operation.

  Note:

  • If the save operation proceeds but fails due to an error in the content manager, the returned value will still be true.
  • Consumers interested in the actual result of the save should listen to the saveState signal to be notified when the save succeeds or fails.