diff options
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 |