cometchat_calls_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
AIExtension
AIOptionsStyle
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
AudioMode
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
BannedGroupMembersRequest
A request object for fetching banned group members.
BannedGroupMembersRequestBuilder
Builder class for BannedGroupMembersRequest.
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.
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.
CallAppSettingBuilder
CallAppSettingBuilder is a builder class for CallAppSettings.
CallAppSettings
CallAppSettings is a class that contains the app settings for the call.
CallBubbleConfiguration
CallBubbleConfiguration is a data class that has configuration properties
CallBubbleStyle
CallBubbleStyle is a data class that has styling-related properties to customize the appearance of CometChatCallBubble
CallButtonsConfiguration
CallButtonsConfiguration is a data class that has configuration properties
CallButtonsStyle
CallButtonsStyle is the data class that contains style configuration for CometChatCallButtons
CallEntity
CallExtensionConstants
CallGroup
CallingConfiguration
CallingExtensionDecorator
CallingExtensionDecorator is a the view model for CometChatCallingExtension 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
CallLog
CallLogDetailsConfiguration
CallLogDetailsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCallLogDetails
CallLogDetailsStyle
CallLogDetailsStyle is a data class that has styling-related properties for CometChatCallLogDetails
CallLogDetailsUtils
CallLogHistoryConfiguration
CallLogHistoryConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCallLogHistory
CallLogHistoryStyle
CallLogHistoryStyle is a data class that has styling-related properties for CometChatCallLogHistory
CallLogParticipantsConfiguration
CallLogParticipantsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCallLogParticipants
CallLogParticipantsStyle
CallLogParticipantsStyle is a data class that has styling-related properties for CometChatCallLogParticipants
CallLogRecordingsConfiguration
CallLogRecordingsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCallLogRecordings
CallLogRecordingsStyle
CallLogRecordingsStyle is a data class that has styling-related properties for CometChatCallLogRecordings
CallLogRequest
CallLogRequest is a class that encapsulates a request for call logs.
CallLogRequestBuilder
CallLogRequestBuilder is a builder class for CallLogRequest.
CallLogsBuilderProtocol
CallLogsBuilderProtocol is an interface that defines the structure for fetching the callLogs. It provides a generic requestBuilder property and methods getRequest and getSearchRequest that needs to be overridden.
CallLogsConfiguration
CallLogsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCallLogs
CallLogsConstants
CallLogsStyle
CallLogsStyle is a data class that has styling-related properties for CometChatCallLogs
CallLogsUtils
CallLogsWithDetailsConfiguration
CallLogsWithDetailsConfiguration is a data class that has configuration properties to customize the functionality and appearance of CometChatCallLogsWithDetails
CallNavigationContext
CallSettings
CallSettings is a class that contains the various settings for a call.
CallSettingsBuilder
CallSettingsBuilder is a builder class for CallSettings.
CallStatusConstants
CallStatusConstants is a utility class that stores String constants of various stages of Call
CallSwitchRequestInfo
CallTypeConstants
CallUser
CallUtils
CallUtils is a utility class that contains methods to perform call related operations.
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>
CometChat
Flutter wrapper for using CometChat SDK.
CometChatActionSheet
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
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.
CometChatCallBubble
CometChatCallBubble is a widget that displays the call information and a button to join the call.
CometChatCallButtons
CometChatCallButtons is a button widget with voice and video call icons.
CometChatCallButtonsController
CometChatCallButtonsController is the view model class for CometChatCallButtons
CometChatCallEvents
class for handling call events.
CometChatCallingExtension
CometChatCallingExtension is the controller class for enabling and disabling the extension
CometChatCallLogDetailProtocolController
CometChatCallLogDetails
CometChatCallLogDetails is a mediator component that provides access to components for viewing profile, call status, participants, history and recordings if the CometChatCallLogDetails component is being shown for a CallGroup and options for video and audio call if the CometChatCallLogDetails component for a CallUser
CometChatCallLogDetailsController
CometChatCallLogDetailsOption
CometChatCallLogDetailsOption is a model class which contains information about options available for every CometChatCallLogDetails
CometChatCallLogDetailsTemplate
CometChatCallLogDetailsTemplate is the section of options displayed in CometChatCallLogDetails
CometChatCallLogHistory
CometChatCallLogHistory is a component that displays a list of callLogs with the help of CometChatListBase and CometChatListItem fetched callLogs are listed down in order of recent activity callLogs are fetched using CallLogsBuilderProtocol and CallLogRequestBuilder
CometChatCallLogHistoryController
CometChatCallLogParticipants
CometChatCallLogParticipants is a component that displays a list of call participants with the help of CometChatListBase and CometChatListItem
CometChatCallLogRecordings
CometChatCallLogRecordings is a component that displays a list of call recordings with the help of CometChatListBase
CometChatCallLogs
CometChatCallLogs is a component that displays a list of callLogs with the help of CometChatListBase and CometChatListItem fetched callLogs are listed down in order of recent activity callLogs are fetched using CallLogsBuilderProtocol and CallLogRequestBuilder
CometChatCallLogsController
CometChatCallLogsWithDetails
CometChatCallLogsWithDetails is a component that displays a list of call recordings with the help of CometChatListBase and CometChatListItem
CometChatCallLogsWithDetailsController
CometChatCalls
CometChatCallsConstants
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
CometChatConversationEvents
Event emitting class for CometchatConversation
CometChatConversationType
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
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
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
CometChatGroupMembersControllerProtocol
CometChatGroupType
CometChatHelper
CometChatImageBubble
CometChatImageBubble creates a widget that gives image bubble
CometChatIncomingCall
CometChatIncomingCall is a widget which is used to display incoming call. when the logged in user receives a call, this widget will be invoked.
CometChatIncomingCallController
CometChatIncomingCallController is the view model class for CometChatIncomingCall
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
CometChatMessageComposerAction
CometChatMessageComposerAction is the type of menu items allowed to be displayed CometChatMessageComposer
CometChatMessageEvents
Event emitting class for CometChatMessages
CometChatMessageInput
CometChatMessageInput is a component that provides a skeleton layout for contents of CometChatMessageComposer like TextField, auxiliary options, primary button view and attachment options.
CometChatMessageListControllerProtocol
CometChatMessageOption
Model class for message options
CometChatMessageTemplate
CometChatMessageTemplate class for setting message types and rendering appropriate views in the message list
CometChatMessageType
CometChatNotificationErrorCode
CometChatNotificationErrorMessages
CometChatNotifications
CometChatOngoingCall
CometChatOngoingCall is a widget that displays the ongoing call screen.
CometChatOngoingCallController
CometChatOngoingCallController is a view model class which manages the state of CometChatOngoingCall widget.
CometChatOption
CometChatOption is a model class which is used to execute any action on a CometChatListItem
CometChatOutgoingCall
CometChatOutgoingCall is a widget which is used to show outgoing call screen. when the logged-in user calls another user
CometChatOutgoingCallController
CometChatOutgoingCallController is the view model class for CometChatOutgoingCall
CometChatPhoneNumberFormatter
CometChatPhoneNumberFormatter is a class which is used to style the phone number text
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
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
CometChatTimeSlotSelector
CometChatUIEvents
CometChatUIKit
CometChatUIKitCalls
CometChatUIKitCalls is a class that initializes the CometChat Calls SDK. And contains methods to initiate a call, accept a call, reject a call, end a call
CometChatUIKitHelper
CometChatUIKitHelper contains static methods for triggering local events
CometChatUrlFormatter
CometChatUrlFormatter is a class which is used to style the url text
CometChatUserEvents
CometChatUserStatus
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
Conversation
Represents a chat conversation.
ConversationOptionConstants
ConversationOptionConstants is a utility class that stores String constants of options available for Conversation items
ConversationsRequest
A request object for fetching conversations.
ConversationsRequestBuilder
Builder class for ConversationsRequest.
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
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
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
DottedBorder
Represents a dropdown model class , used to draw dropdown .
ElementEntity
ErrorCode
ErrorMessage
EventChannelDecode
EventHandler
ExtensionsDataSource
Protocol class every Extension enabler should extend,
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.
GenerateToken
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
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.
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
GroupsRequest
A request object for fetching groups.
GroupsRequestBuilder
Builder class for GroupsRequest.
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
ImageViewer
Gives Full Screen image view for passed image url
IncomingCallConfiguration
IncomingCallConfiguration is a data class that has configuration properties
IncomingCallStyle
IncomingCallStyle is a data class that has styling-related properties to customize the appearance of CometChatIncomingCallScreen
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
ItemSettings
LabelElement
Represents a label model class , used to draw label .
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
LocationService
MainVideoContainerSetting
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
MessageComposerSuggestions
MessageInputStyle
MessageInputStyle is a data class that has styling-related properties to customize the appearance of CometChatMessageInput
MessageOptionConstants
MessageOptionConstants is a utility class that stores String constants of the actions permitted to execute on a particular BaseMessage
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.
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
OngoingCallConfiguration
OngoingCallConfiguration is a data class that has configuration properties for CometChatOngoingCallScreen
OptionElement
OutgoingCallConfiguration
OutgoingCallConfiguration is a data class that has configuration properties for CometChatOutgoingCallScreen
OutgoingCallStyle
OutgoingCallStyle is the data class that contains style configuration for CometChatOutgoingCall
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
Participants
PickedFile
PresentationSettings
PresentationSettingsBuilder
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
Recordings
RegexConstants
RegexConstants is a utility contains patterns or verifying selective text inputs
RequestBuilderConstants
RTCMutedUser
RTCRecordingInfo
RTCUser
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.
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
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.
TimeRange
TimeSlotSelectorStyle
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
UICallLogsBuilder
UICallLogsBuilder is the default CallLogsBuilderProtocol used when a custom builder protocol is not passed
UIConstants
UIConstants contains properties essential and limited to setting up the ui kit
UIElementTypeConstants
UIEventHandler
UIEventUtils
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
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
UsersRequest
A request object for fetching users.
UsersRequestBuilder
Builder class for UsersRequest.
UserStatusConstants
UserStatusConstants is a utility class that stores String constants of the online/offline status of an User
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

Enums

ActionSheetLayoutMode
ActivateSelection
ActivateSelection is an enum that controls on what gesture selection will work
APIActionMethod
AudioModes
AuxiliaryButtonsAlignment
AuxiliaryButtonsAlignment is an enum that defines the position of the auxiliary buttons in the CometChatMessageComposer
AvatarModes
BubbleAlignment
BubbleAlignment is an enum that defines the alignment of the messag bubble
CallModes
Enums For Calls SDK
CallWorkFlow
ChatAlignment
ChatAlignment is an enum that defines the alignment of the messages in the message list
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
Mode
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
VideoStreamsMode
VideoStreamsPosition

Mixins

CallListener
CallListener2
CometChatCallEventListener
Listener class for CometChatCallEvents
CometChatCallsEventsListener
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
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
showLoadingIndicatorDialog(BuildContext context, {Color? background, Color? shadowColor, Color? progressIndicatorColor}) → dynamic

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
UserGroupBuilder = dynamic Function(BuildContext context, User? user, Group? group)