#include <message_pagination.h>

Public Attributes
QString	begin {}

QString	end {}

RoomEvents	chunk {}

RoomEvents	state {}

Detailed Description

Definition at line 98 of file message_pagination.h.

Member Data Documentation

◆ begin

QString Quotient::GetRoomEventsJob::Response::begin {}

A token corresponding to the start of chunk. This will be the same as the value given in from.

Definition at line 101 of file message_pagination.h.

◆ chunk

RoomEvents Quotient::GetRoomEventsJob::Response::chunk {}

A list of room events. The order depends on the dir parameter. For dir=b events will be in reverse-chronological order, for dir=f in chronological order. (The exact definition of chronological is dependent on the server implementation.)

Note that an empty chunk does not necessarily imply that no more events are available. Clients should continue to paginate until no end property is returned.

Definition at line 120 of file message_pagination.h.

◆ end

QString Quotient::GetRoomEventsJob::Response::end {}

A token corresponding to the end of chunk. This token can be passed back to this endpoint to request further events.

If no further events are available (either because we have reached the start of the timeline, or because the user does not have permission to see any more events), this property is omitted from the response.

Definition at line 110 of file message_pagination.h.

◆ state

RoomEvents Quotient::GetRoomEventsJob::Response::state {}

A list of state events relevant to showing the chunk. For example, if lazy_load_members is enabled in the filter then this may contain the membership events for the senders of events in the chunk.

Unless include_redundant_members is true, the server may remove membership events which would have already been sent to the client in prior calls to this endpoint, assuming the membership of those members has not changed.

Definition at line 130 of file message_pagination.h.

The documentation for this struct was generated from the following file: