Room - Event Interfaces

The table below contains the room-related events, as well as the purpose of each event. If you want to execute actions based on room events, you can use any of the events mentioned below as an event interface.

InterfaceDescription

IPostRoomCreate

Handler after a room is created.

IPostRoomDeleted

Handler after a room is deleted.

IPostRoomUserJoined

Event interface that 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

Event interface that 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 the deletion of a room.

IPreRoomUserJoined

Event interface that allows an app to register as a handler of the IPreRoomUserJoined event.

This event is triggered prior to a user successfully

joining 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

Event interface that allows an app to register as a handler of the IPreRoomUserLeave event.

This event is triggered prior to a user successfully

leaving 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.

Last updated

Rocket.Chat versions receive support for six months after release.