Update upstream source from tag 'upstream/0.6.4'

Update to upstream version '0.6.4'
with Debian dir aa8705fd74743e79c043bc9e3e425d5064404cfe

1 files changed, 719 insertions, 603 deletions

diff --git a/lib/room.h b/lib/room.h
index 87ff3b5d..1ddff517 100644
--- a/lib/room.h
+++ b/lib/room.h
@@ -13,626 +13,742 @@
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
 #pragma once
 
-#include "csapi/message_pagination.h"
-#include "events/roommessageevent.h"
-#include "events/accountdataevents.h"
+#include "connection.h"
 #include "eventitem.h"
 #include "joinstate.h"
 
+#include "csapi/message_pagination.h"
+
+#include "events/accountdataevents.h"
+#include "events/encryptedevent.h"
+#include "events/roomkeyevent.h"
+#include "events/roommessageevent.h"
+#include "events/roomcreateevent.h"
+#include "events/roomtombstoneevent.h"
+
+#include <QtCore/QJsonObject>
 #include <QtGui/QImage>
 
-#include <memory>
 #include <deque>
+#include <memory>
 #include <utility>
 
-namespace QMatrixClient
-{
-    class Event;
-    class Avatar;
-    class SyncRoomData;
-    class RoomMemberEvent;
-    class Connection;
-    class User;
-    class MemberSorter;
-    class LeaveRoomJob;
-    class SetRoomStateWithKeyJob;
-    class RedactEventJob;
-
-    /** The data structure used to expose file transfer information to views
+namespace Quotient {
+class Event;
+class Avatar;
+class SyncRoomData;
+class RoomMemberEvent;
+class User;
+class MemberSorter;
+class LeaveRoomJob;
+class SetRoomStateWithKeyJob;
+class RedactEventJob;
+
+/** The data structure used to expose file transfer information to views
+ *
+ * This is specifically tuned to work with QML exposing all traits as
+ * Q_PROPERTY values.
+ */
+class FileTransferInfo {
+    Q_GADGET
+    Q_PROPERTY(bool isUpload MEMBER isUpload CONSTANT)
+    Q_PROPERTY(bool active READ active CONSTANT)
+    Q_PROPERTY(bool started READ started CONSTANT)
+    Q_PROPERTY(bool completed READ completed CONSTANT)
+    Q_PROPERTY(bool failed READ failed CONSTANT)
+    Q_PROPERTY(int progress MEMBER progress CONSTANT)
+    Q_PROPERTY(int total MEMBER total CONSTANT)
+    Q_PROPERTY(QUrl localDir MEMBER localDir CONSTANT)
+    Q_PROPERTY(QUrl localPath MEMBER localPath CONSTANT)
+public:
+    enum Status { None, Started, Completed, Failed, Cancelled };
+    Status status = None;
+    bool isUpload = false;
+    int progress = 0;
+    int total = -1;
+    QUrl localDir {};
+    QUrl localPath {};
+
+    bool started() const { return status == Started; }
+    bool completed() const { return status == Completed; }
+    bool active() const { return started() || completed(); }
+    bool failed() const { return status == Failed; }
+};
+
+class Room : public QObject {
+    Q_OBJECT
+    Q_PROPERTY(Connection* connection READ connection CONSTANT)
+    Q_PROPERTY(User* localUser READ localUser CONSTANT)
+    Q_PROPERTY(QString id READ id CONSTANT)
+    Q_PROPERTY(QString version READ version NOTIFY baseStateLoaded)
+    Q_PROPERTY(bool isUnstable READ isUnstable NOTIFY stabilityUpdated)
+    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 altAliases READ altAliases 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)
+    Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY avatarChanged
+                   STORED false)
+    Q_PROPERTY(QUrl avatarUrl READ avatarUrl NOTIFY avatarChanged)
+    Q_PROPERTY(bool usesEncryption READ usesEncryption NOTIFY encryption)
+
+    Q_PROPERTY(int timelineSize READ timelineSize NOTIFY addedMessages)
+    Q_PROPERTY(QStringList memberNames READ memberNames NOTIFY memberListChanged)
+    Q_PROPERTY(int memberCount READ memberCount NOTIFY memberListChanged)
+    Q_PROPERTY(int joinedCount READ joinedCount NOTIFY memberListChanged)
+    Q_PROPERTY(int invitedCount READ invitedCount NOTIFY memberListChanged)
+    Q_PROPERTY(int totalMemberCount READ totalMemberCount NOTIFY memberListChanged)
+
+    Q_PROPERTY(bool displayed READ displayed WRITE setDisplayed NOTIFY
+                   displayedChanged)
+    Q_PROPERTY(QString firstDisplayedEventId READ firstDisplayedEventId WRITE
+                   setFirstDisplayedEventId NOTIFY firstDisplayedEventChanged)
+    Q_PROPERTY(QString lastDisplayedEventId READ lastDisplayedEventId WRITE
+                   setLastDisplayedEventId NOTIFY lastDisplayedEventChanged)
+
+    Q_PROPERTY(QString readMarkerEventId READ readMarkerEventId WRITE
+                   markMessagesAsRead NOTIFY readMarkerMoved)
+    Q_PROPERTY(bool hasUnreadMessages READ hasUnreadMessages NOTIFY
+                   unreadMessagesChanged)
+    Q_PROPERTY(int unreadCount READ unreadCount NOTIFY unreadMessagesChanged)
+    Q_PROPERTY(int highlightCount READ highlightCount NOTIFY
+                   highlightCountChanged RESET resetHighlightCount)
+    Q_PROPERTY(int notificationCount READ notificationCount NOTIFY
+                   notificationCountChanged RESET resetNotificationCount)
+    Q_PROPERTY(bool allHistoryLoaded READ allHistoryLoaded NOTIFY addedMessages
+                   STORED false)
+    Q_PROPERTY(QStringList tagNames READ tagNames NOTIFY tagsChanged)
+    Q_PROPERTY(bool isFavourite READ isFavourite NOTIFY tagsChanged)
+    Q_PROPERTY(bool isLowPriority READ isLowPriority NOTIFY tagsChanged)
+
+    Q_PROPERTY(GetRoomEventsJob* eventsHistoryJob READ eventsHistoryJob NOTIFY
+                   eventsHistoryJobChanged)
+
+public:
+    using Timeline = std::deque<TimelineItem>;
+    using PendingEvents = std::vector<PendingEventItem>;
+    using RelatedEvents = QVector<const RoomEvent*>;
+    using rev_iter_t = Timeline::const_reverse_iterator;
+    using timeline_iter_t = Timeline::const_iterator;
+
+    enum Change : uint {
+        NoChange = 0x0,
+        NameChange = 0x1,
+        AliasesChange = 0x2,
+        CanonicalAliasChange = AliasesChange,
+        TopicChange = 0x4,
+        UnreadNotifsChange = 0x8,
+        AvatarChange = 0x10,
+        JoinStateChange = 0x20,
+        TagsChange = 0x40,
+        MembersChange = 0x80,
+        /* = 0x100, */
+        AccountDataChange = 0x200,
+        SummaryChange = 0x400,
+        ReadMarkerChange = 0x800,
+        OtherChange = 0x8000,
+        AnyChange = 0xFFFF
+    };
+    Q_DECLARE_FLAGS(Changes, Change)
+    Q_FLAG(Changes)
+
+    Room(Connection* connection, QString id, JoinState initialJoinState);
+    ~Room() override;
+
+    // Property accessors
+
+    Connection* connection() const;
+    User* localUser() const;
+    const QString& id() const;
+    QString version() const;
+    bool isUnstable() const;
+    QString predecessorId() const;
+    /// Room predecessor
+    /** This function validates that the predecessor has a tombstone and
+     * the tombstone refers to the current room. If that's not the case,
+     * or if the predecessor is in a join state not matching \p stateFilter,
+     * the function returns nullptr.
+     */
+    Room* predecessor(JoinStates statesFilter = JoinState::Invite
+                                                | JoinState::Join) const;
+    QString successorId() const;
+    /// Room successor
+    /** This function validates that the successor room's creation event
+     * refers to the current room. If that's not the case, or if the successor
+     * is in a join state not matching \p stateFilter, it returns nullptr.
+     */
+    Room* successor(JoinStates statesFilter = JoinState::Invite
+                                              | JoinState::Join) const;
+    QString name() const;
+    /// Room aliases defined on the current user's server
+    /// \sa remoteAliases, setLocalAliases
+    [[deprecated("Use aliases()")]]
+    QStringList localAliases() const;
+    /// Room aliases defined on other servers
+    /// \sa localAliases
+    [[deprecated("Use aliases()")]]
+    QStringList remoteAliases() const;
+    QString canonicalAlias() const;
+    QStringList altAliases() const;
+    QStringList aliases() const;
+    QString displayName() const;
+    QString topic() const;
+    QString avatarMediaId() const;
+    QUrl avatarUrl() const;
+    const Avatar& avatarObject() const;
+    Q_INVOKABLE JoinState joinState() const;
+    Q_INVOKABLE QList<Quotient::User*> usersTyping() const;
+    QList<User*> membersLeft() const;
+
+    Q_INVOKABLE QList<Quotient::User*> users() const;
+    QStringList memberNames() const;
+    [[deprecated("Use joinedCount(), invitedCount(), totalMemberCount()")]]
+    int memberCount() const;
+    int timelineSize() const;
+    bool usesEncryption() const;
+    RoomEventPtr decryptMessage(const EncryptedEvent& encryptedEvent);
+    void handleRoomKeyEvent(const RoomKeyEvent& roomKeyEvent, const QString& senderKey);
+    int joinedCount() const;
+    int invitedCount() const;
+    int totalMemberCount() const;
+
+    GetRoomEventsJob* eventsHistoryJob() const;
+
+    /**
+     * Returns a square room avatar with the given size and requests it
+     * from the network if needed
+     * \return a pixmap with the avatar or a placeholder if there's none
+     * available yet
+     */
+    Q_INVOKABLE QImage avatar(int dimension);
+    /**
+     * Returns a room avatar with the given dimensions and requests it
+     * from the network if needed
+     * \return a pixmap with the avatar or a placeholder if there's none
+     * available yet
+     */
+    Q_INVOKABLE QImage avatar(int width, int height);
+
+    /**
+     * \brief Get a user object for a given user id
+     * This is the recommended way to get a user object in a room
+     * context. The actual object type may be changed in further
+     * versions to provide room-specific user information (display name,
+     * avatar etc.).
+     * \note The method will return a valid user regardless of
+     *       the membership.
+     */
+    Q_INVOKABLE Quotient::User* user(const QString& userId) const;
+
+    /**
+     * \brief Check the join state of a given user in this room
      *
-     * This is specifically tuned to work with QML exposing all traits as
-     * Q_PROPERTY values.
+     * \note Banned and invited users are not tracked for now (Leave
+     *       will be returned for them).
+     *
+     * \return Join if the user is a room member; Leave otherwise
      */
