Chat Module

Choose the SDK surfaces for channels, members, messages, moderation, and chat engagement state.

The Chat SDK is the client surface for building channel-based messaging across TypeScript, iOS, Android, and Flutter. Use it to create and query channels, manage membership, send and read messages, apply moderation actions, and render engagement state such as previews, unread counts, read receipts, and delivery status.

Looking for a product walkthrough? Use Channels & Conversations and Sending Messages. Use this section when you need the exact SDK objects and methods.

SDK Area Map

Area	Use it for	Start here
Conversation management	Create, query, update, archive, and organize chat channels.	Conversation Management
Member management	Join or leave channels, query channel members, and read membership state.	Member Management
Channel governance	Add or remove members, roles, bans, and mutes.	Channel Governance
Messaging features	Create, query, edit, delete, reply to, and flag messages.	Messaging Features
Engagement features	Read message previews, unread counts, read status, delivery status, and receipt sync state.	Unread Status Overview
Content moderation	Connect user reports, message deletion, and channel governance into a product moderation flow.	Content Moderation

Platform Coverage

Capability group	TypeScript	iOS	Android	Flutter
Channel lifecycle	Supported	Supported	Supported	Supported
Member operations	Supported	Supported	Supported	Supported
Channel governance	Supported	Supported	Supported	Supported
Message creation and querying	Supported	Supported	Supported	Supported
Message reactions and mentions	Supported through core content APIs	Supported through core content APIs	Supported through core content APIs	Supported through core content APIs
Message preview and unread counts	Supported with platform-specific gaps	Supported	Supported	Supported with platform-specific gaps
Delivery receipt user queries	Supported	Supported	Supported	Not exposed in the current public Flutter SDK
Explicit receipt sync start/stop	Supported	Supported	Supported	Not exposed in the current public Flutter SDK

Platform gaps are documented on the specific feature pages. Do not copy a code snippet from another platform when a public SDK surface is not exposed for your target platform.

Implementation Shape

Resolve the channel

Create or query the channel that owns the conversation, then resolve the target subChannelId for message APIs.

Check membership

Use member state to decide whether the current user can read, join, send, or moderate.

Render messages

Query messages by subchannel, apply message-type filters, and handle edits or soft deletes from the message model.

Add engagement state

Read previews, unread counters, receipt counts, and receipt sync state from the SDK where supported.

Product Boundaries

Concern	SDK owns	Your app owns
Identity	Authenticated SDK user context and channel membership state.	Login, user provisioning, and user-facing account policy.
Rendering	Message, channel, member, receipt, and preview models.	UI layout, empty states, moderation copy, and accessibility behavior.
Moderation	Message flagging, message deletion, and channel governance APIs.	Review queues, escalation policy, audit notes, appeal flows, and compliance workflows.
Notifications	Data fields such as unread count, mention state, and preview content.	Push-notification templates, routing, deep links, and notification preferences.

Related Topics

Create Channels

Start a community, live, or conversation channel.

Send Messages

Send text, media, custom, and reply messages.

Message Flagging

Let users report and unreport chat messages.