Class PeerStateView<State>

constructor

• new PeerStateView<State extends PresenceState>(
      value: PeerStatesValue<State>,
  ): PeerStateView<State>

  Type Parameters

  • State extends PresenceState

  Parameters

  • value: PeerStatesValue<State>

  Returns PeerStateView<State>

Readonlyvalue

getStates

• getStates<SummaryState = PeerState<State>>(
      opts?: GetStatesOpts<State, SummaryState>,
  ): Record<PropertyKey, SummaryState>

  Get the presence state of all peers. By default, each peer is its own group, but presence activity can be aggregated by arbitrary criteria.

  Type Parameters

  • SummaryState = PeerState<State>

  Parameters

  • Optionalopts: GetStatesOpts<State, SummaryState>

  Returns Record<PropertyKey, SummaryState>

  presence state for all groups