aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/definitions/push_rule.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-07-18 18:39:56 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-07-18 18:39:56 +0900
commit5e6b4bb975fa9697a6aca001629c65db506a437f (patch)
treedeeb501bd6b534dc1ce454fb03e2d91e09597770 /lib/csapi/definitions/push_rule.h
parent56480bc96b28356c44547cc3d9ea1afbda9f04f9 (diff)
downloadlibquotient-5e6b4bb975fa9697a6aca001629c65db506a437f.tar.gz
libquotient-5e6b4bb975fa9697a6aca001629c65db506a437f.zip
csapi: Doxy-comments thanks to the latest GTAD
Diffstat (limited to 'lib/csapi/definitions/push_rule.h')
-rw-r--r--lib/csapi/definitions/push_rule.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/csapi/definitions/push_rule.h b/lib/csapi/definitions/push_rule.h
index 74ecf79c..d7f93e41 100644
--- a/lib/csapi/definitions/push_rule.h
+++ b/lib/csapi/definitions/push_rule.h
@@ -19,11 +19,20 @@ namespace QMatrixClient
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;
};