cometchat_chat_uikit library

Classes

Abc
Action
This class represents an action performed in the chat.
ActionElementFields
ActionEntity
A base class for representing actions in a chat application.
ActionItem
ActionItem is the type of items displayed in CometChatActionSheet
ActionMessageTypeConstants
ActionTypeConstants
AdditionalConfigurations
AdditionalConfigurations is a class that can be used to add additional configurations to the UI Kit
AddMemberConfiguration
AddMemberConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatAddMembers can be used by a component where CometChatAddMembers is a child component
AddMembersStyle
AddMembersStyle is a data class that has styling-related properties to customize the appearance of CometChatAddMembers
AIAssistBotConfiguration
AIAssistBotConfiguration is a data class that has configuration properties to customize the functionality and appearance of AIAssistBotExtension
AIAssistBotController
AIAssistBotController is the view model for AIAssistBotView
AIAssistBotDecorator
AIAssistBotDecorator is a the view model for AIAssistBotExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
AIAssistBotExtension
AIAssistBotExtension is the controller class for enabling and disabling the extension enabling this extension you can use the assist bot ai feature
AIAssistBotMessage
AIAssistBotStyle
AIAssistBotStyle is a data class that has styling-related properties to customize the appearance of AIAssistBotExtension
AIAssistBotView
AIAssistBotView is a widget that is rendered as the content view for AIAssistBotExtension
AIConversationStarterConfiguration
AIConversationStarterConfiguration is a data class that has configuration properties to customize the functionality and appearance of AIConversationStarterExtension
AIConversationStarterDecorator
AIConversationStarterDecorator is a the view model for AIConversationStarterExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
AIConversationStarterExtension
AIConversationStarterExtension is the controller class for enabling and disabling the extension enabling this extension you can use the conversation starter ai feature
AIConversationStarterStyle
AIConversationStarterStyle is a data class that has styling-related properties to customize the appearance of AIConversationStarterExtension
AIConversationStarterView
AIConversationStarterView is a widget that is rendered as the content view for AIConversationStarterExtension
AIConversationSummaryConfiguration
AIConversationSummaryConfiguration is a data class that has configuration properties to customize the functionality and appearance of AIConversationSummaryConfiguration
AIConversationSummaryDecorator
AIConversationSummaryDecorator is a the view model for AIConversationSummaryExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
AIConversationSummaryExtension
AIConversationSummaryExtension is the controller class for enabling and disabling the extension enabling this extension you can use the conversation summary ai feature
AIConversationSummaryStyle
AIConversationSummaryStyle is a data class that has styling-related properties to customize the appearance of AIConversationSummaryStyle
AIConversationSummaryView
AIConversationSummaryView is a widget that is rendered as the content view for AIConversationSummaryView
AIExtension
AIFeatureConstants
AIFeatureConstants is a data class for storing String constants related to Ai names
AIOptionsStyle
AISmartRepliesConfiguration
AISmartRepliesDecorator
AISmartRepliesDecorator is a the view model for AiSmartReplyExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
AISmartRepliesExtension
AISmartRepliesExtension is the controller class for enabling and disabling the extension enabling this extension would display smart replies to send.
AISmartRepliesStyle
AISmartRepliesStyle is a data class that has styling-related properties to customize the appearance of AISmartRepliesView
AISmartRepliesView
AISmartRepliesView is a widget that is rendered as the content view for AISmartRepliesExtension
APIAction
Represents an action that makes an API request in a chat application.
APIRequestTypeConstants
AppEntity
Represents an entity within the application.
AppSettings
Represents application settings.
AppSettingsBuilder
Builder class for AppSettings.
AssetConstants
AssetConstants is a utility class that stores String constants of asset image paths
Attachment
Represents a file attachment.
AttributedText
AttributedText is a class which is used to style the text
AudioBubbleStyle
AudioBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatAudioBubble
AvatarStyle
AvatarStyle is a data class that has styling-related properties to customize the appearance of CometChatAvatar
BadgeStyle
BadgeStyle is a data class that has styling-related properties to customize the appearance of CometChatBadge
BannedGroupMemberRequestImplementer
BannedGroupMemberRequestImplementer is a class that implements UIBannedGroupMemberRequestBuilder interface
BannedGroupMembersRequest
A request object for fetching banned group members.
BannedGroupMembersRequestBuilder
Builder class for BannedGroupMembersRequest.
BannedMemberBuilderProtocol
BannedMemberConfiguration
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
BannedMembersStyle
BannedMembersStyle is a data class that has styling-related properties to customize the appearance of CometChatBannedMembers
BaseInputElement<T>
BaseInteractiveElement
BaseMessage
Represents a basic chat message.
BaseStyles
BaseStyles is the base style class for most style classes provided by CometChatUIKit
BlockedUsersRequest
A request object for fetching blocked users.
BlockedUsersRequestBuilder
Builder class for BlockedUsersRequest.
BubbleContentVerifier
BubbleUtils
BuilderProtocol<T1, T2>
BuilderProtocol is the Marker class to define protocols Used to generate different request builders T1 is the type of Request builder to be passed and T2 should be the respective request type eg for user list T1 will be UsersRequestBuilder and T2 will be UsersRequest
ButtonElement
Represents a button model class , used to draw button element .
ButtonElementStyle
ButtonStyle
ButtonStyle is a model class for button widget. It contains the styles for the button widget.
Call
Represents a call event within the chat.
CallStatusConstants
CallStatusConstants is a utility class that stores String constants of various stages of Call
CallTypeConstants
CardBubbleStyle
CardBubbleStyle is a model class for card widget. It contains the styles for the card widget.
CardMessage
Represents a message with a card view that contains interactive elements.
CardMessageKeys
CardStyle
CardStyle is a model class for card widget. It contains the styles for the card widget.
ChatConfigurator
This is the configurator class for adding extensions logics
ChatSDKEventInitializer
CheckBoxElement
Represents a checkbox model class , used to draw checkbox .
CheckBoxElementStyle
CircularIntervalList<T>
CollaborativeDocumentConfiguration
CollaborativeDocumentConfiguration is a data class that has configuration properties to customize the functionality and appearance of CollaborativeDocumentExtension
CollaborativeDocumentExtension
CollaborativeDocumentExtension is the controller class for enabling and disabling the extension the extension provides a document to collaborate on will be received on the client side realtime through the message listener onCustomMessageReceived
CollaborativeDocumentExtensionDecorator
CollaborativeDocumentExtensionDecorator is a the view model for CollaborativeDocumentExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
CollaborativeDocumentOptionStyle
CollaborativeDocumentOptionStyle is a data class that has styling-related properties to customize the appearance of the option in the attachment options menu for the CollaborativeDocumentExtension
CollaborativeWhiteBoardConfiguration
CollaborativeWhiteBoardConfiguration is a data class that has configuration properties to customize the functionality and appearance of CollaborativeWhiteBoardExtension
CollaborativeWhiteBoardExtension
CollaborativeWhiteBoardExtension is the controller class for enabling and disabling the extension this extension provides users a whiteboard to collaborate on will be received on the client side realtime through the message listener onCustomMessageReceived
CollaborativeWhiteBoardExtensionDecorator
CollaborativeWhiteBoardExtensionDecorator is a the view model for CollaborativeWhiteBoardExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
CollaborativeWhiteboardOptionStyle
CollaborativeWhiteboardOptionStyle is a data class that has styling-related properties to customize the appearance of the option in the attachment options menu for the CollaborativeWhiteBoardExtension
CometChat
Flutter wrapper for using CometChat SDK.
CometChatActionSheet
CometChatAddMembers
CometChatAddMembers is a component that internally uses CometChatUsers component to display a list of users who can be added to a particular group
CometChatAddMembersController
CometChatAddMembersController is the view model for CometChatAddMembers it contains all the business logic involved in changing the state of the UI of CometChatAddMembers
CometChatAudioBubble
CometChatAudioBubble creates a widget that gives audio bubble
CometChatAvatar
CometChatAvatar is a widget that gives a container for avatar images
CometChatBadge
CometChatBadge is a widget to display a small amount of information about its a component like a count or status
CometChatBannedMembers
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
CometChatBannedMembersController
CometChatBannedMembersController is the view model for CometChatBannedMembers it contains all the business logic involved in changing the state of the UI of CometChatBannedMembers
CometChatBaseOptions
CometChatBaseOptions is a model class which contains a set of properties that is be used by CometChatDetailsOption, CometChatGroupMemberOption thus forming a common base class for both
CometChatBlockedUsersDirection
CometChatButton
CometChatButton is a button widget with customizable styles. Use this widget along with cometchat_btn_style.ButtonStyle to modify the default style.
CometChatCallEvents
class for handling call events.
CometChatCallStatus
CometChatCallType
CometChatCard
CometChatCard is a prebuilt widget which is used to display a card with title, subtitle, avatar and bottom view.
CometChatCardBubble
CometChatCardBubble creates the card view for InteractiveMessage with type MessageTypeConstants.card by default
CometChatCollaborativeDocumentBubble
CometChatCollaborativeDocumentBubble a widget that provides access to collaborative document where users can work on common document
CometChatCollaborativeWebView
CometChatCollaborativeWebView is widget that renders a WebView
CometChatCollaborativeWhiteBoardBubble
CometChatCollaborativeWhiteboardBubble is a widget that is rendered as the content view for CometChatCollaborativeWhiteboardExtension
CometChatContacts
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
CometChatContactsController
CometChatUsersController is the view model for CometChatUsers
CometChatConversationEvents
Event emitting class for CometchatConversation
CometChatConversations
CometChatConversations is a component that shows all conversations involving the logged in user with the help of CometChatListBase and CometChatListItem By default, for each conversation that will be listed, the name of the user or group the logged in user is having conversation with will be displayed in the title of every list item, the subtitle will contain the last message in that conversation along with its receipt status, the leading view will contain the avatars of the user and groups and status indicator will indicate if users are online and icons for indicating a private or password protected group, and the trailing view will contain the time of the last message in that conversation and the number of unread messages.
CometChatConversationsController
CometChatConversationsController is the view model for CometChatConversations it contains all the business logic involved in changing the state of the UI of CometChatConversations
CometChatConversationsWithMessages
CometChatConversationsWithMessages is a component that is composed of CometChatConversations and CometChatMessages component
CometChatConversationsWithMessagesController
CometChatConversationsWithMessagesController is the view model for CometChatConversationsWithMessages it contains all the business logic involved in changing the state of the UI of CometChatConversationsWithMessages
CometChatConversationType
CometChatCreateGroup
CometChatCreateGroup is a widget that allows users to create different type of groups
CometChatCreateGroupController
CometChatCreateGroupController is the view model for CometChatCreateGroup it contains all the business logic involved in changing the state of the UI of CometChatCreateGroup
CometChatDate
CometChatDate is a widget that provides a customizable container to display date and time
CometChatDateTimeFormField
CometChatDecoratedContainer
CometChatDeleteMessageBubble
CometChatDeleteMessageBubble is a widget that provides a placeholder for messages thave been deleted
CometChatDetails
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
CometChatDetailsController
CometChatDetailsController is the view model for CometChatDetails it contains all the business logic involved in changing the state of the UI of CometChatDetails
CometChatDetailsControllerProtocol
CometChatDetailsOption
CometChatDetailsOption is a model class which contains information about options available for every CometChatDetailsTemplate
CometChatDetailsTemplate
CometChatDetailsTemplate is the section of options displayed in CometChatDetails
CometChatEmailFormatter
CometChatEmailFormatter is a class which is used to style the email text
CometChatEmojiKeyboard
CometChatFileBubble
CometChatFileBubble creates a widget that gives file bubble
CometChatFormBubble
A widget for displaying a chat form bubble for category MessageCategoryConstants.interactive and type MessageTypeConstants.form .
CometChatGroupActionBubble
creates a widget that gives group action bubble
CometChatGroupEvents
CometChatGroupMemberOption
CometChatGroupMemberOption is a model class which contains information about options available to execute for every GroupMember
CometChatGroupMembers
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
CometChatGroupMembersController
CometChatGroupMembersController is the view model for CometChatGroupMembers it contains all the business logic involved in changing the state of the UI of CometChatGroupMembers
CometChatGroupMembersControllerProtocol
CometChatGroups
CometChatGroups is a component that displays a list of groups available in the app with the help of CometChatListBase and CometChatListItem fetched groups are listed down alphabetically and in order of recent activity groups are fetched using GroupsBuilderProtocol and GroupsRequestBuilder
CometChatGroupsController
CometChatGroupsController is the view model for CometChatGroups it contains all the business logic involved in changing the state of the UI of CometChatGroups
CometChatGroupScope
CometChatGroupScope is an utility component which displays scopes of a group member with respect to the group they are part of if the scope is permitted to be changed then suggestions of possible scopes appear in dropdown else a simple text is shown if it cannot be changed
CometChatGroupsWithMessages
CometChatGroupsWithMessages is a component that uses CometChatGroups to display a list of groups and allows to access the CometChatMessages component for each group
CometChatGroupsWithMessagesController
CometChatGroupsWithMessagesController is the view model for CometChatGroupsWithMessages it contains all the business logic involved in changing the state of the UI of CometChatGroupsWithMessages
CometChatGroupType
CometChatHelper
CometChatImageBubble
CometChatImageBubble creates a widget that gives image bubble
CometChatJoinProtectedGroup
CometChatJoinProtectedGroup is a component that provides a screen with a form field to join a password protected group
CometChatJoinProtectedGroupController
CometChatJoinProtectedGroupController is the view model for CometChatJoinProtectedGroup it contains all the business logic involved in changing the state of the UI of CometChatJoinProtectedGroup
CometChatListBase
CometChatListBase is a top level container widget used internally by components like CometChatUsers, CometChatGroups, CometChatConversations, CometChatGroupMembers
CometChatListController<T1, T2>
Common Controller Class which holds the logic to fetch data from different request builders
CometChatListItem
CometChatListItem is a top level container widget used internally for displaying each item in components like CometChatUsers, CometChatGroups, CometChatConversations, CometChatGroupMembers
CometChatMediaRecorder
CometChatMediaRecorder is a class that allows users to record audio messages. It has a start button to start recording, a stop button to stop recording, a play button to play the recorded message, a pause button to pause the recorded message, a submit button to submit the recorded message and a close button to close the media recorder.
CometChatMemberScope
CometChatMentionsFormatter
CometChatMentionsFormatter is a class which is used to format the mentions It extends the CometChatTextFormatter It has properties like composerId, onError, suggestionListEventSink, previousTextEventSink, message, mentionedUsersMap, mentionCount, mentionStartIndex, mentionEndIndex, lastCursorPos It has methods like handlePreMessageSend, initializeFetchRequest, fetchItems, onMessageEdit, resetMentionsTracker, cursorInMentionTracker, onChange, onScrollToBottom It has a constructor which takes trackingCharacter, pattern, disableSuggestions, showLoadingIndicator, onSearch, group, composerId, onError, suggestionListEventSink, previousTextEventSink, theme, message, messageBubbleTextStyle, groupMembersRequestBuilder, usersRequestBuilder, messageInputTextStyle as a parameter It has a method onMentionTap which is used to handle the mention tap
CometChatMessageBubble
CometChatMessageBubble is a widget that provides the skeleton structure for any message bubble constructed from a CometChatMessageTemplate which doesnt have a bubbleView it binds together the leadingView, headerView, contentView, footerView, bottomView, threadView declared in the CometChatMessageTemplate to collectively form a message bubble
CometChatMessageCategory
CometChatMessageComposer
CometChatMessageComposer component allows users to send messages and attachments to the chat, participating in the conversation.
CometChatMessageComposerAction
CometChatMessageComposerAction is the type of menu items allowed to be displayed CometChatMessageComposer
CometChatMessageComposerController
CometChatMessageComposerController is the view model for CometChatMessageComposer it contains all the business logic involved in changing the state of the UI of CometChatMessageComposer
CometChatMessageEvents
Event emitting class for CometChatMessages
CometChatMessageHeader
CometChatMessageHeader is a widget which shows user/group details using CometChatListItem if its being shown for an User then the name of the user will be in the title of CometChatListItem and their online/offline status will be in the subtitle if its being shown for an Group then the name of the group will be in the title of CometChatListItem and their member count will be in the subtitle
CometChatMessageHeaderController
CometChatMessageHeaderController is the view model for CometChatMessageHeader it contains all the business logic involved in changing the state of the UI of CometChatMessageHeader
CometChatMessageInformation
CometChatMessageInformation is a widget that internally uses CometChatListBase to display message information.
CometchatMessageInformationController
CometchatMessageInformationController is the view model for CometChatMessageInformation it contains all the business logic involved in changing the state of the UI of CometChatMessageInformation
CometChatMessageInput
CometChatMessageInput is a component that provides a skeleton layout for contents of CometChatMessageComposer like TextField, auxiliary options, primary button view and attachment options.
CometChatMessageList
CometChatMessageList is a component that lists all messages with the help of appropriate message bubbles messages are fetched using MessagesBuilderProtocol and MessagesRequestBuilder fetched messages are listed down in way such that the most recent message will appear at the bottom of the list and the user would have to scroll up to see the previous messages sent or received and as user scrolls up, messages will be fetched again using MessagesBuilderProtocol and MessagesRequestBuilder if available when a new message is sent it will automatically scroll to the bottom of the list if the user has scrolled to the top and when a new message is received then a sticky UI element displaying newMessageIndicatorText will show up at the top of the screen if the user has scrolled to the top
CometChatMessageListController
CometChatMessageListController is the view model for CometChatMessageList it contains all the business logic involved in changing the state of the UI of CometChatMessageList
CometChatMessageListControllerProtocol
CometChatMessageOption
Model class for message options
CometChatMessagePreview
CometChatMessagePreview is a component that provides a bubble consisting of text that can be appended to the message composer, message bubble or any other component as desired the appearance is similar to quote block of markdown files
CometChatMessagePreviewStyle
CometChatMessages
CometChatMessages is a component that provides a skeleton structure that binds together CometChatMessageHeader, CometChatMessageList, CometChatMessageComposer component. and it also facilitates the communication between these components.
CometChatMessagesController
CometChatMessagesController is the view model for CometChatMessages it contains all the business logic involved in changing the state of the UI of CometChatMessages
CometChatMessageTemplate
CometChatMessageTemplate class for setting message types and rendering appropriate views in the message list
CometChatMessageType
CometChatNotificationErrorCode
CometChatNotificationErrorMessages
CometChatNotifications
CometChatOption
CometChatOption is a model class which is used to execute any action on a CometChatListItem
CometChatPhoneNumberFormatter
CometChatPhoneNumberFormatter is a class which is used to style the phone number text
CometChatPollsBubble
CometChatPollsBubble is a widget that is rendered as the content view for PollsExtension
CometChatQuickView
The CometChatQuickView widget is used to display a quick view with a title and an optional subtitle. You can customize the appearance of the title and subtitle using the titleTextStyle and subtitleTextStyle parameters.
CometChatReactionList
CometChatReactionList is a StatefulWidget that displays the list of reactions for a particular message. It requires reactionRequestBuilder to fetch the reactions of a particular message. It also requires messageObject to fetch the reactions of a particular message. It also requires onTap to perform some action on click of a particular reaction.
CometChatReactionListController
CometChatReactions
CometChatReactions is a widget which is used to set the reactions It takes reactionList, theme, alignment, onReactionTap, onReactionLongPress, reactionsStyle as a parameter
CometChatReceipt
CometChatReceipt is a widget that indicates the delivery status of a message by default, a single tick mark indicates a message has been sent a double tick mark indicates a message has been delivered a double tick mark of color cometChatTheme.palette.primary indicates a message has been read
CometChatReceiptType
CometChatReceiverType
CometChatSchedulerBubble
CometChatSchedulerBubble is a widget which is used to display a meeting bubble. Use this widget along with SchedulerBubbleStyle to customize the appearance of CometChatSchedulerBubble.
CometChatSearchListController<T1, T2>
An abstract class which holds the logic for searching in different lists
CometChatSearchListControllerProtocol<T1>
CometChatSingleSelect
A Flutter widget for creating a single select element with multiple options.
CometChatSingleSelectButton
CometChatStartConversationType
CometChatStartConversationType is a utility class that stores String constants of the types of CometChatContacts
CometChatStatusIndicator
CometChatStatusIndicator is a widget that is used to indicate the online status of a User
CometChatStickerBubble
CometChatStickerBubble is a widget that is rendered as the content view for StickersExtension
CometChatStickerKeyboard
CometChatStickerKeyboard renders a keyboard consisting of stickers provided by the extension
CometChatSubscriptionType
CometChatTextBubble
CometChatTextBubble is a widget that gives text bubble
CometChatTextFormatter
CometChatTextFormatter is an abstract class which is used to format the text It has properties like trackingCharacter, pattern, onSearch, showLoadingIndicator, messageBubbleTextStyle, messageInputTextStyle It has methods like init, handlePreMessageSend, onScrollToBottom, buildInputFieldText, mergeAttributedText, getAttributedText, onChange, getLoadingIndicator, getMessageInputTextStyle, getMessageBubbleTextStyle
CometChatTheme
Themes class for defining palette and typography
CometChatThreadedMessageController
CometChatThreadedMessageController is the view model for CometChatThreadedMessages it contains all the business logic involved in changing the state of the UI of CometChatThreadedMessages
CometChatThreadedMessages
CometChatThreadedMessages is a widget that internally uses CometChatListBase, CometChatMessageList and CometChatMessageComposer to display and create messages with respect to a certain parent message
CometChatTimeSlotSelector
CometChatTransferOwnership
CometChatTransferOwnership is a component that internally uses CometChatGroupMembers that displays a list of group members to whom the ownership of the group they are part of can be transferred to
CometChatTransferOwnershipController
CometChatTransferOwnershipController is the view model for CometChatTransferOwnership it contains all the business logic involved in changing the state of the UI of CometChatTransferOwnership
CometChatUIEvents
CometChatUIKit
CometChatUIKitChatAIFeatures
CometChatUIKitChatAIFeatures is a utility class that provides a list of default ai features
CometChatUIKitChatExtensions
CometChatUIKitChatExtensions is a utility class that provides a list of default extensions
CometChatUIKitHelper
CometChatUIKitHelper contains static methods for triggering local events
CometChatUrlFormatter
CometChatUrlFormatter is a class which is used to style the url text
CometChatUserEvents
CometChatUsers
CometChatUsers is a component that displays a list of users with the help of CometChatListBase and CometChatListItem fetched users are listed down alphabetically and in order of recent activity users are fetched using UsersBuilderProtocol and UsersRequestBuilder
CometChatUsersController
CometChatUsersController is the view model for CometChatUsers
CometChatUserStatus
CometChatUsersWithMessages
CometChatUsersWithMessages is a component that uses CometChatUsers to display a list of users and allows to access the CometChatMessages component for each user
CometChatUsersWithMessagesController
CometChatUsersWithMessagesController is the view model for CometChatUsersWithMessages it contains all the business logic involved in changing the state of the UI of CometChatUsersWithMessages
CometChatVideoBubble
CometChatVideoBubble creates a widget that gives video bubble
CometChatWebView
CometChatWebView is widget that renders a WebView
CometChatWSState
ConfirmDialogStyle
ConfirmDialogStyle is a data class that has styling-related properties to customize the appearance of ConfirmDialog
ContactsConfiguration
ContactsConfiguration is a component that displays a list of users and groups with the help of CometChatListBase and CometChatListItem
ContactsStyle
ContactsStyle is a data class that has styling-related properties to customize the appearance of CometChatContacts
Conversation
Represents a chat conversation.
ConversationOptionConstants
ConversationOptionConstants is a utility class that stores String constants of options available for Conversation items
ConversationsBuilderProtocol
ConversationsBuilderProtocol is an interface that defines the structure for fetching the conversation. It provides a generic requestBuilder property and methods getRequest and getSearchRequest that needs to be overridden.
ConversationsConfiguration
ConversationsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatConversations can be used by a component where CometChatConversations is a child component {@tool snippet}
ConversationsRequest
A request object for fetching conversations.
ConversationsRequestBuilder
Builder class for ConversationsRequest.
ConversationsStyle
ConversationsStyle is a data class that has styling-related properties to customize the appearance of CometChatConversations
ConversationsWithMessagesConfiguration
ConversationsWithMessagesConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatConversationsWithMessages can be used by a component where CometChatConversationsWithMessages is a child component
ConversationType
ConversationUpdateSettings
ConversationUtils
ConversationUtils is an Utility class that helps to the last message for any conversation and also provides the default action to execute on a conversation
CreateGroupConfiguration
CreateGroupConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCreateGroup can be used by a component where CometChatCreateGroup is a child component
CreateGroupStyle
CreateGroupStyle is a data class that has styling-related properties to customize the appearance of CometChatCreateGroup
CreatePoll
CreatePoll is a widget used to create a poll bubble accessible from attachment menu options
CreatePollsStyle
CreatePollsStyle is a data class that has styling-related properties to customize the appearance of CometChatCreatePolls
CustomInteractiveMessage
Represents a message that includes various types of messages for interactive elements.
CustomMessage
Represents a custom chat message.
CustomStateView
CustomTextEditingController
DashOffset
DataSource
DataSource abstract class which every data source will implement inorder to provide any extension functionality
DataSourceDecorator
DataSourceDecorator should be extended when creating any extension
DateStyle
DateStyle is a data class that has styling-related properties to customize the appearance of CometChatDate
DateTimeElement
Represents a dropdown model class , used to draw dropdown .
DateTimeElementStyle
DaySchedule
Debouncer
DecoratedContainerStyle
DeletedBubbleStyle
DeletedBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatDeleteMessageBubble
DetailsConfiguration
DetailsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatDetails can be used by a component where CometChatDetails is a child component
DetailsStyle
DetailsStyle is a data class that has styling-related properties to customize the appearance of CometChatDetails
DetailsTemplateConstants
DetailsTemplateConstants is a utility class that stores String constants of the types of CometChatDetailsTemplate
DetailUtils
DetailUtils is a Utility class that provides the default options and templates available in CometChatDetails which allows users to block and unblock other users group members to view, add, ban other members
DocumentBubbleStyle
DocumentBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatDocumentBubble
DottedBorder
Represents a dropdown model class , used to draw dropdown .
ElementEntity
EmojiKeyboardStyle
EmojiKeyboardStyle is a data class that has styling-related properties to customize the appearance of CometChatEmojiKeyboard
ErrorCode
ErrorMessage
EventHandler
ExtensionConstants
ExtensionConstants is a data class for storing String constants related to extension names
ExtensionModerator
ExtensionModerator is an utility class that scans for information of applied extensions inside the metadata of a BaseMessage
ExtensionsDataSource
Protocol class every Extension enabler should extend,
ExtensionType
ExtensionType is a data class for storing String constants related to extension types
ExtensionUrls
ExtensionUrls is a data class for storing String constants related to extension urls
FileBubbleStyle
FileBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatFileBubble
FontBasics
FontStyle
Base class for
Formatter
FormatterUtils
FormatterUtils is an utility class which is used to style the text in the message bubble and the conversation subtitle
FormBubbleStyle
Styling options for the form bubble widget.
FormMessage
Represents a message that includes a form with interactive elements.
Group
Represents a group within the chat.
GroupActionBubbleStyle
GroupMember
Represents a group member within the chat.
GroupMemberOptionConstants
GroupMemberOptionConstants is a utility class that stores String constants of the actions permitted to a GroupMember to execute on a particular Group
GroupMembersBuilderProtocol
GroupMembersBuilderProtocol is an interface that defines the structure for fetching the group members. It provides a generic requestBuilder property and methods getRequest and getSearchRequest that needs to be overridden.
GroupMembersConfiguration
GroupMembersConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatGroupMembers can be used by a component where CometChatGroupMembers is a child component
GroupMemberScope
GroupMemberScope is a utility class that stores String constants of scope of GroupMember with respect to a particular Group
GroupMembersRequest
A request object for fetching group members.
GroupMembersRequestBuilder
Builder class for GroupMembersRequest.
GroupMembersStyle
GroupMembersStyle is a data class that has styling-related properties to customize the appearance of CometChatGroupMembers
GroupOptionConstants
GroupOptionConstants is a utility class that stores String constants of the options available in CometChatDetails if it is being rendered for a Group
GroupPreferences
GroupsBuilderProtocol
GroupsBuilderProtocol is an interface that defines the structure for fetching the groups. It provides a generic requestBuilder property and methods getRequest and getSearchRequest that needs to be overridden.
GroupsConfiguration
GroupsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatGroups can be used by a component where CometChatGroups is a child component
GroupScopeStyle
GroupScopeStyle is a data class that has styling-related properties to customize the appearance of CometChatGroupScope
GroupsRequest
A request object for fetching groups.
GroupsRequestBuilder
Builder class for GroupsRequest.
GroupsStyle
GroupsStyle is a data class that has styling-related properties to customize the appearance of CometChatGroups
GroupsWithMessagesConfiguration
GroupsWithMessagesConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatGroupsWithMessages can be used by a component where CometChatGroupsWithMessages is a child component
GroupTypeConstants
GroupTypeConstants is a utility class that stores String constants of the types of Group
IDMapConstants
ImageBubbleStyle
ImageBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatImageBubble
ImageModerationConfiguration
ImageModerationConfiguration is a data class that has configuration properties to customize the functionality and appearance of ImageModerationExtension can be used by a component where ImageModerationExtension is a child component
ImageModerationExtension
ImageModerationExtension is the controller class for enabling and disabling the extension it censors images with graphic content
ImageModerationExtensionDecorator
ImageModerationExtensionDecorator is a the view model for ImageModerationExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
ImageModerationFilter
ImageModerationFilter is a widget that renders an overlay filter over an image with graphic content
ImageModerationFilterStyle
ImageModerationFilterStyle is a data class that has styling-related properties to customize the appearance of ImageModerationFilter
ImageViewer
Gives Full Screen image view for passed image url
Interaction
Represents an interaction within the chat.
InteractionGoal
Represents an interaction goal within the chat.
InteractionGoalType
InteractionGoalTypeConstants
InteractionReceipt
Represents an interaction receipt within the chat.
InteractiveMessage
Represents a interactive message within the chat.
InteractiveMessageConstants
InteractiveMessageUtils
JoinProtectedGroupConfiguration
JoinProtectedGroupConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatJoinProtectedGroup can be used by a component where CometChatJoinProtectedGroup is a child component
JoinProtectedGroupStyle
JoinProtectedGroupStyle is a data class that has styling-related properties to customize the appearance of CometChatJoinProtectedGroup
LabelElement
Represents a label model class , used to draw label .
LinkPreviewBubble
LinkPreviewBubble is a widget that is rendered as the content view for LinkPreviewExtension
LinkPreviewBubbleStyle
LinkPreviewBubbleStyle is a data class that has styling-related properties to customize the appearance of LinkPreviewBubble
LinkPreviewConfiguration
LinkPreviewConfiguration is a data class that has configuration properties to customize the functionality and appearance of LinkPreviewExtension
LinkPreviewExtension
LinkPreviewExtension is the controller class for enabling and disabling the extension its shows previews for links that have open graph image and favicon declared in meta data to web page and also the link should follow http(s) scheme
LinkPreviewExtensionDecorator
LinkPreviewExtensionDecorator is a the view model for LinkPreviewExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
ListBaseStyle
ListBaseStyle is a data class that has styling-related properties to customize the appearance of CometChatListBase
ListItemStyle
ListItemStyle is a data class that has styling-related properties to customize the appearance of CometChatListItem
LiveReactionConstants
LiveReactionConstants is a utility class that stores constant values related to functioning of TransientMessage
MediaMessage
Represents a media message within the chat.
MediaPicker
MediaRecorderStyle
MediaRecorderStyle is a model class for customizing the styles of CometChatMediaRecorder widget.
MessageBubbleStyle
MessageBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageBubble
MessageCategoryConstants
MessageCategoryConstants is a utility class that stores String constants of categories of messages
MessageComposerConfiguration
MessageComposerConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatMessageComposer can be used by a component where CometChatMessageComposer is a child component
MessageComposerStyle
MessageComposerStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageComposer
MessageComposerSuggestions
MessageConfiguration
MessageConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatMessages can be used by a component where CometChatMessages is a child component
MessageExtensionTranslationDecorator
MessageExtensionTranslationDecorator is a the view model for MessageTranslationExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
MessageHeaderConfiguration
MessageHeaderConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatMessageHeader can be used by a component where CometChatMessageHeader is a child component
MessageHeaderStyle
MessageHeaderStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageHeader
MessageInformationConfiguration
MessageInformationConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatMessageInformation can be used by a component where CometChatConversationsWithMessages is a child component
MessageInformationStyle
MessageInformationStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageInformation
MessageInputStyle
MessageInputStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageInput
MessageListConfiguration
MessageListConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatMessageList can be used by a component where CometChatMessageList is a child component
MessageListStyle
MessageListStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageList
MessageOptionConstants
MessageOptionConstants is a utility class that stores String constants of the actions permitted to execute on a particular BaseMessage
MessageOptionSheet
MessageOptionSheet renders a bottom modal sheet that contains all the actions available to execute on a particular type of message
MessageReceipt
Represents a message receipt within the chat.
MessageReceiptUtils
MessageReceiptUtils is a utility class to determine receipt status
MessagesDataSource
MessagesDataSource is a Utility class that provides default templates to construct message bubbles and also provides the default set of options available for each message bubble
MessagesRequest
A request object for fetching messages.
MessagesRequestBuilder
Builder class for MessagesRequest.
MessagesStyle
MessagesStyle is a data class that has styling-related properties to customize the appearance of CometChatMessages
MessageTranslationBubble
MessageTranslationBubble is a widget that is rendered as the content view for MessageTranslationExtension
MessageTranslationBubbleStyle
MessageTranslationBubbleStyle is a data class that has styling-related properties to customize the appearance of MessageTranslationBubble
MessageTranslationConfiguration
MessageTranslationConfiguration is a data class that has configuration properties to customize the functionality and appearance of MessageTranslationExtension
MessageTranslationExtension
MessageTranslationExtension is the controller class for enabling and disabling the extension this extension temporarily translates text to the default language of the device if it is not so originally
MessageTranslationOptionStyle
MessageTranslationOptionStyle is a data class that has styling-related properties to customize the appearance of the option that appears in the bottom modal sheet on long-pressing a message bubble
MessageTypeConstants
MessageTypeConstants is a utility class that stores String constants of types of messages
MessageUtils
MetadataConstants
MetadataConstants is a utility class that stores String constants to use in the metadata property of a BaseMessage
ModelFieldConstants
MutedConversation
MutePreferences
NetworkUtils
NotificationPreferences
OneOnOnePreferences
OptionElement
Palette
Model class for Themes can also make custom objects to pass on to various theme variable to any CometChat UI element
PaletteModel
Modal class for modes
PickedFile
PollOptions
PollsBubbleStyle
PollsBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatPollsBubble
PollsConfiguration
PollsConfiguration is a data class that has configuration properties to customize the functionality and appearance of PollsExtension
PollsExtension
PollsExtension is the controller class for enabling and disabling the extension this extension allows to create a poll bubble will be received on the client side realtime through the message listener onCustomMessageReceived
PollsExtensionDecorator
PollsExtensionDecorator is a the view model for PollsExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
PollsOptionStyle
PollsOptionStyle is a data class that has styling-related properties to customize the appearance of the option in the attachment options menu for the PollsExtension
PushPreferences
QuickViewStyle
A class representing styling options for a Quick View widget.
RadioButtonElement
Represents a radio button model class , used to draw radio button .
RadioButtonElementStyle
Reaction
Represents a reaction within the chat.
ReactionAction
ReactionConstants
ReactionCount
Represents a count of reactions within the chat.
ReactionEvent
ReactionListConfiguration
ReactionListConfiguration is a class which is used to set the configuration for the reaction list It takes reactionRequestBuilder, errorStateView, errorStateText, loadingStateView, emptyStateView, emptyStateText, avatarStyle, onTap, reactionListStyle, selectedReaction, listItemStyle, messageObject, theme as a parameter
ReactionListStyle
ReactionListStyle is a class which is used to set the style for the reaction list It takes loadingIconTint, emptyTextStyle, errorTextStyle, subtitleTextStyle, width, height, background, gradient, border, borderRadius as a parameter
ReactionsConfiguration
ReactionsConfiguration is a class which is used to set the configuration for the reactions It takes theme, onReactionTap, onReactionLongPress, reactionsStyle as a parameter
ReactionsRequest
A request object for fetching reactions.
ReactionsRequestBuilder
Builder class for ReactionsRequest.
ReactionsStyle
ReactionsStyle is a class which is used to set the style for the reactions It takes reactionTextStyle, reactionCountTextStyle, width, height, background, gradient, border, borderRadius as a parameter
ReceiptStyle
ReceiptStyle is a data class that has styling-related properties to customize the appearance of CometChatReceipt
ReceiptTypeConstants
ReceiptTypeConstants is a utility class that stores String constants of the various stages of message delivery
ReceiverTypeConstants
ReceiverTypeConstants is a utility class that stores String constants of the types of AppEntity that can receive a BaseMessage
RegexConstants
RegexConstants is a utility contains patterns or verifying selective text inputs
RequestBuilderConstants
SchedulerBubbleStyle
SchedulerConstants
SchedulerMessage
SchedulerUtils
SectionSeparator
SingleSelectElement
Represents a single select element model class used to create a single select input element.
SingleSelectStyle
A class representing styling options for a single select element.
SmartReplyConfiguration
SmartReplyConfiguration is a data class that has configuration properties to customize the functionality and appearance of SmartReplyExtension
SmartReplyExtension
SmartReplyExtension is the controller class for enabling and disabling the extension enabling this extension would display automated suggestions to send in response of received text messages
SmartReplyExtensionDecorator
SmartReplyExtensionDecorator is a the view model for SmartReplyExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
SmartReplyStyle
SmartReplyStyle is a data class that has styling-related properties to customize the appearance of SmartReplyView
SmartReplyView
SmartReplyView is a widget that is rendered as the content view for SmartReplyExtension
SnackBarConfiguration
SnackBarUtils
SoundManager
SoundManager is an utility component that provides an audio player
StatusIndicatorStyle
StatusIndicatorStyle is a data class that has styling-related properties to customize the appearance of CometChatStatusIndicator
StatusIndicatorUtils
Sticker
Sticker is the model data class for storing the fetched stickers
StickerAuxiliaryButton
StickerAuxiliaryButton is the widget that represents the StickersExtension in auxiliary button view of the CometChatMessageComposer
StickerConfiguration
StickerConfiguration is a data class that has configuration properties to customize the functionality and appearance of StickersExtension
StickerKeyboardStyle
StickerKeyboardStyle is a data class that has styling-related properties to customize the appearance of CometChatStickerKeyboard
StickersExtension
StickersExtension is the controller class for enabling and disabling the extension this extension offers a wide range of stickers to share as custom messages
StickersExtensionDecorator
StickersExtensionDecorator is a the view model for StickersExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
SuggestionListItem
SuggestionListItem is a modal class used to define the structure of the list item used in the suggestions list.
SwipeTile
SwipeTile is stacked widget which can take a child widget as input upon pressing that child widget down and sliding it to the left menu items are revealed
SwipeTileOptions
TextBubbleStyle
TextBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatTextBubble
TextInputElement
Represents a text input model class , used to draw text input element .
TextInputElementStyle
TextInputPlaceholder
placeholder model for Text field
TextMessage
Represents a text message within the chat.
TextModerationConfiguration
TextModerationConfiguration is a data class that has configuration properties to customize the functionality and appearance of TextModerationExtension
TextModerationExtension
TextModerationExtension is the controller class for enabling and disabling the extension the extension censors out abusive words and sensitive information such as personal details, email ids
TextModerationExtensionDecorator
TextModerationExtensionDecorator is a the view model for TextModerationExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
ThreadedMessagesConfiguration
ThreadedMessagesConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatThreadedMessages
ThreadedMessageStyle
ThreadedMessageStyle is a data class that has styling-related properties to customize the appearance of CometChatThreadedMessages
ThumbnailGenerationConfiguration
ThumbnailGenerationConfiguration is a data class that has configuration properties to customize the functionality and appearance of ThumbnailGenerationExtension
ThumbnailGenerationExtension
ThumbnailGenerationExtension is the controller class for enabling and disabling the extension the extension generates thumbnails for images and videos
ThumbnailGenerationExtensionDecorator
ThumbnailGenerationExtensionDecorator is a the view model for ThumbnailGenerationExtension it contains all the relevant business logic it is also a sub-class of DataSourceDecorator which allows any extension to override the default methods provided by MessagesDataSource
TimeRange
TimeSlotSelectorStyle
TransferOwnershipConfiguration
TransferOwnershipConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatTransferOwnership
TransferOwnershipStyle
TransferOwnershipStyle is a data class that has styling-related properties to customize the appearance of CometChatTransferOwnership
TransientMessage
Represents a temporary or transient message within the chat.
Translations
Callers can lookup localized strings with an instance of Translations returned by Translations.of(context).
TypingIndicator
Represents a typing indicator within the chat.
Typography
UIBannedMemberBuilder
UIConstants
UIConstants contains properties essential and limited to setting up the ui kit
UIConversationsBuilder
UIConversationsBuilder is the default ConversationsBuilderProtocol used when a custom conversations builder protocol is not passed
UIElementTypeConstants
UIEventHandler
UIEventUtils
UIGroupMembersBuilder
UIGroupMembersBuilder is the default GroupMembersBuilderProtocol used when a custom builder protocol is not passed
UIGroupsBuilder
UIGroupsBuilder is the default GroupsBuilderProtocol used when a custom builder protocol is not passed
UIKitSettings
Used to set Ui kit level settings
UIKitSettingsBuilder
Builder class for UIKitSettings
UITabNameConstants
UITabNameConstants is a utility class that stores String constants of the names of the tabs available for CometChatUI
UIUsersBuilder
UIUsersBuilder is the default UsersBuilderProtocol used when a custom builder protocol is not passed
UnmutedConversation
UpdateSettingsConstant
URLNavigationAction
Represents an action for URL navigation within a chat application.
User
Represents a user within the chat.
UserOptionConstants
UserOptionConstants is a utility class that stores String constants of the options available in CometChatDetails if it is being rendered for a User
UsersBuilderProtocol
UsersBuilderProtocol is an interface that defines the structure for fetching the users. It provides a generic requestBuilder property and methods getRequest and getSearchRequest that needs to be overridden.
UsersConfiguration
UsersConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatUsers can be used by a component where CometChatUsers is a child component
UsersRequest
A request object for fetching users.
UsersRequestBuilder
Builder class for UsersRequest.
UsersStyle
UsersStyle is a data class that has styling-related properties to customize the appearance of CometChatUsers
UserStatusConstants
UserStatusConstants is a utility class that stores String constants of the online/offline status of an User
UsersWithMessagesConfiguration
UsersWithMessagesConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatUsersWithMessages
Utils
VideoBubbleStyle
VideoBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatVideoBubble
VideoPlayer
Gives Full screen video player for CometChatVideoBubble
WebViewStyle
WhiteBoardBubbleStyle
WhiteBoardBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatCollaborativeWhiteBoardBubble

