Skip to main content

iOS Chat SDK v4 — LLM docs index (Latest)

Headless Swift chat SDK. Package CometChatSDK@4. This page is an iOS-SDK-v4-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. Each page opens with an “AI Integration Quick Reference” block (package · import · key methods) — read that FIRST, then the body for the full call.
  • Convention: any docs page URL + .md → raw Markdown.
  • Fallback: if a .md twin 404s, fetch the same URL without .md (HTML).
  • Never answer a method signature from memory, and never read the framework binary’s .swiftinterface to decide behaviour — it proves a symbol exists, nothing more.

When to use this index

Two cases:
  1. Headless app — no CometChat UI, you are building your own views on the SDK.
  2. UI Kit fallback — the app uses the iOS UI Kit v5, but the feature you need ships no UI Kit component (AI agents, campaigns, moderation, adding group members, transient messages, low-level presence, webhooks). Check the kit first (iOS UI Kit v5 index); if there is no component, come here.

API facts an agent must not guess

  • Callbacks use .success / .onErrornot Swift’s Result.failure.
  • CometChatException does not conform to Swift’s Error; read errorDescription, not localizedDescription, and downcast with error as? CometChatException.
  • Request objects use the builder pattern (MessagesRequest.MessagesRequestBuilder), and listeners are registered per-class with a unique identifier you must later remove.
  • In SwiftUI hosts, qualify SDK types (CometChatSDK.User, CometChatSDK.Group) — SwiftUI declares its own Group.

Getting started

Messaging

Conversations

Users

Groups

Calling

AI

Real-time, connection, and lifecycle

Push notifications

Platform extras