Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDocumentProvider

An interface for a document provider.

Hierarchy

  • IDocumentProvider

Implemented by

Index

Methods

acquireLock

  • acquireLock(): Promise<number>
  • Acquire a lock. Returns a Promise that resolves to the lock number.

    Returns Promise<number>

destroy

  • destroy(): void
  • Destroy the provider.

    Returns void

putInitializedState

  • putInitializedState(): void
  • Put the initialized state.

    Returns void

releaseLock

  • releaseLock(lock: number): void
  • Release a lock.

    Parameters

    • lock: number

      The lock to release.

    Returns void

requestInitialContent

  • requestInitialContent(): Promise<boolean>
  • Resolves to true if the initial content has been initialized on the server. false otherwise.

    Returns Promise<boolean>

setPath

  • setPath(newPath: string): void
  • This should be called by the docregistry when the file has been renamed to update the websocket connection url

    Parameters

    • newPath: string

    Returns void

Generated using TypeDoc