FollowModeType enum

  • Reference
Package:
@microsoft/live-share

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The follow mode type.

Remarks

Determines which user's stateValue is being referenced by LiveFollowMode's state.value field. Use to tell the user the current state of follow mode (e.g., "You are actively presenting"). Use to determine any relevant button(s) to show to the user (e.g., "Stop presenting").

Fields

activeFollowers

Local user is being followed by other remote users.
activePresenter

Local user is actively presenting to other users.
followPresenter

Local user is following the presenter and is in sync.
followUser

Local user is following a specific user and is in sync.
local

Local user is not following anyone, there is no presenter, and nobody is following them.
suspendFollowPresenter

The local user is suspended from the remote active presenter.
suspendFollowUser

The local user is suspended from following a specific user.