cometchat_sdk library

Classes

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.
BannedGroupMemberFetchListener
Two-phase banned group member read listener (Offline Read Coverage work-area 6).
BannedGroupMembersRequest
A request object for fetching banned group members.
BannedGroupMembersRequestBuilder
Builder class for BannedGroupMembersRequest.
BaseMessage
Represents a basic chat message.
BlockedUsersFetchListener
Two-phase blocked-users read listener (Offline Read Coverage work-area 2).
BlockedUsersRequest
A request object for fetching blocked users.
BlockedUsersRequestBuilder
Builder class for BlockedUsersRequest.
Call
Represents a call event within the chat.
CardMessage
Represents a developer-sent card message within the chat.
CCExtension
Represents a CometChat extension.
CometChat
Flutter wrapper for using CometChat SDK.
CometChatBlockedUsersDirection
CometChatCallStatus
CometChatCallType
CometChatConversationType
CometChatGroupType
CometChatHelper
CometChatMemberScope
CometChatMessageCategory
CometChatMessageType
CometChatNotificationErrorCode
CometChatNotificationErrorMessages
CometChatNotifications
Provides notification management functionality for CometChat.
CometChatReceiptType
CometChatReceiverType
CometChatSubscriptionType
CometChatUserStatus
CometChatWSState
Conversation
Represents a chat conversation.
ConversationDetailsListener
Two-phase listener for the SINGLE-object conversation read (Offline Read Coverage §2).
ConversationFetchListener
Two-phase conversation read listener (WP3).
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
ErrorCode
ErrorMessage
EventHandler
FailedFile
A file that did not upload successfully, with its error.
FlagDetail
FlagReason
ForceSyncListener
Outcome callback for CometChat.forceSyncNow(callback: ...) (foundation §5.5). onForceSyncComplete reports that the catch-up was accepted and started (BEH-SYNC-28); its progress and outcome arrive on SyncListener. On rejection onForceSyncError carries one of OfflineSyncError's codes or the platform's not-logged-in code. (Named distinctly from the removed single-lifecycle sync callbacks so the surface never re-introduces an onSync* name.)
Group
Represents a group within the chat.
GroupFetchListener
Two-phase groups read listener (Offline Read Coverage work-area 5).
GroupMember
Represents a group member within the chat.
GroupMemberFetchListener
Two-phase group members read listener (Offline Read Coverage work-area 5).
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.
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.
LoggerConfig
Immutable configuration for SDK logging.
MediaCallbackListener
Per-call callbacks for an explicit CometChat.downloadMedia(...) (media-caching-spec §10).
MediaDownloadListener
Observes background media downloads (media-caching-spec §6).
MediaMessage
Represents a media message within the chat.
MessageDetailsListener
Two-phase single-message read listener (Offline Read Coverage §2).
MessageFetchListener
Two-phase message read listener (WP3).
MessageReceipt
Represents a message receipt within the chat.
MessageSentListener
Three-phase send listener (WP4).
MessagesRequest
A request object for fetching messages.
MessagesRequestBuilder
Allows step-by-step creation of an MessagesRequest object.
MessageThread
A thread the logged-in user participates in, as returned by ThreadsRequest.
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.
NotificationFeedFetchListener
Two-phase notification feed read listener (Offline Read Coverage work-area 6).
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
OfflineCacheResetListener
Told when the SDK wiped and rebuilt the offline cache, losing its unsent messages (BEH-ENC-15). Registered via CometChat.addOfflineCacheResetListener(id, listener).
OfflineConfig
OfflineEncryptionStatus
The fixed CONTRACT section 4 status shape.
OfflineMessageListener
Global outbox observer (WP4) — one place to watch every queued send across all conversations. Registered via CometChat.addOfflineMessageListener(...) (facade wiring lands in WP9).
OfflineSendError
Per-call error codes of the offline send path (§10.5, R86: identical on every SDK).
OfflineSyncError
Rejection codes returned by forceSyncNow(callback).
OneOnOnePreferences
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
ReactionFetchListener
Two-phase reaction read listener (Offline Read Coverage work-area 6).
ReactionsRequest
A request object for fetching reactions.
ReactionsRequestBuilder
Builder class for ReactionsRequest.
SyncListener
Phase-based offline sync listener (foundation §1 C-01 / §5.4).
TextMessage
Represents a text message within the chat.
ThreadsFetchListener
Two-phase listener for ThreadsRequest.fetchNext (BEH-THR-03).
ThreadsRequest
A request object for fetching the threads the logged-in user participates in, page by page.
ThreadsRequestBuilder
Builder class for ThreadsRequest.
TransientMessage
Represents a temporary or transient message within the chat.
TypingIndicator
Represents a typing indicator within the chat.
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.
UploadFileView
A read-only snapshot of one file in an upload batch — the per-file data a composer needs to rebuild its attachment tray after a restore (offline-uploads-spec OU-13). Returned in add order by UploadFileRequest.getFiles().
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.
UserFetchListener
Two-phase users read listener (Offline Read Coverage work-area 5).
UserPresence
Represents user presence information from WebSocket events.
UsersRequest
A request object for fetching users.
UsersRequestBuilder
Builder class for UsersRequest.

Enums

AttachmentType
CometChatMessageStatus
The lifecycle status of a message, derived for display.
DayOfWeek
DNDOptions
EncryptionFailureBehavior
What happens when encryption cannot be applied at all on this build/device (the BUILD/LINK class -- cipher engine not linked, or secure key storage unavailable).
FeedReadState
Type-safe enum for filtering feed items by read state in NotificationFeedRequestBuilder.setReadState().
LogLayer
Layers of the SDK that can have logging enabled/disabled independently.
MediaCachingMode
Per-user media caching mode. Governs the receive side only; sending media always works in both modes (spec §2, §4).
MediaErrorCode
Why a media download could not be satisfied. Surfaced instead of a raw HTTP failure so callers can render a typed state (spec §7).
MemberActionsOptions
MessageFailureReason
Public reason a send failed (§10.2).
MessagesOptions
MessageSource
Indicates how a message reached the listener.
ModerationStatusEnum
MutedConversationType
OfflineAtRest
The Coverage tier actually achieved -- not what was configured.
OfflineCacheResetReason
Why the SDK wiped and rebuilt the offline cache (BEH-ENC-15).
OfflineKeyStorage
Where the key lives -- the Key protection tier.
PendingMessageOverflowPolicy
At-cap behavior for the pending outbox.
PushPlatforms
QuotedRepliesOptions
Notification options for quoted replies — a message that quotes another message, as distinct from a reply posted into a thread.
ReactionsOptions
RepliesOptions
SortByOrderEnum
SyncOutcome
The result of a message catch-up sweep.
SyncState
Sync state surfaced to the app (offline-sdk.md §7.5).
UploadFileState
Lifecycle state of a single file within an upload group.
UploadStatus
The upload status of a batch, returned by UploadFileRequest.getStatus().

Mixins

AIAssistantListener
CallListener
CallListener2
ConnectionListener
ConversationListener
Live conversation-level events (Pin Conversation, ENG-37600).
GroupListener
LoginListener
MessageListener
NotificationFeedListener
Listener for real-time notification feed events.
UserListener

Extensions

UploadFileStateX on UploadFileState
Convenience predicates for UploadFileState.

Typedefs

AIAssistantToolEventResult = AIAssistantToolResultEvent
Deprecated alias for AIAssistantToolResultEvent.
MediaMessageRef = BaseMessage
Convenience: the attachment a media call refers to.

Exceptions / Errors

CometChatException
MediaException
A typed media failure (spec §7 — "surface typed errors rather than raw HTTP failures").