search chat messages

libtd-ktx / kotlinx.telegram.coroutines / searchChatMessages

searchChatMessages

suspend fun TelegramFlow.searchChatMessages(chatId: Long, query: String?, senderUserId: Int, fromMessageId: Long, offset: Int, limit: Int, filter: SearchMessagesFilter?): Messages

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

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

Return Messages Contains a list of messages.