aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/openid.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/openid.h')
-rw-r--r--lib/csapi/openid.h60
1 files changed, 30 insertions, 30 deletions
diff --git a/lib/csapi/openid.h b/lib/csapi/openid.h
index 807801fb..6e3c744d 100644
--- a/lib/csapi/openid.h
+++ b/lib/csapi/openid.h
@@ -9,8 +9,7 @@
#include "converters.h"
#include <QtCore/QJsonObject>
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Get an OpenID token object to verify the requester's identity.
@@ -19,43 +18,44 @@ namespace QMatrixClient
/// service to verify their identity in Matrix. The generated token is only
/// valid for exchanging for user information from the federation API for
/// OpenID.
- ///
+ ///
/// The access token generated is only valid for the OpenID API. It cannot
/// be used to request another OpenID access token or call ``/sync``, for
/// example.
class RequestOpenIdTokenJob : public BaseJob
{
public:
- /*! Get an OpenID token object to verify the requester's identity.
- * \param userId
- * The user to request and OpenID token for. Should be the user who
- * is authenticated for the request.
- * \param body
- * An empty object. Reserved for future expansion.
- */
- explicit RequestOpenIdTokenJob(const QString& userId, const QJsonObject& body = {});
- ~RequestOpenIdTokenJob() override;
-
- // Result properties
-
- /// An access token the consumer may use to verify the identity of
- /// the person who generated the token. This is given to the federation
- /// API ``GET /openid/userinfo``.
- const QString& accessToken() const;
- /// The string ``Bearer``.
- const QString& tokenType() const;
- /// The homeserver domain the consumer should use when attempting to
- /// verify the user's identity.
- const QString& matrixServerName() const;
- /// The number of seconds before this token expires and a new one must
- /// be generated.
- int expiresIn() const;
+ /*! Get an OpenID token object to verify the requester's identity.
+ * \param userId
+ * The user to request and OpenID token for. Should be the user who
+ * is authenticated for the request.
+ * \param body
+ * An empty object. Reserved for future expansion.
+ */
+ explicit RequestOpenIdTokenJob(const QString& userId,
+ const QJsonObject& body = {});
+ ~RequestOpenIdTokenJob() override;
+
+ // Result properties
+
+ /// An access token the consumer may use to verify the identity of
+ /// the person who generated the token. This is given to the federation
+ /// API ``GET /openid/userinfo``.
+ const QString& accessToken() const;
+ /// The string ``Bearer``.
+ const QString& tokenType() const;
+ /// The homeserver domain the consumer should use when attempting to
+ /// verify the user's identity.
+ const QString& matrixServerName() const;
+ /// The number of seconds before this token expires and a new one must
+ /// be generated.
+ int expiresIn() 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