SendBird.MessageListQuery Class Reference

Public Member Functions
bool	IsLoading ()
void	Next (long messageTimestamp, int limit, bool reverse, MessageListQueryResult handler)
void	Prev (long messageTimestamp, int limit, bool reverse, MessageListQueryResult handler)
void	Load (long messageTimestamp, int prevLimit, int nextLimit, bool reverse, MessageListQueryResult handler)
delegate void	MessageListQueryResult (List< BaseMessage > queryResult, SendBirdException e)

Detailed Description

A class representing query to retrieve message list for channels.

Currently, 1 kind of message list can be queried.

• The list of messages for a channel.

  The query can be get by calling OpenChannel#CreateMessageListQuery() or GroupChannel#CreateMessageListQuery().

Member Function Documentation

IsLoading()

bool SendBird.MessageListQuery.IsLoading ( )

inline

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

Returns

true if the current query is not finished.

Load()

void SendBird.MessageListQuery.Load ( long  messageTimestamp, int  prevLimit, int  nextLimit, bool  reverse, MessageListQueryResult  handler  )

inline

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

Parameters

messageTimestamp	Timestamp. Messages created before, after and at this timestamp will be returned.
prevLimit	Maximum number of previous messages to load.
nextLimit	Maximum number of next messages to load.
reverse	If true the queried result will be returned by creation time descending order.
handler	Callback handler.

MessageListQueryResult()

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

MessageListQueryResult handler. This provides callback for next(long, int, bool, MessageListQueryResult), prev(long, int, bool, MessageListQueryResult) and load(long, int, int, bool, MessageListQueryResult).

Next()

void SendBird.MessageListQuery.Next ( long  messageTimestamp, int  limit, bool  reverse, MessageListQueryResult  handler  )

inline

Requests query result for the next messages from given timestamp. The queried result is passed to handler as list.

Parameters

messageTimestamp	Starting message timestamp to query. Messages created after this timestamp will be returned.
limit	Maximum number of messages to load.
reverse	If true the queried result will be returned by creation time descending order.
handler	Callback handler.

Prev()

void SendBird.MessageListQuery.Prev ( long  messageTimestamp, int  limit, bool  reverse, MessageListQueryResult  handler  )

inline

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

Parameters

messageTimestamp	Starting message timestamp to query. Messages created before this timestamp will be returned.
limit	Maximum number of messages to load.
reverse	If true the queried result will be returned by creation time descending order.
handler	Callback handler.

---

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

• SendBird/src/MessageListQuery.cs