Interface IPreRoomCreateExtend

Handler called when an App wants to enrich a room.

Hierarchy

IPreRoomCreateExtend

Index

Methods

Methods

Optional checkPreRoomCreateExtend

checkPreRoomCreateExtend(room: IRoom, read: IRead, http: IHttp): Promise<boolean>

- Defined in rooms/IPreRoomCreateExtend.ts:15
Checks whether the handler actually shall execute. This method can basically implement a filter.

Parameters
- room: IRoom
  
  The room which was being created
- read: IRead
  
  An accessor to the environment
- http: IHttp
  
  An accessor to the outside world
Returns Promise<boolean>

whether to run the execute or not

executePreRoomCreateExtend

executePreRoomCreateExtend(room: IRoom, extend: IRoomExtender, read: IRead, http: IHttp, persistence: IPersistence): Promise<IRoom>

- Defined in rooms/IPreRoomCreateExtend.ts:27
Method which is to be used to prevent a room from being created.

Parameters
- room: IRoom
  
  The room about to be created
- extend: IRoomExtender
  
  An accessor for modifying the room non-destructively
- read: IRead
  
  An accessor to the environment
- http: IHttp
  
  An accessor to the outside world
- persistence: IPersistence
  
  An accessor to the App's persistence storage
Returns Promise<IRoom>

the resulting room

Generated using TypeDoc