diff options
| author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2018-09-24 19:20:10 +0900 |
|---|---|---|
| committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2018-09-29 21:59:39 +0900 |
| commit | 4244cee8d5e0f760cccd2b45ad587670573ef03c (patch) | |
| tree | 4806108543f1402247e6cce1dba987a98d6fe83b /lib/csapi/pusher.h | |
| parent | f5c2e47fa1ab84fdaffe03c30ba973d7dea5ac05 (diff) | |
| download | libquotient-4244cee8d5e0f760cccd2b45ad587670573ef03c.tar.gz libquotient-4244cee8d5e0f760cccd2b45ad587670573ef03c.zip | |
Prepare for CS API 0.4.0
This commit consists of two parts: upgrading the API infrastructure and trivial but sweeping update to the generated files.
1. The API infrastructure (converters.h, *.mustache and some other non-generated files) now can deal with top-level JSON arrays and response inlining; better supports property maps; and gets some formatting fixes in generated code.
2. Generated files now use QJsonValue instead of QJsonObject as a default type
to (un)marshall Matrix API data structures, to match the change in the infrastructure above
This commit is still using the old Matrix API definitions, before CS API 0.4.0. Getting to CS API 0.4.0 will come next.
Diffstat (limited to 'lib/csapi/pusher.h')
| -rw-r--r-- | lib/csapi/pusher.h | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/csapi/pusher.h b/lib/csapi/pusher.h index 52717cd1..2b506183 100644 --- a/lib/csapi/pusher.h +++ b/lib/csapi/pusher.h @@ -14,7 +14,7 @@ namespace QMatrixClient // Operations /// Gets the current pushers for the authenticated user - /// + /// /// Gets all currently active pushers for the authenticated user. class GetPushersJob : public BaseJob { @@ -91,7 +91,7 @@ namespace QMatrixClient }; /// Modify a pusher for this user on the homeserver. - /// + /// /// This endpoint allows the creation, modification and deletion of `pushers`_ /// for this user ID. The behaviour of this endpoint varies depending on the /// values in the JSON body. @@ -120,7 +120,7 @@ namespace QMatrixClient // Construction/destruction /*! Modify a pusher for this user on the homeserver. - * \param pushkey + * \param pushkey * This is a unique identifier for this pusher. The value you * should use for this is the routing or destination address * information for the notification, for example, the APNS token @@ -130,34 +130,34 @@ namespace QMatrixClient * * If the ``kind`` is ``"email"``, this is the email address to * send notifications to. - * \param kind + * \param kind * The kind of pusher to configure. ``"http"`` makes a pusher that * sends HTTP pokes. ``"email"`` makes a pusher that emails the * user with unread notifications. ``null`` deletes the pusher. - * \param appId + * \param appId * This is a reverse-DNS style identifier for the application. * It is recommended that this end with the platform, such that * different platform versions get different app identifiers. * Max length, 64 chars. * * If the ``kind`` is ``"email"``, this is ``"m.email"``. - * \param appDisplayName + * \param appDisplayName * A string that will allow the user to identify what application * owns this pusher. - * \param deviceDisplayName + * \param deviceDisplayName * A string that will allow the user to identify what device owns * this pusher. - * \param lang + * \param lang * The preferred language for receiving notifications (e.g. 'en' * or 'en-US'). - * \param data + * \param data * A dictionary of information for the pusher implementation * itself. If ``kind`` is ``http``, this should contain ``url`` * which is the URL to use to send notifications to. - * \param profileTag + * \param profileTag * This string determines which set of device specific rules this * pusher executes. - * \param append + * \param append * If true, the homeserver should add another pusher with the * given pushkey and App ID in addition to any others with * different user IDs. Otherwise, the homeserver must remove any |