Datalayer Desktop - v0.0.3
    Preparing search index...

    Electron Collaboration Provider that uses IPC for session ID requests

    Implements

    • ICollaborationProvider
    Index
    _errorOccurred: Signal<ElectronCollaborationProvider, Error> = ...
    _isDisposed: boolean = false
    _onConnectionClose: ((event: CloseEvent | null) => void) | null = null
    _onSync: ((isSynced: boolean) => void) | null = null
    _provider: WebsocketProvider | null = null
    _sharedModel: YNotebook | null = null
    _status: CollaborationStatus = CollaborationStatus.Disconnected
    _statusChanged: Signal<ElectronCollaborationProvider, CollaborationStatus> = ...
    _syncStateChanged: Signal<ElectronCollaborationProvider, boolean> = ...
    type: "datalayer-electron" = 'datalayer-electron'

    Provider type identifier

    • Connect to the collaboration service

      Parameters

      • sharedModel: YNotebook

        The shared notebook model

      • documentId: string

        Document identifier

      • Optionaloptions: Record<string, unknown>

        Additional connection options

      Returns Promise<void>

      Promise that resolves when connected

    • Dispose of the resources held by the object.

      If the object's dispose method is called more than once, all calls made after the first will be a no-op.

      It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

      Returns void

    • Get the underlying WebSocket provider

      Returns WebsocketProvider | null

      The WebSocket provider or null if not connected