Options
All
  • Public
  • Public/Protected
  • All
Menu

Options used to configure the TeamsFluidClient class.

Hierarchy

  • ILiveShareClientOptions

Index

Properties

connection?: AzureConnectionConfig

Optional. Configuration to use when connecting to a custom Azure Fluid Relay instance.

logger?: ITelemetryBaseLogger

Optional. A logger instance to receive diagnostic messages.

Methods

  • getLocalTestContainerId(): undefined | string
  • Optional. Function to lookup the ID of the container to use for local testing.

    remarks

    The default implementation attempts to retrieve the containerId from the window.location.hash.

    If the function returns 'undefined' a new container will be created.

    Returns undefined | string

    ID of the container to connect to or undefined if a new container should be created.

  • setLocalTestContainerId(containerId: string): void
  • Optional. Function to save the ID of a newly created local test container.

    remarks

    The default implementation updates window.location.hash with the ID of the newly created container.

    Parameters

    • containerId: string

      The ID of the container that was created.

    Returns void

Generated using TypeDoc