File indexing completed on 2023-12-03 08:28:33

0001 /*
0002  * Copyright (C) 2013  Daniel Vrátil <dvratil@redhat.com>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Lesser General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2.1 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Lesser General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Lesser General Public
0015  * License along with this library; if not, write to the Free Software
0016  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
0017  *
0018  */
0019 
0020 #ifndef KTP_PENDINGLOGGERLOGS_H
0021 #define KTP_PENDINGLOGGERLOGS_H
0022 
0023 #include <KTp/Logger/pending-logger-operation.h>
0024 #include <KTp/Logger/log-message.h>
0025 #include <KTp/ktpcommoninternals_export.h>
0026 
0027 #include <TelepathyQt/Types>
0028 
0029 namespace KTp {
0030 
0031 /**
0032  * @brief An operation that will retrieve list of chat logs for given account,
0033  *        entity and date from all backends.
0034  *
0035  * The operation will emit finished(KTp::PendingLoggerOperation*) signal when
0036  * all logs were retrieved. When an error occurs in any backend hasError()
0037  * will be set to true. Use error() to retrieve the error message.
0038  *
0039  * @since 0.7
0040  * @author Daniel Vrátil <dvratil@redhat.com>
0041  */
0042 class KTPCOMMONINTERNALS_EXPORT PendingLoggerLogs : public KTp::PendingLoggerOperation
0043 {
0044     Q_OBJECT
0045 
0046   public:
0047     /**
0048      * Destructor.
0049      */
0050     ~PendingLoggerLogs() override;
0051 
0052     /**
0053      * Returns account for which logs are being queried.
0054      */
0055     Tp::AccountPtr account() const;
0056 
0057     /**
0058      * Returns entity for which logs are being queried.
0059      */
0060     KTp::LogEntity entity() const;
0061 
0062     /**
0063      * Returns date for which logs are being queried.
0064      */
0065     QDate date() const;
0066 
0067     /**
0068      * Returns list of retrieved log messages.
0069      */
0070     QList<KTp::LogMessage> logs() const;
0071 
0072 
0073   protected:
0074     explicit PendingLoggerLogs(const Tp::AccountPtr &account,
0075                                const KTp::LogEntity &entity,
0076                                const QDate &date,
0077                                QObject* parent = nullptr);
0078 
0079     void appendLogs(const QList<KTp::LogMessage> &logs);
0080 
0081     class Private;
0082     Private * const d;
0083 };
0084 
0085 } // namespace KTp
0086 
0087 #endif // KTP_PENDINGLOGGERLOGS_H