GroupChannelListQuery (Sendbird Chat SDK for Android reference)

java.lang.Object
- com.sendbird.android.GroupChannelListQuery

```
public final class GroupChannelListQuery
extends java.lang.Object
```
A class representing query to retrieve GroupChannel list for the current User.
Currently, 1 kind of GroupChannel list can be queried.
- The list of GroupChannels the current User is a member of.
  The query can be get by calling GroupChannel.createMyGroupChannelListQuery().

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GroupChannelListQuery.GroupChannelListQueryResultHandler` GroupChannelListQuery handler.
`static class`	`GroupChannelListQuery.HiddenChannelFilter` The hidden channel filter.
`static class`	`GroupChannelListQuery.MemberState` Deprecated. As of 3.0.37, replaced by `GroupChannel.MemberState`.
`static class`	`GroupChannelListQuery.MemberStateFilter` The member state filter.
`static class`	`GroupChannelListQuery.Order` The query result order type.
`static class`	`GroupChannelListQuery.PublicChannelFilter` The public channel filter.
`static class`	`GroupChannelListQuery.QueryType` The query type for currently supported only with `setUserIdsIncludeFilter(List, QueryType)`.
`static class`	`GroupChannelListQuery.SearchField` Fields of `GroupChannel` that are used in search filter.
`static class`	`GroupChannelListQuery.SuperChannelFilter` The super channel filter.
`static class`	`GroupChannelListQuery.UnreadChannelFilter` The unread channel filter.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`belongsTo(GroupChannel channel)` Verify that the given channel information matches the current query filter.
`static GroupChannelListQuery`	`buildFromSerializedData(byte[] data)` Builds `GroupChannelListQuery` instance from serialized data generated by `serialize()`.
`java.lang.String`	`getChannelNameContainsFilter()` Returns channel name filter.
`java.util.List<java.lang.String>`	`getChannelUrlsFilter()` Returns list of channel URL filter.
`java.util.List<java.lang.String>`	`getCustomTypesFilter()` Returns list of custom type filter.
`java.lang.String`	`getCustomTypeStartsWithFilter()` Returns a filter to return channels that start with the specified Custom Type.
`GroupChannelListQuery.HiddenChannelFilter`	`getHiddenChannelFilter()` Returns hidden channel filter.
`int`	`getLimit()` Returns the maximum number of `GroupChannel`s per page.
`GroupChannelListQuery.MemberStateFilter`	`getMemberStateFilter()` Returns a filter to return channels with the current `User` state matching to `GroupChannelListQuery.MemberStateFilter`.
`java.lang.String`	`getMetaDataKey()`
`java.lang.String`	`getMetaDataOrderKeyFilter()` Returns meta data order key filter.
`java.util.List<java.lang.String>`	`getMetaDataValues()`
`java.lang.String`	`getMetaDataValueStartsWith()`
`java.lang.String`	`getNicknameContainsFilter()` Returns nickname filter.
`GroupChannelListQuery.Order`	`getOrder()` Returns result order of channels.
`GroupChannelListQuery.PublicChannelFilter`	`getPublicChannelFilter()` Returns public channel filter.
`java.util.List<GroupChannelListQuery.SearchField>`	`getSearchFields()` Returns search fields.
`java.lang.String`	`getSearchQuery()` Returns query string.
`GroupChannelListQuery.SuperChannelFilter`	`getSuperChannelFilter()` Returns super channel filter.
`GroupChannelListQuery.UnreadChannelFilter`	`getUnreadChannelFilter()` Returns unread channel filter.
`java.util.List<java.lang.String>`	`getUserIdsExactFilter()` Returns `User` IDs exact filter.
`java.util.List<java.lang.String>`	`getUserIdsIncludeFilter()` Returns `User` IDs include filter.
`GroupChannelListQuery.QueryType`	`getUserIdsIncludeFilterQueryType()` Returns `QueryType` of `User` IDs filter.
`boolean`	`hasNext()` Checks if there is a next page.
`boolean`	`isIncludeEmpty()` Checks whether query result includes empty channels.
`boolean`	`isIncludeFrozen()` Checks whether query result includes frozen channels.
`boolean`	`isIncludeMetadata()`
`boolean`	`isLoading()` Checks if the current query is in communication progress with server.
`void`	`next(GroupChannelListQuery.GroupChannelListQueryResultHandler handler)` Gets the list of `GroupChannel`s.
`byte[]`	`serialize()` Serializes the `GroupChannelListQuery` instance.
`void`	`setChannelNameContainsFilter(java.lang.String channelName)` Sets channel name filter.
`void`	`setChannelUrlsFilter(java.util.List<java.lang.String> channelUrls)` Sets with given channel URLs.
`void`	`setCustomTypeFilter(java.lang.String customType)` Deprecated. As of 3.0.47, replaced by `setCustomTypesFilter(List)`.
`void`	`setCustomTypesFilter(java.util.List<java.lang.String> customTypes)` Sets with given channel custom types.
`void`	`setCustomTypeStartsWithFilter(java.lang.String customType)` Sets a filter to return channels that start with the specified Custom Type.
`void`	`setHiddenChannelFilter(GroupChannelListQuery.HiddenChannelFilter hiddenChannelFilter)` Sets hidden channel filter.
`void`	`setIncludeEmpty(boolean includeEmpty)` Sets `true`/`false` to include empty channels or not (channels without messages).
`void`	`setIncludeFrozen(boolean includeFrozen)` Sets `true`/`false` to include frozen channels or not.
`void`	`setIncludeMetadata(boolean includeMetadata)` Sets whether to include channel metadata on fetch.
`void`	`setLimit(int limit)` Sets the maximum number of `GroupChannel`s per queried page.
`void`	`setMemberStateFilter(GroupChannel.MemberState memberState)` Deprecated. As of 3.0.52, replaced by `setMemberStateFilter(MemberStateFilter)`.
`void`	`setMemberStateFilter(GroupChannelListQuery.MemberState memberState)` Deprecated. As of 3.0.37, replaced by `setMemberStateFilter(GroupChannel.MemberState)`.
`void`	`setMemberStateFilter(GroupChannelListQuery.MemberStateFilter memberStateFilter)` Sets a filter to return channels with the current `User` state matching to `GroupChannelListQuery.MemberStateFilter`.
`void`	`setMetaDataOrderKeyFilter(java.lang.String metaDataOrderKey)` Sets meta data order key filter.
`void`	`setMetaDataValuesFilter(java.lang.String metaDataKey, java.util.List<java.lang.String> metaDataValues)` Sets `Channel` meta data filter.
`void`	`setMetaDataValueStartsWithFilter(java.lang.String metaDataKey, java.lang.String metaDataValueStartsWith)` Sets `Channel` meta data filter.
`void`	`setNicknameContainsFilter(java.lang.String nickname)` Sets nickname filter.
`void`	`setOrder(GroupChannelListQuery.Order order)` Sets result order of channels.
`void`	`setPublicChannelFilter(GroupChannelListQuery.PublicChannelFilter publicChannelFilter)` Sets public channel filter.
`void`	`setSearchFilter(java.util.List<GroupChannelListQuery.SearchField> searchFields, java.lang.String query)` Sets 'Search' filter.
`void`	`setSuperChannelFilter(GroupChannelListQuery.SuperChannelFilter superChannelFilter)` Sets super channel filter.
`void`	`setUnreadChannelFilter(GroupChannelListQuery.UnreadChannelFilter unreadChannelFilter)` Sets unread channel filter.
`void`	`setUserIdsExactFilter(java.util.List<java.lang.String> userIds)` Sets `User` IDs filter.
`void`	`setUserIdsFilter(java.util.List<java.lang.String> userIds, boolean exactMatch)` Deprecated. As of 3.0.9, replaced by `setUserIdsIncludeFilter(List, QueryType)` and `setUserIdsExactFilter(List)`.
`void`	`setUserIdsIncludeFilter(java.util.List<java.lang.String> userIds, GroupChannelListQuery.QueryType queryType)` Sets `User` IDs filter.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getLimit
```
public int getLimit()
```
    Returns the maximum number of GroupChannels per page.
    
    Returns:
    
    the number of GroupChannels per page.
    
    Since:
    
    3.0.88
  - setLimit
```
public void setLimit(int limit)
```
    Sets the maximum number of GroupChannels per queried page.
    
    Parameters:
    
    limit - The maximum number of GroupChannels per page.
  - isIncludeEmpty
```
public boolean isIncludeEmpty()
```
    Checks whether query result includes empty channels.
    
    Returns:
    
    Returns true if query result includes empty channels.
    
    Since:
    
    3.0.88
  - setIncludeEmpty
```
public void setIncludeEmpty(boolean includeEmpty)
```
    Sets true/false to include empty channels or not (channels without messages). This flag is false by default.
    
    Parameters:
    
    includeEmpty - Flag to include empty channels.
  - getOrder
```
public GroupChannelListQuery.Order getOrder()
```
    Returns result order of channels. Refer to GroupChannelListQuery.Order.
    
    Returns:
    
    Returns Order.
    
    Since:
    
    3.0.88
  - setOrder
```
public void setOrder(GroupChannelListQuery.Order order)
```
    Sets result order of channels. GroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL works with setMetaDataOrderKeyFilter(String).
    
    Parameters:
    
    order - GroupChannelListQuery.Order.CHRONOLOGICAL or GroupChannelListQuery.Order.LATEST_LAST_MESSAGE or GroupChannelListQuery.Order.CHANNEL_NAME_ALPHABETICAL or GroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL.
  - getMetaDataOrderKeyFilter
```
public java.lang.String getMetaDataOrderKeyFilter()
```
    Returns meta data order key filter. It will return null if meta data order key filter hasn't been set before.
    
    Returns:
    
    Returns meta data order key filter.
    
    Since:
    
    3.0.88
  - setMetaDataOrderKeyFilter
```
public void setMetaDataOrderKeyFilter(java.lang.String metaDataOrderKey)
```
    Sets meta data order key filter. This filter will work only if GroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL is set from setOrder(Order).
    
    Parameters:
    
    metaDataOrderKey - Meta data order key.
    
    Since:
    
    3.0.79
  - getNicknameContainsFilter
```
public java.lang.String getNicknameContainsFilter()
```
    Returns nickname filter. It will return null if nickname filter hasn't been set before.
    
    Returns:
    
    Returns nickname filter.
    
    Since:
    
    3.0.88
  - setNicknameContainsFilter
```
public void setNicknameContainsFilter(java.lang.String nickname)
```
    Sets nickname filter. GroupChannel list containing the passed nickname will be returned. If you pass nickname such as "abc", then the returned channel list will be containing member like "*abc*". This does not cooperate with other filters.
    
    Parameters:
    
    nickname - User nickname to search as the member of the channels.
    
    Since:
    
    3.0.6
  - setUserIdsFilter
```
@Deprecated
public void setUserIdsFilter(java.util.List<java.lang.String> userIds,
                                         boolean exactMatch)
