Interface IRoomExtender

kind

addCustomField

• addCustomField(key, value): IRoomExtender

• 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): IRoomExtender

• Adds a user to the room.

  Parameters

  • user: IUser

    the user which is to be added to the room

  Returns IRoomExtender

getMembersBeingAdded

• getMembersBeingAdded(): IUser[]

• Get a list of users being added to the room.

  Returns IUser[]

getRoom

• getRoom(): IRoom

• 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

getUsernamesOfMembersBeingAdded

• getUsernamesOfMembersBeingAdded(): string[]

• Get a list of usernames of users being added to the room.

  Returns string[]