com.sendbird.android

Class OpenChannelListQuery

java.lang.Object

com.sendbird.android.OpenChannelListQuery

public final class OpenChannelListQuery
extends java.lang.Object

A class representing query to retrieve OpenChannel list.

Currently, 1 kind of OpenChannel list can be queried.

• The list of OpenChannels the APP ID (refer to SendBird.init(String, Context) has.

  The query can be get by calling OpenChannel.createOpenChannelListQuery().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpenChannelListQuery.OpenChannelListQueryResultHandler OpenChannelListQuery handler.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Checks if there is a next page.
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(OpenChannelListQuery.OpenChannelListQueryResultHandler handler) Gets the list of OpenChannels.
void	setCustomTypeFilter(java.lang.String customType) Sets a filter to return only channels with the specified Custom Type.
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 OpenChannels per queried page.
void	setNameKeyword(java.lang.String nameKeyword) Sets search keyword for channel name.
void	setUrlKeyword(java.lang.String urlKeyword) Sets search keyword for channel URL.

Methods inherited from class java.lang.Object

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

Method Detail

setLimit

public void setLimit(int limit)

Sets the maximum number of OpenChannels per queried page.

Parameters:

limit - The maximum number of OpenChannels per page.

setNameKeyword

public void setNameKeyword(java.lang.String nameKeyword)

Sets search keyword for channel name. If this is set, next(OpenChannelListQueryResultHandler) will return the list of OpenChannels of which name matches the specified name.

Parameters:

nameKeyword - Name keyword.

Since:

3.0.2

setUrlKeyword

public void setUrlKeyword(java.lang.String urlKeyword)

Sets search keyword for channel URL. If this is set, next(OpenChannelListQueryResultHandler) will return the list of OpenChannels of which URL matches the specified URL.

Parameters:

urlKeyword - URL keyword.

Since:

3.0.2

setCustomTypeFilter

public void setCustomTypeFilter(java.lang.String customType)

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

hasNext

public boolean hasNext()

Checks if there is a next page.

Returns:

true 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

next

public void next(OpenChannelListQuery.OpenChannelListQueryResultHandler handler)

Gets the list of OpenChannels. 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 OpenChannel 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.