Link Search Menu Expand Document

Constructor: messages.searchResultsCalendar

Back to constructors index

Information about found messages sent on a specific day

Attributes:

NameTypeRequiredDescription
inexactBoolOptionalIf set, indicates that the results may be inexact
countintYesTotal number of results matching query
min_dateintYesStarting timestamp of attached messages
min_msg_idintYesEnding timestamp of attached messages
offset_id_offsetintOptionalIndicates 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}.
periodsArray of SearchResultsCalendarPeriodYesUsed 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.
messagesArray of MessageYesMessages
chatsArray of ChatYesMentioned chats
usersArray of UserYesMentioned 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]];