WaitingRoomModal class
A modal interface to manage participants in a waiting room, allowing hosts to accept or reject entries.
This modal displays a searchable list of participants in the waiting room. Each participant can be accepted or rejected through corresponding buttons. The modal also updates dynamically with any changes in the waiting room list.
Parameters:
- options (
WaitingRoomModalOptions
): Contains configurable properties such as the waiting room list, counter, visibility status, and callback functions for accepting/rejecting participants and handling list changes.
Example usage:
WaitingRoomModal(
options: WaitingRoomModalOptions(
waitingRoomList: [
WaitingRoomParticipant(id: '1', name: 'John Doe'),
WaitingRoomParticipant(id: '2', name: 'Jane Smith'),
],
waitingRoomCounter: 2,
isWaitingModalVisible: true,
onWaitingRoomClose: () => print("Modal closed"),
onWaitingRoomItemPress: (parameters) async {
final participantId = parameters.participantId;
final accepted = parameters.type;
print("Participant $participantId ${accepted ? 'accepted' : 'rejected'}");
},
onWaitingRoomFilterChange: (query) => print("Filter changed: $query"),
roomName: 'MeetingRoom123',
socket: socket,
updateWaitingList: () => print("Waiting list updated"),
),
)
Functional Details:
- The
filterWaitingRoomList
method filters participants by a search query. getModalTopPosition
andgetModalRightPosition
calculate positioning based on theposition
parameter in options.- Handles list updates dynamically and reflects changes in the counter displayed on the modal header.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- WaitingRoomModal
Constructors
- WaitingRoomModal({Key? key, required WaitingRoomModalOptions options})
-
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- options → WaitingRoomModalOptions
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _WaitingRoomModalState -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNode
objects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited