aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/to_device.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/to_device.h')
-rw-r--r--lib/csapi/to_device.h56
1 files changed, 29 insertions, 27 deletions
diff --git a/lib/csapi/to_device.h b/lib/csapi/to_device.h
index 10f6b971..54828337 100644
--- a/lib/csapi/to_device.h
+++ b/lib/csapi/to_device.h
@@ -6,32 +6,34 @@
#include "jobs/basejob.h"
-#include <QtCore/QJsonObject>
-#include <QtCore/QHash>
+namespace Quotient {
-namespace QMatrixClient
-{
- // Operations
+/*! \brief Send an event to a given set of devices.
+ *
+ * This endpoint is used to send send-to-device events to a set of
+ * client devices.
+ */
+class QUOTIENT_API SendToDeviceJob : public BaseJob {
+public:
+ /*! \brief Send an event to a given set of devices.
+ *
+ * \param eventType
+ * The type of event to send.
+ *
+ * \param txnId
+ * The [transaction ID](/client-server-api/#transaction-identifiers) for
+ * this event. Clients should generate an ID unique across requests with the
+ * same access token; it will be used by the server to ensure idempotency of
+ * requests.
+ *
+ * \param messages
+ * The messages to send. A map from user ID, to a map from
+ * device ID to message body. The device ID may also be `*`,
+ * meaning all known devices for the user.
+ */
+ explicit SendToDeviceJob(
+ const QString& eventType, const QString& txnId,
+ const QHash<QString, QHash<QString, QJsonObject>>& messages);
+};
- /// Send an event to a given set of devices.
- ///
- /// This endpoint is used to send send-to-device events to a set of
- /// client devices.
- class SendToDeviceJob : public BaseJob
- {
- public:
- /*! Send an event to a given set of devices.
- * \param eventType
- * The type of event to send.
- * \param txnId
- * The transaction ID for this event. Clients should generate an
- * ID unique across requests with the same access token; it will be
- * used by the server to ensure idempotency of requests.
- * \param messages
- * The messages to send. A map from user ID, to a map from
- * device ID to message body. The device ID may also be `*`,
- * meaning all known devices for the user.
- */
- explicit SendToDeviceJob(const QString& eventType, const QString& txnId, const QHash<QString, QHash<QString, QJsonObject>>& messages = {});
- };
-} // namespace QMatrixClient
+} // namespace Quotient