Query Channels

Search and retrieve channels based on various criteria including display name, tags, membership status, and channel type

Use getChannels to search and retrieve channels filtered by display name, tags, membership status, and channel type. Results are returned as a Live Collection that updates automatically.

Query Capabilities

The query function returns a Live Collection of channels that match your search criteria, enabling you to display search results in your app or apply additional filtering as needed.

Advanced Filtering

Multiple search criteria

• Display name and tag-based searching
• Membership status filtering
• Channel type specification
• Include/exclude deleted channels

Live Collection Results

Real-time search results

• Automatic updates when channels change
• Pagination support for large result sets
• Efficient data loading and caching

Channel Query Parameters

Basic Search

Core search functionality

Search for channels using basic criteria such as display name and membership status.

Parameters

Parameter	Type	Required	Description
displayName	String	❌	Search query for channel’s public display name
includeDeleted	Boolean	❌	Include closed/deleted channels (null = both, false = active only)
filter	String	❌	Membership filter: all (default), member, notMember, flagged
userId	String	❌	Search channels created by specific user (admin only)

Code Examples

iOS

var token: AmityNotificationToken?

func queryChannelExample() {
    
    let query = AmityChannelQueryOptions(
        types: [AmityChannelQueryType.conversation],
        filter: .all,
        includingTags: ["dog"],
        excludingTags: ["cat"],
        includeDeleted: false
    )

    token = channelRepository.getChannels(with: query).observe { liveCollection, error in
        // ...
    }
    
}

Tag Filtering

Tag-based search capabilities

Filter channels using tag inclusion and exclusion criteria for precise search results.

Parameters

Parameter	Type	Required	Description
tags	Array<String>	❌	Include channels with any of these tags
excludeTags	Array<String>	❌	Exclude channels containing any of these tags

Tag Search Behavior

• Including Tags: When multiple tags are specified, the system searches for channels that contain any of those tags (OR logic)
• Excluding Tags: When multiple tags are specified, the system excludes channels that contain any of those tags (OR logic)
• Combined Logic: You can use both including and excluding tags together for precise filtering

Tag filtering supports flexible search patterns. Including tags uses OR logic (channels with any specified tag), while excluding tags removes channels with any of the specified tags.

Channel Types

Filter by specific channel types

Limit search results to specific channel types based on your application needs.

Parameters

Parameter	Type	Required	Description
types	Array<ChannelType>	❌	Channel types to include: conversation, broadcast, live, community

Available Channel Types

• conversation: Private 1-on-1 and small group messaging
• community: Public channels discoverable by all users
• live: Event-focused channels with exclusive membership
• broadcast: One-way communication channels for announcements

You can specify multiple channel types in a single query to search across different channel categories simultaneously.

Filter Options Reference

Understanding the available filter options helps you create precise channel queries:

Membership Filters

Filter	Description
all	Search all channels (default)
member	Search channels where user is a member
notMember	Search channels where user is not a member
flagged	Search channels that user has flagged

Include Deleted Options

Value	Description
null	Show both active and closed channels (default)
false	Show only active/open channels
true	Show only closed/deleted channels

Next Steps

Create Channels

Set up new channels with custom configurations

Get Channels

Retrieve specific channels by ID

Update Channels

Modify channel properties and settings

Search Strategy: Combine multiple filter criteria for precise results. Use tag filtering for category-based searches, membership filters for user-specific queries, and channel types to focus on specific communication patterns.