Class TdApi.SearchChatMessages

Enclosing class:
TdApi

public static class TdApi.SearchChatMessages
extends TdApi.Function
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 should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library.

Returns Messages

  • Field Details

    • chatId

      public long chatId
      Identifier of the chat in which to search messages.
    • query

      public String query
      Query to search for.
    • sender

      public TdApi.MessageSender sender
      If not null, only messages sent by the specified sender will be returned. Not supported in secret chats.
    • fromMessageId

      public long fromMessageId
      Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.
    • offset

      public int offset
      Specify 0 to get results from exactly the fromMessageId or a negative offset to get the specified message and some newer messages.
    • limit

      public int 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. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.
    • filter

      Filter for message content in the search results.
    • messageThreadId

      public long messageThreadId
      If not 0, only messages in the specified thread will be returned; supergroups only.
    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      See Also:
      Constant Field Values
  • Constructor Details

    • SearchChatMessages

      public SearchChatMessages()
      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 should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library.

      Returns Messages

    • SearchChatMessages

      public SearchChatMessages​(long chatId, String query, TdApi.MessageSender sender, long fromMessageId, int offset, int limit, TdApi.SearchMessagesFilter filter, long messageThreadId)
      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 should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library.

      Returns Messages

      Parameters:
      chatId - long Identifier of the chat in which to search messages.
      query - String Query to search for.
      sender - MessageSender If not null, only messages sent by the specified sender will be returned. Not supported in secret chats.
      fromMessageId - long Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.
      offset - int Specify 0 to get results from exactly the fromMessageId or a negative offset to get the specified message and some newer messages.
      limit - int 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. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.
      filter - SearchMessagesFilter Filter for message content in the search results.
      messageThreadId - long If not 0, only messages in the specified thread will be returned; supergroups only.
    • SearchChatMessages

      public SearchChatMessages​(DataInput input) throws IOException
      Throws:
      IOException
  • Method Details