aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/joining.h
diff options
context:
space:
mode:
authorMarc Deop <marc@marcdeop.com>2019-03-02 12:26:57 +0100
committerMarc Deop <marc@marcdeop.com>2019-03-02 12:26:57 +0100
commitaacc4bcb4a487871daae6717f77605aaba444341 (patch)
tree4f50b6874821667ccb6b91c017e5d041e3846112 /lib/csapi/joining.h
parentc971b924cd62822ed6fb1a0291c483ae73a3ecda (diff)
downloadlibquotient-aacc4bcb4a487871daae6717f77605aaba444341.tar.gz
libquotient-aacc4bcb4a487871daae6717f77605aaba444341.zip
style: apply .clang-format to all .cpp and .h files
Diffstat (limited to 'lib/csapi/joining.h')
-rw-r--r--lib/csapi/joining.h209
1 files changed, 111 insertions, 98 deletions
diff --git a/lib/csapi/joining.h b/lib/csapi/joining.h
index 52c8ea42..5d118dab 100644
--- a/lib/csapi/joining.h
+++ b/lib/csapi/joining.h
@@ -9,143 +9,156 @@
#include "converters.h"
#include <QtCore/QJsonObject>
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Start the requesting user participating in a particular room.
///
- /// *Note that this API requires a room ID, not alias.* ``/join/{roomIdOrAlias}`` *exists if you have a room alias.*
- ///
+ /// *Note that this API requires a room ID, not alias.*
+ /// ``/join/{roomIdOrAlias}`` *exists if you have a room alias.*
+ ///
/// This API starts a user participating in a particular room, if that user
/// is allowed to participate in that room. After this call, the client is
/// allowed to see all current state events in the room, and all subsequent
/// events associated with the room until the user leaves the room.
- ///
+ ///
/// After a user has joined a room, the room will appear as an entry in the
/// response of the |/initialSync|_ and |/sync|_ APIs.
- ///
+ ///
/// If a ``third_party_signed`` was supplied, the homeserver must verify
/// that it matches a pending ``m.room.third_party_invite`` event in the
/// room, and perform key validity checking if required by the event.
class JoinRoomByIdJob : public BaseJob
{
public:
- // Inner data structures
-
- /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room.
- struct ThirdPartySigned
- {
- /// The Matrix ID of the user who issued the invite.
- QString sender;
- /// The Matrix ID of the invitee.
- QString mxid;
- /// The state key of the m.third_party_invite event.
- QString token;
- /// A signatures object containing a signature of the entire signed object.
- QJsonObject signatures;
- };
-
- // Construction/destruction
-
- /*! Start the requesting user participating in a particular room.
- * \param roomId
- * The room identifier (not alias) to join.
- * \param thirdPartySigned
- * A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room.
- */
- explicit JoinRoomByIdJob(const QString& roomId, const Omittable<ThirdPartySigned>& thirdPartySigned = none);
- ~JoinRoomByIdJob() override;
-
- // Result properties
-
- /// The joined room ID.
- const QString& roomId() const;
+ // Inner data structures
+
+ /// A signature of an ``m.third_party_invite`` token to prove that this
+ /// user owns a third party identity which has been invited to the room.
+ struct ThirdPartySigned {
+ /// The Matrix ID of the user who issued the invite.
+ QString sender;
+ /// The Matrix ID of the invitee.
+ QString mxid;
+ /// The state key of the m.third_party_invite event.
+ QString token;
+ /// A signatures object containing a signature of the entire signed
+ /// object.
+ QJsonObject signatures;
+ };
+
+ // Construction/destruction
+
+ /*! Start the requesting user participating in a particular room.
+ * \param roomId
+ * The room identifier (not alias) to join.
+ * \param thirdPartySigned
+ * A signature of an ``m.third_party_invite`` token to prove that this
+ * user owns a third party identity which has been invited to the room.
+ */
+ explicit JoinRoomByIdJob(
+ const QString& roomId,
+ const Omittable<ThirdPartySigned>& thirdPartySigned = none);
+ ~JoinRoomByIdJob() override;
+
+ // Result properties
+
+ /// The joined room ID.
+ const QString& roomId() const;
protected:
- Status parseJson(const QJsonDocument& data) override;
+ Status parseJson(const QJsonDocument& data) override;
private:
- class Private;
- QScopedPointer<Private> d;
+ class Private;
+ QScopedPointer<Private> d;
};
/// Start the requesting user participating in a particular room.
///
- /// *Note that this API takes either a room ID or alias, unlike* ``/room/{roomId}/join``.
- ///
+ /// *Note that this API takes either a room ID or alias, unlike*
+ /// ``/room/{roomId}/join``.
+ ///
/// This API starts a user participating in a particular room, if that user
/// is allowed to participate in that room. After this call, the client is
/// allowed to see all current state events in the room, and all subsequent
/// events associated with the room until the user leaves the room.
- ///
+ ///
/// After a user has joined a room, the room will appear as an entry in the
/// response of the |/initialSync|_ and |/sync|_ APIs.
- ///
+ ///
/// If a ``third_party_signed`` was supplied, the homeserver must verify
/// that it matches a pending ``m.room.third_party_invite`` event in the
/// room, and perform key validity checking if required by the event.
class JoinRoomJob : public BaseJob
{
public:
- // Inner data structures
-
- /// *Note that this API takes either a room ID or alias, unlike* ``/room/{roomId}/join``.
- ///
- /// This API starts a user participating in a particular room, if that user
- /// is allowed to participate in that room. After this call, the client is
- /// allowed to see all current state events in the room, and all subsequent
- /// events associated with the room until the user leaves the room.
- ///
- /// After a user has joined a room, the room will appear as an entry in the
- /// response of the |/initialSync|_ and |/sync|_ APIs.
- ///
- /// If a ``third_party_signed`` was supplied, the homeserver must verify
- /// that it matches a pending ``m.room.third_party_invite`` event in the
- /// room, and perform key validity checking if required by the event.
- struct Signed
- {
- /// The Matrix ID of the user who issued the invite.
- QString sender;
- /// The Matrix ID of the invitee.
- QString mxid;
- /// The state key of the m.third_party_invite event.
- QString token;
- /// A signatures object containing a signature of the entire signed object.
- QJsonObject signatures;
- };
-
- /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room.
- struct ThirdPartySigned
- {
- /// A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room.
- Signed signedData;
- };
-
- // Construction/destruction
-
- /*! Start the requesting user participating in a particular room.
- * \param roomIdOrAlias
- * The room identifier or alias to join.
- * \param serverName
- * The servers to attempt to join the room through. One of the servers
- * must be participating in the room.
- * \param thirdPartySigned
- * A signature of an ``m.third_party_invite`` token to prove that this user owns a third party identity which has been invited to the room.
- */
- explicit JoinRoomJob(const QString& roomIdOrAlias, const QStringList& serverName = {}, const Omittable<ThirdPartySigned>& thirdPartySigned = none);
- ~JoinRoomJob() override;
-
- // Result properties
-
- /// The joined room ID.
- const QString& roomId() const;
+ // Inner data structures
+
+ /// *Note that this API takes either a room ID or alias, unlike*
+ /// ``/room/{roomId}/join``.
+ ///
+ /// This API starts a user participating in a particular room, if that
+ /// user is allowed to participate in that room. After this call, the
+ /// client is allowed to see all current state events in the room, and
+ /// all subsequent events associated with the room until the user leaves
+ /// the room.
+ ///
+ /// After a user has joined a room, the room will appear as an entry in
+ /// the response of the |/initialSync|_ and |/sync|_ APIs.
+ ///
+ /// If a ``third_party_signed`` was supplied, the homeserver must verify
+ /// that it matches a pending ``m.room.third_party_invite`` event in the
+ /// room, and perform key validity checking if required by the event.
+ struct Signed {
+ /// The Matrix ID of the user who issued the invite.
+ QString sender;
+ /// The Matrix ID of the invitee.
+ QString mxid;
+ /// The state key of the m.third_party_invite event.
+ QString token;
+ /// A signatures object containing a signature of the entire signed
+ /// object.
+ QJsonObject signatures;
+ };
+
+ /// A signature of an ``m.third_party_invite`` token to prove that this
+ /// user owns a third party identity which has been invited to the room.
+ struct ThirdPartySigned {
+ /// A signature of an ``m.third_party_invite`` token to prove that
+ /// this user owns a third party identity which has been invited to
+ /// the room.
+ Signed signedData;
+ };
+
+ // Construction/destruction
+
+ /*! Start the requesting user participating in a particular room.
+ * \param roomIdOrAlias
+ * The room identifier or alias to join.
+ * \param serverName
+ * The servers to attempt to join the room through. One of the servers
+ * must be participating in the room.
+ * \param thirdPartySigned
+ * A signature of an ``m.third_party_invite`` token to prove that this
+ * user owns a third party identity which has been invited to the room.
+ */
+ explicit JoinRoomJob(
+ const QString& roomIdOrAlias,
+ const QStringList& serverName = {},
+ const Omittable<ThirdPartySigned>& thirdPartySigned = none);
+ ~JoinRoomJob() override;
+
+ // Result properties
+
+ /// The joined room ID.
+ const QString& roomId() const;
protected:
- Status parseJson(const QJsonDocument& data) override;
+ Status parseJson(const QJsonDocument& data) override;
private:
- class Private;
- QScopedPointer<Private> d;
+ class Private;
+ QScopedPointer<Private> d;
};
} // namespace QMatrixClient