Link Search Menu Expand Document

Constructor: searchResultsCalendarPeriod

Back to constructors index

Information about found messages sent on a specific day, used to split the messages in messages.searchResultsCalendar constructors by days.

Multiple searchResultsCalendarPeriod constructors are returned in messages.searchResultsCalendar, each containing information about the first, last and total number of messages matching the filter that were sent on a specific day.

Attributes:

NameTypeRequiredDescription
dateintYesThe day this object is referring to.
min_msg_idintYesFirst message ID that was sent on this day.
max_msg_idintYesLast message ID that was sent on this day.
countintYesAll messages that were sent on this day.

Type: SearchResultsCalendarPeriod

Example:

$searchResultsCalendarPeriod = ['_' => 'searchResultsCalendarPeriod', 'date' => int, 'min_msg_id' => int, 'max_msg_id' => int, 'count' => int];