aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/capabilities.h
blob: 39e2f4d182ac1a959de4229a85dfe4d99c5e1be0 (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

#include <QtCore/QJsonObject>
#include "converters.h"
#include <QtCore/QHash>

namespace QMatrixClient
{
    // Operations

    /// Gets information about the server's capabilities.
    ///
    /// Gets information about the server's supported feature set
    /// and other relevant capabilities.
    class GetCapabilitiesJob : public BaseJob
    {
        public:
            // Inner data structures

            /// Capability to indicate if the user can change their password.
            struct ChangePasswordCapability
            {
                /// True if the user can change their password, false otherwise.
                bool enabled;
            };

            /// The room versions the server supports.
            struct RoomVersionsCapability
            {
                /// The default room version the server is using for new rooms.
                QString defaultVersion;
                /// A detailed description of the room versions the server supports.
                QHash<QString, QString> available;
            };

            /// Gets information about the server's supported feature set
            /// and other relevant capabilities.
            struct Capabilities
            {
                /// Capability to indicate if the user can change their password.
                Omittable<ChangePasswordCapability> changePassword;
                /// The room versions the server supports.
                Omittable<RoomVersionsCapability> roomVersions;
                /// The custom capabilities the server supports, using the
                /// Java package naming convention.
                QHash<QString, QJsonObject> additionalProperties;
            };

            // Construction/destruction

            explicit GetCapabilitiesJob();

            /*! Construct a URL without creating a full-fledged job object
             *
             * This function can be used when a URL for
             * GetCapabilitiesJob is necessary but the job
             * itself isn't.
             */
            static QUrl makeRequestUrl(QUrl baseUrl);

            ~GetCapabilitiesJob() override;

            // Result properties

            /// Gets information about the server's supported feature set
            /// and other relevant capabilities.
            const Capabilities& capabilities() const;

        protected:
            Status parseJson(const QJsonDocument& data) override;

        private:
            class Private;
            QScopedPointer<Private> d;
    };
} // namespace QMatrixClient