com.sendbird.android

Class GroupChannelCollection

java.lang.Object

com.sendbird.android.GroupChannelCollection

public final class GroupChannelCollection
extends java.lang.Object

Collection that handles channel lists, also supporting local caching.

Since:

3.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupChannelCollection.Builder A builder to create the GroupChannelCollection.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes current GroupChannelCollection and stops all events from being received.
java.util.List<GroupChannel>	getChannelList() Returns List of total channel list.
java.util.Comparator<GroupChannel>	getComparator() Returns a new Comparator for sorting group channels using the GroupChannelListQuery.Order set in this collection.
static java.util.Comparator<GroupChannel>	getGroupChannelComparator(GroupChannelListQuery.Order groupChannelListQueryOrder) Returns a new Comparator for sorting group channels using the GroupChannelListQuery.Order.
boolean	hasMore() Returns whether there's more data to load.
void	loadMore(OnChannelLoadResultHandler handler) Loads next channel lists, depending on the GroupChannelListQuery.Order set in the current collection.
void	setGroupChannelCollectionHandler(GroupChannelCollectionHandler handler) Sets the channel collection handler to be used for this GroupChannelCollection.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getChannelList

public java.util.List<GroupChannel> getChannelList()

Returns List of total channel list.

Returns:

List.

Since:

3.1.0

hasMore

public boolean hasMore()

Returns whether there's more data to load.

Returns:

whether there's more data to load.

Since:

3.1.0

dispose

public void dispose()

Disposes current GroupChannelCollection and stops all events from being received.

Since:

3.1.0

loadMore

public void loadMore(OnChannelLoadResultHandler handler)

Loads next channel lists, depending on the GroupChannelListQuery.Order set in the current collection.

Parameters:

handler - OnChannelLoadResultHandler to receive the next channel list.

Since:

3.1.0

setGroupChannelCollectionHandler

public void setGroupChannelCollectionHandler(GroupChannelCollectionHandler handler)

Sets the channel collection handler to be used for this GroupChannelCollection.

Parameters:

handler - GroupChannelCollectionHandler.

Since:

3.1.0

getComparator

public java.util.Comparator<GroupChannel> getComparator()

Returns a new Comparator for sorting group channels using the GroupChannelListQuery.Order set in this collection.

Returns:

the new comparator object.

Since:

3.1.0

See Also:

GroupChannelListQuery.Order, GroupChannel.compareTo(GroupChannel, GroupChannel, GroupChannelListQuery.Order, SortOrder)

getGroupChannelComparator

public static java.util.Comparator<GroupChannel> getGroupChannelComparator(GroupChannelListQuery.Order groupChannelListQueryOrder)

Returns a new Comparator for sorting group channels using the GroupChannelListQuery.Order.

Parameters:

groupChannelListQueryOrder - GroupChannelListQuery.Order to be used in sorting group channels.

Returns:

the new comparator object.

Since:

3.1.0

See Also:

GroupChannelListQuery.Order, GroupChannel.compareTo(GroupChannel, GroupChannel, GroupChannelListQuery.Order, SortOrder)