Enums

ActionSheetLayoutMode
ActivateSelection
ActivateSelection is an enum that controls on what gesture selection will work
AIMessageStatus
AIMessageStatus is an enum that defines the status of message being sent
APIActionMethod
AuxiliaryButtonsAlignment
AuxiliaryButtonsAlignment is an enum that defines the position of the auxiliary buttons in the CometChatMessageComposer
BubbleAlignment
BubbleAlignment is an enum that defines the alignment of the messag bubble
ChatAlignment
ChatAlignment is an enum that defines the alignment of the messages in the message list
CometChatPollsBubbleType
ConversationTypes
ConversationTypes is an enum that is used fetch filtered Conversation list
CustomUIPosition
DateTimePattern
DateTimeVisibilityMode
DayOfWeek
DNDOptions
EventStatus
EventStatus is an enum that contains the various stages of deleting a message inProgress means the request to delete a BaseMessage is currently ongoing or has been made but awaiting success response success means message was deleted successfully and a success response has been received in the onSuccess callback for the request to delete a BaseMessage
FileType
LiveReactionType
Listener class for CometChatMessages
MemberActionsOptions
MentionsType
MentionsVisibility
MessageEditStatus
MessageEditStatus is an enum that contains the various stages of updating a messag inProgress means the request to update a BaseMessage is currently ongoing or has been made but awaiting success response success means message was updated successfully and a success response has been received in the onSuccess callback for the request to update a BaseMessage
MessagesOptions
MessageStatus
MessageStatus is an enum that contains the various stages of message delivery inProgress means the request to send a BaseMessage is currently ongoing or has been made but awaiting success response sent means message was sent successfully and a success response has been received in the onSuccess callback for the request to send a BaseMessage error the request for sending a message has failed and an error response has been in received in the onError callback
MutedConversationType
PaletteThemeModes
By default two modes
PlayStates
PreviewMessageMode
PreviewMessageMode is an enum that defines the nature of the message preview that needs to be shown in the CometChatMessageComposer
PushPlatforms
ReactionsOptions
ReceiptStatus
RepliesOptions
SchedulerBubbleStage
ScheduleStatus
SelectionMode
SelectionMode is an enum that defines how many items can be selected in a list
Sound
TabVisibility
TimeAlignment
TimeAlignment is an enum that defines the position of the timestamp shown in the message bubble top places the timestamp in the header of CometChatMessageBubble bottom places the timestamp in the footer of CometChatMessageBubble
TimeFormat

