SessionLifecycleEvent
SessionLifecycleEvent =
SessionStartedEvent| {generation:number;type:"session.connected"; } | {generation:number;type:"session.disconnecting"; } | {generation:number;type:"session.disconnected"; } | {generation:number;type:"session.error"; }
Defined in: packages/realtime/src/lib/realtime-session/session-event-bus.ts:31
Connection lifecycle facts. Only the session knows them.
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ generation: number; type: "session.connected"; }
generation
Section titled “generation”
readonlygeneration:number
Connection generation the fact belongs to.
readonlytype:"session.connected"
The provider connection of this generation is established.
Type Literal
Section titled “Type Literal”{ generation: number; type: "session.disconnecting"; }
generation
Section titled “generation”
readonlygeneration:number
Connection generation the fact belongs to.
readonlytype:"session.disconnecting"
Local teardown of this generation began.
Type Literal
Section titled “Type Literal”{ generation: number; type: "session.disconnected"; }
generation
Section titled “generation”
readonlygeneration:number
Connection generation the fact belongs to.
readonlytype:"session.disconnected"
The session is dormant after teardown.
Type Literal
Section titled “Type Literal”{ generation: number; type: "session.error"; }
generation
Section titled “generation”
readonlygeneration:number
Connection generation the fact belongs to.
readonlytype:"session.error"
The connection of this generation failed.