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

#pragma once

#include "converters.h"

#include "csapi/definitions/push_condition.h"
#include <QtCore/QVector>
#include <QtCore/QVariant>
#include "converters.h"

namespace QMatrixClient
{
    // Data structures

    /// Specifies an entry to the 'tweaks' dictionary sent in
    /// the notification request to the Push Gateway.
    /// Tweak parameters, if any, are provided as additional
    /// key-value pairs in this structure.
    struct SetTweakAction
    {
        /// The tweak type. Two predefined types are `sound`
        /// and `highlight`; client applications and Push Gateways
        /// may agree on additional tweak types.
        QString setTweak;
        /// Specifies an entry to the 'tweaks' dictionary sent in
        /// the notification request to the Push Gateway.
        /// Tweak parameters, if any, are provided as additional
        /// key-value pairs in this structure.
        QVariantHash additionalProperties;
    };

    QJsonObject toJson(const SetTweakAction& pod);

    template <> struct FromJson<SetTweakAction>
    {
        SetTweakAction operator()(const QJsonValue& jv);
    };

    struct PushRule
    {
        /// The actions to perform when this rule is matched.
        QVector<QVariant> actions;
        /// Whether this is a default rule, or has been set explicitly.
        bool isDefault;
        /// Whether the push rule is enabled or not.
        bool enabled;
        /// The ID of this rule.
        QString ruleId;
        /// The conditions that must hold true for an event in order for a rule to be
        /// applied to an event. A rule with no conditions always matches. Only
        /// applicable to ``underride`` and ``override`` rules.
        QVector<PushCondition> conditions;
        /// The glob-style pattern to match against.  Only applicable to ``content``
        /// rules.
        QString pattern;
    };

    QJsonObject toJson(const PushRule& pod);

    template <> struct FromJson<PushRule>
    {
        PushRule operator()(const QJsonValue& jv);
    };

} // namespace QMatrixClient