aboutsummaryrefslogtreecommitdiff
path: root/lib/room.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2019-07-06 23:08:24 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2019-07-06 23:08:24 +0900
commit717f3bc6c91b14905f222e094e439b4cdcdab2c8 (patch)
treef3e43f5427e8b124b8aec4b6f437017fca65356b /lib/room.h
parenta4d1acb8e9e3f101c891f9089a07e214e5cc55f8 (diff)
parentf58819e4e930ee66e790eccaedf551f807956d72 (diff)
downloadlibquotient-717f3bc6c91b14905f222e094e439b4cdcdab2c8.tar.gz
libquotient-717f3bc6c91b14905f222e094e439b4cdcdab2c8.zip
Merge branch 'master' into e2ee-enc-mng
Diffstat (limited to 'lib/room.h')
-rw-r--r--lib/room.h26
1 files changed, 18 insertions, 8 deletions
diff --git a/lib/room.h b/lib/room.h
index 055da3da..3abf262d 100644
--- a/lib/room.h
+++ b/lib/room.h
@@ -86,7 +86,8 @@ namespace QMatrixClient
Q_PROPERTY(QString predecessorId READ predecessorId NOTIFY baseStateLoaded)
Q_PROPERTY(QString successorId READ successorId NOTIFY upgraded)
Q_PROPERTY(QString name READ name NOTIFY namesChanged)
- Q_PROPERTY(QStringList aliases READ aliases NOTIFY namesChanged)
+ Q_PROPERTY(QStringList localAliases READ localAliases NOTIFY namesChanged)
+ Q_PROPERTY(QStringList remoteAliases READ remoteAliases NOTIFY namesChanged)
Q_PROPERTY(QString canonicalAlias READ canonicalAlias NOTIFY namesChanged)
Q_PROPERTY(QString displayName READ displayName NOTIFY displaynameChanged)
Q_PROPERTY(QString topic READ topic NOTIFY topicChanged)
@@ -156,7 +157,12 @@ namespace QMatrixClient
QString predecessorId() const;
QString successorId() const;
QString name() const;
- QStringList aliases() const;
+ /// Room aliases defined on the current user's server
+ /// \sa remoteAliases, setLocalAliases
+ QStringList localAliases() const;
+ /// Room aliases defined on other servers
+ /// \sa localAliases
+ QStringList remoteAliases() const;
QString canonicalAlias() const;
QString displayName() const;
QString topic() const;
@@ -322,7 +328,7 @@ namespace QMatrixClient
bool hasAccountData(const QString& type) const;
/** Get a generic account data event of the given type
- * This returns a generic hashmap for any room account data event
+ * This returns a generic hash map for any room account data event
* stored on the server. Tags and read markers cannot be retrieved
* using this method _yet_.
*/
@@ -434,9 +440,13 @@ namespace QMatrixClient
const QJsonObject& eventContent);
QString retryMessage(const QString& txnId);
void discardMessage(const QString& txnId);
+
+ /// Send a request to update the room state with the given event
+ SetRoomStateWithKeyJob* setState(const StateEventBase& evt) const;
void setName(const QString& newName);
void setCanonicalAlias(const QString& newAlias);
- void setAliases(const QStringList& aliases);
+ /// Set room aliases on the user's current server
+ void setLocalAliases(const QStringList& aliases);
void setTopic(const QString& newTopic);
/// You shouldn't normally call this method; it's here for debugging
@@ -446,6 +456,7 @@ namespace QMatrixClient
void inviteToRoom(const QString& memberId);
LeaveRoomJob* leaveRoom();
+ /// \deprecated - use setState() instead")
SetRoomStateWithKeyJob* setMemberState(
const QString& memberId, const RoomMemberEvent& event) const;
void kickMember(const QString& memberId, const QString& reason = {});
@@ -516,7 +527,7 @@ namespace QMatrixClient
/** A common signal for various kinds of changes in the room
* Aside from all changes in the room state
- * @param changes a set of flags describing what changes occured
+ * @param changes a set of flags describing what changes occurred
* upon the last sync
* \sa StateChange
*/
@@ -524,7 +535,7 @@ namespace QMatrixClient
/**
* \brief The room name, the canonical alias or other aliases changed
*
- * Not triggered when displayname changes.
+ * Not triggered when display name changes.
*/
void namesChanged(Room* room);
void displaynameAboutToChange(Room* room);
@@ -581,7 +592,7 @@ namespace QMatrixClient
/// The room's version stability may have changed
void stabilityUpdated(QString recommendedDefault,
QStringList stableVersions);
- /// This room has been upgraded and won't receive updates anymore
+ /// This room has been upgraded and won't receive updates any more
void upgraded(QString serverMessage, Room* successor);
/// An attempted room upgrade has failed
void upgradeFailed(QString errorMessage);
@@ -590,7 +601,6 @@ namespace QMatrixClient
void beforeDestruction(Room*);
protected:
- /// Returns true if any of room names/aliases has changed
virtual Changes processStateEvent(const RoomEvent& e);
virtual Changes processEphemeralEvent(EventPtr&& event);
virtual Changes processAccountDataEvent(EventPtr&& event);