```
    Deprecated. As of 3.0.9, replaced by setUserIdsIncludeFilter(List, QueryType) and setUserIdsExactFilter(List).
    
    Sets User IDs filter. GroupChannel list containing the passed User IDs will be returned. This does not cooperate with other filters.
    
    Parameters:
    
    userIds - User IDs to search as the member of the channels. The list of IDs operates as AND option.
    
    exactMatch - If this is true, the channels exactly containing the current User and the passed User IDs will be returned. Otherwise, the channels which have the current User, the passed User IDs and others will be returned.
    
    Since:
    
    3.0.5
  - getUserIdsIncludeFilter
```
public java.util.List<java.lang.String> getUserIdsIncludeFilter()
```
    Returns User IDs include filter. It will return null if User IDs include filter hasn't been set before. Modification of returned List will not affect GroupChannelListQuery's filter value. If you want to modify the filter value, please find the setUserIdsIncludeFilter(List, QueryType).
    
    Returns:
    
    User IDs include filter.
    
    Since:
    
    3.0.88
  - getUserIdsIncludeFilterQueryType
```
public GroupChannelListQuery.QueryType getUserIdsIncludeFilterQueryType()
```
    Returns QueryType of User IDs filter.
    
    Returns:
    
    QueryType.
    
    Since:
    
    3.0.88
  - setUserIdsIncludeFilter
```
public void setUserIdsIncludeFilter(java.util.List<java.lang.String> userIds,
                                    GroupChannelListQuery.QueryType queryType)
