Interface BreakoutRoomsModalParameters

Configuration parameters for breakout rooms modal.

BreakoutRoomsModalParameters

Participant Management:

interface BreakoutRoomsModalParameters {
    participants: Participant[];
    showAlert?: ShowAlert;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    itemPageLimit: number;
    meetingDisplayType: string;
    prevMeetingDisplayType: string;
    roomName: string;
    shareScreenStarted: boolean;
    shared: boolean;
    breakOutRoomStarted: boolean;
    breakOutRoomEnded: boolean;
    isBreakoutRoomsModalVisible: boolean;
    currentRoomIndex: number;
    canStartBreakout: boolean;
    breakoutRooms: BreakoutParticipant[][];
    updateBreakOutRoomStarted: ((started: boolean) => void);
    updateBreakOutRoomEnded: ((ended: boolean) => void);
    updateCurrentRoomIndex: ((roomIndex: number) => void);
    updateCanStartBreakout: ((canStart: boolean) => void);
    updateBreakoutRooms: ((breakoutRooms: BreakoutParticipant[][]) => void);
    updateMeetingDisplayType: ((displayType: string) => void);
    getUpdatedAllParams: (() => BreakoutRoomsModalParameters);
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

participants showAlert? socket localSocket? itemPageLimit meetingDisplayType prevMeetingDisplayType roomName shareScreenStarted shared breakOutRoomStarted breakOutRoomEnded isBreakoutRoomsModalVisible currentRoomIndex canStartBreakout breakoutRooms updateBreakOutRoomStarted updateBreakOutRoomEnded updateCurrentRoomIndex updateCanStartBreakout updateBreakoutRooms updateMeetingDisplayType getUpdatedAllParams

Properties

participants

participants: Participant[]

List of all meeting participants available for assignment

Breakout Room State:

OptionalshowAlert

showAlert?: ShowAlert

Alert display function for user feedback

Modal State:

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Primary Socket.io instance for breakout room events

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

Optional local Socket.io instance

itemPageLimit

itemPageLimit: number

Number of items per page in participant lists

meetingDisplayType

meetingDisplayType: string

Current meeting display mode

prevMeetingDisplayType

prevMeetingDisplayType: string

Previous display mode (for restoration after breakout)

roomName

roomName: string

Main room identifier

shareScreenStarted

shareScreenStarted: boolean

Whether screen sharing is active

shared

shared: boolean

Whether screen is currently being shared

breakOutRoomStarted

breakOutRoomStarted: boolean

Whether breakout rooms session has started

breakOutRoomEnded

breakOutRoomEnded: boolean

Whether breakout rooms session has ended

isBreakoutRoomsModalVisible

isBreakoutRoomsModalVisible: boolean

Modal visibility state

Utility:

currentRoomIndex

currentRoomIndex: number

Index of currently selected room for editing

canStartBreakout

canStartBreakout: boolean

Whether breakout rooms can be started (all participants assigned)

breakoutRooms

breakoutRooms: BreakoutParticipant[][]

Array of breakout rooms, each containing assigned participants

updateBreakOutRoomStarted

updateBreakOutRoomStarted: ((started: boolean) => void)

Updates breakout started state

updateBreakOutRoomEnded

updateBreakOutRoomEnded: ((ended: boolean) => void)

Updates breakout ended state

updateCurrentRoomIndex

updateCurrentRoomIndex: ((roomIndex: number) => void)

Updates selected room index

updateCanStartBreakout

updateCanStartBreakout: ((canStart: boolean) => void)

Updates whether start is allowed

Display State:

updateBreakoutRooms

updateBreakoutRooms: ((breakoutRooms: BreakoutParticipant[][]) => void)

Updates breakout room assignments

updateMeetingDisplayType

updateMeetingDisplayType: ((displayType: string) => void)

Updates display mode

Session Context:

getUpdatedAllParams

getUpdatedAllParams: (() => BreakoutRoomsModalParameters)

Function to retrieve latest parameters

Settings

Member Visibility

On This Page

Properties