Member Management Overview

Capability Map

Capability	Use it for	SDK page
Join a channel	Add the current user to a joinable channel.	Join & Leave Channel
Leave a channel	Remove the current user from a channel where leaving is allowed.	Join & Leave Channel
Read current membership	Hide composer controls, redirect banned users, or show join prompts.	Join & Leave Channel
Query members	Build member lists, moderator lists, banned lists, or muted lists.	Query Members
Search members	Build mention pickers and member directories.	Query Members
Preview members	Show a small channel-member sample where the platform exposes preview members.	Preview Members

Platform Surface

Surface	TypeScript	iOS	Android	Flutter
Join channel	Supported	Supported	Supported	Supported
Leave channel	Supported	Supported	Supported	Supported
Current membership state	Supported	Supported	Supported	Supported
Query members	Supported	Supported	Supported	Supported
Search members	Supported	Supported	Supported	Supported
Role filters	Supported	Supported	Supported	Supported
Preview-member field	Supported	Supported	Use member-query fallback	Use member-query fallback

Parameters

Parameter	Required	Description
`channelId`	Yes	Channel whose membership state should be read or changed.
Membership filter	No	Filter member queries by state such as member, banned, muted, or all where supported.
`roles`	No	Filter members by channel role, such as `moderator` or another role configured for your app.
Search keyword	No	Search member display names where the platform exposes member search.
`includeDeleted`	No	Include deleted users in member query results where supported.

Implementation Shape

Gate channel UI

Read membership before showing the composer, join button, leave action, or banned-state messaging.

Query members by channel, membership state, role, search keyword, and deletion state where supported.

Use member search for mention pickers and user-selection flows.

Use preview members where exposed; otherwise query a small member page for fallback display.