SbPreviousMessageListQuery

A class representing query to retrieve previous message list for channels. More...

Public Member Functions
void	LoadNextPage (SbMessageListHandler inCompletionHandler)
	Requests query result for the previous messages. The queried result is passed to handler as list. More...

Properties
bool	Reverse [get]
	Indicates whether the queried result will be reversed. If true, the result will be returned by creation time descending order. More...
SbMessageTypeFilter	MessageTypeFilter [get]
	Message type filter. SbMessageTypeFilter More...
IReadOnlyList< string >	CustomTypesFilter [get]
	The custom type filter of the message. More...
IReadOnlyList< string >	SenderUserIdsFilter [get]
	Sender user ids filter. More...
bool	IncludeMetaArray [get]
	Whether the meta arrays should be included in the results. More...
bool	IncludeReactions [get]
	Whether the reaction data should be included in the results. More...
bool	IncludeThreadInfo [get]
	Whether the thread information should be included in the results. More...
bool	IncludeParentMessageInfo [get]
	Whether the information of a parent message should be included in the reply messages included in the results. More...
SbReplyType	ReplyType [get]
	Determines the reply types to include in the results. More...
bool	ShowSubChannelMessagesOnly [get]
	If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel. More...
int	Limit [get]
	The maximum number of messages per queried page. More...
bool	HasNext [get]
	Whether there is more page to load. More...
bool	IsLoading [get]
	Whether the current query is in communication progress with server. More...

Detailed Description

A class representing query to retrieve previous message list for channels.

Since

4.0.0

Member Function Documentation

LoadNextPage()

void LoadNextPage

(

SbMessageListHandler

inCompletionHandler

)

Requests query result for the previous messages. The queried result is passed to handler as list.

Parameters

inCompletionHandler

Since

4.0.0

Property Documentation

CustomTypesFilter

IReadOnlyList<string> CustomTypesFilter

get

The custom type filter of the message.

Since

4.0.0

HasNext

bool HasNext

get

Whether there is more page to load.

Since

4.0.0

IncludeMetaArray

bool IncludeMetaArray

get

Whether the meta arrays should be included in the results.

Since

4.0.0

IncludeParentMessageInfo

bool IncludeParentMessageInfo

get

Whether the information of a parent message should be included in the reply messages included in the results.

Since

4.0.0

IncludeReactions

bool IncludeReactions

get

Whether the reaction data should be included in the results.

Since

4.0.0

IncludeThreadInfo

bool IncludeThreadInfo

get

Whether the thread information should be included in the results.

Since

4.0.0

IsLoading

bool IsLoading

get

Whether the current query is in communication progress with server.

Since

4.0.0

Limit

int Limit

get

The maximum number of messages per queried page.

Since

4.0.0

MessageTypeFilter

SbMessageTypeFilter MessageTypeFilter

get

Message type filter. SbMessageTypeFilter

Since

4.0.0

ReplyType

SbReplyType ReplyType

get

Determines the reply types to include in the results.

Since

4.0.0

Reverse

bool Reverse

get

Indicates whether the queried result will be reversed. If true, the result will be returned by creation time descending order.

Since

4.0.0

SenderUserIdsFilter

IReadOnlyList<string> SenderUserIdsFilter

get

Sender user ids filter.

Since

4.0.0

ShowSubChannelMessagesOnly

bool ShowSubChannelMessagesOnly

get

If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.

Since

4.0.0