SendBird.OpenChannelListQuery Class Reference

Public Member Functions
bool	HasNext ()
bool	IsLoading ()
void	Next (OpenChannelListQueryResultHandler handler)
delegate void	OpenChannelListQueryResultHandler (List< OpenChannel > queryResult, SendBirdException e)

Properties
int	Limit [get, set]
string	NameKeyword [get, set]
string	UrlKeyword [get, set]

Detailed Description

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 SendBirdClient#Init(string) has.

  The query can be get by calling OpenChannel#CreateOpenChannelListQuery().

Member Function Documentation

HasNext()

bool SendBird.OpenChannelListQuery.HasNext ( )

inline

Checks if there is a next page.

Returns

true there is a next page.

IsLoading()

bool SendBird.OpenChannelListQuery.IsLoading ( )

inline

Checks if the current query is in communication progress with server.

Returns

true if the current query is not finished.

Next()

void SendBird.OpenChannelListQuery.Next ( OpenChannelListQueryResultHandler  handler )

inline

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.

OpenChannelListQueryResultHandler()

delegate void SendBird.OpenChannelListQuery.OpenChannelListQueryResultHandler	(	List< OpenChannel >	queryResult,
		SendBirdException	e
	)

OpenChannelListQuery handler. This handler provides callback for next(OpenChannelListQueryResultHandler).

Property Documentation

Limit

int SendBird.OpenChannelListQuery.Limit

getset

Sets the maximum number of OpenChannels per queried page.

Parameters

limit

The maximum number of OpenChannels per page.

NameKeyword

string SendBird.OpenChannelListQuery.NameKeyword

getset

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

Parameters

nameKeyword

Name keyword.

UrlKeyword

string SendBird.OpenChannelListQuery.UrlKeyword

getset

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

Parameters

urlKeyword

URL keyword.

---

The documentation for this class was generated from the following file:

• SendBird/src/OpenChannelListQuery.cs