haskell-tdlib-2.0.63.0
Safe HaskellSafe-Inferred
LanguageGHC2021

TD.Query.SearchChatMessages

Synopsis

Documentation

data SearchChatMessages Source #

Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. 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, sender_id, filter and topic_id search criteria is expected to be supported, only if it is required for Telegram official application implementation. Returns FoundChatMessages

Constructors

SearchChatMessages 

Fields

  • chat_id :: Maybe Int

    Identifier of the chat in which to search messages

  • topic_id :: Maybe MessageTopic

    Pass topic identifier to search messages only in specific topic; pass null to search for messages in all topics

  • query :: Maybe Text

    Query to search for

  • sender_id :: Maybe MessageSender

    Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats

  • from_message_id :: Maybe Int

    Identifier of the message starting from which history must be fetched; use 0 to get results from the last message

  • offset :: Maybe Int

    Specify 0 to get results from exactly the message from_message_id or a negative offset to get the specified message and some newer messages

  • limit :: Maybe 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 :: Maybe SearchMessagesFilter

    Additional filter for messages to search; pass null to search for all messages

Instances

Instances details
ToJSON SearchChatMessages Source # 
Instance details

Defined in TD.Query.SearchChatMessages

Methods

toJSON :: SearchChatMessages -> Value #

toEncoding :: SearchChatMessages -> Encoding #

toJSONList :: [SearchChatMessages] -> Value #

toEncodingList :: [SearchChatMessages] -> Encoding #

Show SearchChatMessages Source # 
Instance details

Defined in TD.Query.SearchChatMessages

Methods

showsPrec :: Int -> SearchChatMessages -> ShowS #

show :: SearchChatMessages -> String #

showList :: [SearchChatMessages] -> ShowS #

Eq SearchChatMessages Source # 
Instance details

Defined in TD.Query.SearchChatMessages

Methods

(==) :: SearchChatMessages -> SearchChatMessages -> Bool #

(/=) :: SearchChatMessages -> SearchChatMessages -> Bool #

ShortShow SearchChatMessages Source # 
Instance details

Defined in TD.Query.SearchChatMessages

Methods

shortShow :: SearchChatMessages -> String Source #

defaultSearchChatMessages :: SearchChatMessages Source #