Interface IOptions

The options used to initialize a document manager.

Hierarchy

IOptions

Index

Properties

isConnectedCallback? manager opener registry sessionDialogs? setBusy? translator? when?

Properties

`Optional` isConnectedCallback

isConnectedCallback?: (() => boolean)

Type declaration

- (): boolean
- Autosaving should be paused while this callback function returns false. By default, it always returns true.
  
  Returns boolean

manager

manager: ServiceManager.IManager

A service manager instance.

opener

opener: IDocumentWidgetOpener

A widget opener for sibling widgets.

registry

registry: DocumentRegistry

A document registry instance.

`Optional` sessionDialogs

sessionDialogs?: IDialogs

The provider for session dialogs.

`Optional` setBusy

setBusy?: (() => IDisposable)

Type declaration

- (): IDisposable
- A function called when a kernel is busy.
  
  Returns IDisposable

`Optional` translator

translator?: ITranslator

The application language translator.

`Optional` when

when?: Promise<void>

A promise for when to start using the manager.

Generated using TypeDoc