whoami.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 the owner of an access token.
//!
//! Gets information about the owner of a given access token.
//!
//! Note that, as with the rest of the Client-Server API,
//! Application Services may masquerade as users within their
//! namespace by giving a `user_id` query parameter. In this
//! situation, the server should verify that the given `user_id`
//! is registered by the appservice, and return it in the response
//! body.
class QUOTIENT_API GetTokenOwnerJob : public BaseJob {
public:
    explicit GetTokenOwnerJob();
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetTokenOwnerJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData);
 
    // Result properties
 
    //! The user ID that owns the access token.
    QString userId() const { return loadFromJson<QString>("user_id"_L1); }
 
    //! Device ID associated with the access token. If no device
    //! is associated with the access token (such as in the case
    //! of application services) then this field can be omitted.
    //! Otherwise this is required.
    QString deviceId() const { return loadFromJson<QString>("device_id"_L1); }
 
    //! When `true`, the user is a [Guest User](#guest-access). When
    //! not present or `false`, the user is presumed to be a non-guest
    //! user.
    std::optional<bool> isGuest() const { return loadFromJson<std::optional<bool>>("is_guest"_L1); }
 
    struct Response {
        //! The user ID that owns the access token.
        QString userId{};
 
        //! Device ID associated with the access token. If no device
        //! is associated with the access token (such as in the case
        //! of application services) then this field can be omitted.
        //! Otherwise this is required.
        QString deviceId{};
 
        //! When `true`, the user is a [Guest User](#guest-access). When
        //! not present or `false`, the user is presumed to be a non-guest
        //! user.
        std::optional<bool> isGuest{};
    };
};
 
template <std::derived_from<GetTokenOwnerJob> JobT>
constexpr inline auto doCollectResponse<JobT> = [](JobT* j) -> GetTokenOwnerJob::Response {
    return { j->userId(), j->deviceId(), j->isGuest() };
};
 
} // namespace Quotient