cometchat_calls_uikit library

Classes

AcceptCall
Accept the incoming call Triggers CometChat.acceptCall and navigates to OngoingCall screen on success
AcceptCallUseCase
Use case for accepting an incoming call.
Action
This class represents an action performed in the chat.
AgenticKeys
AIAssistantBaseEvent
AIAssistantCardEndedEvent
Represents an AI Assistant card_end streaming event.
AIAssistantCardReceivedEvent
Represents an AI Assistant card streaming event containing the full card payload.
AIAssistantCardStartedEvent
Represents an AI Assistant card_start streaming event.
AIAssistantContentReceivedEvent
AIAssistantElement
Represents a single element in the ordered content blocks of an AI Assistant message.
AIAssistantMessage
Represents an AI Assistant message within the chat.
AIAssistantMessageEndedEvent
Represents an event when an AI Assistant message has ended.
AIAssistantRunFinishedEvent
Represents an event when an AI Assistant run has finished.
AIAssistantRunStartedEvent
Represents an event when an AI Assistant run has started.
AIAssistantToolArgumentEvent
Represents an AI Assistant tool argument event.
AIAssistantToolEndedEvent
Represents an AI Assistant tool ended event.
AIAssistantToolResultEvent
Represents an AI Assistant tool result event.
AIAssistantToolStartedEvent
Represents an AI Assistant tool started event.
AIToolArgumentMessage
Represents a tool argument message in AI Assistant.
AIToolCall
Represents a tool call used in AI Assistant messages.
AIToolCallFunction
Represents a function call associated with an AI tool call.
AIToolResultMessage
Represents a tool result message in AI Assistant.
AppEntity
Represents an entity within the application.
AppSettings
Represents application settings.
AppSettingsBuilder
Builder class for AppSettings.
Attachment
Represents a file attachment.
BannedGroupMembersRequest
A request object for fetching banned group members.
BannedGroupMembersRequestBuilder
Builder class for BannedGroupMembersRequest.
BaseMessage
Represents a basic chat message.
BlockedUsersRequest
A request object for fetching blocked users.
BlockedUsersRequestBuilder
Builder class for BlockedUsersRequest.
ButtonClickListeners
Button click event listeners. Provides callbacks for UI button interactions.
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.
CallButtonsBloc
BLoC for managing call buttons state and call initiation workflow
CallButtonsConfiguration
CallButtonsConfiguration is a data class that has configuration properties
CallButtonsEvent
Base class for all call buttons events Uses Equatable for proper event comparison in BLoC
CallButtonsState
State for CallButtons BLoC Manages button disabled state and call initiation workflow
CallCancelled
Call was cancelled by the caller Dismisses the overlay automatically
CallEnded
Call has ended (either by user or remote party) Re-enables the call buttons
CallEntity
CallEventService
Singleton service that manages global call SDK event listeners with proper lifecycle (init/dispose).
CallGroup
CallingConfiguration
CallingWidgetReceived
Calling widget received from SDK
CallLog
CallLogRequest
CallLogRequest is a class that encapsulates a request for call logs. It includes parameters for filtering and pagination of the call logs.
CallLogRequestBuilder
CallLogRequestBuilder is a builder class for CallLogRequest. Use this class to create an instance of CallLogRequest.
CallLogsBloc
BLoC for managing call logs list
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.
CallLogsConstants
CallLogsEmptyView
A widget that displays the empty state for the call logs list.
CallLogsErrorView
A widget that displays the error state for the call logs list.
CallLogsEvent
Base class for all call logs events Uses Equatable for proper event comparison in BLoC
CallLogsList
A widget that displays the list of call logs.
CallLogsListItem
A widget that displays a single call log item in the list.
CallLogsLoadingView
A widget that displays the loading state for the call logs list.
CallLogsLocalDataSource
Abstract interface for call logs local data source. Handles local caching of call log data.
CallLogsLocalDataSourceImpl
Implementation of CallLogsLocalDataSource using in-memory cache. In a production app, this could use SharedPreferences, Hive, or SQLite.
CallLogsRemoteDataSource
Abstract interface for call logs remote data source. Handles all interactions with CometChat Calls SDK.
CallLogsRemoteDataSourceImpl
Implementation of CallLogsRemoteDataSource using CometChat Calls SDK.
CallLogsRepository
Repository interface for call logs data operations. Defines the contract for call logs data access following Clean Architecture.
CallLogsRepositoryImpl
Implementation of CallLogsRepository. Coordinates between remote and local data sources.
CallLogsServiceLocator
Service Locator for CallLogs module Provides dependency injection for call logs clean architecture Follows singleton pattern for consistent dependency resolution
CallLogsState
Immutable state class for CallLogs BLoC
CallLogsUtils
CallNavigationContext
CallOperationsDataSource
Abstract interface for call operations data source.
CallOperationsDataSourceImpl
Implementation of CallOperationsDataSource using CometChat SDK.
CallOperationsRepository
Shared repository interface for call operations used across call_buttons, incoming_call, outgoing_call, and ongoing_call.
CallOperationsRepositoryImpl
Implementation of CallOperationsRepository. Wraps datasource calls in Result for consistent error handling.
CallOperationsServiceLocator
Shared service locator for call operations used by call_buttons, incoming_call, outgoing_call, and ongoing_call.
CallPermissions
Utility to request microphone/camera permissions before starting a call.
CallRejected
Call was rejected by the receiver or system Re-enables the call buttons
CallScreenOverlay
Launches CometChatOngoingCall in a completely isolated widget tree (its own MaterialApp inside an OverlayEntry).
CallSession
Represents an active call session. Provides methods for call controls and listener management.
CallSettings
CallSettings class to configure call parameters.
CallSettingsBuilder
Builder for CallSettings. Provides a fluent API for configuring call options.
CallStateService
Service for managing global call state using ValueNotifier pattern.
CallSwitchRequestInfo
CallToken
CallTokenKeyConstants
CallUser
CallUtils
CallUtils is a utility class that contains methods to perform call related operations.
CancelCall
Cancel the outgoing call Triggers CometChatUIKitCalls.rejectCall with cancelled status
CardMessage
Represents a developer-sent card message within the chat.
CCExtension
Represents a CometChat extension.
CometChat
Flutter wrapper for using CometChat SDK.
CometChatBlockedUsersDirection
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.
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
CometChatCallLogsStyle
CometChatCallLogsStyle is a data class that has styling-related properties for CometChatCallLogs This class is used to style CometChatCallLogs
CometChatCalls
Main SDK class - Single source of truth for SDK state and business logic. All validation, state management, and business logic belongs here. The platform layer is used only for native communication.
CometChatCallsConstants
CometChatCallsEventsListener
Deprecated v4 monolithic event listener for call events.
CometChatCallsLogger
Created by Ashfaq Ali on July 02, 2025.
CometChatCallStatus
CometChatCallType
CometChatConversationType
CometChatGroupType
CometChatHelper
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.
CometChatIncomingCallConfiguration
CometChatIncomingCallConfiguration is a data class that has configuration properties
CometChatIncomingCallStyle
CometChatIncomingCallStyle is a data class that has styling-related properties to customize the appearance of CometChatIncomingCallScreen
CometChatMemberScope
CometChatMessageCategory
CometChatMessageType
CometChatNotificationErrorCode
CometChatNotificationErrorMessages
CometChatNotifications
Provides notification management functionality for CometChat.
CometChatOngoingCall
CometChatOngoingCall is a widget that displays the ongoing call screen.
CometChatOngoingCallService
Service for managing ongoing call notifications.
CometChatOutgoingCall
CometChatOutgoingCall is a widget which is used to show outgoing call screen when the logged-in user calls another user.
CometChatOutgoingCallConfiguration
CometChatOutgoingCallConfiguration is a data class that has configuration properties for CometChatOutgoingCallScreen
CometChatOutgoingCallStyle
CometChatOutgoingCallStyle is the data class that contains style configuration for CometChatOutgoingCall
CometChatReceiptType
CometChatReceiverType
CometChatSubscriptionType
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
CometChatUserStatus
CometChatWSState
Conversation
Represents a chat conversation.
ConversationsRequest
A request object for fetching conversations.
ConversationsRequestBuilder
Builder class for ConversationsRequest.
ConversationType
ConversationUpdateSettings
CurrentUser
Represents the currently authenticated user.
CustomMessage
Represents a custom chat message.
DaySchedule
EndCallButtonPressed
End call button was pressed Behavior depends on callWorkFlow:
EndCallUseCase
Use case for ending an active call via CometChat SDK.
EndSessionUseCase
Use case for ending the current WebRTC session.
ErrorCode
ErrorCodeConstants
Created by Ashfaq Ali on July 02, 2025.
ErrorDetailConstants
ErrorMessage
ErrorMessageConstants
EventChannelDecode
EventHandler
ExtraKeysConstants
FailedFile
A file that did not upload successfully, with its error.
Features
Features configuration for call settings.
FlagDetail
FlagReason
GenerateCallTokenUseCase
Use case for generating a call token to join a session.
GenerateToken
GetCallLoggedInUserUseCase
Use case for getting the currently logged-in user.
GetCallLogsUseCase
Use case for getting call logs with pagination support. Handles business logic for fetching initial call log lists.
GetLoggedInUserUseCase
Use case for getting the currently logged-in user. Handles business logic for user retrieval.
GetUserAuthTokenUseCase
Use case for getting the user auth token.
Group
Represents a group within the chat.
GroupMember
Represents a group member within the chat.
GroupMembersRequest
A request object for fetching group members.
GroupMembersRequestBuilder
Builder class for GroupMembersRequest.
GroupPreferences
GroupsRequest
A request object for fetching groups.
GroupsRequestBuilder
Builder class for GroupsRequest.
IncomingCallBloc
BLoC for managing incoming call screen state and actions
IncomingCallEvent
Base class for all incoming call events Uses Equatable for proper event comparison in BLoC
IncomingCallOverlay
IncomingCallState
State class for IncomingCallBloc Uses Equatable for proper state comparison in BLoC
InitiateCallFromLog
Initiate a call from a call log entry
InitiateCallUseCase
Use case for initiating a call from a call log entry. Handles business logic for call initiation.
InitiateDirectCallUseCase
Use case for initiating a direct call to a user.
InitiateVideoCall
Initiate a video call For user receivers: initiates a direct video call For group receivers: initiates a meeting with video
InitiateVoiceCall
Initiate a voice (audio) call For user receivers: initiates a direct audio call For group receivers: initiates a meeting with audio only
InputValidator
Centralized input validation for CometChat Calls SDK. All validation logic is consolidated here to ensure consistency.
Interaction
Represents an interaction within the chat.
InteractionGoal
Represents an interaction goal within the chat.
InteractionGoalType
InteractionReceipt
Represents an interaction receipt within the chat.
InteractiveMessage
Represents a interactive message within the chat.
LayoutListeners
Layout event listeners. Provides callbacks for layout-related changes during a call session.
LoadCallingScreen
Load the calling screen Triggers token generation and session start
LoadCallLogs
Load initial call logs
LoadMoreCallLogs
Load more call logs (pagination)
LoadMoreCallLogsUseCase
Use case for loading more call logs with pagination support. Handles business logic for fetching additional call log pages.
LoggerConfig
Immutable configuration for SDK logging.
MediaEventListeners
Media event listeners. Provides callbacks for local media state changes.
MediaMessage
Represents a media message within the chat.
MessageReceipt
Represents a message receipt within the chat.
MessagesRequest
A request object for fetching messages.
MessagesRequestBuilder
Allows step-by-step creation of an MessagesRequest object.
MutedConversation
MutePreferences
NotificationCategoriesRequest
A request object for fetching notification categories.
NotificationCategoriesRequestBuilder
Builder class for NotificationCategoriesRequest.
NotificationCategory
Represents a notification category used for filtering notification feed items.
NotificationFeedItem
Represents a notification feed item within the CometChat notification feed.
NotificationFeedRequest
A request object for fetching notification feed items.
NotificationFeedRequestBuilder
Builder class for NotificationFeedRequest.
NotificationPreferences
OneOnOnePreferences
OngoingCallBloc
BLoC for managing ongoing call screen state and actions
OngoingCallEnded
Call ended (from SDK callback) Behavior depends on who ended the call
OngoingCallEvent
Base class for all ongoing call events Uses Equatable for proper event comparison in BLoC
OngoingCallState
State class for OngoingCallBloc Uses Equatable for proper state comparison in BLoC
OtherPayloadKeyConstants
OutgoingCallAccepted
Outgoing call was accepted by the receiver Navigates to OngoingCall screen
OutgoingCallBloc
BLoC for managing outgoing call screen state and actions
OutgoingCallEvent
Base class for all outgoing call events Uses Equatable for proper event comparison in BLoC
OutgoingCallRejected
Outgoing call was rejected by the receiver Pops the screen
OutgoingCallState
State class for OutgoingCallBloc Uses Equatable for proper state comparison in BLoC
ParamConstants
Participant
Represents a participant in a call session.
ParticipantEventListeners
Participant event listeners. Provides callbacks for participant-related events in a call session.
ParticipantListChanged
Participant list changed (from V5 SDK callback) Updates the participants list in state
PayloadKeyConstants
PlatformConstants
PushNotification
Represents a push notification payload for engagement tracking.
Reaction
Represents a reaction within the chat.
ReactionAction
ReactionCount
Represents a count of reactions within the chat.
ReactionEvent
ReactionsRequest
A request object for fetching reactions.
ReactionsRequestBuilder
Builder class for ReactionsRequest.
Recordings
RefreshCallLogs
Refresh call logs list
RejectCall
Reject the incoming call Triggers CometChatUIKitCalls.rejectCall and dismisses the overlay
RejectCallUseCase
Use case for rejecting or cancelling a call.
ResponseCodeConstants
ResponseKeyConstants
RTCMutedUser
RTCRecordingInfo
RTCUser
SdkIdentificationKeyConstants
Keys and values for SDK identification telemetry (POST /user_sessions).
SendMeetingMessageUseCase
Use case for sending a meeting custom message.
SessionSettings
SessionSettings holds all configuration options for a call session. Use SessionSettingsBuilder to create an instance.
SessionSettingsBuilder
Builder for SessionSettings. Provides a fluent API for configuring session options.
SessionStatusListeners
Session status event listeners. Provides callbacks for session lifecycle and connection events.
SessionTimeout
Session timeout occurred Ends the session
SettingsKeyConstants
StartSessionUseCase
Use case for starting a call session with a session ID and settings. The SDK generates the call token internally.
TextMessage
Represents a text message within the chat.
TransientMessage
Represents a temporary or transient message within the chat.
TypingIndicator
Represents a typing indicator within the chat.
UICallLogsBuilder
UICallLogsBuilder is the default CallLogsBuilderProtocol used when a custom builder protocol is not passed
UICustomization
UI customization options for call settings.
UnmutedConversation
UploadAttachment
One {fileId, file} pair for UploadFileRequest.uploadAttachments.
UploadedFile
A successfully uploaded file and its resulting Attachment.
UploadFile
A platform-neutral descriptor for a file to be uploaded via CometChat.uploadFiles.
UploadFileListener
Per-file and batch-completion callbacks for a multi-attachment upload.
UploadFileRequest
The app's handle on one upload batch, scoped to a single destination.
UploadLimits
Default client-side limits for multi-attachment uploads.
UploadMetadataKeys
Conventional MediaMessage.metadata keys used by the CometChat UI Kits to group and disambiguate multi-attachment messages.
UploadResult
The settled state of an upload group, delivered via MediaUploadListener.onComplete each time the group drains (no files in-flight).
User
Represents a user within the chat.
UserListChanged
User list changed (from SDK callback) Updates the participants list in state
UserPresence
Represents user presence information from WebSocket events.
UsersRequest
A request object for fetching users.
UsersRequestBuilder
Builder class for UsersRequest.
VerifyTokenKeyConstants

