Class BreakoutRooms

constructor

• new BreakoutRooms(room: ChatRoom): BreakoutRooms

  Constructs breakout room.

  Parameters

  • room: ChatRoom

    the room we are in.

  Returns BreakoutRooms

_isBreakoutRoom

_mainRoomJid

_rooms

room

_filterUpdatePayload

• _filterUpdatePayload(payload: any): any

  Filters the hidden participants from the payload.

  Parameters

  • payload: any

    The payload of the update message.

  Returns any

  • The filtered payload.

_handleMessages

• _handleMessages(payload: any): void

  Handles a message for managing breakout rooms.

  Parameters

  • payload: any

    Arbitrary data.

  Returns void

_sendMessage

• _sendMessage(message: any): void

  Helper to send a breakout rooms message to the component.

  Parameters

  • message: any

    Command that needs to be sent.

  Returns void

_setIsBreakoutRoom

• _setIsBreakoutRoom(isBreakoutRoom: boolean): void

  Stores if the current room is a breakout room.

  Parameters

  • isBreakoutRoom: boolean

    Whether this room is a breakout room.

  Returns void

_setMainRoomJid

• _setMainRoomJid(jid: string): void

  Sets the main room JID associated with this breakout room. Only applies when in a breakout room.

  Parameters

  • jid: string

    The main room JID.

  Returns void

createBreakoutRoom

• createBreakoutRoom(subject: string): void

  Creates a breakout room with the given subject.

  Parameters

  • subject: string

    A subject for the breakout room.

  Returns void

dispose

• dispose(): void

  Stops listening for events.

  Returns void

getComponentAddress

• getComponentAddress(): any

  Gets the address of the Breakout Rooms XMPP component.

  Returns any

  The address of the component.

getMainRoomJid

• getMainRoomJid(): string

  Gets the main room's JID associated with this breakout room.

  Returns string

  The main room JID.

isBreakoutRoom

• isBreakoutRoom(): boolean

  Checks whether this room is a breakout room.

  Returns boolean

  True if the room is a breakout room, false otherwise.

isFeatureSupported

• isFeatureSupported(feature: string): boolean

  Retrieves whether a breakout room feature is supported.

  Parameters

  • feature: string

    Feature to check.

  Returns boolean

  Wether the feature is supported.

isSupported

• isSupported(): boolean

  Whether Breakout Rooms support is enabled in the backend or not.

  Returns boolean

removeBreakoutRoom

• removeBreakoutRoom(breakoutRoomJid: string): void

  Removes a breakout room.

  Parameters

  • breakoutRoomJid: string

    JID of the room to be removed.

  Returns void

renameBreakoutRoom

• renameBreakoutRoom(breakoutRoomJid: string, subject: string): void

  Changes the subject of a breakout room.

  Parameters

  • breakoutRoomJid: string

    JID of the room to be removed.
  • subject: string

    A new subject for the breakout room.

  Returns void

sendParticipantToRoom

• sendParticipantToRoom(participantJid: string, roomJid: string): void

  Sends the given participant to the given room.

  Parameters

  • participantJid: string

    JID of the participant to be sent to a room.
  • roomJid: string

    JID of the target room.

  Returns void