ParticipantListItem class
ParticipantListItem
is a widget that represents an individual participant in a list,
allowing actions like muting/unmuting, messaging, and removing the participant.
This component enables various participant management features based on the isBroadcast
state.
It provides controls for muting, messaging, and removing participants, which can be triggered
by icons within each list item.
Parameters:
- ParticipantListItemOptions (
options
): Configuration options for the participant item, including:participant
: The participant data object.isBroadcast
: Boolean indicating if the broadcast is active, affecting the visibility of certain controls.onMuteParticipants
: Callback for muting/unmuting the participant.onMessageParticipants
: Callback for sending a direct message to the participant.onRemoveParticipants
: Callback for removing the participant.socket
: The socket instance for real-time communication.coHostResponsibility
,member
,islevel
,coHost
,roomName
: Additional settings for control access and room data.updateIsMessagesModalVisible
,updateDirectMessageDetails
,updateStartDirectMessage
: Callbacks to update message modal and details.participants
,updateParticipants
: List of all participants and the function to update it.
Example Usage:
ParticipantListItem(
options: ParticipantListItemOptions(
participant: Participant(id: '1', name: 'John Doe', muted: false, islevel: '1'),
isBroadcast: false,
onMuteParticipants: (options) => print("Mute participant: ${options.participant.name}"),
onMessageParticipants: (options) => print("Message participant: ${options.participant.name}"),
onRemoveParticipants: (options) => print("Remove participant: ${options.participant.name}"),
socket: io.Socket(),
coHostResponsibility: [CoHostResponsibility()],
member: 'user123',
islevel: '1',
showAlert: (message) => print("Alert: $message"),
coHost: 'user456',
roomName: 'Room A',
updateIsMessagesModalVisible: (visible) => print("Messages modal visible: $visible"),
updateDirectMessageDetails: (details) => print("Direct message details updated"),
updateStartDirectMessage: (start) => print("Start direct message: $start"),
participants: [Participant(id: '1', name: 'John Doe', muted: false, islevel: '1')],
updateParticipants: (newList) => print("Participants updated: $newList"),
),
);
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ParticipantListItem
Constructors
- ParticipantListItem.new({Key? key, required ParticipantListItemOptions 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 → ParticipantListItemOptions
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
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, int wrapWidth = 65}) → 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