Skip to main content

​
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 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.

​
Getting started / integration

​
Messaging — send & receive

​
Messaging — signals & state

​
Conversations

​
Users

​
Groups

​
Connection & lifecycle

​
AI & moderation

​
Extend & operate

​
Migration & misc