aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/room_state.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/room_state.h')
-rw-r--r--lib/csapi/room_state.h96
1 files changed, 25 insertions, 71 deletions
diff --git a/lib/csapi/room_state.h b/lib/csapi/room_state.h
index 7843cff4..eeb2b33c 100644
--- a/lib/csapi/room_state.h
+++ b/lib/csapi/room_state.h
@@ -6,14 +6,13 @@
#include "jobs/basejob.h"
-#include <QtCore/QJsonObject>
-
namespace Quotient {
-// Operations
-
/*! \brief Send a state event to the given room.
*
+ * .. For backwards compatibility with older links...
+ * .. _`put-matrix-client-r0-rooms-roomid-state-eventtype`:
+ *
* State events can be sent using this endpoint. These events will be
* overwritten if ``<room id>``, ``<event type>`` and ``<state key>`` all
* match.
@@ -25,18 +24,32 @@ namespace Quotient {
* 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.
+ *
+ * If the event type being sent is ``m.room.canonical_alias`` servers
+ * SHOULD ensure that any new aliases being listed in the event are valid
+ * per their grammar/syntax and that they point to the room ID where the
+ * state event is to be sent. Servers do not validate aliases which are
+ * being removed or are already present in the state event.
*/
class SetRoomStateWithKeyJob : public BaseJob {
public:
/*! \brief Send a state event to the given room.
*
+ *
* \param roomId
* The room to set the state in
+ *
* \param eventType
* The type of event to send.
+ *
* \param stateKey
- * The state_key for the state to send. Defaults to the empty string.
+ * The state_key for the state to send. Defaults to the empty string. When
+ * an empty string, the trailing slash on this endpoint is optional.
+ *
* \param body
+ * .. For backwards compatibility with older links...
+ * .. _`put-matrix-client-r0-rooms-roomid-state-eventtype`:
+ *
* State events can be sent using this endpoint. These events will be
* overwritten if ``<room id>``, ``<event type>`` and ``<state key>`` all
* match.
@@ -48,81 +61,22 @@ public:
* 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.
+ *
+ * If the event type being sent is ``m.room.canonical_alias`` servers
+ * SHOULD ensure that any new aliases being listed in the event are valid
+ * per their grammar/syntax and that they point to the room ID where the
+ * state event is to be sent. Servers do not validate aliases which are
+ * being removed or are already present in the state event.
*/
explicit SetRoomStateWithKeyJob(const QString& roomId,
const QString& eventType,
const QString& stateKey,
const QJsonObject& body = {});
- ~SetRoomStateWithKeyJob() 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;
-};
-
-/*! \brief Send a state event to the given room.
- *
- * State events can be sent using this endpoint. This endpoint is
- * equivalent to calling `/rooms/{roomId}/state/{eventType}/{stateKey}`
- * with an empty `stateKey`. Previous state events with matching
- * `<roomId>` and `<eventType>`, and empty `<stateKey>`, will be overwritten.
- *
- * Requests to this endpoint **cannot use transaction IDs**
- * like other ``PUT`` paths because they cannot be differentiated from the
- * ``state_key``. Furthermore, ``POST`` is unsupported on state paths.
- *
- * 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 SetRoomStateJob : public BaseJob {
-public:
- /*! \brief Send a state event to the given room.
- *
- * \param roomId
- * The room to set the state in
- * \param eventType
- * The type of event to send.
- * \param body
- * State events can be sent using this endpoint. This endpoint is
- * equivalent to calling `/rooms/{roomId}/state/{eventType}/{stateKey}`
- * with an empty `stateKey`. Previous state events with matching
- * `<roomId>` and `<eventType>`, and empty `<stateKey>`, will be
- * overwritten.
- *
- * Requests to this endpoint **cannot use transaction IDs**
- * like other ``PUT`` paths because they cannot be differentiated from the
- * ``state_key``. Furthermore, ``POST`` is unsupported on state paths.
- *
- * 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 SetRoomStateJob(const QString& roomId, const QString& eventType,
- const QJsonObject& body = {});
-
- ~SetRoomStateJob() 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;
+ QString eventId() const { return loadFromJson<QString>("event_id"_ls); }
};
} // namespace Quotient