A GroupChannelCollection
allows you to swiftly create a channel list view that doesn’t miss any channel-related events. This page explains how to make a view using the collection.
Note: Understand the differences between local caching and SyncManager, and learn how to migrate Group channel collection.
You can create a GroupChannelCollection
instance through the createGroupChannelCollection()
method.
First, create a GroupChannelListQuery
instance through the createMyGroupChannelListQuery()
method and query setters. This will determine which channel to include in the channel list and how to order it.
Once the collection is created, you should call the loadMore()
.
A GroupChannelCollection
can retrieve channels through the loadMore()
method to display in the view.
Whenever a scroll reaches the bottom of the channel list view, the loadMore()
is called and the hasMore()
will first check if there are more channels to load. If true, the loadMore()
will fetch them.
The loadMore()
should also be called after you've created a GroupChannelCollection
.
Use the setGroupChannelCollectionHandler()
to determine how the client app would react to channel-related events.
This is called whenever a new channel is created as a real-time event or changelog sync is prompted when the client app is back online.
The following table shows possible cases where each event handler can be called.
Event | Called when |
---|---|
| - A new group channel is created as a real-time event. |
| - The channel information that is included in the user's current chat view is updated as a real-time event. |
| - A group channel is deleted as a real-time event. |
The dispose()
should be called when you need to clear the current channel list view.