admin.h

Go to the documentation of this file.

// THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 
#pragma once
 
#include <Quotient/jobs/basejob.h>
 
namespace Quotient {
 
//! \brief Gets information about a particular user.
//!
//! Gets information about a particular user.
//!
//! This API may be restricted to only be called by the user being looked
//! up, or by a server admin. Server-local administrator privileges are not
//! specified in this document.
class QUOTIENT_API GetWhoIsJob : public BaseJob {
public:
    // Inner data structures
 
    struct QUOTIENT_API ConnectionInfo {
        //! Most recently seen IP address of the session.
        QString ip{};
 
        //! Unix timestamp that the session was last active.
        std::optional<qint64> lastSeen{};
 
        //! User agent string last seen in the session.
        QString userAgent{};
    };
 
    struct QUOTIENT_API SessionInfo {
        //! Information particular connections in the session.
        QVector<ConnectionInfo> connections{};
    };
 
    struct QUOTIENT_API DeviceInfo {
        //! A user's sessions (i.e. what they did with an access token from one login).
        QVector<SessionInfo> sessions{};
    };
 
    // Construction/destruction
 
    //! \param userId
    //!   The user to look up.
    explicit GetWhoIsJob(const QString& userId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetWhoIsJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& userId);
 
    // Result properties
 
    //! The Matrix user ID of the user.
    QString userId() const { return loadFromJson<QString>("user_id"_L1); }
 
    //! Each key is an identifier for one of the user's devices.
    QHash<QString, DeviceInfo> devices() const
    {
        return loadFromJson<QHash<QString, DeviceInfo>>("devices"_L1);
    }
 
    struct Response {
        //! The Matrix user ID of the user.
        QString userId{};
 
        //! Each key is an identifier for one of the user's devices.
        QHash<QString, DeviceInfo> devices{};
    };
};
 
template <std::derived_from<GetWhoIsJob> JobT>
constexpr inline auto doCollectResponse<JobT> =
    [](JobT* j) -> GetWhoIsJob::Response { return { j->userId(), j->devices() }; };
 
template <>
struct QUOTIENT_API JsonObjectConverter<GetWhoIsJob::ConnectionInfo> {
    static void fillFrom(const QJsonObject& jo, GetWhoIsJob::ConnectionInfo& result)
    {
        fillFromJson(jo.value("ip"_L1), result.ip);
        fillFromJson(jo.value("last_seen"_L1), result.lastSeen);
        fillFromJson(jo.value("user_agent"_L1), result.userAgent);
    }
};
 
template <>
struct QUOTIENT_API JsonObjectConverter<GetWhoIsJob::SessionInfo> {
    static void fillFrom(const QJsonObject& jo, GetWhoIsJob::SessionInfo& result)
    {
        fillFromJson(jo.value("connections"_L1), result.connections);
    }
};
 
template <>
struct QUOTIENT_API JsonObjectConverter<GetWhoIsJob::DeviceInfo> {
    static void fillFrom(const QJsonObject& jo, GetWhoIsJob::DeviceInfo& result)
    {
        fillFromJson(jo.value("sessions"_L1), result.sessions);
    }
};
 
} // namespace Quotient