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
126
127
128
129
130
131
132
133
134
|
// SPDX-FileCopyrightText: 2015 Felix Rohrbach <kde@fxrh.de>
// SPDX-FileCopyrightText: 2016 Kitsune Ral <Kitsune-Ral@users.sf.net>
// SPDX-License-Identifier: LGPL-2.1-or-later
#pragma once
#include "avatar.h"
#include "quotient_export.h"
#include <QtCore/QObject>
namespace Quotient {
class Connection;
class Room;
class RoomMemberEvent;
class QUOTIENT_API User : public QObject {
Q_OBJECT
Q_PROPERTY(QString id READ id CONSTANT)
Q_PROPERTY(bool isGuest READ isGuest CONSTANT)
Q_PROPERTY(int hue READ hue CONSTANT)
Q_PROPERTY(qreal hueF READ hueF CONSTANT)
Q_PROPERTY(QString name READ name NOTIFY defaultNameChanged)
Q_PROPERTY(QString displayName READ displayname NOTIFY defaultNameChanged STORED false)
Q_PROPERTY(QString fullName READ fullName NOTIFY defaultNameChanged STORED false)
Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY defaultAvatarChanged STORED false)
Q_PROPERTY(QUrl avatarUrl READ avatarUrl NOTIFY defaultAvatarChanged)
public:
User(QString userId, Connection* connection);
~User() override;
Connection* connection() const;
/** Get unique stable user id
* User id is generated by the server and is not changed ever.
*/
QString id() const;
/** Get the name chosen by the user
* This may be empty if the user didn't choose the name or cleared
* it. If the user is bridged, the bridge postfix (such as '(IRC)')
* is stripped out. No disambiguation for the room is done.
* \sa displayName
*/
QString name(const Room* room = nullptr) const;
/** Get the displayed user name
* When \p room is null, this method returns result of name() if
* the name is non-empty; otherwise it returns user id.
* When \p room is non-null, this call is equivalent to
* Room::roomMembername invocation for the user (i.e. the user's
* disambiguated room-specific name is returned).
* \sa name, id, fullName, Room::roomMembername
*/
QString displayname(const Room* room = nullptr) const;
/** Get user name and id in one string
* The constructed string follows the format 'name (id)'
* which the spec recommends for users disambiguation in
* a room context and in other places.
* \sa displayName, Room::roomMembername
*/
QString fullName(const Room* room = nullptr) const;
/** Whether the user is a guest
* As of now, the function relies on the convention used in Synapse
* that guests and only guests have all-numeric IDs. This may or
* may not work with non-Synapse servers.
*/
bool isGuest() const;
/** Hue color component of this user based on id.
* The implementation is based on XEP-0392:
* https://xmpp.org/extensions/xep-0392.html
* Naming and ranges are the same as QColor's hue methods:
* https://doc.qt.io/qt-5/qcolor.html#integer-vs-floating-point-precision
*/
int hue() const;
qreal hueF() const;
/// Get a reference to a user avatar object for a given room
/*! This reference should be considered short-lived: processing the next
* room member event for this user may (or may not) invalidate it.
*/
const Avatar& avatarObject(const Room* room = nullptr) const;
Q_INVOKABLE QImage avatar(int dimension,
const Quotient::Room* room = nullptr) const;
Q_INVOKABLE QImage avatar(int requestedWidth, int requestedHeight,
const Quotient::Room* room = nullptr) const;
QImage avatar(int width, int height, const Room* room,
const Avatar::get_callback_t& callback) const;
QString avatarMediaId(const Room* room = nullptr) const;
QUrl avatarUrl(const Room* room = nullptr) const;
public Q_SLOTS:
/// Set a new name in the global user profile
void rename(const QString& newName);
/// Set a new name for the user in one room
void rename(const QString& newName, const Room* r);
/// Upload the file and use it as an avatar
bool setAvatar(const QString& fileName);
/// Upload contents of the QIODevice and set that as an avatar
bool setAvatar(QIODevice* source);
/// Removes the avatar from the profile
void removeAvatar();
/// Create or find a direct chat with this user
/*! The resulting chat is returned asynchronously via
* Connection::directChatAvailable()
*/
void requestDirectChat();
/// Add the user to the ignore list
void ignore();
/// Remove the user from the ignore list
void unmarkIgnore();
/// Check whether the user is in ignore list
bool isIgnored() const;
/// Force loading displayName and avartar url. This is required in
/// some cases where the you need to use an user independent of the
/// room.
void load();
Q_SIGNALS:
void defaultNameChanged();
void defaultAvatarChanged();
private:
class Private;
QScopedPointer<Private> d;
template <typename SourceT>
bool doSetAvatar(SourceT&& source);
};
} // namespace Quotient
|
