aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/notifications.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/notifications.h')
-rw-r--r--lib/csapi/notifications.h41
1 files changed, 19 insertions, 22 deletions
diff --git a/lib/csapi/notifications.h b/lib/csapi/notifications.h
index eeec5d4e..0e86e424 100644
--- a/lib/csapi/notifications.h
+++ b/lib/csapi/notifications.h
@@ -13,45 +13,43 @@
#include <QtCore/QVariant>
#include <QtCore/QVector>
-namespace Quotient
-{
+namespace Quotient {
// Operations
-/// Gets a list of events that the user has been notified about
-/*!
+/*! \brief Gets a list of events that the user has been notified about
+ *
* This API is used to paginate through the list of events that the
* user has been, or would have been notified about.
*/
-class GetNotificationsJob : public BaseJob
-{
+class GetNotificationsJob : public BaseJob {
public:
// Inner data structures
- /// This API is used to paginate through the list of events that theuser has
- /// been, or would have been notified about.
- struct Notification
- {
- /// The action(s) to perform when the conditions for this rule are
- /// met.See `Push Rules: API`_.
+ /// This API is used to paginate through the list of events that the
+ /// user has been, or would have been notified about.
+ struct Notification {
+ /// The action(s) to perform when the conditions for this rule are met.
+ /// See `Push Rules: API`_.
QVector<QVariant> actions;
/// The Event object for the event that triggered the notification.
EventPtr event;
/// The profile tag of the rule that matched this event.
QString profileTag;
- /// Indicates whether the user has sent a read receipt indicatingthat
- /// they have read this message.
+ /// Indicates whether the user has sent a read receipt indicating
+ /// that they have read this message.
bool read;
/// The ID of the room in which the event was posted.
QString roomId;
- /// The unix timestamp at which the event notification was sent,in
- /// milliseconds.
+ /// The unix timestamp at which the event notification was sent,
+ /// in milliseconds.
int ts;
};
// Construction/destruction
- /*! Gets a list of events that the user has been notified about
+ /*! \brief Gets a list of events that the user has been notified about
+ *
* \param from
* Pagination token given to retrieve the next set of events.
* \param limit
@@ -65,16 +63,14 @@ public:
Omittable<int> limit = none,
const QString& only = {});
- /*! Construct a URL without creating a full-fledged job object
+ /*! \brief Construct a URL without creating a full-fledged job object
*
- * This function can be used when a URL for
- * GetNotificationsJob is necessary but the job
- * itself isn't.
+ * This function can be used when a URL for GetNotificationsJob
+ * is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl, const QString& from = {},
Omittable<int> limit = none,
const QString& only = {});
-
~GetNotificationsJob() override;
// Result properties
@@ -83,6 +79,7 @@ public:
/// ``/notifications`` request in order to request more
/// events. If this is absent, there are no more results.
const QString& nextToken() const;
+
/// The list of events that triggered notifications.
std::vector<Notification>&& notifications();