-    class FileTransferInfo
-    {
-            Q_GADGET
-            Q_PROPERTY(bool isUpload MEMBER isUpload CONSTANT)
-            Q_PROPERTY(bool active READ active CONSTANT)
-            Q_PROPERTY(bool started READ started CONSTANT)
-            Q_PROPERTY(bool completed READ completed CONSTANT)
-            Q_PROPERTY(bool failed READ failed CONSTANT)
-            Q_PROPERTY(int progress MEMBER progress CONSTANT)
-            Q_PROPERTY(int total MEMBER total CONSTANT)
-            Q_PROPERTY(QUrl localDir MEMBER localDir CONSTANT)
-            Q_PROPERTY(QUrl localPath MEMBER localPath CONSTANT)
-        public:
-            enum Status { None, Started, Completed, Failed, Cancelled };
-            Status status = None;
-            bool isUpload = false;
-            int progress = 0;
-            int total = -1;
-            QUrl localDir { };
-            QUrl localPath { };
-
-            bool started() const { return status == Started; }
-            bool completed() const { return status == Completed; }
-            bool active() const { return started() || completed(); }
-            bool failed() const { return status == Failed; }
-    };
+    Q_INVOKABLE Quotient::JoinState memberJoinState(Quotient::User* user) const;
 
-    class Room: public QObject
-    {
-            Q_OBJECT
-            Q_PROPERTY(Connection* connection READ connection CONSTANT)
-            Q_PROPERTY(User* localUser READ localUser CONSTANT)
-            Q_PROPERTY(QString id READ id CONSTANT)
-            Q_PROPERTY(QString version READ version NOTIFY baseStateLoaded)
-            Q_PROPERTY(bool isUnstable READ isUnstable NOTIFY stabilityUpdated)
-            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(QString canonicalAlias READ canonicalAlias NOTIFY namesChanged)
-            Q_PROPERTY(QString displayName READ displayName NOTIFY displaynameChanged)
-            Q_PROPERTY(QString topic READ topic NOTIFY topicChanged)
-            Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY avatarChanged STORED false)
-            Q_PROPERTY(QUrl avatarUrl READ avatarUrl NOTIFY avatarChanged)
-            Q_PROPERTY(bool usesEncryption READ usesEncryption NOTIFY encryption)
-
-            Q_PROPERTY(int timelineSize READ timelineSize NOTIFY addedMessages)
-            Q_PROPERTY(QStringList memberNames READ memberNames NOTIFY memberListChanged)
-            Q_PROPERTY(int memberCount READ memberCount NOTIFY memberListChanged)
-            Q_PROPERTY(int joinedCount READ joinedCount NOTIFY memberListChanged)
-            Q_PROPERTY(int invitedCount READ invitedCount NOTIFY memberListChanged)
-            Q_PROPERTY(int totalMemberCount READ totalMemberCount NOTIFY memberListChanged)
-
-            Q_PROPERTY(bool displayed READ displayed WRITE setDisplayed NOTIFY displayedChanged)
-            Q_PROPERTY(QString firstDisplayedEventId READ firstDisplayedEventId WRITE setFirstDisplayedEventId NOTIFY firstDisplayedEventChanged)
-            Q_PROPERTY(QString lastDisplayedEventId READ lastDisplayedEventId WRITE setLastDisplayedEventId NOTIFY lastDisplayedEventChanged)
-
-            Q_PROPERTY(QString readMarkerEventId READ readMarkerEventId WRITE markMessagesAsRead NOTIFY readMarkerMoved)
-            Q_PROPERTY(bool hasUnreadMessages READ hasUnreadMessages NOTIFY unreadMessagesChanged)
-            Q_PROPERTY(int unreadCount READ unreadCount NOTIFY unreadMessagesChanged)
-            Q_PROPERTY(QStringList tagNames READ tagNames NOTIFY tagsChanged)
-            Q_PROPERTY(bool isFavourite READ isFavourite NOTIFY tagsChanged)
-            Q_PROPERTY(bool isLowPriority READ isLowPriority NOTIFY tagsChanged)
-
-            Q_PROPERTY(GetRoomEventsJob* eventsHistoryJob READ eventsHistoryJob NOTIFY eventsHistoryJobChanged)
-
-        public:
-            using Timeline = std::deque<TimelineItem>;
-            using PendingEvents = std::vector<PendingEventItem>;
-            using RelatedEvents = QVector<const RoomEvent*>;
-            using rev_iter_t = Timeline::const_reverse_iterator;
-            using timeline_iter_t = Timeline::const_iterator;
-
-            enum Change : uint {
-                NoChange = 0x0,
-                NameChange = 0x1,
-                CanonicalAliasChange = 0x2,
-                TopicChange = 0x4,
-                UnreadNotifsChange = 0x8,
-                AvatarChange = 0x10,
-                JoinStateChange = 0x20,
-                TagsChange = 0x40,
-                MembersChange = 0x80,
-                /* = 0x100, */
-                AccountDataChange = 0x200,
-                SummaryChange = 0x400,
-                ReadMarkerChange = 0x800,
-                OtherChange = 0x8000,
-                AnyChange = 0xFFFF
-            };
-            Q_DECLARE_FLAGS(Changes, Change)
-            Q_FLAG(Changes)
-
-            Room(Connection* connection, QString id, JoinState initialJoinState);
-            ~Room() override;
-
-            // Property accessors
-
-            Connection* connection() const;
-            User* localUser() const;
-            const QString& id() const;
-            QString version() const;
-            bool isUnstable() const;
-            QString predecessorId() const;
-            QString successorId() const;
-            QString name() const;
-            QStringList aliases() const;
-            QStringList altAliases() const;
-            QString canonicalAlias() const;
-            QString displayName() const;
-            QString topic() const;
-            QString avatarMediaId() const;
-            QUrl avatarUrl() const;
-            const Avatar& avatarObject() const;
-            Q_INVOKABLE JoinState joinState() const;
-            Q_INVOKABLE QList<User*> usersTyping() const;
-            QList<User*> membersLeft() const;
-
-            Q_INVOKABLE QList<User*> users() const;
-            QStringList memberNames() const;
-            [[deprecated("Use joinedCount(), invitedCount(), totalMemberCount()")]]
-            int memberCount() const;
-            int timelineSize() const;
-            bool usesEncryption() const;
-            int joinedCount() const;
-            int invitedCount() const;
-            int totalMemberCount() const;
-
-            GetRoomEventsJob* eventsHistoryJob() const;
-
-            /**
-             * Returns a square room avatar with the given size and requests it
-             * from the network if needed
-             * \return a pixmap with the avatar or a placeholder if there's none
-             * available yet
-             */
-            Q_INVOKABLE QImage avatar(int dimension);
-            /**
-             * Returns a room avatar with the given dimensions and requests it
-             * from the network if needed
-             * \return a pixmap with the avatar or a placeholder if there's none
-             * available yet
-             */
-            Q_INVOKABLE QImage avatar(int width, int height);
-
-            /**
-             * \brief Get a user object for a given user id
-             * This is the recommended way to get a user object in a room
-             * context. The actual object type may be changed in further
-             * versions to provide room-specific user information (display name,
-             * avatar etc.).
-             * \note The method will return a valid user regardless of
-             *       the membership.
-             */
-            Q_INVOKABLE User* user(const QString& userId) const;
-
-            /**
-             * \brief Check the join state of a given user in this room
-             *
-             * \note Banned and invited users are not tracked for now (Leave
-             *       will be returned for them).
-             *
-             * \return either of Join, Leave, depending on the given
-             *         user's state in the room
-             */
-            Q_INVOKABLE JoinState memberJoinState(User* user) const;
-
-            /**
-             * Get a disambiguated name for a given user in
-             * the context of the room
-             */
-            Q_INVOKABLE QString roomMembername(const User* u) const;
-            /**
-             * Get a disambiguated name for a user with this id in
-             * the context of the room
-             */
-            Q_INVOKABLE QString roomMembername(const QString& userId) const;
-
-            const Timeline& messageEvents() const;
-            const PendingEvents& pendingEvents() const;
-            /**
-             * A convenience method returning the read marker to the position
-             * before the "oldest" event; same as messageEvents().crend()
-             */
-            rev_iter_t historyEdge() const;
-            /**
-             * A convenience method returning the iterator beyond the latest
-             * arrived event; same as messageEvents().cend()
-             */
-            Timeline::const_iterator syncEdge() const;
-            /// \deprecated Use historyEdge instead
-            rev_iter_t timelineEdge() const;
-            Q_INVOKABLE TimelineItem::index_t minTimelineIndex() const;
-            Q_INVOKABLE TimelineItem::index_t maxTimelineIndex() const;
-            Q_INVOKABLE bool isValidIndex(TimelineItem::index_t timelineIndex) const;
-
-            rev_iter_t findInTimeline(TimelineItem::index_t index) const;
-            rev_iter_t findInTimeline(const QString& evtId) const;
-            PendingEvents::iterator findPendingEvent(const QString & txnId);
-            PendingEvents::const_iterator findPendingEvent(const QString & txnId) const;
-
-            const RelatedEvents relatedEvents(const QString& evtId,
-                                              const char* relType) const;
-            const RelatedEvents relatedEvents(const RoomEvent& evt,
-                                              const char* relType) const;
-
-            bool displayed() const;
-            /// Mark the room as currently displayed to the user
-            /**
-             * Marking the room displayed causes the room to obtain the full
-             * list of members if it's been lazy-loaded before; in the future
-             * it may do more things bound to "screen time" of the room, e.g.
-             * measure that "screen time".
-             */
-            void setDisplayed(bool displayed = true);
-            QString firstDisplayedEventId() const;
-            rev_iter_t firstDisplayedMarker() const;
-            void setFirstDisplayedEventId(const QString& eventId);
-            void setFirstDisplayedEvent(TimelineItem::index_t index);
-            QString lastDisplayedEventId() const;
-            rev_iter_t lastDisplayedMarker() const;
-            void setLastDisplayedEventId(const QString& eventId);
-            void setLastDisplayedEvent(TimelineItem::index_t index);
-
-            rev_iter_t readMarker(const User* user) const;
-            rev_iter_t readMarker() const;
-            QString readMarkerEventId() const;
-            QList<User*> usersAtEventId(const QString& eventId);
-            /**
-             * \brief Mark the event with uptoEventId as read
-             *
-             * Finds in the timeline and marks as read the event with
-             * the specified id; also posts a read receipt to the server either
-             * for this message or, if it's from the local user, for
-             * the nearest non-local message before. uptoEventId must be non-empty.
-             */
-            void markMessagesAsRead(QString uptoEventId);
-
-            /// Check whether there are unread messages in the room
-            bool hasUnreadMessages() const;
-
-            /** Get the number of unread messages in the room
-             * Depending on the read marker state, this call may return either
-             * a precise or an estimate number of unread events. Only "notable"
-             * events (non-redacted message events from users other than local)
-             * are counted.
-             *
-             * In a case when readMarker() == timelineEdge() (the local read
-             * marker is beyond the local timeline) only the bottom limit of
-             * the unread messages number can be estimated (and even that may
-             * be slightly off due to, e.g., redactions of events not loaded
-             * to the local timeline).
-             *
-             * If all messages are read, this function will return -1 (_not_ 0,
-             * as zero may mean "zero or more unread messages" in a situation
-             * when the read marker is outside the local timeline.
-             */
-            int unreadCount() const;
-
-            Q_INVOKABLE int notificationCount() const;
-            Q_INVOKABLE void resetNotificationCount();
-            Q_INVOKABLE int highlightCount() const;
-            Q_INVOKABLE void resetHighlightCount();
-
-            /** Check whether the room has account data of the given type
-             * Tags and read markers are not supported by this method _yet_.
-             */
-            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
-             * stored on the server. Tags and read markers cannot be retrieved
-             * using this method _yet_.
-             */
-            const EventPtr& accountData(const QString& type) const;
-
-            QStringList tagNames() const;
-            TagsMap tags() const;
-            TagRecord tag(const QString& name) const;
-
-            /** Add a new tag to this room
-             * If this room already has this tag, nothing happens. If it's a new
-             * tag for the room, the respective tag record is added to the set
-             * of tags and the new set is sent to the server to update other
-             * clients.
-             */
-            void addTag(const QString& name, const TagRecord& record = {});
-            Q_INVOKABLE void addTag(const QString& name, float order);
-
-            /// Remove a tag from the room
-            Q_INVOKABLE void removeTag(const QString& name);
-
-            /** Overwrite the room's tags
-             * This completely replaces the existing room's tags with a set
-             * of new ones and updates the new set on the server. Unlike
-             * most other methods in Room, this one sends a signal about changes
-             * immediately, not waiting for confirmation from the server
-             * (because tags are saved in account data rather than in shared
-             * room state).
-             */
-            void setTags(TagsMap newTags);
-
-            /// Check whether the list of tags has m.favourite
-            bool isFavourite() const;
-            /// Check whether the list of tags has m.lowpriority
-            bool isLowPriority() const;
-            /// Check whether this room is for server notices (MSC1452)
-            bool isServerNoticeRoom() const;
-
-            /// Check whether this room is a direct chat
-            Q_INVOKABLE bool isDirectChat() const;
-
-            /// Get the list of users this room is a direct chat with
-            QList<User*> directChatUsers() const;
-
-            Q_INVOKABLE QUrl urlToThumbnail(const QString& eventId) const;
-            Q_INVOKABLE QUrl urlToDownload(const QString& eventId) const;
-
-            /// Get a file name for downloading for a given event id
-            /*!
-             * The event MUST be RoomMessageEvent and have content
-             * for downloading. \sa RoomMessageEvent::hasContent
-             */
-            Q_INVOKABLE QString fileNameToDownload(const QString& eventId) const;
-
-            /// Get information on file upload/download
-            /*!
-             * \param id uploads are identified by the corresponding event's
-             *           transactionId (because uploads are done before
-             *           the event is even sent), while downloads are using
-             *           the normal event id for identifier.
-             */
-            Q_INVOKABLE FileTransferInfo fileTransferInfo(const QString& id) const;
-
-            /// Get the URL to the actual file source in a unified way
-            /*!
-             * For uploads it will return a URL to a local file; for downloads
-             * the URL will be taken from the corresponding room event.
-             */
-            Q_INVOKABLE QUrl fileSource(const QString& id) const;
-
-            /** Pretty-prints plain text into HTML
-             * As of now, it's exactly the same as QMatrixClient::prettyPrint();
-             * in the future, it will also linkify room aliases, mxids etc.
-             * using the room context.
-             */
-            QString prettyPrint(const QString& plainText) const;
-
-            MemberSorter memberSorter() const;
-
-            Q_INVOKABLE void inviteCall(const QString& callId,
-                                        const int lifetime, const QString& sdp);
-            Q_INVOKABLE void sendCallCandidates(const QString& callId,
-                                            const QJsonArray& candidates);
-            Q_INVOKABLE void answerCall(const QString& callId, const int lifetime,
-                                        const QString& sdp);
-            Q_INVOKABLE void answerCall(const QString& callId,
-                                        const QString& sdp);
-            Q_INVOKABLE void hangupCall(const QString& callId);
-            Q_INVOKABLE bool supportsCalls() const;
-
-        public slots:
-            /** Check whether the room should be upgraded */
-            void checkVersion();
-
-            QString postMessage(const QString& plainText, MessageEventType type);
-            QString postPlainText(const QString& plainText);
-            QString postHtmlMessage(const QString& plainText,
-                        const QString& html,
-                        MessageEventType type = MessageEventType::Text);
-            QString postHtmlText(const QString& plainText, const QString& html);
-            /** Send a reaction on a given event with a given key */
-            QString postReaction(const QString& eventId, const QString& key);
-
-            QString postFile(const QString& plainText, const QUrl& localPath,
-                             bool asGenericFile = false);
-            /** Post a pre-created room message event
-             *
-             * Takes ownership of the event, deleting it once the matching one
-             * arrives with the sync
-             * \return transaction id associated with the event.
-             */
-            QString postEvent(RoomEvent* event);
-            QString postJson(const QString& matrixType,
-                             const QJsonObject& eventContent);
-            QString retryMessage(const QString& txnId);
-            void discardMessage(const QString& txnId);
-            void setName(const QString& newName);
-            void setCanonicalAlias(const QString& newAlias);
-            void setAliases(const QStringList& aliases);
-            void setTopic(const QString& newTopic);
-
-            /// You shouldn't normally call this method; it's here for debugging
-            void refreshDisplayName();
-
-            void getPreviousContent(int limit = 10);
-
-            void inviteToRoom(const QString& memberId);
-            LeaveRoomJob* leaveRoom();
-            SetRoomStateWithKeyJob* setMemberState(
-                    const QString& memberId, const RoomMemberEvent& event) const;
-            void kickMember(const QString& memberId, const QString& reason = {});
-            void ban(const QString& userId, const QString& reason = {});
-            void unban(const QString& userId);
-            void redactEvent(const QString& eventId,
-                             const QString& reason = {});
-
-            void uploadFile(const QString& id, const QUrl& localFilename,
-                            const QString& overrideContentType = {});
-            // If localFilename is empty a temporary file is created
-            void downloadFile(const QString& eventId,
-                              const QUrl& localFilename = {});
-            void cancelFileTransfer(const QString& id);
-
-            /// Mark all messages in the room as read
-            void markAllMessagesAsRead();
-
-            /// Whether the current user is allowed to upgrade the room
-            bool canSwitchVersions() const;
-
-            /// Switch the room's version (aka upgrade)
-            void switchVersion(QString newVersion);
-
-        signals:
-            /// Initial set of state events has been loaded
-            /**
-             * The initial set is what comes from the initial sync for the room.
-             * This includes all basic things like RoomCreateEvent,
-             * RoomNameEvent, a (lazy-loaded, not full) set of RoomMemberEvents
-             * etc. This is a per-room reflection of Connection::loadedRoomState
-             * \sa Connection::loadedRoomState
-             */
-            void baseStateLoaded();
-            void eventsHistoryJobChanged();
-            void aboutToAddHistoricalMessages(RoomEventsRange events);
-            void aboutToAddNewMessages(RoomEventsRange events);
-            void addedMessages(int fromIndex, int toIndex);
-            /// The event is about to be appended to the list of pending events
-            void pendingEventAboutToAdd(RoomEvent* event);
-            /// An event has been appended to the list of pending events
-            void pendingEventAdded();
-            /// The remote echo has arrived with the sync and will be merged
-            /// with its local counterpart
-            /** NB: Requires a sync loop to be emitted */
-            void pendingEventAboutToMerge(RoomEvent* serverEvent,
-                                          int pendingEventIndex);
-            /// The remote and local copies of the event have been merged
-            /** NB: Requires a sync loop to be emitted */
-            void pendingEventMerged();
-            /// An event will be removed from the list of pending events
-            void pendingEventAboutToDiscard(int pendingEventIndex);
-            /// An event has just been removed from the list of pending events
-            void pendingEventDiscarded();
-            /// The status of a pending event has changed
-            /** \sa PendingEventItem::deliveryStatus */
-            void pendingEventChanged(int pendingEventIndex);
-            /// The server accepted the message
-            /** This is emitted when an event sending request has successfully
-             * completed. This does not mean that the event is already in the
-             * local timeline, only that the server has accepted it.
-             * \param txnId transaction id assigned by the client during sending
-             * \param eventId event id assigned by the server upon acceptance
-             * \sa postEvent, postPlainText, postMessage, postHtmlMessage
-             * \sa pendingEventMerged, aboutToAddNewMessages
-             */
-            void messageSent(QString txnId, QString eventId);
-
-            /** 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
-             *                upon the last sync
-             * \sa StateChange
-             */
-            void changed(Changes changes);
-            /**
-             * \brief The room name, the canonical alias or other aliases changed
-             *
-             * Not triggered when displayname changes.
-             */
-            void namesChanged(Room* room);
-            void displaynameAboutToChange(Room* room);
-            void displaynameChanged(Room* room, QString oldName);
-            void topicChanged();
-            void avatarChanged();
-            void userAdded(User* user);
-            void userRemoved(User* user);
-            void memberAboutToRename(User* user, QString newName);
-            void memberRenamed(User* user);
-            /// The list of members has changed
-            /** Emitted no more than once per sync, this is a good signal to
-             * for cases when some action should be done upon any change in
-             * the member list. If you need per-item granularity you should use
-             * userAdded, userRemoved and memberAboutToRename / memberRenamed
-             * instead.
-             */
-            void memberListChanged();
-            /// The previously lazy-loaded members list is now loaded entirely
-            /// \sa setDisplayed
-            void allMembersLoaded();
-            void encryption();
-
-            void joinStateChanged(JoinState oldState, JoinState newState);
-            void typingChanged();
-
-            void highlightCountChanged(Room* room);
-            void notificationCountChanged(Room* room);
-
-            void displayedChanged(bool displayed);
-            void firstDisplayedEventChanged();
-            void lastDisplayedEventChanged();
-            void lastReadEventChanged(User* user);
-            void readMarkerMoved(QString fromEventId, QString toEventId);
-            void readMarkerForUserMoved(User* user, QString fromEventId, QString toEventId);
-            void unreadMessagesChanged(Room* room);
-
-            void accountDataAboutToChange(QString type);
-            void accountDataChanged(QString type);
-            void tagsAboutToChange();
-            void tagsChanged();
-
-            void updatedEvent(QString eventId);
-            void replacedEvent(const RoomEvent* newEvent,
-                               const RoomEvent* oldEvent);
-
-            void newFileTransfer(QString id, QUrl localFile);
-            void fileTransferProgress(QString id, qint64 progress, qint64 total);
-            void fileTransferCompleted(QString id, QUrl localFile, QUrl mxcUrl);
-            void fileTransferFailed(QString id, QString errorMessage = {});
-            void fileTransferCancelled(QString id);
-
-            void callEvent(Room* room, const RoomEvent* event);
-
-            /// 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
-            void upgraded(QString serverMessage, Room* successor);
-            /// An attempted room upgrade has failed
-            void upgradeFailed(QString errorMessage);
-
-            /// The room is about to be deleted
-            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);
-            virtual void onAddNewTimelineEvents(timeline_iter_t /*from*/) { }
-            virtual void onAddHistoricalTimelineEvents(rev_iter_t /*from*/) { }
-            virtual void onRedaction(const RoomEvent& /*prevEvent*/,
-                                     const RoomEvent& /*after*/) { }
-            virtual QJsonObject toJson() const;
-            virtual void updateData(SyncRoomData&& data, bool fromCache = false);
-
-        private:
-            friend class Connection;
-
-            class Private;
-            Private* d;
-
-            // This is called from Connection, reflecting a state change that
-            // arrived from the server. Clients should use
-            // Connection::joinRoom() and Room::leaveRoom() to change the state.
-            void setJoinState(JoinState state);
-    };
+    /**
+     * Get a disambiguated name for a given user in
+     * the context of the room
+     */
+    Q_INVOKABLE QString roomMembername(const Quotient::User* u) const;
+    /**
+     * Get a disambiguated name for a user with this id in
+     * the context of the room
+     */
+    Q_INVOKABLE QString roomMembername(const QString& userId) const;
 
