Skip to main content

Type Alias: SessionEvents<ClientType>

type SessionEvents<ClientType> = {
  on-inactivity-warning: InactivityWarningEvent;
  on-activity-detected: ActivityDetectedEvent;
  on-disconnected: DisconnectedEvent;
  on-client-joined: ClientJoinedEvent<ClientType>;
  on-client-left: ClientLeftEvent<ClientType>;
  TO_REMOVE__viewports-added: TO_REMOVE__ViewportsAddedEvent;
};

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:104

The events dispatched by Session.

Declared key by key rather than intersecting the shared map with the browser-only entry: TypeDoc expands only the literal half of an intersection, so the shared events went undocumented, and the client lifecycle entries have to point at the flavours the browser SDK publishes. livelink.js/tests/EventMaps.test.ts fails to compile if this drifts from the shared map.

Type Parameters​

Type ParameterDefault type
ClientType extends ClientClient

Properties​

on-inactivity-warning​

on-inactivity-warning: InactivityWarningEvent;

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:105

on-activity-detected​

on-activity-detected: ActivityDetectedEvent;

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:106

on-disconnected​

on-disconnected: DisconnectedEvent;

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:107

on-client-joined​

on-client-joined: ClientJoinedEvent<ClientType>;

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:108

on-client-left​

on-client-left: ClientLeftEvent<ClientType>;

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:109

TO_REMOVE__viewports-added​

TO_REMOVE__viewports-added: TO_REMOVE__ViewportsAddedEvent;

Defined in: livelink.clients/livelink.js/sources/session/SessionEvents.ts:113

Deprecated​