SbOpenChannelListQuery

A class representing query to retrieve OpenChannel list. More...

Public Member Functions
void	LoadNextPage (SbOpenChannelListHandler inCompletionHandler)
	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. More...

Properties
string	NameKeyword [get]
	Indicate search keyword for channel name. More...
string	UrlKeyword [get]
	Indicate search keyword for channel URL. More...
string	CustomTypeFilter [get]
	A filter to return only channels with the specified customType. More...
bool	HasNext [get]
	Indicate whether if there is a next page. More...
bool	IsLoading [get]
	Indicate whether if the current query is in communication progress with server. More...
bool	IncludeFrozen [get]
	Indicate whether to include frozen channels or not. More...
bool	IncludeMetadata [get]
	Indicate whether to include channel metadata on fetch. More...
int	Limit [get]
	The maximum number of items per queried page. More...

Detailed Description

A class representing query to retrieve OpenChannel list.

Since

4.0.0

Member Function Documentation

LoadNextPage()

void LoadNextPage

(

SbOpenChannelListHandler

inCompletionHandler

)

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.

Parameters

inCompletionHandler

Since

4.0.0

Property Documentation

CustomTypeFilter

string CustomTypeFilter

get

A filter to return only channels with the specified customType.

Since

4.0.0

HasNext

bool HasNext

get

Indicate whether if there is a next page.

Since

4.0.0

IncludeFrozen

bool IncludeFrozen

get

Indicate whether to include frozen channels or not.

Since

4.0.0

IncludeMetadata

bool IncludeMetadata

get

Indicate whether to include channel metadata on fetch.

Since

4.0.0

IsLoading

bool IsLoading

get

Indicate whether if the current query is in communication progress with server.

Since

4.0.0

Limit

int Limit

get

The maximum number of items per queried page.

Since

4.0.0

NameKeyword

string NameKeyword

get

Indicate search keyword for channel name.

Since

4.0.0

UrlKeyword

string UrlKeyword

get

Indicate search keyword for channel URL.

Since

4.0.0