> ## Documentation Index
> Fetch the complete documentation index at: https://cometchat-22654f5b-docs-skills-v5-temp.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Flutter Chat SDK v5 — LLM docs index

> Machine-readable, Flutter-SDK-v5-scoped index of every SDK page as a clean .md twin. Built for AI coding agents; kept out of the human sidebar.

# Flutter Chat SDK v5 — LLM docs index (Latest)

> Low-level (headless) Flutter chat + calling client — no UI. Package `cometchat_sdk@5`
> (calling adds `cometchat_calls_sdk@5`). This page is a **Flutter-SDK-v5-only** routing index
> for AI agents — a scoped alternative to the site-wide `/docs/llms.txt`.

## How to use this index

Each link points to the docs page; **append `.md`** to its URL to fetch the clean Markdown twin
(verbatim code + method signatures, parameters, and listener contracts). Pick the page for the
intent, then read the API there.

* Convention: any docs page URL + `.md` → raw Markdown.
* Fallback: if a `.md` twin 404s, fetch the same URL **without** `.md` (HTML). Never read the
  installed Dart source in place of a doc, and never answer APIs from memory.

## Platform rules — headless, and Dart

This is the **SDK**, not the UI Kit: it ships no widgets. You own every view. Also:

* **Callbacks, not futures, carry the result.** The message and group APIs take `onSuccess` and
  `onError` callbacks and both are **required** — awaiting the call alone gives you nothing to
  act on. Write the success path inside `onSuccess`.
* **Listeners must be removed.** Every `add*Listener(id, …)` needs the matching
  `remove*Listener(id)`, normally in `dispose()`. Leaked listeners are the top source of
  duplicate-message bugs.
* **You do not receive your own sends.** The realtime listeners deliver other people's messages.
  A message you send is returned to you through `onSuccess` and nowhere else, so any local list
  must append it yourself.
* **The UI Kit re-exports this SDK.** If the app already depends on `cometchat_chat_uikit`, the
  SDK types resolve from the kit barrel — do not add a second, differently-versioned direct
  dependency.
* Building UI from scratch is a lot of work. If the goal is "add chat", prefer the
  [Flutter UI Kit](/ui-kit/flutter/overview) and drop to this SDK only for custom UI or
  headless/background logic.

## Hot path — usually no fetch needed

For a plain integration the install, `init → login`, and the core send / receive-listener flow
are stable; a well-built agent skill bakes them. Fetch below only for exhaustive parameters,
long-tail methods, group/user management, calling, or edge-case listeners.

* Setup: [Setup](/sdk/flutter/setup)
* Auth/lifecycle: [Authentication](/sdk/flutter/authentication-overview)
* Core send/receive: [Send A Message](/sdk/flutter/send-message) · [Receive A Message](/sdk/flutter/receive-messages) · [All Real Time Listeners](/sdk/flutter/real-time-listeners)

## Getting started / integration

* [Overview](/sdk/flutter/overview)
* [Setup](/sdk/flutter/setup)
* [Authentication](/sdk/flutter/authentication-overview)
* [Login Listeners](/sdk/flutter/login-listeners)
* [Flutter Chat UI Kit](/sdk/flutter/flutter-overview)

## Messaging — send & receive

* [Messaging Overview](/sdk/flutter/messaging-overview)
* [Send A Message](/sdk/flutter/send-message)
* [Receive A Message](/sdk/flutter/receive-messages)
* [Edit A Message](/sdk/flutter/edit-message)
* [Delete A Message](/sdk/flutter/delete-message)
* [Upload Files & Send Attachments](/sdk/flutter/upload-files)
* [Threaded Messages](/sdk/flutter/threaded-messages)
* [Transient Messages](/sdk/flutter/transient-messages)
* [Additional Message Filtering](/sdk/flutter/additional-message-filtering)

## Messaging — signals & state

* [All Real Time Listeners](/sdk/flutter/real-time-listeners)
* [Typing Indicators](/sdk/flutter/typing-indicators)
* [Delivery & Read Receipts](/sdk/flutter/delivery-read-receipts)
* [Reactions](/sdk/flutter/reactions)
* [Mentions](/sdk/flutter/mentions)
* [Flag Message](/sdk/flutter/flag-message)

## Conversations

* [Retrieve Conversations](/sdk/flutter/retrieve-conversations)
* [Delete A Conversation](/sdk/flutter/delete-conversation)

## Users

* [Users Overview](/sdk/flutter/users-overview)
* [User Management](/sdk/flutter/user-management)
* [Retrieve Users](/sdk/flutter/retrieve-users)
* [User Presence](/sdk/flutter/user-presence)
* [Block Users](/sdk/flutter/block-users)

## Groups

* [Groups Overview](/sdk/flutter/groups-overview)
* [Create A Group](/sdk/flutter/create-group)
* [Retrieve Groups](/sdk/flutter/retrieve-groups)
* [Join A Group](/sdk/flutter/join-group)
* [Leave A Group](/sdk/flutter/leave-group)
* [Update A Group](/sdk/flutter/update-group)
* [Delete A Group](/sdk/flutter/delete-group)
* [Add Members To A Group](/sdk/flutter/group-add-members)
* [Retrieve Group Members](/sdk/flutter/retrieve-group-members)
* [Change Member Scope](/sdk/flutter/group-change-member-scope)
* [Ban / Kick Member](/sdk/flutter/group-kick-member)
* [Transfer Group Ownership](/sdk/flutter/transfer-group-ownership)

## Connection & lifecycle

* [Connection Status](/sdk/flutter/connection-status)
* [Connection Behaviour](/sdk/flutter/connection-behaviour)

## AI & moderation

* [AI Overview](/sdk/flutter/ai-user-copilot-overview)
* [AI Agents](/sdk/flutter/ai-agents)
* [Bots](/sdk/flutter/ai-chatbots-overview)
* [AI Moderation](/sdk/flutter/ai-moderation)

## Extend & operate

* [Extensions](/sdk/flutter/extensions-overview)
* [Webhooks](/sdk/flutter/webhooks-overview)
* [Campaigns](/sdk/flutter/campaigns)
* [Advanced](/sdk/flutter/advanced-overview)
* [Resources](/sdk/flutter/resources-overview)

## Migration & misc

* [Upgrading from v4](/sdk/flutter/upgrading-from-v4-guide)
* [Changelog](/sdk/flutter/changelog)