CometChatContacts class

CometChatContacts is a component that displays a list of users and groups with the help of CometChatListBase and CometChatListItem fetched users and groups are listed down alphabetically and in order of recent activity users are fetched using UsersBuilderProtocol and UsersRequestBuilder groups are fetched using GroupsBuilderProtocol and GroupsRequestBuilder

  CometChatContacts(
  contactsStyle: ContactsStyle(),
);
Inheritance

Constructors

CometChatContacts({Key? key, UsersConfiguration? usersConfiguration, UserGroupBuilder? onItemTap, GroupsConfiguration? groupsConfiguration, String? usersTabTitle, String? groupsTabTitle, CometChatTheme? theme, String? title, Widget? closeIcon, ContactsStyle contactsStyle = const ContactsStyle(), VoidCallback? onClose, dynamic onSubmitIconTap(BuildContext context, List<User>? selectedUsersList, List<Group>? selectedGroupsList)?, TabVisibility tabVisibility = TabVisibility.usersAndGroups, bool? hideSubmitIcon, int? selectionLimit = 5, SelectionMode? selectionMode, Widget? submitIcon, SnackBarConfiguration? snackBarConfiguration})
const

Properties

closeIcon → Widget?
closeIcon close icon widget
final
contactsStyle → ContactsStyle
contactsStyle sets style
final
groupsConfiguration → GroupsConfiguration?
GroupConfiguration custom request groups request builder protocol
final
groupsTabTitle → String?
groupsTabTitle title text of group tab
final
hashCode → int
The hash code for this object.
no setterinherited
hideSubmitIcon → bool?
hideSubmitIcon triggered visibility of selection icon
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onClose → VoidCallback?
onClose call function to be called on close button click
final
onItemTap → UserGroupBuilder?
onItemTap callback triggered on tapping a user or group item
final
onSubmitIconTap → dynamic Function(BuildContext context, List<User>? selectedUsersList, List<Group>? selectedGroupsList)?
onSubmitIconTap triggered when clicked on submit icon
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectionLimit → int?
selectionLimit set the limit for maximum selection limit, default limit is 5
final
selectionMode → SelectionMode?
SelectionMode sets the selection mode
final
snackBarConfiguration → SnackBarConfiguration?
snackBarConfiguration sets configuration properties for showing snackBar
final
submitIcon → Widget?
submitIcon triggered when clicked on submit icon
final
tabVisibility → TabVisibility
tabVisibility parameter to alter visibility of different tabs
final
theme → CometChatTheme?
theme set custom theme
final
title → String?
title sets title for the list
final
usersConfiguration → UsersConfiguration?
usersConfiguration set custom users request builder protocol
final
usersTabTitle → String?
usersTabTitle title text of user tab
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CometChatContacts>
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, 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