aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/definitions/public_rooms_response.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/definitions/public_rooms_response.h')
-rw-r--r--lib/csapi/definitions/public_rooms_response.h47
1 files changed, 27 insertions, 20 deletions
diff --git a/lib/csapi/definitions/public_rooms_response.h b/lib/csapi/definitions/public_rooms_response.h
index 1cb3aad5..36aa52b9 100644
--- a/lib/csapi/definitions/public_rooms_response.h
+++ b/lib/csapi/definitions/public_rooms_response.h
@@ -8,61 +8,68 @@
#include <QtCore/QVector>
-namespace Quotient
-{
+namespace Quotient {
// Data structures
-struct PublicRoomsChunk
-{
+struct PublicRoomsChunk {
/// Aliases of the room. May be empty.
QStringList aliases;
+
/// The canonical alias of the room, if any.
QString canonicalAlias;
+
/// The name of the room, if any.
QString name;
+
/// The number of members joined to the room.
int numJoinedMembers;
+
/// The ID of the room.
QString roomId;
+
/// The topic of the room, if any.
QString topic;
+
/// Whether the room may be viewed by guest users without joining.
bool worldReadable;
- /// Whether guest users may join the room and participate in it.If they can,
- /// they will be subject to ordinary power levelrules like any other user.
+
+ /// Whether guest users may join the room and participate in it.
+ /// If they can, they will be subject to ordinary power level
+ /// rules like any other user.
bool guestCanJoin;
+
/// The URL for the room's avatar, if one is set.
QString avatarUrl;
};
template <>
-struct JsonObjectConverter<PublicRoomsChunk>
-{
+struct JsonObjectConverter<PublicRoomsChunk> {
static void dumpTo(QJsonObject& jo, const PublicRoomsChunk& pod);
static void fillFrom(const QJsonObject& jo, PublicRoomsChunk& pod);
};
-
/// A list of the rooms on the server.
-struct PublicRoomsResponse
-{
+struct PublicRoomsResponse {
/// A paginated chunk of public rooms.
QVector<PublicRoomsChunk> chunk;
- /// A pagination token for the response. The absence of this tokenmeans
- /// there are no more results to fetch and the client shouldstop paginating.
+
+ /// A pagination token for the response. The absence of this token
+ /// means there are no more results to fetch and the client should
+ /// stop paginating.
QString nextBatch;
- /// A pagination token that allows fetching previous results. Theabsence of
- /// this token means there are no results before thisbatch, i.e. this is the
- /// first batch.
+
+ /// A pagination token that allows fetching previous results. The
+ /// absence of this token means there are no results before this
+ /// batch, i.e. this is the first batch.
QString prevBatch;
- /// An estimate on the total number of public rooms, if theserver has an
- /// estimate.
+
+ /// An estimate on the total number of public rooms, if the
+ /// server has an estimate.
Omittable<int> totalRoomCountEstimate;
};
template <>
-struct JsonObjectConverter<PublicRoomsResponse>
-{
+struct JsonObjectConverter<PublicRoomsResponse> {
static void dumpTo(QJsonObject& jo, const PublicRoomsResponse& pod);
static void fillFrom(const QJsonObject& jo, PublicRoomsResponse& pod);
};