KGAPI2::TaskFetchJob

#include <taskfetchjob.h>

Inheritance diagram for KGAPI2::TaskFetchJob:

Properties

quint64 completedMax
 
quint64 completedMin
 
quint64 dueMax
 
quint64 dueMin
 
bool fetchCompleted
 
bool fetchDeleted
 
quint64 fetchOnlyUpdated
 
- Properties inherited from KGAPI2::Job
bool isRunning
 
int maxTimeout
 
- Properties inherited from QObject
 objectName
 

Public Member Functions

 TaskFetchJob (const QString &taskListId, const AccountPtr &account, QObject *parent=nullptr)
 
 TaskFetchJob (const QString &taskId, const QString &taskListId, const AccountPtr &account, QObject *parent=nullptr)
 
 ~TaskFetchJob () override
 
quint64 completedMax () const
 
quint64 completedMin () const
 
quint64 dueMax () const
 
quint64 dueMin () const
 
bool fetchCompleted () const
 
bool fetchDeleted () const
 
quint64 fetchOnlyUpdated ()
 
void setCompletedMax (quint64 timestamp)
 
void setCompletedMin (quint64 timestamp)
 
void setDueMax (quint64 timestamp)
 
void setDueMin (quint64 timestamp)
 
void setFetchCompleted (bool fetchCompleted=true)
 
void setFetchDeleted (bool fetchDeleted=true)
 
void setFetchOnlyUpdated (quint64 timestamp)
 
- Public Member Functions inherited from KGAPI2::FetchJob
 FetchJob (QObject *parent=nullptr)
 
 FetchJob (const KGAPI2::AccountPtr &account, QObject *parent=nullptr)
 
 ~FetchJob () override
 
virtual ObjectsList items () const
 
- Public Member Functions inherited from KGAPI2::Job
 Job (QObject *parent=nullptr)
 
 Job (const AccountPtr &account, QObject *parent=nullptr)
 
 ~Job () override
 
AccountPtr account () const
 
KGAPI2::Error error () const
 
QString errorString () const
 
QStringList fields () const
 
bool isRunning () const
 
int maxTimeout () const
 
bool prettyPrint () const
 
void restart ()
 
void setAccount (const AccountPtr &account)
 
void setFields (const QStringList &fields)
 
void setMaxTimeout (int maxTimeout)
 
void setPrettyPrint (bool prettyPrint)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

ObjectsList handleReplyWithItems (const QNetworkReply *reply, const QByteArray &rawData) override
 
void start () override
 
- Protected Member Functions inherited from KGAPI2::FetchJob
void aboutToStart () override
 
void dispatchRequest (QNetworkAccessManager *accessManager, const QNetworkRequest &request, const QByteArray &data, const QString &contentType) override
 
void handleReply (const QNetworkReply *reply, const QByteArray &rawData) override
 
- Protected Member Functions inherited from KGAPI2::Job
virtual void aboutToFinish ()
 
virtual void emitFinished ()
 
virtual void emitProgress (int processed, int total)
 
virtual void enqueueRequest (const QNetworkRequest &request, const QByteArray &data=QByteArray(), const QString &contentType=QString())
 
void setError (KGAPI2::Error error)
 
void setErrorString (const QString &errorString)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Signals inherited from KGAPI2::Job
void finished (KGAPI2::Job *job)
 
void progress (KGAPI2::Job *job, int processed, int total)
 
- Static Public Member Functions inherited from KGAPI2::Job
static QString buildSubfields (const QString &field, const QStringList &fields)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

A job to fetch all tasks from given tasklist in user's Google Tasks account.

Author
Daniel Vrátil dvrat[email protected][email protected][email protected]edhat[email protected].com
Since
2.0

Definition at line 26 of file taskfetchjob.h.

Property Documentation

quint64 TaskFetchJob::completedMax
readwrite

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 also
completedMax, setCompletedMax

Definition at line 86 of file taskfetchjob.h.

quint64 TaskFetchJob::completedMin
readwrite

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 also
completedMin, setCompletedMin

Definition at line 101 of file taskfetchjob.h.

quint64 TaskFetchJob::dueMax
readwrite

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 also
dueMax, setDueMax

Definition at line 116 of file taskfetchjob.h.

quint64 TaskFetchJob::dueMin
readwrite

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 also
dueMin, setDueMin

Definition at line 131 of file taskfetchjob.h.

bool TaskFetchJob::fetchCompleted
readwrite

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 also
setFetchCompleted, fetchCompleted

Definition at line 56 of file taskfetchjob.h.

