Options
All
  • Public
  • Public/Protected
  • All
Menu

Live fluid object that synchronizes presence information for the user with other clients.

Type Parameters

  • TData extends object = object

    Type of data object to share with clients.

Hierarchy

Index

Constructors

  • Type Parameters

    • TData extends object = object

    Parameters

    Returns LivePresence<TData>

Properties

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

The objects fluid type/name.

factory: DataObjectFactory<LivePresence<object>, DataObjectTypes> = ...

The objects fluid type factory.

Accessors

  • get data(): undefined | TData
  • get expirationPeriod(): number
  • set expirationPeriod(value: number): void
  • Number of seconds without a presence update before a remote user is considered offline.

    remarks

    Defaults to a value of 20 seconds. The minimum value is 0.1 seconds for testing purposes.

    Returns number

  • Number of seconds without a presence update before a remote user is considered offline.

    remarks

    Defaults to a value of 20 seconds. The minimum value is 0.1 seconds for testing purposes.

    Parameters

    • value: number

    Returns void

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

Methods

  • dispose(): void
  • Counts the number of users that the object is tracking presence for.

    Parameters

    • Optional filter: PresenceState

      Optional. Presence state to filter count to.

    Returns number

    Total number of other users we've seen or number of users with a given presence status.

  • initialize(userId?: string, data?: TData, state?: PresenceState): Promise<void>
  • Starts sharing presence information.

    Parameters

    • Optional userId: string

      Optional. ID of the local user. Defaults to a GUID if not provided.

    • Optional data: TData

      Optional. Custom data object to sshare. A deep copy of the data object is saved to avoid any accidental modifications.

    • state: PresenceState = PresenceState.online

      Optional. Initial presence state. Defaults to PresenceState.online.

    Returns Promise<void>

  • Updates the users presence state and/or shared data object.

    remarks

    This will trigger the immediate broadcast of the users presence to all other clients.

    Parameters

    • Optional state: PresenceState

      Optional. Presence state to change.

    • Optional data: TData

      Optional. Data object to change. A deep copy of the data object is saved to avoid any future changes.

    Returns void

Generated using TypeDoc