/****************************************************************************** * Copyright (C) 2015 Felix Rohrbach * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * 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 */ #pragma once #include #include #include namespace QMatrixClient { class Room; class User; class RoomEvent; class ConnectionPrivate; class ConnectionData; class SyncJob; class RoomMessagesJob; class PostReceiptJob; class MediaThumbnailJob; class JoinRoomJob; class Connection: public QObject { Q_OBJECT public: explicit Connection(const QUrl& server, QObject* parent = nullptr); Connection(); virtual ~Connection(); QHash roomMap() const; Q_INVOKABLE virtual void resolveServer(const QString& domain); Q_INVOKABLE virtual void connectToServer(const QString& user, const QString& password); Q_INVOKABLE virtual void connectWithToken(const QString& userId, const QString& token); Q_INVOKABLE virtual void reconnect(); /** @deprecated Use stopSync() instead */ Q_INVOKABLE virtual void disconnectFromServer() { stopSync(); } Q_INVOKABLE virtual void logout(); Q_INVOKABLE void sync(int timeout = -1); Q_INVOKABLE void stopSync(); /** @deprecated Use callApi() or Room::postMessage() instead */ Q_INVOKABLE virtual void postMessage(Room* room, const QString& type, const QString& message) const; /** @deprecated Use callApi() or Room::postReceipt() instead */ Q_INVOKABLE virtual PostReceiptJob* postReceipt(Room* room, RoomEvent* event) const; Q_INVOKABLE virtual JoinRoomJob* joinRoom(const QString& roomAlias); /** @deprecated Use callApi() or Room::leaveRoom() instead */ Q_INVOKABLE virtual void leaveRoom( Room* room ); Q_INVOKABLE virtual RoomMessagesJob* getMessages(Room* room, const QString& from) const; virtual MediaThumbnailJob* getThumbnail(const QUrl& url, QSize requestedSize) const; MediaThumbnailJob* getThumbnail(const QUrl& url, int requestedWidth, int requestedHeight) const; Q_INVOKABLE QUrl homeserver() const; Q_INVOKABLE User* user(const QString& userId); Q_INVOKABLE User* user(); Q_INVOKABLE QString userId() const; /** @deprecated Use accessToken() instead. */ Q_INVOKABLE QString token() const; Q_INVOKABLE QString accessToken() const; Q_INVOKABLE SyncJob* syncJob() const; Q_INVOKABLE int millisToReconnect() const; template JobT* callApi(JobArgTs... jobArgs) const { auto job = new JobT(connectionData(), jobArgs...); job->start(); return job; } /** Generates a new transaction id. Transaction id's are unique within * a single Connection object */ Q_INVOKABLE QByteArray generateTxnId(); signals: void resolved(); void connected(); void reconnected(); void loggedOut(); void syncDone(); void newRoom(Room* room); void joinedRoom(Room* room); void leftRoom(Room* room); void loginError(QString error); void networkError(size_t nextAttempt, int inMilliseconds); void resolveError(QString error); void syncError(QString error); //void jobError(BaseJob* job); protected: /** * @brief Access the underlying ConnectionData class */ const ConnectionData* connectionData() const; /** * @brief Find a (possibly new) Room object for the specified id * Use this method whenever you need to find a Room object in * the local list of rooms. Note that this does not interact with * the server; in particular, does not automatically create rooms * on the server. * @return a pointer to a Room object with the specified id; nullptr * if roomId is empty if createRoom() failed to create a Room object. */ Room* provideRoom(const QString& roomId); /** * makes it possible for derived classes to have its own User class */ virtual User* createUser(const QString& userId); /** * makes it possible for derived classes to have its own Room class */ virtual Room* createRoom(const QString& roomId); private: class Private; Private* d; }; } // namespace QMatrixClient