diff options
author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-04-17 07:42:13 +0200 |
---|---|---|
committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-04-17 07:49:41 +0200 |
commit | 7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424 (patch) | |
tree | fa9e37d8874303bf56d5381b0844738bd516a79b /lib/csapi/capabilities.h | |
parent | 906699cc525e9e0be231a58cabffc31ad1f5193c (diff) | |
download | libquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.tar.gz libquotient-7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424.zip |
Regenerate API files using new GTAD and refreshed templates
No functional changes.
Diffstat (limited to 'lib/csapi/capabilities.h')
-rw-r--r-- | lib/csapi/capabilities.h | 37 |
1 files changed, 15 insertions, 22 deletions
diff --git a/lib/csapi/capabilities.h b/lib/csapi/capabilities.h index b608a2f2..9f46ab2e 100644 --- a/lib/csapi/capabilities.h +++ b/lib/csapi/capabilities.h @@ -11,63 +11,56 @@ #include <QtCore/QHash> #include <QtCore/QJsonObject> -namespace Quotient -{ +namespace Quotient { // Operations -/// Gets information about the server's capabilities. -/*! +/*! \brief Gets information about the server's capabilities. + * * Gets information about the server's supported feature set * and other relevant capabilities. */ -class GetCapabilitiesJob : public BaseJob -{ +class GetCapabilitiesJob : public BaseJob { public: // Inner data structures /// Capability to indicate if the user can change their password. - struct ChangePasswordCapability - { + struct ChangePasswordCapability { /// True if the user can change their password, false otherwise. bool enabled; }; /// The room versions the server supports. - struct RoomVersionsCapability - { + struct RoomVersionsCapability { /// The default room version the server is using for new rooms. QString defaultVersion; /// A detailed description of the room versions the server supports. QHash<QString, QString> available; }; - /// The custom capabilities the server supports, using theJava package - /// naming convention. - struct Capabilities - { + /// The custom capabilities the server supports, using the + /// Java package naming convention. + struct Capabilities { /// Capability to indicate if the user can change their password. Omittable<ChangePasswordCapability> changePassword; /// The room versions the server supports. Omittable<RoomVersionsCapability> roomVersions; - - /// The custom capabilities the server supports, using theJava package - /// naming convention. + /// The custom capabilities the server supports, using the + /// Java package naming convention. QHash<QString, QJsonObject> additionalProperties; }; // Construction/destruction + /// Gets information about the server's capabilities. explicit GetCapabilitiesJob(); - /*! Construct a URL without creating a full-fledged job object + /*! \brief Construct a URL without creating a full-fledged job object * - * This function can be used when a URL for - * GetCapabilitiesJob is necessary but the job - * itself isn't. + * This function can be used when a URL for GetCapabilitiesJob + * is necessary but the job itself isn't. */ static QUrl makeRequestUrl(QUrl baseUrl); - ~GetCapabilitiesJob() override; // Result properties |