Variable useRemoteAwareness`Const`

useRemoteAwareness: <T>(
    { handle, localUserId, offlineTimeout, getTime, }: UseRemoteAwarenessProps<
        T,
    >,
) => [PeerStates, Heartbeats]

Type declaration

- <T>(
      { handle, localUserId, offlineTimeout, getTime, }: UseRemoteAwarenessProps<
          T,
      >,
  ): [PeerStates, Heartbeats]
- Type Parameters
  - T
  Parameters
  - { handle, localUserId, offlineTimeout, getTime, }: UseRemoteAwarenessProps<T>
  Returns [PeerStates, Heartbeats]
  [ peerStates: { [userId]: state, ... }, { [userId]: heartbeatEpochTime, ...} ]

Deprecated

use the usePresence hook instead

This hook returns read-only state for remote clients. It also returns their heartbeat status. It is intended to be used alongside useLocalAwareness.