SearchChatMessages

public struct SearchChatMessages : Codable, Equatable, TDFunction

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

  • Undocumented

    Declaration

    Swift

    public typealias Result = Messages
    Show on GitHub

  • Identifier of the chat in which to search messages

    Declaration

    Swift

    public let chatId: Int53
    Show on GitHub

  • Query to search for

    Declaration

    Swift

    public let query: String
    Show on GitHub

  • If not 0, only messages sent by the specified user will be returned. Not supported in secret chats

    Declaration

    Swift

    public let senderUserId: Int32
    Show on GitHub

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

    Declaration

    Swift

    public let fromMessageId: Int53
    Show on GitHub

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

    Declaration

    Swift

    public let offset: Int32
    Show on GitHub

  • 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

    Declaration

    Swift

    public let limit: Int32
    Show on GitHub

  • Filter for message content in the search results

    Declaration

    Swift

    public let filter: SearchMessagesFilter
    Show on GitHub

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

    Declaration

    Swift

    public init(chatId: Int53, query: String, senderUserId: Int32, fromMessageId: Int53, offset: Int32, limit: Int32, filter: SearchMessagesFilter)

    Parameters

    chatId

    Identifier of the chat in which to search messages
    query

    Query to search for
    senderUserId

    If not 0, only messages sent by the specified user will be returned. 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 from_message_id 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. 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
    Show on GitHub