CometChatGroupMembers class

CometChatGroupMembers is a component that displays all the members of a Group in the form of a list with the help of CometChatListBase and CometChatListItem fetched are listed down alphabetically and in order of recent activity group members are fetched using GroupMembersBuilderProtocol and GroupMembersRequestBuilder

  CometChatGroupMembers(
   group: Group(guid: 'guid', name: 'name', type: 'public'),
   groupMemberStyle: GroupMembersStyle(),
   groupScopeStyle: GroupScopeStyle(),
 );
Inheritance

Constructors

CometChatGroupMembers({Key? key, GroupMembersBuilderProtocol? groupMembersProtocol, Widget? subtitleView(BuildContext, GroupMember)?, bool? hideSeparator, Widget listItemView(GroupMember)?, GroupMembersStyle groupMemberStyle = const GroupMembersStyle(), ScrollController? controller, CometChatTheme? theme, String? searchPlaceholder, Widget? backButton, bool showBackButton = true, Widget? searchBoxIcon, bool hideSearch = false, SelectionMode? selectionMode, dynamic onSelection(List<GroupMember>?)?, String? title, String? errorStateText, String? emptyStateText, dynamic stateCallBack(CometChatGroupMembersController controller)?, GroupMembersRequestBuilder? groupMembersRequestBuilder, bool? hideError, WidgetBuilder? loadingStateView, WidgetBuilder? emptyStateView, WidgetBuilder? errorStateView, ListItemStyle? listItemStyle, AvatarStyle? avatarStyle, StatusIndicatorStyle? statusIndicatorStyle, List<Widget>? appBarOptions, List<CometChatOption>? options(Group group, GroupMember member, CometChatGroupMembersController controller, BuildContext context)?, required Group group, GroupScopeStyle? groupScopeStyle, dynamic tailView(BuildContext, GroupMember)?, Widget? selectIcon, Widget? submitIcon, bool disableUsersPresence = false, OnError? onError, VoidCallback? onBack, dynamic onItemTap(GroupMember)?, dynamic onItemLongPress(GroupMember)?, ActivateSelection? activateSelection})

Properties

activateSelection → ActivateSelection?
activateSelection lets the widget know if groups are allowed to be selected
final
appBarOptions → List<Widget>?
appBarOptions list of options to be visible in app bar
final
avatarStyle → AvatarStyle?
avatarStyle set style for avatar
final
backButton → Widget?
backButton back button
final
controller → ScrollController?
controller sets controller for the list
final
disableUsersPresence → bool
disableUsersPresence controls visibility of user online status indicator
final
emptyStateText → String?
emptyStateText text to be displayed when the list is empty
final
emptyStateView → WidgetBuilder?
emptyStateView returns view fow empty state
final
errorStateText → String?
errorStateText text to be displayed when error occur
final
errorStateView → WidgetBuilder?
errorStateView returns view fow error state behind the dialog
final
group → Group
object to passed across to fetch members of
final
groupMembersProtocol → GroupMembersBuilderProtocol?
property to be set internally by using passed parameters groupMembersProtocol ,selectionMode ,options these are passed to the CometChatGroupMembersController which is responsible for the business logic groupMembersProtocol set custom request builder protocol
final
groupMembersRequestBuilder → GroupMembersRequestBuilder?
groupMembersRequestBuilder set custom request builder
final
groupMemberStyle → GroupMembersStyle
groupMemberStyle sets style
final
groupScopeStyle → GroupScopeStyle?
groupScopeStyle styling properties for group scope which is displayed on tail of every list item
final
hashCode → int
The hash code for this object.
no setterinherited
hideError → bool?
hideError toggle visibility of error dialog
final
hideSearch → bool
hideSearch switch on/ff search input
final
hideSeparator → bool?
hideSeparator toggle visibility of separator
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listItemStyle → ListItemStyle?
listItemStyle style for every list item
final
listItemView → Widget Function(GroupMember)?
listItemView set custom view for each groupMember
final
loadingStateView → WidgetBuilder?
loadingStateView returns view fow loading state
final
onBack → VoidCallback?
onBack callback triggered on closing this screen
final
onError → OnError?
onError in case any error occurs
final
onItemLongPress → dynamic Function(GroupMember)?
onItemLongPress callback triggered on pressing for long on a user item
final
onItemTap → dynamic Function(GroupMember)?
onItemTap callback triggered on tapping a user item
final
onSelection → dynamic Function(List<GroupMember>?)?
onSelection function will be performed
final
options → List<CometChatOption>? Function(Group group, GroupMember member, CometChatGroupMembersController controller, BuildContext context)?
options set options which will be visible at slide of each groupMember
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchBoxIcon → Widget?
searchBoxIcon search icon
final
searchPlaceholder → String?
searchPlaceholder placeholder text of search input
final
selectIcon → Widget?
selectIcon will override the default selection icon
final
selectionMode → SelectionMode?
selectionMode specifies mode groupMembers module is opening in
final
showBackButton → bool
showBackButton switch on/off back button
final
stateCallBack → dynamic Function(CometChatGroupMembersController controller)?
stateCallBack to access controller functions from parent pass empty reference of CometChatGroupMembersController object
final
statusIndicatorStyle → StatusIndicatorStyle?
statusIndicatorStyle set style for status indicator
final
submitIcon → Widget?
submitIcon will override the default selection complete icon
final
subtitleView → Widget? Function(BuildContext, GroupMember)?
subtitleView to set subtitle for each groupMember
final
tailView → dynamic Function(BuildContext, GroupMember)?
tailView a custom widget for the tail section of the group member list item
final
theme → CometChatTheme?
theme can pass custom theme
final
title → String?
title sets title for the list
final

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
getDefaultItem(GroupMember member, CometChatGroupMembersController controller, CometChatTheme theme, BuildContext context) → Widget
getListItem(GroupMember member, CometChatGroupMembersController controller, CometChatTheme theme, BuildContext context) → Widget
getSelectionWidget(CometChatGroupMembersController memberController, CometChatTheme theme) → Widget
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