```
    Sets User IDs filter. GroupChannel list containing the passed User IDs and other members will be returned. This does not cooperate with other filters.
    
    Parameters:
    
    userIds - User IDs to search as the member of the channels.
    
    queryType - The logical operation options. If passed GroupChannelListQuery.QueryType.AND with userIds = {A, B}, the channels containing A AND B + other members will be returned. If GroupChannelListQuery.QueryType.OR, the channels with A OR B + other members will be returned.
    
    Since:
    
    3.0.9
  - getUserIdsExactFilter
```
public java.util.List<java.lang.String> getUserIdsExactFilter()
```
    Returns User IDs exact filter. It will return null if User IDs exact filter hasn't been set before. Modification of returned List will not affect GroupChannelListQuery's filter value. If you want to modify the filter value, please find the setUserIdsExactFilter(List).
    
    Returns:
    
    User IDs exact filter.
    
    Since:
    
    3.0.88
  - setUserIdsExactFilter
```
public void setUserIdsExactFilter(java.util.List<java.lang.String> userIds)
```
    Sets User IDs filter. GroupChannel list containing only and exactly the passed User IDs will be returned. This does not cooperate with other filters.
    
    Parameters:
    
    userIds - User IDs to search as the member of the channels.
    
    Since:
    
    3.0.9
  - setSearchFilter
```
public void setSearchFilter(java.util.List<GroupChannelListQuery.SearchField> searchFields,
                            java.lang.String query)
