/usr/include/libkgapi2/tasks/taskfetchjob.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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 | /*
* This file is part of LibKGAPI 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_TASKFETCHJOB_H
#define LIBKGAPI2_TASKFETCHJOB_H
#include <libkgapi2/fetchjob.h>
#include <libkgapi2/libkgapi2_export.h>
namespace KGAPI2 {
/**
* @brief A job to fetch all tasks from given tasklist in user's Google Tasks
* account.
*
* @author Daniel Vrátil <dvratil@redhat.com>
* @since 2.0
*/
class LIBKGAPI2_EXPORT TaskFetchJob : public KGAPI2::FetchJob
{
Q_OBJECT
/**
* @brief Whether to fetch deleted tasks as well
*
* When an tasks is deleted from tasklist, it's stored as a placeholder
* on Google server and can still be retrieved. Such task will have
* KGAPI2::Task::deleted set to @p true.
*
* By default, the job will fetch deleted tasks.
*
* This property does not have any effect when fetching a specific task and
* can be modified only when the job is not running.
*
* @see setFetchDeleted, fetchDeleted
*/
Q_PROPERTY(bool fetchDeleted READ fetchDeleted WRITE setFetchDeleted)
/**
* @brief Whether to fetch completed tasks as well
*
* By default, the job will fetch completed tasks.
*
* This property does not have any effect when fetching a specific event and
* can be modified only when the job is not running.
*
* @see setFetchCompleted, fetchCompleted
*/
Q_PROPERTY(bool fetchCompleted READ fetchCompleted WRITE setFetchCompleted)
/**
* @brief Timestamp to fetch only tasks modified since then
*
* When set, this job will only fetch tasks that have been modified since
* given timestamp.
*
* By default the timestamp is 0 and all tasks are fetched.
*
* This property does not have any effect when fetching a specific task and
* can be modified only when the job is not running.
*
* @see setFetchOnlyUpdated, fetchOnlyUpdated
*/
Q_PROPERTY(quint64 fetchOnlyUpdated READ fetchOnlyUpdated WRITE setFetchOnlyUpdated)
/**
* @brief Timestamp of the newest completed task that will be fetched
*
* Only tasks that have been completed before or precisely at the time
* indicated by this property will be fetched.
*
* By default the timestamp is 0 and no limit is applied.
*
* This property does not have any effect when fetching a specific task and
* can be modified only when the job is not running.
*
* @see completedMax, setCompletedMax
*/
Q_PROPERTY(quint64 completedMax READ completedMax WRITE setCompletedMax)
/**
* @brief Timestamp of the oldest completed task that will be fetched
*
* Only tasks that have been completed after or precisely at the time
* indicated by this property will be fetched.
*
* By default the timestamp is 0 and no limit is applied.
*
* This property does not have any effect when fetching a specific task and
* can be modified only when the job is not running.
*
* @see completedMin, setCompletedMin
*/
Q_PROPERTY(quint64 completedMin READ completedMin WRITE setCompletedMin)
/**
* @brief Timestamp of the newest due task that will be fetched
*
* Only tasks that are due before or precisely at the time indicated by
* this property will be fetched.
*
* By default the timestamp is 0 and no limit is applied.
*
* This property does not have any effect when fetching a specific task and
* can be modified only when the job is not running.
*
* @see dueMax, setDueMax
*/
Q_PROPERTY(quint64 dueMax READ dueMax WRITE setDueMax)
/**
* @brief Timestamp of the oldest due task that will be fetched
*
* Only tasks that are due after or precisely at the time indicated by
* this property will be fetched.
*
* By default the timestamp is 0 and no limit is applied.
*
* This property does not have any effect when fetching a specific task and
* can be modified only when the job is not running.
*
* @see dueMin, setDueMin
*/
Q_PROPERTY(quint64 dueMin READ dueMin WRITE setDueMin)
public:
/**
* @brief Constructs a job that will fetch all tasks from a tasklist with
* given @p taskListId
*
* Result of this job might not contain all tasks, depending on configured
* filters.
*
* @param taskListId ID of tasklist from which to fetch tasks
* @param account Account to authenticate the request
* @param parent
*/
explicit TaskFetchJob(const QString &taskListId, const AccountPtr &account,
QObject* parent = 0);
/**
* @brief Constructs a job that will fetch a task with given @p taskId
* from a tasklist with given @p taskListId
*
* Note that none of the properties fetchDeleted, fetchCompleted,
* fetchOnlyUpdated, completedMax, completedMin, dueMax or dueMin are applied
* in this case.
*
* @param taskId ID of task to fetch
* @param taskListId ID of tasklist in which the event is
* @param account Account to authenticate the request
* @param parent
*/
explicit TaskFetchJob(const QString &taskId, const QString &taskListId,
const AccountPtr &account, QObject* parent = 0);
/**
* @brief Destructor
*/
virtual ~TaskFetchJob();
/**
* @brief Sets whether to fetch should deleted tasks
*
* @param fetchDeleted
*/
void setFetchDeleted(bool fetchDeleted = true);
/**
* @brief Returns whether to fetch will deleted tasks
*/
bool fetchDeleted() const;
/**
* @brief Sets whether the job should fetch completed tasks
*
* @param fethCompleted
*/
void setFetchCompleted(bool fetchCompleted = true);
/**
* @brief Returns whether the job will fetch completed tasks
*/
bool fetchCompleted() const;
/**
* @brief Sets the job to fetch only events modified since @p timestamp
*
* @param timestamp
*/
void setFetchOnlyUpdated(quint64 timestamp);
/**
* @brief Returns whether the job will fetch only modified events
*
* @return 0 when all events will be fetched, a timestamp of since when the
* modified events will be fetched.
*/
quint64 fetchOnlyUpdated();
/**
* @brief Sets timestamp of newest completed task that can be fetched.
*
* @param timestamp
*/
void setCompletedMax(quint64 timestamp);
/**
* @brief Returns upper date limit for fetching completed tasks
*/
quint64 completedMax() const;
/**
* @brief Sets timestamp of oldest completed task that can be fetched.
*
* @param timestamp
*/
void setCompletedMin(quint64 timestamp);
/**
* @brief Returns bottom date limit for fetching completed tasks
*/
quint64 completedMin() const;
/**
* @brief Sets timestamp of newest due task that can be fetched.
*
* @param timestamp
*/
void setDueMax(quint64 timestamp);
/**
* @brief Returns upper date limit for fetching due tasks
*/
quint64 dueMax() const;
/**
* @brief Sets timestamp of oldest due task that can be fetched.
*
* @param timestamp
*/
void setDueMin(quint64 timestamp);
/**
* @brief Returns bottom date limit for fetching due tasks.
*/
quint64 dueMin() const;
protected:
/**
* @brief KGAPI2::Job::start implementation
*/
virtual void start();
/**
* @brief KGAPI2::FetchJob::handleReplyWithItems implementation
*
* @param reply
* @param rawData
*/
virtual ObjectsList handleReplyWithItems(const QNetworkReply *reply,
const QByteArray& rawData);
private:
class Private;
Private * const d;
friend class Private;
};
} // namespace KGAPI2
#endif // LIBKGAPI2_TASKFETCHJOB_H
|