aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/room_send.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2019-08-03 17:29:52 +0900
committerGitHub <noreply@github.com>2019-08-03 17:29:52 +0900
commit66e116b7b1e848e80577a0229c8995db0a54932e (patch)
tree763340439a0f4034e9c829d76cb1ffe9766b83c5 /lib/csapi/room_send.h
parent5b236dfe895c7766002559570aa29c9033009228 (diff)
parentc05ade838f0fce81f2bbe80a3295618a8a26ff52 (diff)
downloadlibquotient-66e116b7b1e848e80577a0229c8995db0a54932e.tar.gz
libquotient-66e116b7b1e848e80577a0229c8995db0a54932e.zip
Merge pull request #295 from marcdeop/140_impose_coding_standard
140 impose coding standard
Diffstat (limited to 'lib/csapi/room_send.h')
-rw-r--r--lib/csapi/room_send.h99
1 files changed, 52 insertions, 47 deletions
diff --git a/lib/csapi/room_send.h b/lib/csapi/room_send.h
index 85c298e0..aa2efd79 100644
--- a/lib/csapi/room_send.h
+++ b/lib/csapi/room_send.h
@@ -10,51 +10,56 @@
namespace QMatrixClient
{
- // Operations
-
- /// Send a message event to the given room.
- ///
- /// This endpoint is used to send a message event to a room. Message events
- /// allow access to historical events and pagination, making them suited
- /// for "once-off" activity in a room.
- ///
- /// The body of the request should be the content object of the event; the
- /// fields in this object will vary depending on the type of event. See
- /// `Room Events`_ for the m. event specification.
- class SendMessageJob : public BaseJob
- {
- public:
- /*! Send a message event to the given room.
- * \param roomId
- * The room to send the event to.
- * \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 body
- * This endpoint is used to send a message event to a room. Message events
- * allow access to historical events and pagination, making them suited
- * for "once-off" activity in a room.
- *
- * The body of the request should be the content object of the event; the
- * fields in this object will vary depending on the type of event. See
- * `Room Events`_ for the m. event specification.
- */
- explicit SendMessageJob(const QString& roomId, const QString& eventType, const QString& txnId, const QJsonObject& body = {});
- ~SendMessageJob() override;
-
- // Result properties
-
- /// A unique identifier for the event.
- const QString& eventId() const;
-
- protected:
- Status parseJson(const QJsonDocument& data) override;
-
- private:
- class Private;
- QScopedPointer<Private> d;
- };
+
+// Operations
+
+/// Send a message event to the given room.
+/*!
+ * This endpoint is used to send a message event to a room. Message events
+ * allow access to historical events and pagination, making them suited
+ * for "once-off" activity in a room.
+ *
+ * The body of the request should be the content object of the event; the
+ * fields in this object will vary depending on the type of event. See
+ * `Room Events`_ for the m. event specification.
+ */
+class SendMessageJob : public BaseJob
+{
+public:
+ /*! Send a message event to the given room.
+ * \param roomId
+ * The room to send the event to.
+ * \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 body
+ * This endpoint is used to send a message event to a room. Message events
+ * allow access to historical events and pagination, making them suited
+ * for "once-off" activity in a room.
+ *
+ * The body of the request should be the content object of the event; the
+ * fields in this object will vary depending on the type of event. See
+ * `Room Events`_ for the m. event specification.
+ */
+ explicit SendMessageJob(const QString& roomId, const QString& eventType,
+ const QString& txnId, const QJsonObject& body = {});
+
+ ~SendMessageJob() override;
+
+ // Result properties
+
+ /// A unique identifier for the event.
+ const QString& eventId() const;
+
+protected:
+ Status parseJson(const QJsonDocument& data) override;
+
+private:
+ class Private;
+ QScopedPointer<Private> d;
+};
+
} // namespace QMatrixClient