Skip to main content
Get a quick preview of channel members to display participant information in channel lists, headers, or summary views. The preview members feature returns up to 4 members from both conversation and community channels, perfect for UI elements that need to show channel participation at a glance.

​
Overview

Quick Member Preview

Limited member display - Returns up to 4 active members - Optimized for UI preview components - Supports both conversation and community channels - Instant member information access

Efficient Performance

Lightweight operation - Minimal data transfer for preview purposes - Fast response times for UI rendering - Automatic filtering of active members only - Ideal for channel list displays

​
Quick Start

1

Initialize Channel Repository

Set up the channel repository to access preview member functionality
2

Call Preview Members

Use the channel object to get up to 4 member previews
3

Handle Response

Process the returned member data for your UI components

​
Code Examples

// Code implementation will be available soon

​
Parameters & Configuration

No Direct Parameters Required: The preview members feature doesn’t require specific parameters. It’s accessed as a property of the AmityChannel object after fetching the channel using the channel repository.
Channel Fetching RequiredBefore accessing preview members, you must first fetch the AmityChannel object using:
  • Channel ID for the target channel
  • Proper channel repository initialization
  • Appropriate permissions to view the channel
Compatible Channel TypesPreview members are available for the following channel types:
  • Conversation Channels: 1-on-1 and group chat channels
  • Community Channels: Public and private community channels

​
Best Practices

Efficient member preview implementation - Use preview members for UI display instead of querying full member lists - Cache channel data with preview members to avoid repeated API calls - Implement proper loading states while channel data is being fetched - Consider using skeleton screens for member avatars during loading
Enhanced member visibility patterns - Display member avatars in overlapping circles for visual appeal - Show “+X more” indicator when there are additional members - Use fallback initials or default avatars for members without profile pictures - Implement hover/tap states to show member names or additional info

Query All Members

Comprehensive member querying with advanced filtering and search capabilities for detailed member management

Get Channel Details

Retrieve complete channel information including metadata, settings, and comprehensive channel properties

Join/Leave Channel

Manage channel membership with join and leave operations for conversation and community participation