aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/keys.h
blob: d4b0f62fffd3c4ef78cc329c3abb16c437319c45 (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

#include "csapi/definitions/device_keys.h"
#include <QtCore/QHash>
#include "converters.h"
#include <QtCore/QVariant>
#include <QtCore/QJsonObject>

namespace QMatrixClient
{
    // Operations

    class UploadKeysJob : public BaseJob
    {
        public:
            explicit UploadKeysJob(const Omittable<DeviceKeys>& deviceKeys = none, const QHash<QString, QVariant>& oneTimeKeys = {});
            ~UploadKeysJob() override;

            // Result properties

            const QHash<QString, int>& oneTimeKeyCounts() const;

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

        private:
            class Private;
            QScopedPointer<Private> d;
    };

    class QueryKeysJob : public BaseJob
    {
        public:
            // Inner data structures

            struct UnsignedDeviceInfo
            {
                QString deviceDisplayName;
            };

            struct DeviceInformation : DeviceKeys
            {
                Omittable<UnsignedDeviceInfo> unsignedData;
            };

            // Construction/destruction

            explicit QueryKeysJob(const QHash<QString, QStringList>& deviceKeys, Omittable<int> timeout = none, const QString& token = {});
            ~QueryKeysJob() override;

            // Result properties

            const QHash<QString, QJsonObject>& failures() const;
            const QHash<QString, QHash<QString, DeviceInformation>>& deviceKeys() const;

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

        private:
            class Private;
            QScopedPointer<Private> d;
    };

    class ClaimKeysJob : public BaseJob
    {
        public:
            explicit ClaimKeysJob(const QHash<QString, QHash<QString, QString>>& oneTimeKeys, Omittable<int> timeout = none);
            ~ClaimKeysJob() override;

            // Result properties

            const QHash<QString, QJsonObject>& failures() const;
            const QHash<QString, QHash<QString, QVariant>>& oneTimeKeys() const;

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

        private:
            class Private;
            QScopedPointer<Private> d;
    };

    class GetKeysChangesJob : public BaseJob
    {
        public:
            explicit GetKeysChangesJob(const QString& from, const QString& to);

            /** Construct a URL out of baseUrl and usual parameters passed to
             * GetKeysChangesJob. This function can be used when
             * a URL for GetKeysChangesJob is necessary but the job
             * itself isn't.
             */
            static QUrl makeRequestUrl(QUrl baseUrl, const QString& from, const QString& to);

            ~GetKeysChangesJob() override;

            // Result properties

            const QStringList& changed() const;
            const QStringList& left() const;

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

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