get_search_results_calendar()

async Client.get_search_results_calendar()

Get a calendar view of search results.

Usable by Users Bots
Parameters:
  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • filter (MessagesFilter) – The filter to search with (e.g., photos, videos).

  • offset_id (int, optional) – Only return messages starting from the specified id.

  • offset_date (int, optional) – Only return messages sent before the specified date.

  • saved_peer_id (int | str, optional) – Peer for saved messages context.

Returns:

SearchResultsCalendar – The calendar of search results.

Example

calendar = await app.get_search_results_calendar(
    chat_id, raw.types.InputMessagesFilterPhotos()
)