aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/definitions/push_condition.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_condition.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_condition.h')
-rw-r--r--lib/csapi/definitions/push_condition.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/csapi/definitions/push_condition.h b/lib/csapi/definitions/push_condition.h
index 5744b9b8..83f63183 100644
--- a/lib/csapi/definitions/push_condition.h
+++ b/lib/csapi/definitions/push_condition.h
@@ -15,8 +15,18 @@ namespace QMatrixClient
struct PushCondition
{
QString kind;
+ /// Required for ``event_match`` conditions. The dot-separated field of the
+ /// event to match.
QString key;
+ /// Required for ``event_match`` conditions. The glob-style pattern to
+ /// match against. Patterns with no special glob characters should be
+ /// treated as having asterisks prepended and appended when testing the
+ /// condition.
QString pattern;
+ /// Required for ``room_member_count`` conditions. A decimal integer
+ /// optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches
+ /// rooms where the member count is strictly less than the given number and
+ /// so forth. If no prefix is present, this parameter defaults to ==.
QString is;
};