aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/versions.h
blob: 3303752d37122056a3a9e68e84cfede16e56689a (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
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"


namespace QMatrixClient
{
    // Operations

    /// Gets the versions of the specification supported by the server.
    /// 
    /// Gets the versions of the specification supported by the server.
    /// 
    /// Values will take the form ``rX.Y.Z``.
    /// 
    /// Only the latest ``Z`` value will be reported for each supported ``X.Y`` value.
    /// i.e. if the server implements ``r0.0.0``, ``r0.0.1``, and ``r1.2.0``, it will report ``r0.0.1`` and ``r1.2.0``.
    class GetVersionsJob : public BaseJob
    {
        public:
            explicit GetVersionsJob();

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

            ~GetVersionsJob() override;

            // Result properties

            /// The supported versions.
            const QStringList& versions() const;

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

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