IFollowModeState interface

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.

Information about the state of the local user's follow mode.

Remarks

This includes information such as whether there is a presenting user and which user's state is relevant to the local user.

Properties

followingUserId	The userId of the user that the user is following. This value can be either the presenting user or a specific user the local user is following.
isLocalValue	Indicates that is true when the value is referencing the local user's ["stateValue"].
otherUsersCount	Number of other non-local users following along with this current state value
type	The follow mode type for the local user.
value	The custom value the app should use locally to reflect the follow state.

Property Details

followingUserId

The userId of the user that the user is following. This value can be either the presenting user or a specific user the local user is following.

followingUserId: string

Property Value

string

Remarks

Is a string when type is followPresenter, suspendFollowPresenter, followUser, or suspendFollowUser. Is undefined when type is local or activePresenter. Presenting takes precedence over following a specific user.

isLocalValue

Indicates that is true when the value is referencing the local user's ["stateValue"].

isLocalValue: boolean

Property Value

boolean

Remarks

When true, followingUserId may not be the local user's id when type is suspendFollowUser or suspendFollowPresenter.

otherUsersCount

Number of other non-local users following along with this current state value

otherUsersCount: number

Property Value

number

type

The follow mode type for the local user.

type: FollowModeType

Property Value

FollowModeType

Remarks

Determines which user's ["stateValue"] to use for value. Calculated using a combination of different conditions, such as whether there is an active presenter.

value

The custom value the app should use locally to reflect the follow state.

value: TData

Property Value

TData

Remarks

The relevant user's ["stateValue"], as determined by type. For example, if FollowModeType is activePresenter, this value will be the actively presenting user's stateValue.