```
    Sets 'Search' filter. GroupChannels will be included in the result if its data in specified SearchFields contains specified query string. Refer to GroupChannelListQuery.SearchField. If you set multiple SearchFields, the result will be union of each result.
    
    Parameters:
    
    searchFields - Target fields that you want to search. Refer to GroupChannelListQuery.SearchField.
    
    query - Query string you want to search with.
    
    Since:
    
    3.0.98
  - getSearchQuery
```
public java.lang.String getSearchQuery()
```
    Returns query string. Refer to setSearchFilter(List, String).
    
    Returns:
    
    String.
    
    Since:
    
    3.0.98
  - getSearchFields
```
public java.util.List<GroupChannelListQuery.SearchField> getSearchFields()
```
    Returns search fields. Refer to setSearchFilter(List, String) and GroupChannelListQuery.SearchField.
    
    Returns:
    
    GroupChannelListQuery.SearchField.
    
    Since:
    
    3.0.98
  - setCustomTypeFilter
```
@Deprecated
public void setCustomTypeFilter(java.lang.String customType)
```
    Deprecated. As of 3.0.47, replaced by setCustomTypesFilter(List).
    
    Sets a filter to return only channels with the specified Custom Type.
    
    Parameters:
    
    customType - The Custom Type of the channels to return.
    
    Since:
    
    3.0.27
  - getCustomTypeStartsWithFilter
```
public java.lang.String getCustomTypeStartsWithFilter()
```
    Returns a filter to return channels that start with the specified Custom Type. It will return null if custom type starts with filter hasn't been set before.
    
    Returns:
    
    The CustomType
    
    Since:
    
    3.0.88
  - setCustomTypeStartsWithFilter
```
public void setCustomTypeStartsWithFilter(java.lang.String customType)
```
    Sets a filter to return channels that start with the specified Custom Type.
    
    Parameters:
    
    customType - The Custom Type
    
    Since:
    
    3.0.50
  - getCustomTypesFilter
```
public java.util.List<java.lang.String> getCustomTypesFilter()
```
    Returns list of custom type filter. It will return null if custom types filter hasn't been set before.
    
    Returns:
    
    list of custom type filter.
    
    Since:
    
    3.0.88
  - setCustomTypesFilter
```
public void setCustomTypesFilter(java.util.List<java.lang.String> customTypes)
```
    Sets with given channel custom types. Sets GroupChannel custom types filter. GroupChannel list containing only and exactly the passed custom types will be returned.
    
    Parameters:
    
    customTypes - GroupChannel custom types.
    
    Since:
    
    3.0.47
  - setMemberStateFilter
```
@Deprecated
public void setMemberStateFilter(GroupChannelListQuery.MemberState memberState)
```
    Deprecated. As of 3.0.37, replaced by setMemberStateFilter(GroupChannel.MemberState).
    
    Sets a filter to return channels with the current User state matching to GroupChannelListQuery.MemberState. If set GroupChannelListQuery.MemberState.INVITED_ONLY, only the channels from which invitations has been sent to the current User (but not accepted yet) will be returned. If set GroupChannelListQuery.MemberState.JOINED_ONLY, only the channels the current User is already joined will be returned.
    
    Parameters:
    
    memberState - The member state of the current User of the channels to return.
    
    Since:
    
    3.0.30
  - setMemberStateFilter
```
@Deprecated
public void setMemberStateFilter(GroupChannel.MemberState memberState)
```
    Deprecated. As of 3.0.52, replaced by setMemberStateFilter(MemberStateFilter).
    
    Sets a filter to return channels with the current User state matching to GroupChannel.MemberState. If set GroupChannel.MemberState.INVITED, only the channels from which invitations has been sent to the current User (but not accepted yet) will be returned. If set GroupChannel.MemberState.INVITED_BY_FRIEND, only the channels from which invitations by friend has been sent to the current User (but not accepted yet) will be returned. If set GroupChannel.MemberState.INVITED_BY_NON_FRIEND, only the channels from which invitations by non friend has been sent to the current User (but not accepted yet) will be returned. If set GroupChannel.MemberState.JOINED, only the channels the current User is already joined will be returned.
    
    Parameters:
    
    memberState - The member state of the current User of the channels to return.
    
    Since:
    
    3.0.37
  - getMemberStateFilter
```
public GroupChannelListQuery.MemberStateFilter getMemberStateFilter()
```
    Returns a filter to return channels with the current User state matching to GroupChannelListQuery.MemberStateFilter.
    
    Returns:
    
    Returns MemberStateFilter
    
    Since:
    
    3.0.88
  - setMemberStateFilter
```
public void setMemberStateFilter(GroupChannelListQuery.MemberStateFilter memberStateFilter)
```
    Sets a filter to return channels with the current User state matching to GroupChannelListQuery.MemberStateFilter. If set GroupChannelListQuery.MemberStateFilter.INVITED, only the channels from which invitations has been sent to the current User (but not accepted yet) will be returned. If set GroupChannelListQuery.MemberStateFilter.INVITED_BY_FRIEND, only the channels from which invitations by friend has been sent to the current User (but not accepted yet) will be returned. If set GroupChannelListQuery.MemberStateFilter.INVITED_BY_NON_FRIEND, only the channels from which invitations by non friend has been sent to the current User (but not accepted yet) will be returned. If set GroupChannelListQuery.MemberStateFilter.JOINED, only the channels the current User is already joined will be returned.
    
    Parameters:
    
    memberStateFilter - The member state of the current User of the channels to return.
    
    Since:
    
    3.0.52
  - getChannelUrlsFilter
```
public java.util.List<java.lang.String> getChannelUrlsFilter()
```
    Returns list of channel URL filter. It will return null if channel URL filter hasn't been set before.
    
    Returns:
    
    list of channel URL filter.
    
    Since:
    
    3.0.88
  - setChannelUrlsFilter
```
public void setChannelUrlsFilter(java.util.List<java.lang.String> channelUrls)
```
    Sets with given channel URLs. Sets GroupChannel URLs filter. GroupChannel list containing only and exactly the passed GroupChannel URLs will be returned.
    
    Parameters:
    
    channelUrls - GroupChannel URLs.
    
    Since:
    
    3.0.33
  - getChannelNameContainsFilter
```
public java.lang.String getChannelNameContainsFilter()
```
    Returns channel name filter. It will return null if channel name filter hasn't been set before.
    
    Returns:
    
    channel name filter.
    
    Since:
    
    3.0.88
  - setChannelNameContainsFilter
```
public void setChannelNameContainsFilter(java.lang.String channelName)
```
    Sets channel name filter. GroupChannel list containing the passed channel name will be returned. If you pass name such as "abc", then the returned channel list will be containing name like "*abc*".
    
    Parameters:
    
    channelName - Name of channel to search.
    
    Since:
    
    3.0.34
  - getSuperChannelFilter
```
public GroupChannelListQuery.SuperChannelFilter getSuperChannelFilter()
```
    Returns super channel filter.
    
    Returns:
    
    super channel filter GroupChannelListQuery.SuperChannelFilter.
    
    Since:
    
    3.0.88
  - setSuperChannelFilter
```
public void setSuperChannelFilter(GroupChannelListQuery.SuperChannelFilter superChannelFilter)
```
    Sets super channel filter.
    
    Parameters:
    
    superChannelFilter - GroupChannelListQuery.SuperChannelFilter
    
    Since:
    
    3.0.49
  - getPublicChannelFilter
```
public GroupChannelListQuery.PublicChannelFilter getPublicChannelFilter()
```
    Returns public channel filter.
    
    Returns:
    
    public channel filter GroupChannelListQuery.PublicChannelFilter.
    
    Since:
    
    3.0.88
  - setPublicChannelFilter
```
public void setPublicChannelFilter(GroupChannelListQuery.PublicChannelFilter publicChannelFilter)
```
    Sets public channel filter.
    
    Parameters:
    
    publicChannelFilter - GroupChannelListQuery.PublicChannelFilter
    
    Since:
    
    3.0.50
  - getUnreadChannelFilter
```
public GroupChannelListQuery.UnreadChannelFilter getUnreadChannelFilter()
```
    Returns unread channel filter.
    
    Returns:
    
    unread channel filter GroupChannelListQuery.UnreadChannelFilter.
    
    Since:
    
    3.0.88
  - setUnreadChannelFilter
```
public void setUnreadChannelFilter(GroupChannelListQuery.UnreadChannelFilter unreadChannelFilter)
```
    Sets unread channel filter.
    
    Parameters:
    
    unreadChannelFilter - GroupChannelListQuery.UnreadChannelFilter
    
    Since:
    
    3.0.74
  - getHiddenChannelFilter
```
public GroupChannelListQuery.HiddenChannelFilter getHiddenChannelFilter()
```
    Returns hidden channel filter.
    
    Returns:
    
    hidden channel filter GroupChannelListQuery.HiddenChannelFilter.
    
    Since:
    
    3.0.88
  - setHiddenChannelFilter
```
public void setHiddenChannelFilter(GroupChannelListQuery.HiddenChannelFilter hiddenChannelFilter)
```
    Sets hidden channel filter.
    
    Parameters:
    
    hiddenChannelFilter - GroupChannelListQuery.HiddenChannelFilter
    
    Since:
    
    3.0.83
  - hasNext
```
public boolean hasNext()
```
    Checks if there is a next page.
    
    Returns:
    
    true if there is a next page.
  - isLoading
```
public boolean isLoading()
```
    Checks if the current query is in communication progress with server.
    
    Returns:
    
    true if the current query is not finished.
  - isIncludeFrozen
```
public boolean isIncludeFrozen()
```
    Checks whether query result includes frozen channels.
    
    Returns:
    
    Returns true if query result includes frozen channels.
    
    Since:
    
    3.0.131
  - setIncludeFrozen
```
public void setIncludeFrozen(boolean includeFrozen)
```
    Sets true/false to include frozen channels or not. This flag is true by default.
    
    Parameters:
    
    includeFrozen - Flag to include frozen channels.
    
    Since:
    
    3.0.131
  - isIncludeMetadata
```
public boolean isIncludeMetadata()
```
    Returns:
    
    if metadata will be included upon fetch.
    
    Since:
    
    3.0.163
  - setIncludeMetadata
```
public void setIncludeMetadata(boolean includeMetadata)
```
    Sets whether to include channel metadata on fetch. This flag is true by default.
    
    Since:
    
    3.0.163
  - setMetaDataValuesFilter
```
public void setMetaDataValuesFilter(java.lang.String metaDataKey,
                                    java.util.List<java.lang.String> metaDataValues)
