aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/definitions/public_rooms_response.h
blob: 6d8caf9894f3e69c23f7830bc94a53c1b01de9a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "converters.h"

#include "converters.h"
#include <QtCore/QVector>

namespace QMatrixClient {
    // Data structures

    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 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> {
        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 {
        /// A paginated chunk of public rooms.
        QVector<PublicRoomsChunk> chunk;
        /// 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. 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 the
        /// server has an estimate.
        Omittable<int> totalRoomCountEstimate;
    };
    template <> struct JsonObjectConverter<PublicRoomsResponse> {
        static void dumpTo(QJsonObject& jo, const PublicRoomsResponse& pod);
        static void fillFrom(const QJsonObject& jo, PublicRoomsResponse& pod);
    };

} // namespace QMatrixClient