CometChatDetails class
CometChatDetails is a mediator component that provides access to components for viewing, adding, banning group members if the CometChatDetails component is being shown for a Group and also components for transferring ownership and leaving the group and options for blocking and unblocking a user if the CometChatDetails component for a User
for a User
CometChatDetails(
user: User(uid: 'uid', name: 'name'),
detailsStyle: DetailsStyle(),
addMemberConfiguration: AddMemberConfiguration(),
bannedMemberConfiguration: BannedMemberConfiguration(),
groupMembersConfiguration: GroupMembersConfiguration(),
transferOwnershipConfiguration: TransferOwnershipConfiguration(),
);
for a Group
CometChatDetails(
group: Group(guid: 'guid', name: 'name', type: 'public'),
detailsStyle: DetailsStyle(),
addMemberConfiguration: AddMemberConfiguration(),
bannedMemberConfiguration: BannedMemberConfiguration(),
groupMembersConfiguration: GroupMembersConfiguration(),
transferOwnershipConfiguration: TransferOwnershipConfiguration(),
);
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- CometChatDetails
Constructors
-
CometChatDetails({Key? key, User? user, Group? group, String? title, DetailsStyle? detailsStyle, Widget? chatAvatar({String? name, required bool online, Color? rimColor, double? size, required String url})?, Widget? chatConversationItem({required String avatarName, String? avatarUrl, bool? isGroupChat, String? lastAction, bool? online, String? subtitle, DateTime? time, required String title, int? unreadCount})?, bool? showCloseButton = true, Icon? closeButtonIcon, List<
CometChatDetailsTemplate> ? data(Group? group, User? user)?, GroupMembersConfiguration? groupMembersConfiguration, AddMemberConfiguration? addMemberConfiguration, TransferOwnershipConfiguration? transferOwnershipConfiguration, BannedMemberConfiguration? bannedMemberConfiguration, void stateCallBack(CometChatDetailsController)?, bool disableUsersPresence = false, List<Widget> ? appBarOptions, ListItemStyle? listItemStyle, AvatarStyle? avatarStyle, StatusIndicatorStyle? statusIndicatorStyle, Widget? subtitleView({BuildContext context, Group? group, User? user})?, bool? hideProfile, Widget? customProfileView, Widget? protectedGroupIcon, Widget? privateGroupIcon, CometChatTheme? theme, VoidCallback? onBack, ConfirmDialogStyle? leaveGroupDialogStyle, OnError? onError})
Properties
-
appBarOptions
→ List<
Widget> ? -
appBarOptions list of options to be visible in app bar
final
- avatarStyle → AvatarStyle?
-
avatarStyle set style for avatar
final
- chatAvatar → Widget? Function({String? name, required bool online, Color? rimColor, double? size, required String url})?
-
final
- chatConversationItem → Widget? Function({required String avatarName, String? avatarUrl, bool? isGroupChat, String? lastAction, bool? online, String? subtitle, DateTime? time, required String title, int? unreadCount})?
-
final
- closeButtonIcon → Icon?
-
to change closeButtonIcon
final
- customProfileView → Widget?
-
customProfileView provides a customized view profile for users
final
- detailsStyle → DetailsStyle?
-
detailsStyle is used to pass styling properties
final
- disableUsersPresence → bool
-
disableUsersPresence controls visibility of status indicator
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideProfile → bool?
-
hideProfile hides view profile for users
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- listItemStyle → ListItemStyle?
-
listItemStyle style for every list item
final
- onBack → VoidCallback?
-
onBack callback triggered on closing this screen
final
- privateGroupIcon → Widget?
-
privateGroupIcon provides icon in status indicator for private group
final
- protectedGroupIcon → Widget?
-
protectedGroupIcon provides icon in status indicator for protected group
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showCloseButton → bool?
-
showCloseButton toggles visibility for close button
final
- statusIndicatorStyle → StatusIndicatorStyle?
-
statusIndicatorStyle set style for status indicator
final
- subtitleView → Widget? Function({BuildContext context, Group? group, User? user})?
-
subtitleView to set subtitle for each conversation
final
- theme → CometChatTheme?
-
theme custom theme
final
- title → String?
-
to pass CometChatDetails header text use title
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
-
getDefaultSubtitleView(
BuildContext context, CometChatTheme theme, CometChatDetailsController detailsController) → 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