Events

instant.connectedClients.change

Detailed viewer event reference for instant.connectedClients.change.

Summary

  • Category: Instant
  • Event: instant.connectedClients.change
  • Trigger: Fires when the connected-clients list changes.

Payload

[unknown[]]

Payload fields

Payload is not an object literal. Use the declaration above and runtime guards when handling this event.

Subscription example

function onEvent(payload) {
  console.log('instant.connectedClients.change', payload);
}

instance.addEventListener('instant.connectedClients.change', onEvent);
instance.removeEventListener('instant.connectedClients.change', onEvent);