com.sendbird.android

Class FriendListQuery

java.lang.Object

com.sendbird.android.FriendListQuery

public final class FriendListQuery
extends java.lang.Object

A class representing query to retrieve lists related to friend.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FriendListQuery.FriendListQueryResultHandler FriendListQueryResult handler.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Checks if there is a next page.
boolean	isLoading() Checks if the current query is in communication progress with server.
void	next(FriendListQuery.FriendListQueryResultHandler handler) Gets the list of friends.
void	setLimit(int limit) Sets the maximum number of friends per queried page.

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 friends per queried page.

Parameters:

limit - The maximum number of friends per page.

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.

next

public void next(FriendListQuery.FriendListQueryResultHandler handler)

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