Room - Event Interfaces

Prev Next

The table below lists the room-related events and their purposes. If you want to execute actions based on room events, you can use any of the events mentioned below as an event interface. For further details, you can refer to the Apps-Engine TypeScript definition.

Check out the examples for some of the event interfaces here.

Interface

Description

IPostRoomCreate

Handler after a room is created.

IPostRoomDeleted

Handler after a room is deleted.

IPostRoomUserJoined

Allows an app to register as a handler of the IPostRoomUserJoined event.

This event is triggered after a user successfully joins a room. This event does not allow an app to prevent any action from happening. For that, see the IPreRoomUserJoined interface.

IPostRoomUserLeave

Allows an app to register as a handler of the IPostRoomUserLeave event.

This event is triggered after a user successfully leaves a room. This event does not allow an app to prevent any action from happening. For that, see the IPreRoomUserLeave interface.

IPreRoomCreateExtend

Handler called when an app wants to extend a room.

IPreRoomCreateModify

​​Handler called when an app wants to modify a room.

IPreRoomCreatePrevent

Handler called when an app wants to prevent the creation of a room.

IPreRoomDeletePrevent

Handler called when an app wants to prevent a room from being deleted.

IPreRoomUserJoined

Allows an app to register as a handler of the IPreRoomUserJoined event.

This event is triggered before a user successfully joins a room. To prevent the user from executing such an action, an app should throw the UserNotAllowedException. This event is not triggered before a room has been created. For that, check the IPreRoomCreate event.

IPreRoomUserLeave

Allows an app to register as a handler of the IPreRoomUserLeave event.

This event is triggered before a user successfully leaves a room. To prevent the user from executing such an action, an app should throw the UserNotAllowedException. This event is not triggered before a room has been created. For that, check the IPreRoomCreate event.