Sendbird Chat SDK for .NET  3.0.29
SendBird.PreviousMessageListQuery Class Reference

Public Member Functions

bool HasMore ()
 
bool IsLoading ()
 
void SetLimit (int limit)
 
void SetReverse (bool reverse)
 
void SetMessageTypeFilter (BaseChannel.MessageTypeFilter messageType)
 
void SetCustomTypeFilter (string customType)
 
void SetSenderUserIdsFilter (List< string > senderUserIds)
 
void SetIncludeMetaArray (bool includeMetaArray)
 
void SetIncludeReactions (bool includeReactions)
 
void SetIncludeThreadInfo (bool includeThreadInfo)
 
void SetIncludeReplies (bool includeReplies)
 
void SetIncludeParentMessageText (bool includeParentMessageText)
 
void Load (MessageListQueryResult handler)
 
void Load (int limit, bool reverse, MessageListQueryResult handler)
 
delegate void MessageListQueryResult (List< BaseMessage > queryResult, SendBirdException e)
 

Properties

BaseChannel Channel [get]
 
long MessageTimestamp [get]
 
int Limit [get]
 
bool ShouldReverse [get]
 
BaseChannel.MessageTypeFilter MessageTypeFilter [get]
 
string CustomTypeFilter [get]
 
List< string > SenderUserIdsFilter [get]
 
bool ShouldIncludeMetaArray [get]
 
bool ShouldIncludeReactions [get]
 
bool IsIncludeThreadInfo [get]
 
bool ShouldIncludeReplies [get]
 
bool ShouldIncludeParentMessageText [get]
 

Detailed Description

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

Currently, 1 kind of message list can be queried.

Member Function Documentation

◆ HasMore()

bool SendBird.PreviousMessageListQuery.HasMore ( )
inline

Checks if there are more previous messages.

Returns
true if there are more previous messages.

◆ IsLoading()

bool SendBird.PreviousMessageListQuery.IsLoading ( )
inline

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

Returns
true if the current query is not finished.

◆ Load() [1/2]

void SendBird.PreviousMessageListQuery.Load ( int  limit,
bool  reverse,
MessageListQueryResult  handler 
)
inline

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

Parameters
limitMaximum number of previous messages to load.
reverseIf true the queried result will be returned by creation time descending order.
handlerCallback handler.

◆ Load() [2/2]

void SendBird.PreviousMessageListQuery.Load ( MessageListQueryResult  handler)
inline

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

Parameters
handlerCallback handler.
Since
3.0.66

◆ MessageListQueryResult()

delegate void SendBird.PreviousMessageListQuery.MessageListQueryResult ( List< BaseMessage queryResult,
SendBirdException  e 
)

MessageListQueryResult handler. This provides callback for load(int, bool, MessageListQueryResult).

◆ SetCustomTypeFilter()

void SendBird.PreviousMessageListQuery.SetCustomTypeFilter ( string  customType)
inline

Sets custom type filter.

Parameters
customTypeCustom type.
Since
3.0.18

◆ SetIncludeMetaArray()

void SendBird.PreviousMessageListQuery.SetIncludeMetaArray ( bool  includeMetaArray)
inline

Sets message meta array.

Parameters
includeMetaArrayIf true the queried result will be returned with message meta array.
Since
3.0.18

◆ SetIncludeParentMessageText()

void SendBird.PreviousMessageListQuery.SetIncludeParentMessageText ( bool  includeParentMessageText)
inline

Determines whether to include the parent message text in the results when the updated messages are replies in a thread. If the type of the parent message is UserMessage, the value is a BaseMessage#getMessage() of the parent message. If it is FileMessage, the value is the name of the uploaded file.

Parameters
includeParentMessageTextIf true the queried result will be returned with parent message's text for reply messages. PreviousMessageListQuery#setIncludeReplies(bool) must be set to true.
Since
3.0.18

◆ SetIncludeReactions()

void SendBird.PreviousMessageListQuery.SetIncludeReactions ( bool  includeReactions)
inline

Sets message reactions.

Parameters
includeReactionsIf true the queried result will be returned with message reactions.
Since
3.0.18

◆ SetIncludeReplies()

void SendBird.PreviousMessageListQuery.SetIncludeReplies ( bool  includeReplies)
inline

