Skip to main content
Version: 0.11.x

Interface: OdinLeftEventPayload

The payload for the Left event. This event is fired when the local user leaves a room, either due to a server-initiated disconnect or when room.close() is called programmatically.

Extends

Properties

event

event: keyof OdinEvents

The name of the event that was fired (see keys of OdinEvents for possible values).

Inherited from

OdinEventPayload.event

Defined in

odin.room.d.ts:96


reason

reason: string

The reason for leaving the room.

  • 'ClientDisconnect': The client called room.close() programmatically
  • Other values: Server-initiated disconnects (e.g., 'kicked', 'timeout', etc.)

Defined in

odin.room.d.ts:225


roomId

roomId: string

The ID of the room that was left.

Defined in

odin.room.d.ts:218


tag

tag: number

An internal integer representing the type of the event. This is mainly used internally for testing purposes.

Inherited from

OdinEventPayload.tag

Defined in

odin.room.d.ts:101