bool TaskFetchJob::fetchDeleted
readwrite

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 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 also
setFetchDeleted, fetchDeleted

Definition at line 44 of file taskfetchjob.h.

quint64 TaskFetchJob::fetchOnlyUpdated
readwrite

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 also
setFetchOnlyUpdated, fetchOnlyUpdated

Definition at line 71 of file taskfetchjob.h.

Constructor & Destructor Documentation

TaskFetchJob::TaskFetchJob ( const QString taskListId,
const AccountPtr account,
QObject parent = nullptr 
)
explicit

Constructs a job that will fetch all tasks from a tasklist with given taskListId.

Result of this job might not contain all tasks, depending on configured filters.

Parameters
taskListIdID of tasklist from which to fetch tasks
accountAccount to authenticate the request
parent

Definition at line 50 of file taskfetchjob.cpp.

TaskFetchJob::TaskFetchJob ( const QString taskId,
const QString taskListId,
const AccountPtr account,
QObject parent = nullptr 
)
explicit

Constructs a job that will fetch a task with given taskId from a tasklist with given taskListId.

Note that none of the properties fetchDeleted, fetchCompleted, fetchOnlyUpdated, completedMax, completedMin, dueMax or dueMin are applied in this case.

Parameters
taskIdID of task to fetch
taskListIdID of tasklist in which the event is
accountAccount to authenticate the request
parent

Definition at line 57 of file taskfetchjob.cpp.

TaskFetchJob::~TaskFetchJob ( )
overridedefault

Destructor.

Member Function Documentation

quint64 KGAPI2::TaskFetchJob::completedMax ( ) const

Returns upper date limit for fetching completed tasks.

quint64 KGAPI2::TaskFetchJob::completedMin ( ) const

Returns bottom date limit for fetching completed tasks.

quint64 KGAPI2::TaskFetchJob::dueMax ( ) const

Returns upper date limit for fetching due tasks.

quint64 KGAPI2::TaskFetchJob::dueMin ( ) const

Returns bottom date limit for fetching due tasks.

bool KGAPI2::TaskFetchJob::fetchCompleted ( ) const

Returns whether the job will fetch completed tasks.

bool KGAPI2::TaskFetchJob::fetchDeleted ( ) const

Returns whether to fetch will deleted tasks.

quint64 KGAPI2::TaskFetchJob::fetchOnlyUpdated ( )

Returns whether the job will fetch only modified events.

Returns
0 when all events will be fetched, a timestamp of since when the modified events will be fetched.
ObjectsList TaskFetchJob::handleReplyWithItems ( const QNetworkReply reply,
const QByteArray rawData 
)
overrideprotectedvirtual

KGAPI2::FetchJob::handleReplyWithItems implementation.

Parameters
reply
rawData

Reimplemented from KGAPI2::FetchJob.

Definition at line 202 of file taskfetchjob.cpp.

void TaskFetchJob::setCompletedMax ( quint64  timestamp)

Sets timestamp of newest completed task that can be fetched.

Parameters
timestamp

Definition at line 124 of file taskfetchjob.cpp.

void TaskFetchJob::setCompletedMin ( quint64  timestamp)

Sets timestamp of oldest completed task that can be fetched.

Parameters
timestamp

Definition at line 110 of file taskfetchjob.cpp.

void TaskFetchJob::setDueMax ( quint64  timestamp)

Sets timestamp of newest due task that can be fetched.

Parameters
timestamp

Definition at line 152 of file taskfetchjob.cpp.

void TaskFetchJob::setDueMin ( quint64  timestamp)

Sets timestamp of oldest due task that can be fetched.

Parameters
timestamp

Definition at line 138 of file taskfetchjob.cpp.

void TaskFetchJob::setFetchCompleted ( bool  fetchCompleted = true)

Sets whether the job should fetch completed tasks.

Parameters
fetchCompleted

Definition at line 82 of file taskfetchjob.cpp.

void TaskFetchJob::setFetchDeleted ( bool  fetchDeleted = true)

Sets whether to fetch should deleted tasks.

Parameters
fetchDeleted

Definition at line 96 of file taskfetchjob.cpp.

void TaskFetchJob::setFetchOnlyUpdated ( quint64  timestamp)

Sets the job to fetch only events modified since timestamp.

Parameters
timestamp

Definition at line 68 of file taskfetchjob.cpp.

void TaskFetchJob::start ( )
overrideprotectedvirtual

KGAPI2::Job::start implementation.

Implements KGAPI2::Job.

Definition at line 166 of file taskfetchjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Nov 26 2020 23:09:12 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.