Mixins

CallListener
CallListener2
CometChatCallEventListener
Listener class for CometChatCallEvents
CometChatConversationEventListener
Listener class for CometChatConversations
CometChatConversationsControllerProtocol
CometChatGroupEventListener
Events can be triggered by Group Module e.g. Clicking on a particular group. All public-facing components in each module will trigger events.
CometChatListProtocol<T1>
Marker class to state predefined methods for CometChatList
CometChatMessageEventListener
CometChatSelectable<T1, T2>
An mixin to hold common logic for selecting list item
CometChatUIEventListener
Listener class for CometChatConversations
CometChatUserEventListener
Events can be triggered by the user action for e.g. Clicking on a particular user item. All public-facing components in each module will trigger events.
ConnectionListener
GroupListener
KeyIdentifier<T, T2>
Abstract class to get the key in case of searching
LoginListener
MessageListener
UIBannedGroupMemberRequestBuilder
UIBannedGroupMemberRequestBuilder is an interface that is used to construct the request body for fetching banned group members using BannedGroupMembersRequestBuilder
UserListener

Constants

defaultPaletteTheme → const Palette
Default exposed theme with light mode

Properties

channel MethodChannel
getter/setter pair
cometchatConstantString String
getter/setter pair
cometChatTheme CometChatTheme
getter/setter pair
defaultTypographyTheme Typography
Default exposed typographytheme
getter/setter pair
eventStreamChannel EventChannel
getter/setter pair
typingStream EventChannel
getter/setter pair

