aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/kicking.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/kicking.cpp')
0 files changed, 0 insertions, 0 deletions
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-17 01:44:08 +0000
a id='n55' href='#n55'>55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "jobs/basejob.h"

namespace Quotient {

/*! \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 {
public:
    // Inner data structures

    /// Capability to indicate if the user can change their password.
    struct ChangePasswordCapability {
        /// True if the user can change their password, false otherwise.
        bool enabled;
    };

    /// The room versions the server supports.
    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 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 the
        /// Java package naming convention.
        QHash<QString, QJsonObject> additionalProperties;
    };

    // Construction/destruction

    /// Gets information about the server's capabilities.
    explicit GetCapabilitiesJob();

    /*! \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.
     */
    static QUrl makeRequestUrl(QUrl baseUrl);

    // Result properties

    /// The custom capabilities the server supports, using the
    /// Java package naming convention.
    Capabilities capabilities() const
    {
        return loadFromJson<Capabilities>("capabilities"_ls);
    }
};

template <>
struct JsonObjectConverter<GetCapabilitiesJob::ChangePasswordCapability> {
    static void fillFrom(const QJsonObject& jo,
                         GetCapabilitiesJob::ChangePasswordCapability& result)
    {
        fromJson(jo.value("enabled"_ls), result.enabled);
    }
};

template <>
struct JsonObjectConverter<GetCapabilitiesJob::RoomVersionsCapability> {
    static void fillFrom(const QJsonObject& jo,
                         GetCapabilitiesJob::RoomVersionsCapability& result)
    {
        fromJson(jo.value("default"_ls), result.defaultVersion);
        fromJson(jo.value("available"_ls), result.available);
    }
};

template <>
struct JsonObjectConverter<GetCapabilitiesJob::Capabilities> {
    static void fillFrom(QJsonObject jo,
                         GetCapabilitiesJob::Capabilities& result)
    {
        fromJson(jo.take("m.change_password"_ls), result.changePassword);
        fromJson(jo.take("m.room_versions"_ls), result.roomVersions);
        fromJson(jo, result.additionalProperties);
    }
};

} // namespace Quotient