Module tdlight.api
Package it.tdlight.jni

Class TdApi.SearchChatMessages

java.lang.Object
it.tdlight.jni.TdApi.Object
it.tdlight.jni.TdApi.Function<TdApi.FoundChatMessages>
it.tdlight.jni.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 Summary

    Fields
    Modifier and Type
    Field
    Description
    long
    chatId
    Identifier of the chat in which to search messages.
    static final 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.
    long
    fromMessageId
    Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.
    int
    limit
    The maximum number of messages to be returned; must be positive and can't be greater than 100.
    long
    messageThreadId
    If not 0, only messages in the specified thread will be returned; supergroups only.
    int
    offset
    Specify 0 to get results from exactly the message fromMessageId or a negative offset to get the specified message and some newer messages.
    String
    query
    Query to search for.
    long
    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.
    TdApi.MessageSender
    senderId
    Identifier of the sender of messages to search for; pass null to search for messages from any sender.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchChatMessages()
    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)
    Searches for messages with given words in the chat.
    SearchChatMessages(DataInput input)
    Searches for messages with given words in the chat.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    int
    getConstructor()
    Returns an identifier uniquely determining type of the object.
    int
    hashCode()
     
    void
    serialize(DataOutput output)
    Serialize the TDLib class

    Methods inherited from class it.tdlight.jni.TdApi.Function

    toString

    Methods inherited from class it.tdlight.jni.TdApi.Object

    serialize

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • 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 message 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

      public TdApi.SearchMessagesFilter 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.

    • savedMessagesTopicId

      public long 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.

    • CONSTRUCTOR

      public static final int CONSTRUCTOR
      Identifier uniquely determining type of the object.
      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, long savedMessagesTopicId)
      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.

      Returns FoundChatMessages

    • 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

      Parameters:
      input - Serialized input
      Throws:
      IOException - the deserialization failed

  • 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 class TdApi.Object
      Returns:
      this.CONSTRUCTOR

    • serialize

      public void serialize(DataOutput output) throws IOException
      Serialize the TDLib class
      Specified by:
      serialize in class TdApi.Object
      Parameters:
      output - output data stream
      Throws:
      IOException - the serialization failed

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object