public final class PublicGroupChannelListQuery
extends java.lang.Object
GroupChannel
list for the current User
.
Currently, 1 kind of public GroupChannel
list can be queried.
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.
|
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.
|
public int getLimit()
GroupChannel
s per page.GroupChannel
s per page.public void setLimit(int limit)
GroupChannel
s per queried page.limit
- The maximum number of public GroupChannel
s per page.public boolean isIncludeEmpty()
public void setIncludeEmpty(boolean includeEmpty)
true
/false
to include empty channels or not (channels without messages).
This flag is false by default.includeEmpty
- Flag to include empty channels.public PublicGroupChannelListQuery.Order getOrder()
PublicGroupChannelListQuery.Order
.public void setOrder(PublicGroupChannelListQuery.Order order)
PublicGroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL
works with setMetaDataOrderKeyFilter(String)
.order
- PublicGroupChannelListQuery.Order.CHRONOLOGICAL
or PublicGroupChannelListQuery.Order.CHANNEL_NAME_ALPHABETICAL
or PublicGroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL
.public java.lang.String getMetaDataOrderKeyFilter()
null
if meta data order key filter hasn't been set before.public void setMetaDataOrderKeyFilter(java.lang.String metaDataOrderKey)
PublicGroupChannelListQuery.Order.METADATA_VALUE_ALPHABETICAL
is set from setOrder(Order)
.metaDataOrderKey
- Meta data order key.public java.lang.String getCustomTypeStartsWithFilter()
null
if custom type starts with filter hasn't been set before.public void setCustomTypeStartsWithFilter(java.lang.String customType)
customType
- The Custom Typepublic java.util.List<java.lang.String> getCustomTypesFilter()
null
if custom types filter hasn't been set before.public void setCustomTypesFilter(java.util.List<java.lang.String> customTypes)
GroupChannel
custom types filter. public GroupChannel
list containing only and exactly the passed custom types will be returned.customTypes
- public GroupChannel
custom types.public java.util.List<java.lang.String> getChannelUrlsFilter()
null
if channel URL filter hasn't been set before.public void setChannelUrlsFilter(java.util.List<java.lang.String> channelUrls)
GroupChannel
URLs filter. public GroupChannel
list containing only and exactly the passed public GroupChannel
URLs will be returned.channelUrls
- public GroupChannel
URLs.public java.lang.String getChannelNameContainsFilter()
null
if channel name filter hasn't been set before.public void setChannelNameContainsFilter(java.lang.String channelName)
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*".channelName
- Name of channel to search.public PublicGroupChannelListQuery.SuperChannelFilter getSuperChannelFilter()
PublicGroupChannelListQuery.SuperChannelFilter
.public void setSuperChannelFilter(PublicGroupChannelListQuery.SuperChannelFilter superChannelFilter)
superChannelFilter
- PublicGroupChannelListQuery.SuperChannelFilter
public PublicGroupChannelListQuery.MembershipFilter getMembershipFilter()
PublicGroupChannelListQuery.MembershipFilter
.public void setMembershipFilter(PublicGroupChannelListQuery.MembershipFilter membershipFilter)
PublicGroupChannelListQuery.MembershipFilter.JOINED
.membershipFilter
- PublicGroupChannelListQuery.MembershipFilter
public boolean hasNext()
true
if there is a next page.public boolean isLoading()
true
if the current query is not finished.public boolean isIncludeFrozen()
public void setIncludeFrozen(boolean includeFrozen)
true
/false
to include frozen channels or not.
This flag is true by default.includeFrozen
- Flag to include frozen channels.public boolean isIncludeMetadata()
public void setIncludeMetadata(boolean includeMetadata)
public void setMetaDataValuesFilter(java.lang.String metaDataKey, java.util.List<java.lang.String> metaDataValues)
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)
.metaDataKey
- Channel
meta data key.metaDataValues
- Channel
meta data values. Must not be empty.setMetaDataValueStartsWithFilter(String, String).
public void setMetaDataValueStartsWithFilter(java.lang.String metaDataKey, java.lang.String metaDataValueStartsWith)
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)
.metaDataKey
- Channel
meta data key.metaDataValueStartsWith
- Channel
meta data value to start with. Must not be empty.setMetaDataValuesFilter(String, List).
public java.lang.String getMetaDataKey()
public java.util.List<java.lang.String> getMetaDataValues()
public java.lang.String getMetaDataValueStartsWith()
public void next(PublicGroupChannelListQuery.PublicGroupChannelListQueryResultHandler handler)
GroupChannel
s. 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
.handler
- A callback handler to get the queried result. Copyright © 2021, Sendbird or its affiliates. All rights reserved.
Report a bug or request a feature
For further developer documentation, see Chat SDK Documentation. That documentation contains more detailed descriptions, conceptual overviews, definitions of terms, and code examples.