File: profile.h

package info (click to toggle)
libquotient 0.9.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,588 kB
  • sloc: xml: 39,103; cpp: 25,226; sh: 97; makefile: 10
file content (125 lines) | stat: -rw-r--r-- 4,549 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// 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