```
    Sets Channel meta data filter. Channel list containing only and exactly the passed Channel meta data will be returned. If this is set, it will reset the filter set from setMetaDataValueStartsWithFilter(String, String).
    
    Parameters:
    
    metaDataKey - Channel meta data key.
    
    metaDataValues - Channel meta data values. Must not be empty.
    
    Since:
    
    3.0.171
    
    See Also:
    
    setMetaDataValueStartsWithFilter(String, String).
  - setMetaDataValueStartsWithFilter
```
public void setMetaDataValueStartsWithFilter(java.lang.String metaDataKey,
                                             java.lang.String metaDataValueStartsWith)
```
    Sets Channel meta data filter. Channel list containing passed Channel meta data key with values that starts with the passed on value will be returned. If this is set, it will reset the filter set from setMetaDataValuesFilter(String, List).
    
    Parameters:
    
    metaDataKey - Channel meta data key.
    
    metaDataValueStartsWith - Channel meta data value to start with. Must not be empty.
    
    Since:
    
    3.0.171
    
    See Also:
    
    setMetaDataValuesFilter(String, List).
  - getMetaDataKey
```
public java.lang.String getMetaDataKey()
```
  - getMetaDataValues
```
public java.util.List<java.lang.String> getMetaDataValues()
```
  - getMetaDataValueStartsWith
```
public java.lang.String getMetaDataValueStartsWith()
```
  - next
```
public void next(GroupChannelListQuery.GroupChannelListQueryResultHandler handler)
```
    Gets the list of GroupChannels. The queried result is passed to handler as list. If this method is repeatedly called after each next() is finished, it retrieves the following pages of the GroupChannel list. If there is no more pages to be read, an empty List (not null) is returned to handler.
    
    Parameters:
    
    handler - A callback handler to get the queried result.
  - buildFromSerializedData
```
public static GroupChannelListQuery buildFromSerializedData(byte[] data)
```
    Builds GroupChannelListQuery instance from serialized data generated by serialize().
    
    Parameters:
    
    data - Serialized GroupChannelListQuery data.
    
    Returns:
    
    GroupChannelListQuery instance.
    
    Since:
    
    3.0.91
  - serialize
```
public byte[] serialize()
```
    Serializes the GroupChannelListQuery instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData(byte[]).
    
    Returns:
    
    Serialized GroupChannelListQuery data.
    
    Since:
    
    3.0.91
  - belongsTo
```
public boolean belongsTo(GroupChannel channel)
```
    Verify that the given channel information matches the current query filter.
    
    Parameters:
    
    channel - GroupChannel to check. Returns false if the channel is not matched with the query.
    
    Returns:
    
    whether the channel isn't matched with the query.
    
    Since:
    
    3.0.167

Class GroupChannelListQuery

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLimit

setLimit

isIncludeEmpty

setIncludeEmpty

getOrder

setOrder

getMetaDataOrderKeyFilter

setMetaDataOrderKeyFilter

getNicknameContainsFilter

setNicknameContainsFilter

setUserIdsFilter

getUserIdsIncludeFilter

getUserIdsIncludeFilterQueryType

setUserIdsIncludeFilter

getUserIdsExactFilter

setUserIdsExactFilter

setSearchFilter

getSearchQuery

getSearchFields

setCustomTypeFilter

getCustomTypeStartsWithFilter

setCustomTypeStartsWithFilter

getCustomTypesFilter

setCustomTypesFilter

setMemberStateFilter

setMemberStateFilter

getMemberStateFilter

setMemberStateFilter

getChannelUrlsFilter

setChannelUrlsFilter

getChannelNameContainsFilter

setChannelNameContainsFilter

getSuperChannelFilter

setSuperChannelFilter

getPublicChannelFilter

setPublicChannelFilter

getUnreadChannelFilter

setUnreadChannelFilter

getHiddenChannelFilter

setHiddenChannelFilter

hasNext

isLoading

isIncludeFrozen

setIncludeFrozen

isIncludeMetadata

setIncludeMetadata

setMetaDataValuesFilter

setMetaDataValueStartsWithFilter

getMetaDataKey

getMetaDataValues

getMetaDataValueStartsWith

next

buildFromSerializedData

serialize

belongsTo