PublicGroupChannelListQuery (Sendbird Chat SDK for Android reference)

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

```
public final class PublicGroupChannelListQuery
extends java.lang.Object
```
A class representing query to retrieve GroupChannel list for the current User.
Currently, 1 kind of public GroupChannel list can be queried.

Since:

3.0.50

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PublicGroupChannelListQuery.MembershipFilter` The public channel membership filter.
`static class`	`PublicGroupChannelListQuery.Order` The query result order type.
`static interface`	`PublicGroupChannelListQuery.PublicGroupChannelListQueryResultHandler` GroupChannelListQuery handler.
`static class`	`PublicGroupChannelListQuery.SuperChannelFilter` The super channel filter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`int`	`getLimit()` Returns the maximum number of `GroupChannel`s per page.
`PublicGroupChannelListQuery.MembershipFilter`	`getMembershipFilter()` Returns membership filter.
`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()`
`PublicGroupChannelListQuery.Order`	`getOrder()` Returns result order of channels.
`PublicGroupChannelListQuery.SuperChannelFilter`	`getSuperChannelFilter()` Returns super channel 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(PublicGroupChannelListQuery.PublicGroupChannelListQueryResultHandler handler)` Gets the list of public `GroupChannel`s.
`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`	`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`	`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 public `GroupChannel`s per queried page.
`void`	`setMembershipFilter(PublicGroupChannelListQuery.MembershipFilter membershipFilter)` Sets membership filter.
`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`	`setOrder(PublicGroupChannelListQuery.Order order)` Sets result order of channels.
`void`	`setSuperChannelFilter(PublicGroupChannelListQuery.SuperChannelFilter superChannelFilter)` Sets super channel 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 public GroupChannels per queried page.
    
    Parameters:
    
    limit - The maximum number of public GroupChannels per page.
    
    Since:
    
    3.0.50
  - 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.
    
    Since:
    
    3.0.50
  - getOrder
```
public PublicGroupChannelListQuery.Order getOrder()
```
    Returns result order of channels. Refer to PublicGroupChannelListQuery.Order.
    
    Returns:
    
    Returns Order.
    
    Since:
    
    3.0.88
  - setOrder
```
public void setOrder(PublicGroupChannelListQuery.Order order)
```
    Sets result order of channels. PublicGroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL works with setMetaDataOrderKeyFilter(String).
    
    Parameters:
    
    order - PublicGroupChannelListQuery.Order.CHRONOLOGICAL or PublicGroupChannelListQuery.Order.CHANNEL_NAME_ALPHABETICAL or PublicGroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL.
    
    Since:
    
    3.0.50
  - 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 PublicGroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL is set from setOrder(Order).
    
    Parameters:
    
    metaDataOrderKey - Meta data order key.
    
    Since:
    
    3.0.79
  - 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 public GroupChannel custom types filter. public GroupChannel list containing only and exactly the passed custom types will be returned.
    
    Parameters:
    
    customTypes - public GroupChannel custom types.
    
    Since:
    
    3.0.50
  - 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 public GroupChannel URLs filter. public GroupChannel list containing only and exactly the passed public GroupChannel URLs will be returned.
    
    Parameters:
    
    channelUrls - public GroupChannel URLs.
    
    Since:
    
    3.0.50
  - 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. public 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.50
  - getSuperChannelFilter
```
public PublicGroupChannelListQuery.SuperChannelFilter getSuperChannelFilter()
```
    Returns super channel filter.
    
    Returns:
    
    super channel filter PublicGroupChannelListQuery.SuperChannelFilter.
    
    Since:
    
    3.0.88
  - setSuperChannelFilter
```
public void setSuperChannelFilter(PublicGroupChannelListQuery.SuperChannelFilter superChannelFilter)
```
    Sets super channel filter.
    
    Parameters:
    
    superChannelFilter - PublicGroupChannelListQuery.SuperChannelFilter
    
    Since:
    
    3.0.50
  - getMembershipFilter
```
public PublicGroupChannelListQuery.MembershipFilter getMembershipFilter()
```
    Returns membership filter.
    
    Returns:
    
    membership filter PublicGroupChannelListQuery.MembershipFilter.
    
    Since:
    
    3.0.88
  - setMembershipFilter
```
public void setMembershipFilter(PublicGroupChannelListQuery.MembershipFilter membershipFilter)
```
    Sets membership filter. Default is PublicGroupChannelListQuery.MembershipFilter.JOINED.
    
    Parameters:
    
    membershipFilter - PublicGroupChannelListQuery.MembershipFilter
    
    Since:
    
    3.0.50
  - hasNext
```
public boolean hasNext()
```
    Checks if there is a next page.
    
    Returns:
    
    true if there is a next page.
    
    Since:
    
    3.0.50
  - isLoading
```
public boolean isLoading()
```
    Checks if the current query is in communication progress with server.
    
    Returns:
    
    true if the current query is not finished.
    
    Since:
    
    3.0.50
  - 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(PublicGroupChannelListQuery.PublicGroupChannelListQueryResultHandler handler)
```
    Gets the list of public 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 public 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.
    
    Since:
    
    3.0.50

Class PublicGroupChannelListQuery

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLimit

setLimit

isIncludeEmpty

setIncludeEmpty

getOrder

setOrder

getMetaDataOrderKeyFilter

setMetaDataOrderKeyFilter

getCustomTypeStartsWithFilter

setCustomTypeStartsWithFilter

getCustomTypesFilter

setCustomTypesFilter

getChannelUrlsFilter

setChannelUrlsFilter

getChannelNameContainsFilter

setChannelNameContainsFilter

getSuperChannelFilter

setSuperChannelFilter

getMembershipFilter

setMembershipFilter

hasNext

isLoading

isIncludeFrozen

setIncludeFrozen

isIncludeMetadata

setIncludeMetadata

setMetaDataValuesFilter

setMetaDataValueStartsWithFilter

getMetaDataKey

getMetaDataValues

getMetaDataValueStartsWith

next