BannedMemberConfiguration class

BannedMemberConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatBannedMembers can be used by a component where CometChatBannedMembers is a child component

BannedMemberConfiguration(
    title: "members banished",
    disableUsersPresence: true,
		bannedMembersStyle: BannedMembersStyle(
    backIconTint: Colors.green,
    background: Colors.lightBlue,
    titleStyle: TextStyle(
    backgroundColor: Colors.yellow,
          color: Colors.deepOrange,
          fontSize: 21,
          fontWeight: FontWeight.bold
    )
  )
 );

Constructors

BannedMemberConfiguration({UIBannedGroupMemberRequestBuilder? requestBuilder, bool? hideSeparator, Widget childView(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, Widget? subtitleView(GroupMember)?, AvatarStyle? avatarStyle, bool? disableUsersPresence, WidgetBuilder? loadingStateView, WidgetBuilder? emptyStateView, WidgetBuilder? errorStateView, bool? hideError, StatusIndicatorStyle? statusIndicatorStyle, OnError? onError, VoidCallback? onBack, dynamic onItemTap(User)?, dynamic onItemLongPress(User)?, ActivateSelection? activateSelection, List<Widget>? appBarOptions, ListItemStyle? listItemStyle, BannedMemberBuilderProtocol? bannedMemberProtocol, BannedGroupMembersRequestBuilder? bannedMemberRequestBuilder, String? unbanIconUrl, String? unbanIconUrlPackageName, dynamic stateCallBack(CometChatBannedMembersController controller)?})

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
bannedMembersStyle → BannedMembersStyle
bannedMembersStyle sets bannedMembersStyle
final
childView → Widget Function(GroupMember)?
childView set custom view for each banned member
final
controller → ScrollController?
controller sets controller for the list
final
disableUsersPresence → bool?
hideUserPresence 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 occurs
final
errorStateView → WidgetBuilder?
errorStateView returns view fow error state behind the dialog
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
listItemStyle → ListItemStyle?
listItemStyle bannedMembersStyle for every list item
final
loadingStateView → WidgetBuilder?
loadingStateView returns view fow loading state
final
onBack → VoidCallback?
onBack callback triggered on closing this screen
final
onError → OnError?
onError callback triggered in case any error happens when fetching users
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
requestBuilder → UIBannedGroupMemberRequestBuilder?
requestBuilder set custom request builder
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
unbanIconUrl → String?
unbanIconUrl is a custom icon for the default option
final
unbanIconUrlPackageName → String?
unbanIconUrlPackageName is the package for the asset image to show as custom icon for the default option
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited