Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

  • Parameters

    Returns LiveTimer

Properties

TypeName: "@microsoft/live-share:LiveTimer" = ...

The objects fluid type/name.

factory: DataObjectFactory<LiveTimer, { Events: ILiveTimerEvents }> = ...

The objects fluid type factory.

Accessors

  • get isInitialized(): boolean
  • get isStarted(): boolean

Methods

  • dispose(): void
  • pause(): void
  • play(): void
  • start(duration: number): void
  • Starts the timer with a specified duration.

    remarks

    Starting an already started timer will restart the timer with a new duration.

    Parameters

    • duration: number

      in Milliseconds

    Returns void

Generated using TypeDoc