A class representing query to retrieve list of SbBaseMessages that matches a given query with given filters. More...

Public Member Functions
void	LoadNextPage (SbMessageListHandler inCompletionHandler)
	Gets the list of SbBaseMessages that matches the given search. The queried result is passed to handler as list. If this method is repeatedly called after each LoadNextPage() is finished, it retrieves the following search results as SbBaseMessage list. More...

Properties
string	Keyword `[get]`
	The current search keyword. More...

bool	Reverse `[get]`
	Whether the current search result is set to be reversed or not. More...

string	ChannelCustomType `[get]`
	The current custom type of channel set as the search scope. More...

bool	ExactMatch `[get]`
	Whether the current search query should be an exact match or not. More...

long	MessageTimestampFrom `[get]`
	The start message timestamp set as the search range. More...

long	MessageTimestampTo `[get]`
	The end message timestamp set as the search range. More...

SbMessageSearchQueryOrder	Order `[get]`
	The current order method. More...

bool	IsAdvancedQuery `[get]`
	Whether the current search query should be an advanced query or not. More...

IReadOnlyList< string >	TargetFields `[get]`
	The target fields of the current query as the search scope. More...

int	TotalCount `[get]`
	The total count of results that matches the given search. More...

int	Limit `[get]`
	The maximum number of BaseMessages per single query. More...

bool	HasNext `[get]`
	Whether there is a next page. More...

bool	IsLoading `[get]`
	Whether the current query is in communication progress with server. More...

Detailed Description

A class representing query to retrieve list of SbBaseMessages that matches a given query with given filters.

Since: 4.0.0

Member Function Documentation

◆ LoadNextPage()

void LoadNextPage ( SbMessageListHandler inCompletionHandler )

Gets the list of SbBaseMessages that matches the given search. The queried result is passed to handler as list. If this method is repeatedly called after each LoadNextPage() is finished, it retrieves the following search results as SbBaseMessage list.

Parameters

inCompletionHandler

Property Documentation

◆ ChannelCustomType

string ChannelCustomType

get

The current custom type of channel set as the search scope.

Since: 4.0.0

◆ ExactMatch

bool ExactMatch

get

Whether the current search query should be an exact match or not.

Since: 4.0.0

◆ HasNext

bool HasNext

get

Whether there is a next page.

Since: 4.0.0

◆ IsAdvancedQuery

bool IsAdvancedQuery

get

Whether the current search query should be an advanced query or not.

Since: 4.0.0

◆ IsLoading

bool IsLoading

get

Whether the current query is in communication progress with server.

Since: 4.0.0

◆ Keyword

string Keyword

get

The current search keyword.

Since: 4.0.0

◆ Limit

int Limit

get

The maximum number of BaseMessages per single query.

Since: 4.0.0

◆ MessageTimestampFrom

long MessageTimestampFrom

get

The start message timestamp set as the search range.

Since: 4.0.0

◆ MessageTimestampTo

long MessageTimestampTo

get

The end message timestamp set as the search range.

Since: 4.0.0

◆ Order

SbMessageSearchQueryOrder Order

get

The current order method.

Since: 4.0.0

◆ Reverse

bool Reverse

get

Whether the current search result is set to be reversed or not.

Since: 4.0.0

◆ TargetFields

IReadOnlyList<string> TargetFields

get

The target fields of the current query as the search scope.

Since: 4.0.0

◆ TotalCount

int TotalCount

get

The total count of results that matches the given search.

Since: 4.0.0

Public Member Functions

Properties