Module tdlight.api

Class TdApi.SearchChatMessages

Enclosing class:
TdApi

public static final class TdApi.SearchChatMessages extends TdApi.Function<TdApi.FoundChatMessages>
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 Details

    • chatId

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

      public String query
      Query to search for.
    • senderId

      public TdApi.MessageSender 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 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. 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 messageThreadId
      If not 0, only messages in the specified thread will be returned; supergroups only.
    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      See Also:
  • 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 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)
      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 - long Identifier of the chat in which to search messages.
      query - String Query to search for.
      senderId - MessageSender Identifier of the sender of messages to search for; pass null to search for messages from any sender. 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. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit.
      filter - SearchMessagesFilter Additional filter for messages to search; pass null to search for all messages.
      messageThreadId - long If not 0, only messages in the specified thread will be returned; supergroups only.
    • SearchChatMessages

      public SearchChatMessages(DataInput input) throws IOException
      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
      Throws:
      IOException
  • Method Details