SBDOpenChannelListQuery Class Reference

#include <SBDOpenChannelListQuery.h>

Public Member Functions
void	SetChannelUrlFilter (const std::wstring &channel_url)
void	SetChannelNameFilter (const std::wstring &channel_name)
void	SetCustomTypeFilter (const std::wstring &custom_type)
void	LoadNextPage (std::function< void(std::vector< SBDOpenChannel * > channels, SBDError *)> completion_handler)

Public Attributes
int64_t	limit
bool	has_next
bool	is_loading

Detailed Description

The SBDOpenChannelListQuery class is a query class for getting the list of open channels. The instance of this class is created by [CreateOpenChannelListQuery()]() in SBDOpenChannel class.

Member Function Documentation

LoadNextPage()

void SBDOpenChannelListQuery::LoadNextPage

(

std::function< void(std::vector< SBDOpenChannel * > channels, SBDError *)>

completion_handler

)

Gets the list of channels. If this method is repeatedly called, it will retrieve the following pages of the channel list.

Parameters

completion_handler

The handler interface to execute.

SetChannelNameFilter()

void SBDOpenChannelListQuery::SetChannelNameFilter

(

const std::wstring &

channel_name

)

Sets the channel name filter.

Parameters

channel_name

The channel name to search.

SetChannelUrlFilter()

void SBDOpenChannelListQuery::SetChannelUrlFilter

(

const std::wstring &

channel_url

)

Sets the channel URL filter.

Parameters

channel_url

The channel url to search.

SetCustomTypeFilter()

void SBDOpenChannelListQuery::SetCustomTypeFilter

(

const std::wstring &

custom_type

)

Sets the custom type filter.

Parameters

custom_type

The custom type to search.

Member Data Documentation

has_next

bool SBDOpenChannelListQuery::has_next

Shows if there is a next page.

is_loading

bool SBDOpenChannelListQuery::is_loading

Shows if the query is loading.

limit

int64_t SBDOpenChannelListQuery::limit

Sets the number of channels per page.