CometChatBannedMembers class

CometChatBannedMembers is a component that displays members banned from a particular Group in a listed form using CometChatListBase and CometChatListItem fetched banned members are listed down according to the sequence they were added to the list initially banned members are fetched using BannedMemberBuilderProtocol and BannedGroupMembersRequestBuilder

  CometChatBannedMembers(
  group: Group(guid: 'guid', name: 'name', type: 'public'),
  bannedMembersStyle: BannedMembersStyle(),
);
Inheritance

Constructors

CometChatBannedMembers({Key? key, required Group group, BannedMemberBuilderProtocol? bannedMemberProtocol, Widget? subtitleView(GroupMember)?, bool? hideSeparator = true, Widget listItemView(GroupMember)?, BannedMembersStyle bannedMembersStyle = const BannedMembersStyle(), List<CometChatOption>? options(Group group, GroupMember member, CometChatBannedMembersController controller, BuildContext context)?, ScrollController? controller, CometChatTheme? theme, String? searchPlaceholder, Widget? backButton, bool showBackButton = true, Widget? searchBoxIcon, bool hideSearch = true, SelectionMode? selectionMode, dynamic onSelection(List<GroupMember>?)?, String? title, String? errorStateText, String? emptyStateText, dynamic stateCallBack(CometChatBannedMembersController controller)?, BannedGroupMembersRequestBuilder? bannedMemberRequestBuilder, bool? hideError, WidgetBuilder? loadingStateView, WidgetBuilder? emptyStateView, WidgetBuilder? errorStateView, bool disableUsersPresence = true, AvatarStyle? avatarStyle, StatusIndicatorStyle? statusIndicatorStyle, List<Widget>? appBarOptions, ListItemStyle? listItemStyle, OnError? onError, VoidCallback? onBack, dynamic onItemTap(User)?, dynamic onItemLongPress(User)?, ActivateSelection? activateSelection, String? unbanIconUrl, String? unbanIconUrlPackageName})

Properties

activateSelection → ActivateSelection?
activateSelection lets the widget know if banned members are allowed to be selected
final
appBarOptions → List<Widget>?
appBarOptions list of options to be visible in app bar
final
avatarStyle → AvatarStyle?
avatarStyle is applied to the avatar of the user banned from the group
final
backButton → Widget?
backButton back button
final
bannedMemberProtocol → BannedMemberBuilderProtocol?
bannedMemberProtocol is a wrapper for request builder
final
bannedMemberRequestBuilder → BannedGroupMembersRequestBuilder?
bannedMemberRequestBuilder set custom request builder
final
bannedMembersController → CometChatBannedMembersController
bannedMembersController contains the business logic
final
bannedMembersStyle → BannedMembersStyle
bannedMembersStyle sets bannedMembersStyle
final
controller → ScrollController?
controller sets controller for the list
final
disableUsersPresence → bool
disableUsersPresence controls visibility of 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
group stores a reference to the group for which banned members will be shown
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/off 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 bannedMembersStyle for every list item
final
listItemView → Widget Function(GroupMember)?
listItemView set custom view for each banned member
final
loadingStateView → WidgetBuilder?
loadingStateView returns view fow loading state
final
onBack → VoidCallback?
onBack callback triggered on closing this screen
final
onItemLongPress → dynamic Function(User)?
onItemLongPress callback triggered on pressing for long on a user item
final
onItemTap → dynamic Function(User)?
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, CometChatBannedMembersController controller, BuildContext context)?
options set options which will be visible at slide of each banned member
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
selectionMode → SelectionMode?
selectionMode specifies mode banned members module is opening in
final
showBackButton → bool
showBackButton switch on/off back button
final
stateCallBack → dynamic Function(CometChatBannedMembersController controller)?
stateCallBack to access controller functions from parent pass empty reference of CometChatBannedMembersController object
final
statusIndicatorStyle → StatusIndicatorStyle?
statusIndicatorStyle is applied to the online/offline status indicator of the user banned from the group
final
subtitleView → Widget? Function(GroupMember)?
subtitleView to set subtitleView for each banned member
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 bannedMember, CometChatBannedMembersController controller, CometChatTheme theme, BuildContext context) → Widget
getListItem(GroupMember bannedMember, CometChatBannedMembersController controller, CometChatTheme theme, BuildContext context) → Widget
getSelectionWidget(CometChatBannedMembersController bannedMembersController, 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