aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/pushrules.h
blob: a01049af9e5d9d3c0cd677ff582b0d137845f5ae (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

#include "lib/csapi/definitions/push_ruleset.h"
#include <QtCore/QVector>
#include "converters.h"
#include "lib/csapi/definitions/push_rule.h"
#include "lib/csapi/definitions/push_condition.h"

namespace QMatrixClient
{
    // Operations

    class GetPushRulesJob : public BaseJob
    {
        public:
            explicit GetPushRulesJob();

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

            ~GetPushRulesJob() override;

            // Result properties

            const PushRuleset& global() const;

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

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

    class GetPushRuleJob : public BaseJob
    {
        public:
            explicit GetPushRuleJob(const QString& scope, const QString& kind, const QString& ruleId);

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

            ~GetPushRuleJob() override;

            // Result properties

            const PushRule& data() const;

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

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

    class DeletePushRuleJob : public BaseJob
    {
        public:
            explicit DeletePushRuleJob(const QString& scope, const QString& kind, const QString& ruleId);

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

    };

    class SetPushRuleJob : public BaseJob
    {
        public:
            explicit SetPushRuleJob(const QString& scope, const QString& kind, const QString& ruleId, const QStringList& actions, const QString& before = {}, const QString& after = {}, const QVector<PushCondition>& conditions = {}, const QString& pattern = {});
    };

    class IsPushRuleEnabledJob : public BaseJob
    {
        public:
            explicit IsPushRuleEnabledJob(const QString& scope, const QString& kind, const QString& ruleId);

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

            ~IsPushRuleEnabledJob() override;

            // Result properties

            bool enabled() const;

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

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

    class SetPushRuleEnabledJob : public BaseJob
    {
        public:
            explicit SetPushRuleEnabledJob(const QString& scope, const QString& kind, const QString& ruleId, bool enabled);
    };

    class GetPushRuleActionsJob : public BaseJob
    {
        public:
            explicit GetPushRuleActionsJob(const QString& scope, const QString& kind, const QString& ruleId);

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

            ~GetPushRuleActionsJob() override;

            // Result properties

            const QStringList& actions() const;

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

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

    class SetPushRuleActionsJob : public BaseJob
    {
        public:
            explicit SetPushRuleActionsJob(const QString& scope, const QString& kind, const QString& ruleId, const QStringList& actions);
    };
} // namespace QMatrixClient