mirror of
https://github.com/danog/MadelineProtoDocs.git
synced 2024-12-03 10:08:28 +01:00
2.4 KiB
2.4 KiB
title | description | nav_exclude | image | redirect_from |
---|---|---|---|---|
messages.searchResultsCalendar | Information about found messages sent on a specific day | true | https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png | /API_docs/constructors/messages_searchResultsCalendar.html |
Constructor: messages.searchResultsCalendar
Information about found messages sent on a specific day
Attributes:
Name | Type | Required | Description |
---|---|---|---|
inexact | Bool | Optional | If set, indicates that the results may be inexact |
count | int | Yes | Total number of results matching query |
min_date | int | Yes | Starting timestamp of attached messages |
min_msg_id | int | Yes | Ending timestamp of attached messages |
offset_id_offset | int | Optional | Indicates the absolute position of messages[0] within the total result set with count count . This is useful, for example, if we need to display a progress/total counter (like photo 134 of 200 , for all media in a chat, we could simply use photo ${offset_id_offset} of ${count} . |
periods | Array of SearchResultsCalendarPeriod | Yes | Used to split the messages by days: multiple SearchResultsCalendarPeriod constructors are returned, each containing information about the first, last and total number of messages matching the filter that were sent on a specific day. This information can be easily used to split the returned messages by day. |
messages | Array of Message | Yes | Messages |
chats | Array of Chat | Yes | Mentioned chats |
users | Array of User | Yes | Mentioned users |
Type: messages.SearchResultsCalendar
Example:
$messages_searchResultsCalendar = ['_' => 'messages.searchResultsCalendar', 'inexact' => Bool, 'count' => int, 'min_date' => int, 'min_msg_id' => int, 'offset_id_offset' => int, 'periods' => [SearchResultsCalendarPeriod, SearchResultsCalendarPeriod], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]];