Interface IRoomExtender

Hierarchy

IRoomExtender

Index

Properties

kind

Methods

Properties

kind

kind: ROOM

Methods

addCustomField

addCustomField(key: string, value: any): IRoomExtender

- Defined in accessors/IModify.ts:179
Adds a custom field to the room. Note: This key can not already exist or it will throw an error. Note: The key must not contain a period in it, an error will be thrown.

Parameters
- key: string
  
  the name of the custom field
- value: any
  
  the value of this custom field
Returns IRoomExtender

addMember

addMember(user: IUser): IRoomExtender

- Defined in accessors/IModify.ts:186
Adds a user to the room.

Parameters
- user: IUser
  
  the user which is to be added to the room
Returns IRoomExtender

getRoom

getRoom(): IRoom

- Defined in accessors/IModify.ts:192
Gets the resulting room that has been extended at the point of calling this. Note: modifying the returned value will have no effect.

Returns IRoom

Generated using TypeDoc