Link Search Menu Expand Document

Constructor: messages.messagesSlice

Back to constructors index

Incomplete list of messages and auxiliary data.

Attributes:

NameTypeRequiredDescription
inexactBoolOptionalIf set, indicates that the results may be inexact
countintYesTotal number of messages in the list
next_rateintOptionalRate to use in the offset_rate parameter in the next call to messages.searchGlobal
offset_id_offsetintOptionalIndicates the absolute position of messages[0] within the total result set with count count.
This is useful, for example, if the result was fetched using offset_id, and 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}).
search_floodSearchPostsFloodOptionalFor global post searches », the remaining amount of free searches, here query_is_free is related to the current call only, not to the next paginated call, and all subsequent pagination calls will always be free.
messagesArray of MessageYesList of messages
topicsArray of ForumTopicYes
chatsArray of ChatYesList of chats mentioned in messages
usersArray of UserYesList of users mentioned in messages and chats

Type: messages.Messages

Example:

$messages_messagesSlice = ['_' => 'messages.messagesSlice', 'inexact' => Bool, 'count' => int, 'next_rate' => int, 'offset_id_offset' => int, 'search_flood' => SearchPostsFlood, 'messages' => [Message, Message], 'topics' => [ForumTopic, ForumTopic], 'chats' => [Chat, Chat], 'users' => [User, User]];