Functions

cast<T>(dynamic x) → T?
lookupTranslations(Locale locale) Translations
showCometChatActionSheet({required BuildContext context, WidgetBuilder? builder, required List<ActionItem> actionItems, Color? backgroundColor, Color? iconBackground, String? title, TextStyle? titleStyle, IconData? layoutModeIcon, bool? isLayoutModeIconVisible, Color? layoutIconColor, bool? isTitleVisible, bool? isGridLayout, ShapeBorder? alertShapeBorder}) Future<ActionItem?>?
Function to show comeChat action sheet
showCometChatAiOptionSheet({required BuildContext context, required List<CometChatMessageComposerAction> actionItems, Color? backgroundColor, Color? iconBackground, User? user, Group? group, required CometChatTheme theme, double? borderRadius}) Future<CometChatMessageComposerAction?>?
Function to show comeChat action sheet
showCometChatConfirmDialog({required BuildContext context, Widget? title, Widget? messageText, String? confirmButtonText, String? cancelButtonText, dynamic onConfirm()?, dynamic onCancel()?, ConfirmDialogStyle style = const ConfirmDialogStyle()}) → dynamic
showCometChatConfirmDialog is a function that renders a alert dialog box
showCometChatEmojiKeyboard({required BuildContext context, Color? backgroundColor, TextStyle? titleStyle, Color? dividerColor, TextStyle? categoryLabel, Color? selectedCategoryIconColor, Color? unselectedCategoryIconColor}) Future<String?>
Public function to show emoji keyboard , returns the tapped emoji
showLoadingIndicatorDialog(BuildContext context, {Color? background, Color? shadowColor, Color? progressIndicatorColor}) → dynamic
showMessageOptionSheet({required BuildContext context, required List<ActionItem> actionItems, Color? backgroundColor, String? title, TextStyle? titleStyle, ShapeBorder? alertShapeBorder, CometChatTheme? theme, required dynamic message, required CometChatMessageListController state, dynamic onReactionTap(BaseMessage, String?)?, Widget? addReactionIcon, dynamic addReactionIconTap(BaseMessage)?, bool hideReactions = false, List<String>? favoriteReactions}) Future<ActionItem?>
Function to show message option bottom sheet

Typedefs

ComposerActionsBuilder = List<CometChatMessageComposerAction> Function(BuildContext context, User? user, Group? group, Map<String, dynamic>? id)
ComposerWidgetBuilder = Widget Function(BuildContext context, User? user, Group? group, Map<String, dynamic>? id)
OnError = dynamic Function(Exception e)
OnError defines the structure of error handler used by the components in the ui kit
ThreadRepliesClick = void Function(BaseMessage message, BuildContext context, {Widget bubbleView(BaseMessage, BuildContext)?})
UserGroupBuilder = dynamic Function(BuildContext context, User? user, Group? group)

Exceptions / Errors

CometChatException