Class RoomBeforeDestroyEvent

Emitted just before a room is destroyed.

See RoomDestroyEvent to guarantee that the room has been destroyed and cannot be brought back.

Hierarchy

CancelableEvent
- RoomBeforeDestroyEvent

Index

Properties

eventName canceled eventName reason room

Methods

Constructors

Properties

`Static` eventName

eventName: "room.beforedestroy" = ...

canceled

canceled: boolean

eventName

eventName: "room.beforedestroy" = ...

`Readonly` reason

reason: DisconnectReason

Reason for why the room will be destroyed.

`Readonly` room

room: Room

The room that is being destroyed.

Methods

cancel

cancel(): void
Returns void
Inherited from CancelableEvent.cancel
- Defined in node_modules/@skeldjs/events/dist/lib/CancelableEvent.d.ts:5

Constructors

constructor

new RoomBeforeDestroyEvent(room: Room, reason: DisconnectReason): RoomBeforeDestroyEvent
Parameters
- room: Room
  
  The room that is being destroyed.
- reason: DisconnectReason
  
  Reason for why the room will be destroyed.
Returns RoomBeforeDestroyEvent
Overrides CancelableEvent.constructor
- Defined in src/api/events/room/BeforeDestroy.ts:15

Generated using TypeDoc