Enums

AttachmentType
AudioMode
CallLogsStatus
Status enum for CallLogs BLoC state
CallWorkFlow
CameraFacing
DayOfWeek
DNDOptions
FeedReadState
Type-safe enum for filtering feed items by read state in NotificationFeedRequestBuilder.setReadState().
IncomingCallStatus
Status enum for incoming call screen
LayoutType
LogLayer
Layers of the SDK that can have logging enabled/disabled independently.
MemberActionsOptions
MessagesOptions
ModerationStatusEnum
MutedConversationType
OngoingCallStatus
Status enum for ongoing call screen
OutgoingCallStatus
Status enum for outgoing call screen
PushPlatforms
ReactionsOptions
RepliesOptions
SessionType
Session type enum matching native Android SDK
SortByOrderEnum
UploadFileState
Lifecycle state of a single file within an upload group.
UploadStatus
The upload status of a batch, returned by UploadFileRequest.getStatus().

Extensions

UploadFileStateX on UploadFileState
Convenience predicates for UploadFileState.

Typedefs

AIAssistantToolEventResult = AIAssistantToolResultEvent
Deprecated alias for AIAssistantToolResultEvent.
Participants = Participant
v4 backward-compatible alias — the v4 SDK used the plural name Participants.

Exceptions / Errors

CallLogsLocalDataSourceException
Exception thrown when local data source operations fail
CallLogsRemoteDataSourceException
Exception thrown when remote data source operations fail
CallOperationsException
Exception thrown when call operations fail.
CometChatCallsException
Exception class for CometChat Calls SDK errors. All errors in the SDK are returned as CometChatCallsException with:
CometChatException