/usr/include/libkgapi2/fetchjob.h is in libkgapi-dev 2.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* This file is part of LiKGAPI library
*
* Copyright (C) 2013 Daniel Vrátil <dvratil@redhat.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#ifndef LIBKGAPI2_FETCHJOB_H
#define LIBKGAPI2_FETCHJOB_H
#include <libkgapi2/job.h>
#include <libkgapi2/libkgapi2_export.h>
namespace KGAPI2 {
/**
* @headerfile FetchJob
* @brief Abstract superclass for all jobs that fetch resources from Google
*
* @author Daniel Vrátil <dvratil@redhat.com>
* @since 2.0
*/
class LIBKGAPI2_EXPORT FetchJob : public KGAPI2::Job
{
Q_OBJECT
public:
/**
* @brief Constructor for jobs that don't require authentication
*
* @param parent
*/
explicit FetchJob(QObject* parent = 0);
/**
* @brief Constructor for jobs that require authentication
*
* @param account Account to use to authenticate the requests send by this job
* @param parent
*/
explicit FetchJob(const KGAPI2::AccountPtr &account, QObject* parent = 0);
/**
* @brief Destructor
*/
virtual ~FetchJob();
/**
* @brief Returns all items fetched by this job.
*
* Returns all items fetch by this job. This method can be called only
* from handler of Job::finished signal. Calling this method on a running
* job will print a warning and return an empty list.
*
* @return All items fetched by this job.
*/
virtual ObjectsList items() const;
protected:
/**
* @brief KGAPI::Job::dispatchRequest implementation
*
* @param accessManager
* @param request
* @param data
* @param contentType
*/
virtual void dispatchRequest(QNetworkAccessManager* accessManager, const QNetworkRequest& request,
const QByteArray& data, const QString& contentType);
/**
* @brief KGAPI::Job::handleReply implementation
*
* @param rawData
* @param contentType
*/
virtual void handleReply(const QNetworkReply *reply, const QByteArray& rawData);
/**
* @brief KGAPI::Job::aboutToStart implementation
*/
virtual void aboutToStart();
/**
* @brief A reply handler that returns items parsed from \@ rawData
*
* This method can be reimplemented in a FetchJob subclasses. It is called
* automatically when a reply is received and the returned items are stored
* in FetchJob and accessible via FetchJob::items when the job has finished.
*
* If you need more control over handling reply and items, you can reimplement
* FetchJob::handleReply. Note that reimplementing FetchJob::handleReply
* usually requires reimplementing FetchJob::items as well and storing the
* parsed items in your implementation.
*
* @param reply A QNetworkReply received from Google server
* @param rawData Content of body of the @p reply. Don't use
* QNetworkReply::readAll(), because the content has already been read
* by Job implementation and thus it would return empty data.
*
* @return Items parsed from @p rawData
*/
virtual ObjectsList handleReplyWithItems(const QNetworkReply *reply,
const QByteArray &rawData);
private:
class Private;
Private * const d;
friend class Private;
};
} // namespace KGAPI2
#endif // LIBKGAPI2_FETCHJOB_H
|