profile.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 Set the user's display name.
//!
//! This API sets the given user's display name. You must have permission to
//! set this user's display name, e.g. you need to have their `access_token`.
class QUOTIENT_API SetDisplayNameJob : public BaseJob {
public:
    //! \param userId
    //!   The user whose display name to set.
    //!
    //! \param displayname
    //!   The new display name for this user.
    explicit SetDisplayNameJob(const QString& userId, const QString& displayname);
};
 
//! \brief Get the user's display name.
//!
//! Get the user's display name. This API may be used to fetch the user's
//! own displayname or to query the name of other users; either locally or
//! on remote homeservers.
class QUOTIENT_API GetDisplayNameJob : public BaseJob {
public:
    //! \param userId
    //!   The user whose display name to get.
    explicit GetDisplayNameJob(const QString& userId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetDisplayNameJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& userId);
 
    // Result properties
 
    //! The user's display name if they have set one, otherwise not present.
    QString displayname() const { return loadFromJson<QString>("displayname"_L1); }
};
 
inline auto collectResponse(const GetDisplayNameJob* job) { return job->displayname(); }
 
//! \brief Set the user's avatar URL.
//!
//! This API sets the given user's avatar URL. You must have permission to
//! set this user's avatar URL, e.g. you need to have their `access_token`.
class QUOTIENT_API SetAvatarUrlJob : public BaseJob {
public:
    //! \param userId
    //!   The user whose avatar URL to set.
    //!
    //! \param avatarUrl
    //!   The new avatar URL for this user.
    explicit SetAvatarUrlJob(const QString& userId, const QUrl& avatarUrl);
};
 
//! \brief Get the user's avatar URL.
//!
//! Get the user's avatar URL. This API may be used to fetch the user's
//! own avatar URL or to query the URL of other users; either locally or
//! on remote homeservers.
class QUOTIENT_API GetAvatarUrlJob : public BaseJob {
public:
    //! \param userId
    //!   The user whose avatar URL to get.
    explicit GetAvatarUrlJob(const QString& userId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetAvatarUrlJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& userId);
 
    // Result properties
 
    //! The user's avatar URL if they have set one, otherwise not present.
    QUrl avatarUrl() const { return loadFromJson<QUrl>("avatar_url"_L1); }
};
 
inline auto collectResponse(const GetAvatarUrlJob* job) { return job->avatarUrl(); }
 
//! \brief Get this user's profile information.
//!
//! Get the combined profile information for this user. This API may be used
//! to fetch the user's own profile information or other users; either
//! locally or on remote homeservers.
class QUOTIENT_API GetUserProfileJob : public BaseJob {
public:
    //! \param userId
    //!   The user whose profile information to get.
    explicit GetUserProfileJob(const QString& userId);
 
    //! \brief Construct a URL without creating a full-fledged job object
    //!
    //! This function can be used when a URL for GetUserProfileJob
    //! is necessary but the job itself isn't.
    static QUrl makeRequestUrl(const HomeserverData& hsData, const QString& userId);
 
    // Result properties
 
    //! The user's avatar URL if they have set one, otherwise not present.
    QUrl avatarUrl() const { return loadFromJson<QUrl>("avatar_url"_L1); }
 
    //! The user's display name if they have set one, otherwise not present.
    QString displayname() const { return loadFromJson<QString>("displayname"_L1); }
 
    struct Response {
        //! The user's avatar URL if they have set one, otherwise not present.
        QUrl avatarUrl{};
 
        //! The user's display name if they have set one, otherwise not present.
        QString displayname{};
    };
};
 
template <std::derived_from<GetUserProfileJob> JobT>
constexpr inline auto doCollectResponse<JobT> =
    [](JobT* j) -> GetUserProfileJob::Response { return { j->avatarUrl(), j->displayname() }; };
 
} // namespace Quotient