-    class MemberSorter
-    {
-        public:
-            explicit MemberSorter(const Room* r) : room(r) { }
+    /** Get a display-safe member name in the context of this room
+     *
+     * Display-safe means HTML-safe + without RLO/LRO markers
+     * (see https://github.com/quotient-im/Quaternion/issues/545).
+     */
+    Q_INVOKABLE QString safeMemberName(const QString& userId) const;
 
-            bool operator()(User* u1, User* u2) const;
-            bool operator()(User* u1, const QString& u2name) const;
+    const Timeline& messageEvents() const;
+    const PendingEvents& pendingEvents() const;
 
-            template <typename ContT, typename ValT>
-            typename ContT::size_type lowerBoundIndex(const ContT& c,
-                                                      const ValT& v) const
-            {
-                return std::lower_bound(c.begin(), c.end(), v, *this) - c.begin();
-            }
+    /// Check whether all historical messages are already loaded
+    /**
+     * \return true if the "oldest" event in the timeline is
+     *         a room creation event and there's no further history
+     *         to load; false otherwise
+     */
+    bool allHistoryLoaded() const;
+    /**
+     * A convenience method returning the read marker to the position
+     * before the "oldest" event; same as messageEvents().crend()
+     */
+    rev_iter_t historyEdge() const;
+    /**
+     * A convenience method returning the iterator beyond the latest
+     * arrived event; same as messageEvents().cend()
+     */
+    Timeline::const_iterator syncEdge() const;
+    /// \deprecated Use historyEdge instead
+    rev_iter_t timelineEdge() const;
+    Q_INVOKABLE Quotient::TimelineItem::index_t minTimelineIndex() const;
+    Q_INVOKABLE Quotient::TimelineItem::index_t maxTimelineIndex() const;
+    Q_INVOKABLE bool
+    isValidIndex(Quotient::TimelineItem::index_t timelineIndex) const;
+
+    rev_iter_t findInTimeline(TimelineItem::index_t index) const;
+    rev_iter_t findInTimeline(const QString& evtId) const;
+    PendingEvents::iterator findPendingEvent(const QString& txnId);
+    PendingEvents::const_iterator findPendingEvent(const QString& txnId) const;
+
+    const RelatedEvents relatedEvents(const QString& evtId,
+                                      const char* relType) const;
+    const RelatedEvents relatedEvents(const RoomEvent& evt,
+                                      const char* relType) const;
+
+    const RoomCreateEvent* creation() const
+    { return getCurrentState<RoomCreateEvent>(); }
+    const RoomTombstoneEvent* tombstone() const
+    { return getCurrentState<RoomTombstoneEvent>(); }
+
+    bool displayed() const;
+    /// Mark the room as currently displayed to the user
+    /**
+     * Marking the room displayed causes the room to obtain the full
+     * list of members if it's been lazy-loaded before; in the future
+     * it may do more things bound to "screen time" of the room, e.g.
+     * measure that "screen time".
+     */
+    void setDisplayed(bool displayed = true);
+    QString firstDisplayedEventId() const;
+    rev_iter_t firstDisplayedMarker() const;
+    void setFirstDisplayedEventId(const QString& eventId);
+    void setFirstDisplayedEvent(TimelineItem::index_t index);
+    QString lastDisplayedEventId() const;
+    rev_iter_t lastDisplayedMarker() const;
+    void setLastDisplayedEventId(const QString& eventId);
+    void setLastDisplayedEvent(TimelineItem::index_t index);
+
+    rev_iter_t readMarker(const User* user) const;
+    rev_iter_t readMarker() const;
+    QString readMarkerEventId() const;
+    QList<User*> usersAtEventId(const QString& eventId);
+    /**
+     * \brief Mark the event with uptoEventId as read
+     *
+     * Finds in the timeline and marks as read the event with
+     * the specified id; also posts a read receipt to the server either
+     * for this message or, if it's from the local user, for
+     * the nearest non-local message before. uptoEventId must be non-empty.
+     */
+    void markMessagesAsRead(QString uptoEventId);
+
+    /// Check whether there are unread messages in the room
+    bool hasUnreadMessages() const;
+
+    /** Get the number of unread messages in the room
+     * Depending on the read marker state, this call may return either
+     * a precise or an estimate number of unread events. Only "notable"
+     * events (non-redacted message events from users other than local)
+     * are counted.
+     *
+     * In a case when readMarker() == timelineEdge() (the local read
+     * marker is beyond the local timeline) only the bottom limit of
+     * the unread messages number can be estimated (and even that may
+     * be slightly off due to, e.g., redactions of events not loaded
+     * to the local timeline).
+     *
+     * If all messages are read, this function will return -1 (_not_ 0,
+     * as zero may mean "zero or more unread messages" in a situation
+     * when the read marker is outside the local timeline.
+     */
+    int unreadCount() const;
 
-        private:
-            const Room* room;
+    Q_INVOKABLE int notificationCount() const;
+    Q_INVOKABLE void resetNotificationCount();
+    Q_INVOKABLE int highlightCount() const;
+    Q_INVOKABLE void resetHighlightCount();
+
+    /** Check whether the room has account data of the given type
+     * Tags and read markers are not supported by this method _yet_.
+     */
+    bool hasAccountData(const QString& type) const;
+
+    /** Get a generic account data event of the given type
+     * 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_.
+     */
+    const EventPtr& accountData(const QString& type) const;
+
+    QStringList tagNames() const;
+    TagsMap tags() const;
+    TagRecord tag(const QString& name) const;
+
+    /** Add a new tag to this room
+     * If this room already has this tag, nothing happens. If it's a new
+     * tag for the room, the respective tag record is added to the set
+     * of tags and the new set is sent to the server to update other
+     * clients.
+     */
+    void addTag(const QString& name, const TagRecord& record = {});
+    Q_INVOKABLE void addTag(const QString& name, float order);
+
+    /// Remove a tag from the room
+    Q_INVOKABLE void removeTag(const QString& name);
+
+    /// The scope to apply an action on
+    /*! This enumeration is used to pick a strategy to propagate certain
+     * actions on the room to its predecessors and successors.
+     */
+    enum ActionScope {
+        ThisRoomOnly,    //< Do not apply to predecessors and successors
+        WithinSameState, //< Apply to predecessors and successors in the same
+                         //< state as the current one
+        OmitLeftState,   //< Apply to all reachable predecessors and successors
+                         //< except those in Leave state
+        WholeSequence    //< Apply to all reachable predecessors and successors
     };
-}  // namespace QMatrixClient
-Q_DECLARE_METATYPE(QMatrixClient::FileTransferInfo)
-Q_DECLARE_OPERATORS_FOR_FLAGS(QMatrixClient::Room::Changes)
+
+    /** Overwrite the room's tags
+     * This completely replaces the existing room's tags with a set
+     * of new ones and updates the new set on the server. Unlike
+     * most other methods in Room, this one sends a signal about changes
+     * immediately, not waiting for confirmation from the server
+     * (because tags are saved in account data rather than in shared
+     * room state).
+     * \param applyOn setting this to Room::OnAllConversations will set tags
+     *                on this and all _known_ predecessors and successors;
+     *                by default only the current room is changed
+     */
+    void setTags(TagsMap newTags, ActionScope applyOn = ThisRoomOnly);
+
+    /// Check whether the list of tags has m.favourite
+    bool isFavourite() const;
+    /// Check whether the list of tags has m.lowpriority
+    bool isLowPriority() const;
+    /// Check whether this room is for server notices (MSC1452)
+    bool isServerNoticeRoom() const;
+
+    /// Check whether this room is a direct chat
+    Q_INVOKABLE bool isDirectChat() const;
+
+    /// Get the list of users this room is a direct chat with
+    QList<User*> directChatUsers() const;
+
+    Q_INVOKABLE QUrl urlToThumbnail(const QString& eventId) const;
+    Q_INVOKABLE QUrl urlToDownload(const QString& eventId) const;
+
+    /// Get a file name for downloading for a given event id
+    /*!
+     * The event MUST be RoomMessageEvent and have content
+     * for downloading. \sa RoomMessageEvent::hasContent
+     */
+    Q_INVOKABLE QString fileNameToDownload(const QString& eventId) const;
+
+    /// Get information on file upload/download
+    /*!
+     * \param id uploads are identified by the corresponding event's
+     *           transactionId (because uploads are done before
+     *           the event is even sent), while downloads are using
+     *           the normal event id for identifier.
+     */
+    Q_INVOKABLE Quotient::FileTransferInfo
+    fileTransferInfo(const QString& id) const;
+
+    /// Get the URL to the actual file source in a unified way
+    /*!
+     * For uploads it will return a URL to a local file; for downloads
+     * the URL will be taken from the corresponding room event.
+     */
+    Q_INVOKABLE QUrl fileSource(const QString& id) const;
+
+    /** Pretty-prints plain text into HTML
+     * As of now, it's exactly the same as Quotient::prettyPrint();
+     * in the future, it will also linkify room aliases, mxids etc.
+     * using the room context.
+     */
+    Q_INVOKABLE QString prettyPrint(const QString& plainText) const;
+
+    MemberSorter memberSorter() const;
+
+    Q_INVOKABLE bool supportsCalls() const;
+
+    /// Whether the current user is allowed to upgrade the room
+    Q_INVOKABLE bool canSwitchVersions() const;
+
+    /// Get a state event with the given event type and state key
+    /*! This method returns a (potentially empty) state event corresponding
+     * to the pair of event type \p evtType and state key \p stateKey.
+     */
+    Q_INVOKABLE const Quotient::StateEventBase*
+    getCurrentState(const QString& evtType, const QString& stateKey = {}) const;
+
+    /// Get a state event with the given event type and state key
+    /*! This is a typesafe overload that accepts a C++ event type instead of
+     * its Matrix name.
+     */
+    template <typename EvT>
+    const EvT* getCurrentState(const QString& stateKey = {}) const
+    {
+        const auto* evt =
+            eventCast<const EvT>(getCurrentState(EvT::matrixTypeId(), stateKey));
+        Q_ASSERT(evt);
+        Q_ASSERT(evt->matrixTypeId() == EvT::matrixTypeId()
+                 && evt->stateKey() == stateKey);
+        return evt;
+    }
+
+    /// Set a state event of the given type with the given arguments
+    /*! This typesafe overload attempts to send a state event with the type
+     * \p EvT and the content defined by \p args. Specifically, the function
+     * creates a temporary object of type \p EvT passing \p args to
+     * the constructor, and sends a request to the homeserver using
+     * the Matrix event type defined by \p EvT and the event content produced
+     * via EvT::contentJson().
+     */
+    template <typename EvT, typename... ArgTs>
+    auto setState(ArgTs&&... args) const
+    {
+        return setState(EvT(std::forward<ArgTs>(args)...));
+    }
+
+public slots:
+    /** Check whether the room should be upgraded */
+    void checkVersion();
+
+    QString postMessage(const QString& plainText, MessageEventType type);
+    QString postPlainText(const QString& plainText);
+    QString postHtmlMessage(const QString& plainText, const QString& html,
+                            MessageEventType type = MessageEventType::Text);
+    QString postHtmlText(const QString& plainText, const QString& html);
+    /// Send a reaction on a given event with a given key
+    QString postReaction(const QString& eventId, const QString& key);
+    QString postFile(const QString& plainText, const QUrl& localPath,
+                     bool asGenericFile = false);
+    /** Post a pre-created room message event
+     *
+     * Takes ownership of the event, deleting it once the matching one
+     * arrives with the sync
+     * \return transaction id associated with the event.
+     */
+    QString postEvent(RoomEvent* event);
+    QString postJson(const QString& matrixType, 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);
+    /// 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
+    void refreshDisplayName();
+
+    void getPreviousContent(int limit = 10);
+
+    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 = {});
+    void ban(const QString& userId, const QString& reason = {});
+    void unban(const QString& userId);
+    void redactEvent(const QString& eventId, const QString& reason = {});
+
+    void uploadFile(const QString& id, const QUrl& localFilename,
+                    const QString& overrideContentType = {});
+    // If localFilename is empty a temporary file is created
+    void downloadFile(const QString& eventId, const QUrl& localFilename = {});
+    void cancelFileTransfer(const QString& id);
+
+    /// Mark all messages in the room as read
+    void markAllMessagesAsRead();
+
+    /// Switch the room's version (aka upgrade)
+    void switchVersion(QString newVersion);
+
+    void inviteCall(const QString& callId, const int lifetime,
+                    const QString& sdp);
+    void sendCallCandidates(const QString& callId, const QJsonArray& candidates);
+    void answerCall(const QString& callId, const int lifetime,
+                    const QString& sdp);
+    void answerCall(const QString& callId, const QString& sdp);
+    void hangupCall(const QString& callId);
+
+signals:
+    /// Initial set of state events has been loaded
+    /**
+     * The initial set is what comes from the initial sync for the room.
+     * This includes all basic things like RoomCreateEvent,
+     * RoomNameEvent, a (lazy-loaded, not full) set of RoomMemberEvents
+     * etc. This is a per-room reflection of Connection::loadedRoomState
+     * \sa Connection::loadedRoomState
+     */
+    void baseStateLoaded();
+    void eventsHistoryJobChanged();
+    void aboutToAddHistoricalMessages(RoomEventsRange events);
+    void aboutToAddNewMessages(RoomEventsRange events);
+    void addedMessages(int fromIndex, int toIndex);
+    /// The event is about to be appended to the list of pending events
+    void pendingEventAboutToAdd(RoomEvent* event);
+    /// An event has been appended to the list of pending events
+    void pendingEventAdded();
+    /// The remote echo has arrived with the sync and will be merged
+    /// with its local counterpart
+    /** NB: Requires a sync loop to be emitted */
+    void pendingEventAboutToMerge(Quotient::RoomEvent* serverEvent,
+                                  int pendingEventIndex);
+    /// The remote and local copies of the event have been merged
+    /** NB: Requires a sync loop to be emitted */
+    void pendingEventMerged();
+    /// An event will be removed from the list of pending events
+    void pendingEventAboutToDiscard(int pendingEventIndex);
+    /// An event has just been removed from the list of pending events
+    void pendingEventDiscarded();
+    /// The status of a pending event has changed
+    /** \sa PendingEventItem::deliveryStatus */
+    void pendingEventChanged(int pendingEventIndex);
+    /// The server accepted the message
+    /** This is emitted when an event sending request has successfully
+     * completed. This does not mean that the event is already in the
+     * local timeline, only that the server has accepted it.
+     * \param txnId transaction id assigned by the client during sending
+     * \param eventId event id assigned by the server upon acceptance
+     * \sa postEvent, postPlainText, postMessage, postHtmlMessage
+     * \sa pendingEventMerged, aboutToAddNewMessages
+     */
+    void messageSent(QString txnId, QString eventId);
+
+    /** 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 occurred
+     *                upon the last sync
+     * \sa Changes
+     */
+    void changed(Quotient::Room::Changes changes);
+    /**
+     * \brief The room name, the canonical alias or other aliases changed
+     *
+     * Not triggered when display name changes.
+     */
+    void namesChanged(Quotient::Room* room);
+    void displaynameAboutToChange(Quotient::Room* room);
+    void displaynameChanged(Quotient::Room* room, QString oldName);
+    void topicChanged();
+    void avatarChanged();
+    void userAdded(Quotient::User* user);
+    void userRemoved(Quotient::User* user);
+    void memberAboutToRename(Quotient::User* user, QString newName);
+    void memberRenamed(Quotient::User* user);
+    /// The list of members has changed
+    /** Emitted no more than once per sync, this is a good signal to
+     * for cases when some action should be done upon any change in
+     * the member list. If you need per-item granularity you should use
+     * userAdded, userRemoved and memberAboutToRename / memberRenamed
+     * instead.
+     */
+    void memberListChanged();
+    /// The previously lazy-loaded members list is now loaded entirely
+    /// \sa setDisplayed
+    void allMembersLoaded();
+    void encryption();
+
+    void joinStateChanged(Quotient::JoinState oldState,
+                          Quotient::JoinState newState);
+    void typingChanged();
+
+    void highlightCountChanged();
+    void notificationCountChanged();
+
+    void displayedChanged(bool displayed);
+    void firstDisplayedEventChanged();
+    void lastDisplayedEventChanged();
+    void lastReadEventChanged(Quotient::User* user);
+    void readMarkerMoved(QString fromEventId, QString toEventId);
+    void readMarkerForUserMoved(Quotient::User* user, QString fromEventId,
+                                QString toEventId);
+    void unreadMessagesChanged(Quotient::Room* room);
+
+    void accountDataAboutToChange(QString type);
+    void accountDataChanged(QString type);
+    void tagsAboutToChange();
+    void tagsChanged();
+
+    void updatedEvent(QString eventId);
+    void replacedEvent(const Quotient::RoomEvent* newEvent,
+                       const Quotient::RoomEvent* oldEvent);
+
+    void newFileTransfer(QString id, QUrl localFile);
+    void fileTransferProgress(QString id, qint64 progress, qint64 total);
+    void fileTransferCompleted(QString id, QUrl localFile, QUrl mxcUrl);
+    void fileTransferFailed(QString id, QString errorMessage = {});
+    void fileTransferCancelled(QString id);
+
+    void callEvent(Quotient::Room* room, const Quotient::RoomEvent* event);
+
+    /// The room's version stability may have changed
+    void stabilityUpdated(QString recommendedDefault,
+                          QStringList stableVersions);
+    /// This room has been upgraded and won't receive updates any more
+    void upgraded(QString serverMessage, Quotient::Room* successor);
+    /// An attempted room upgrade has failed
+    void upgradeFailed(QString errorMessage);
+
+    /// The room is about to be deleted
+    void beforeDestruction(Quotient::Room*);
+
+protected:
+    virtual Changes processStateEvent(const RoomEvent& e);
+    virtual Changes processEphemeralEvent(EventPtr&& event);
+    virtual Changes processAccountDataEvent(EventPtr&& event);
+    virtual void onAddNewTimelineEvents(timeline_iter_t /*from*/) {}
+    virtual void onAddHistoricalTimelineEvents(rev_iter_t /*from*/) {}
+    virtual void onRedaction(const RoomEvent& /*prevEvent*/,
+                             const RoomEvent& /*after*/)
+    {}
+    virtual QJsonObject toJson() const;
+    virtual void updateData(SyncRoomData&& data, bool fromCache = false);
+
+private:
+    friend class Connection;
+
+    class Private;
+    Private* d;
+
+    // This is called from Connection, reflecting a state change that
+    // arrived from the server. Clients should use
+    // Connection::joinRoom() and Room::leaveRoom() to change the state.
+    void setJoinState(JoinState state);
+};
+
+class MemberSorter {
+public:
+    explicit MemberSorter(const Room* r) : room(r) {}
+
+    bool operator()(User* u1, User* u2) const;
+    bool operator()(User* u1, const QString& u2name) const;
+
+    template <typename ContT, typename ValT>
+    typename ContT::size_type lowerBoundIndex(const ContT& c, const ValT& v) const
+    {
+        return std::lower_bound(c.begin(), c.end(), v, *this) - c.begin();
+    }
+
+private:
+    const Room* room;
+};
+} // namespace Quotient
+Q_DECLARE_METATYPE(Quotient::FileTransferInfo)
+Q_DECLARE_OPERATORS_FOR_FLAGS(Quotient::Room::Changes)