Determines whether replies are included in the results.

Parameters
includeRepliesIf true the queried result will be returned with reply messages as well.
Since
3.0.18

◆ SetIncludeThreadInfo()

void SendBird.PreviousMessageListQuery.SetIncludeThreadInfo ( bool  includeThreadInfo)
inline

Determines whether to include the thread information of the returned messages in the results when the results contain parent messages.

Parameters
includeThreadInfoIf true the queried result will be returned with thread information.
Since
3.0.18

◆ SetLimit()

void SendBird.PreviousMessageListQuery.SetLimit ( int  limit)
inline

Sets the maximum number of messages per queried page.

Parameters
limitThe maximum number of messages per page.
Since
3.0.18

◆ SetMessageTypeFilter()

void SendBird.PreviousMessageListQuery.SetMessageTypeFilter ( BaseChannel.MessageTypeFilter  messageType)
inline

Sets message type filter.

Parameters
messageTypeMessage type. Refer to com.sendbird.android.BaseChannel.MessageTypeFilter.
Since
3.0.18

◆ SetReverse()

void SendBird.PreviousMessageListQuery.SetReverse ( bool  reverse)
inline

Sets reverse.

Parameters
reverseIf true the queried result will be returned by creation time descending order.
Since
3.0.18

◆ SetSenderUserIdsFilter()

void SendBird.PreviousMessageListQuery.SetSenderUserIdsFilter ( List< string >  senderUserIds)
inline

Sets sender user ids filter.

Parameters
senderUserIdsSender user IDs.
Since
3.0.18

Property Documentation

◆ Channel

BaseChannel SendBird.PreviousMessageListQuery.Channel
get

Current channel.

Returns
a current group channel.
Since
3.0.18

◆ CustomTypeFilter

string SendBird.PreviousMessageListQuery.CustomTypeFilter
get

Returns the custom type filter of message.

Returns
Custom type filter of message.
Since
3.0.18

◆ IsIncludeThreadInfo

bool SendBird.PreviousMessageListQuery.IsIncludeThreadInfo
get

Returns whether to include the thread information of the returned messages in the results when the results contain parent messages.

Returns
Whether to include the thread information of the returned messages in the results when the results contain parent messages.
Since
3.0.18

◆ Limit

int SendBird.PreviousMessageListQuery.Limit
get

Returns the maximum number of messages per page.

Returns
the number of messages per page.
Since
3.0.18

◆ MessageTimestamp

long SendBird.PreviousMessageListQuery.MessageTimestamp
get

Returns the time of a request.

Returns
Timestamp in milliseconds.
Since
3.0.18

◆ MessageTypeFilter

BaseChannel.MessageTypeFilter SendBird.PreviousMessageListQuery.MessageTypeFilter
get

◆ SenderUserIdsFilter

List<string> SendBird.PreviousMessageListQuery.SenderUserIdsFilter
get

Returns the sender user ids filter.

Returns
The sender user ids filter.
Since
3.0.18

◆ ShouldIncludeMetaArray

bool SendBird.PreviousMessageListQuery.ShouldIncludeMetaArray
get

Returns whether the meta array should be included in the results.

Returns
Whether the meta array should be included in the results.
Since
3.0.18

◆ ShouldIncludeParentMessageText

bool SendBird.PreviousMessageListQuery.ShouldIncludeParentMessageText
get

Returns whether the text of a parent message should be included in the reply messages included in the results.

Returns
Whether the text of a parent message should be included in the reply messages included in the results.
Since
3.0.18

◆ ShouldIncludeReactions

bool SendBird.PreviousMessageListQuery.ShouldIncludeReactions
get

Returns whether the reaction data should be included in the results.

Returns
Whether the reaction data should be included in the results.
Since
3.0.18

◆ ShouldIncludeReplies

bool SendBird.PreviousMessageListQuery.ShouldIncludeReplies
get

Returns whether the replies should be included in the results.

Returns
Whether the replies should be included in the results.
Since
3.0.18

◆ ShouldReverse

bool SendBird.PreviousMessageListQuery.ShouldReverse
get

Returns whether the results should be reversed.

Returns
Whether the results should be reversed.
Since
3.0.18

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