Package org.drinkless.tdlib

Class TdApi.SearchMessages

java.lang.Object

org.drinkless.tdlib.TdApi.Object

org.drinkless.tdlib.TdApi.Function

org.drinkless.tdlib.TdApi.SearchMessages

Enclosing class:

TdApi

public static class TdApi.SearchMessages
extends TdApi.Function

Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chatId, messageId)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Returns Messages

Field Summary

Fields

Modifier and Type	Field	Description
TdApi.ChatList	chatList	Chat list in which to search messages; pass null to search in all chats regardless of their chat list.
static int	CONSTRUCTOR	Identifier uniquely determining type of the object.
TdApi.SearchMessagesFilter	filter	Additional filter for messages to search; pass null to search for all messages.
int	limit	The maximum number of messages to be returned; up to 100.
int	maxDate	If not 0, the maximum date of the messages to return.
int	minDate	If not 0, the minimum date of the messages to return.
long	offsetChatId	The chat identifier of the last found message, or 0 for the first request.
int	offsetDate	The date of the message starting from which the results need to be fetched.
long	offsetMessageId	The message identifier of the last found message, or 0 for the first request.
String	query	Query to search for.

Constructor Summary

Constructors

Constructor	Description
SearchMessages()	Default constructor for a function, which searches for messages in all chats except secret chats.
SearchMessages(TdApi.ChatList chatList, String query, int offsetDate, long offsetChatId, long offsetMessageId, int limit, TdApi.SearchMessagesFilter filter, int minDate, int maxDate)	Creates a function, which searches for messages in all chats except secret chats.

Method Summary

Modifier and Type	Method	Description
int	getConstructor()

Methods inherited from class org.drinkless.tdlib.TdApi.Function

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

chatList

public TdApi.ChatList chatList

Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported.

query

public String query

Query to search for.

offsetDate

public int offsetDate

The date of the message starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last message.

offsetChatId

public long offsetChatId

The chat identifier of the last found message, or 0 for the first request.

offsetMessageId

public long offsetMessageId

The message identifier of the last found message, or 0 for the first request.

limit

public int limit

The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

filter

public TdApi.SearchMessagesFilter filter

Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterFailedToSend and searchMessagesFilterPinned are unsupported in this function.

minDate

public int minDate

If not 0, the minimum date of the messages to return.

maxDate

public int maxDate

If not 0, the maximum date of the messages to return.

CONSTRUCTOR

public static final int CONSTRUCTOR

Identifier uniquely determining type of the object.

See Also:

Constant Field Values

Constructor Detail

SearchMessages

public SearchMessages()

Default constructor for a function, which searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chatId, messageId)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Returns Messages

SearchMessages

public SearchMessages(TdApi.ChatList chatList,
                      String query,
                      int offsetDate,
                      long offsetChatId,
                      long offsetMessageId,
                      int limit,
                      TdApi.SearchMessagesFilter filter,
                      int minDate,
                      int maxDate)

Creates a function, which searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chatId, messageId)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

Returns Messages

Parameters:

chatList - Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported.

query - Query to search for.

offsetDate - The date of the message starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last message.

offsetChatId - The chat identifier of the last found message, or 0 for the first request.

offsetMessageId - The message identifier of the last found message, or 0 for the first request.

limit - The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.

filter - Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterFailedToSend and searchMessagesFilterPinned are unsupported in this function.

minDate - If not 0, the minimum date of the messages to return.

maxDate - If not 0, the maximum date of the messages to return.

Method Detail

getConstructor

public int getConstructor()

Specified by:

getConstructor in class TdApi.Object

Returns:

this.CONSTRUCTOR