Class TdApi.SearchChatMessages
java.lang.Object
dev.voroby.springframework.telegram.client.TdApi.Object
dev.voroby.springframework.telegram.client.TdApi.Function<TdApi.FoundChatMessages>
dev.voroby.springframework.telegram.client.TdApi.SearchChatMessages
- Enclosing class:
- TdApi
Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing messageId. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, senderId, filter and messageThreadId search criteria is expected to be supported, only if it is required for Telegram official application implementation.
Returns FoundChatMessages
-
Field Summary
Modifier and TypeFieldDescriptionlong
Identifier of the chat in which to search messages.static final int
Identifier uniquely determining type of the object.Additional filter for messages to search; pass null to search for all messages.long
Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.int
The maximum number of messages to be returned; must be positive and can't be greater than 100.long
If not 0, only messages in the specified thread will be returned; supergroups only.int
Specify 0 to get results from exactly the message fromMessageId or a negative offset to get the specified message and some newer messages.Query to search for.long
If not 0, only messages in the specified Saved Messages topic will be returned; pass 0 to return all messages, or for chats other than Saved Messages.Identifier of the sender of messages to search for; pass null to search for messages from any sender. -
Constructor Summary
ConstructorDescriptionDefault constructor for a function, which searches for messages with given words in the chat.SearchChatMessages
(long chatId, String query, TdApi.MessageSender senderId, long fromMessageId, int offset, int limit, TdApi.SearchMessagesFilter filter, long messageThreadId, long savedMessagesTopicId) Creates a function, which searches for messages with given words in the chat. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns an identifier uniquely determining type of the object.Methods inherited from class dev.voroby.springframework.telegram.client.TdApi.Function
toString
-
Field Details
-
chatId
public long chatIdIdentifier of the chat in which to search messages. -
query
Query to search for. -
senderId
Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats. -
fromMessageId
public long fromMessageIdIdentifier of the message starting from which history must be fetched; use 0 to get results from the last message. -
offset
public int offsetSpecify 0 to get results from exactly the message fromMessageId or a negative offset to get the specified message and some newer messages. -
limit
public int limitThe maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. 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. -
messageThreadId
public long messageThreadIdIf not 0, only messages in the specified thread will be returned; supergroups only. -
savedMessagesTopicId
public long savedMessagesTopicIdIf not 0, only messages in the specified Saved Messages topic will be returned; pass 0 to return all messages, or for chats other than Saved Messages. -
CONSTRUCTOR
public static final int CONSTRUCTORIdentifier uniquely determining type of the object.- See Also:
-
-
Constructor Details
-
SearchChatMessages
public SearchChatMessages()Default constructor for a function, which searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing messageId. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, senderId, filter and messageThreadId search criteria is expected to be supported, only if it is required for Telegram official application implementation.Returns
FoundChatMessages
-
SearchChatMessages
public SearchChatMessages(long chatId, String query, TdApi.MessageSender senderId, long fromMessageId, int offset, int limit, TdApi.SearchMessagesFilter filter, long messageThreadId, long savedMessagesTopicId) Creates a function, which searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing messageId. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit. A combination of query, senderId, filter and messageThreadId search criteria is expected to be supported, only if it is required for Telegram official application implementation.Returns
FoundChatMessages
- Parameters:
chatId
- Identifier of the chat in which to search messages.query
- Query to search for.senderId
- Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats.fromMessageId
- Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.offset
- Specify 0 to get results from exactly the message fromMessageId or a negative offset to get the specified message and some newer messages.limit
- The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. 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.messageThreadId
- If not 0, only messages in the specified thread will be returned; supergroups only.savedMessagesTopicId
- If not 0, only messages in the specified Saved Messages topic will be returned; pass 0 to return all messages, or for chats other than Saved Messages.
-
-
Method Details
-
getConstructor
public int getConstructor()Description copied from class:TdApi.Object
Returns an identifier uniquely determining type of the object.- Specified by:
getConstructor
in classTdApi.Object
- Returns:
- this.CONSTRUCTOR
-