Methods

api.searchChatMessages()

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

Parameters SearchChatMessagesParams:

Parameters

Interface

Name	Type	Description
`chatId`	`number`	Identifier of the chat in which to search messages
`query`	`string`	Query to search for
`senderId`	MessageSenderInputUnion	Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats
`fromMessageId`	`number`	Identifier of the message starting from which history must be fetched; use 0 to get results from the last message
`offset`	`number`	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`	`number`	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`	SearchMessagesFilterInputUnion	Additional filter for messages to search; pass null to search for all messages
`messageThreadId`	`number`	If not 0, only messages in the specified thread will be returned; supergroups only

Returns ApiResponse interface:

interface ApiResponse {
  _: 'searchChatMessages' | 'error'
  airgram: Airgram
  request: {
    method: 'searchChatMessages'
    params: SearchChatMessagesParams
  }
  response: MessagesUnion
 | Error
  setState: (nextState: Record<string, unknown>) => void
  getState: () => Record<string, unknown>
}