com.sendbird.android

Class OperatorListQuery

java.lang.Object

com.sendbird.android.OperatorListQuery

public final class OperatorListQuery
extends java.lang.Object

A class representing query to retrieve operator lists related to User.

Since:

3.0.57

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OperatorListQuery.OperatorListQueryResultHandler OperatorListQueryResult handler.

Method Summary

Modifier and Type	Method and Description
static OperatorListQuery	create(BaseChannel.ChannelType channelType, java.lang.String channelUrl) Creates a query instance to get the operator list from given channel url.
boolean	hasNext() Checks if there is a next page.
boolean	isLoading() Checks if the current query is in communication progress with server.
void	next(OperatorListQuery.OperatorListQueryResultHandler handler) Gets the list of operators.
void	setLimit(int limit) Sets the maximum number of operators per queried page.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OperatorListQuery create(BaseChannel.ChannelType channelType,
                                       java.lang.String channelUrl)

Creates a query instance to get the operator list from given channel url.

Parameters:

channelType - a type of channel.

channelUrl - an url of channel.

Returns:

Query to use.

Since:

3.1.5

setLimit

public void setLimit(int limit)

Sets the maximum number of operators per queried page.

Parameters:

limit - The maximum number of operators per page.

Since:

3.0.57

hasNext

public boolean hasNext()

Checks if there is a next page.

Returns:

true if there is a next page.

Since:

3.0.57

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.57

next

public void next(OperatorListQuery.OperatorListQueryResultHandler handler)

Gets the list of operators. 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 operator 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.57