KGAPI2::TaskFetchJob

#include <taskfetchjob.h>

Inheritance diagram for KGAPI2::TaskFetchJob:

[legend]

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 &taskId, const QString &taskListId, const AccountPtr &account, QObject *parent=nullptr)

	TaskFetchJob (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 (const KGAPI2::AccountPtr &account, QObject *parent=nullptr)

	FetchJob (QObject *parent=nullptr)

	~FetchJob () override

virtual ObjectsList	items () const

Public Member Functions inherited from KGAPI2::Job
	Job (const AccountPtr &account, QObject *parent=nullptr)

	Job (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)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () 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())

virtual bool	handleError (int statusCode, const QByteArray &rawData)

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

QObject *	sender () 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 context, Functor functor, 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)

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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (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.nosp@m.il@r.nosp@m.edhat.nosp@m..com

Since: 2.0

Definition at line 26 of file taskfetchjob.h.

Property Documentation

◆ completedMax

quint64 KGAPI2::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.

◆ completedMin

quint64 KGAPI2::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.

◆ dueMax

quint64 KGAPI2::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.

◆ dueMin

quint64 KGAPI2::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.

◆ fetchCompleted

bool KGAPI2::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.

◆ fetchDeleted

bool KGAPI2::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.

◆ fetchOnlyUpdated

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() [1/2]

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

taskListId	ID of tasklist from which to fetch tasks
account	Account to authenticate the request
parent

Definition at line 49 of file taskfetchjob.cpp.

◆ TaskFetchJob() [2/2]

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

taskId	ID of task to fetch
taskListId	ID of tasklist in which the event is
account	Account to authenticate the request
parent

Definition at line 56 of file taskfetchjob.cpp.

◆ ~TaskFetchJob()

TaskFetchJob::~TaskFetchJob ( )

overridedefault

Destructor.

Member Function Documentation

◆ completedMax()

quint64 TaskFetchJob::completedMax ( ) const

Returns upper date limit for fetching completed tasks.

Definition at line 131 of file taskfetchjob.cpp.

◆ completedMin()

quint64 TaskFetchJob::completedMin ( ) const

Returns bottom date limit for fetching completed tasks.

Definition at line 117 of file taskfetchjob.cpp.

◆ dueMax()

quint64 TaskFetchJob::dueMax ( ) const

Returns upper date limit for fetching due tasks.

Definition at line 159 of file taskfetchjob.cpp.

◆ dueMin()

quint64 TaskFetchJob::dueMin ( ) const

Returns bottom date limit for fetching due tasks.

Definition at line 145 of file taskfetchjob.cpp.

◆ fetchCompleted()

bool TaskFetchJob::fetchCompleted ( ) const

Returns whether the job will fetch completed tasks.

Definition at line 89 of file taskfetchjob.cpp.

◆ fetchDeleted()

bool TaskFetchJob::fetchDeleted ( ) const

Returns whether to fetch will deleted tasks.

Definition at line 103 of file taskfetchjob.cpp.

◆ fetchOnlyUpdated()

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.

◆ handleReplyWithItems()

ObjectsList TaskFetchJob::handleReplyWithItems	(	const QNetworkReply *	reply,
		const QByteArray &	rawData )

overrideprotectedvirtual

KGAPI2::FetchJob::handleReplyWithItems implementation.

Parameters

reply
rawData

Reimplemented from KGAPI2::FetchJob.

Definition at line 200 of file taskfetchjob.cpp.

◆ setCompletedMax()

void TaskFetchJob::setCompletedMax ( quint64 timestamp )

Sets timestamp of newest completed task that can be fetched.

Parameters

timestamp

Definition at line 122 of file taskfetchjob.cpp.

◆ setCompletedMin()

void TaskFetchJob::setCompletedMin ( quint64 timestamp )

Sets timestamp of oldest completed task that can be fetched.

Parameters

timestamp

Definition at line 108 of file taskfetchjob.cpp.

◆ setDueMax()

void TaskFetchJob::setDueMax ( quint64 timestamp )

Sets timestamp of newest due task that can be fetched.

Parameters

timestamp

Definition at line 150 of file taskfetchjob.cpp.

◆ setDueMin()

void TaskFetchJob::setDueMin ( quint64 timestamp )

Sets timestamp of oldest due task that can be fetched.

Parameters

timestamp

Definition at line 136 of file taskfetchjob.cpp.

◆ setFetchCompleted()

void TaskFetchJob::setFetchCompleted ( bool fetchCompleted = true )

Sets whether the job should fetch completed tasks.

Parameters

fetchCompleted

Definition at line 80 of file taskfetchjob.cpp.

◆ setFetchDeleted()

void TaskFetchJob::setFetchDeleted ( bool fetchDeleted = true )

Sets whether to fetch should deleted tasks.

Parameters

fetchDeleted

Definition at line 94 of file taskfetchjob.cpp.

◆ setFetchOnlyUpdated()

void TaskFetchJob::setFetchOnlyUpdated ( quint64 timestamp )

Sets the job to fetch only events modified since timestamp.

Parameters

timestamp

Definition at line 66 of file taskfetchjob.cpp.

◆ start()

void TaskFetchJob::start ( )

overrideprotectedvirtual

KGAPI2::Job::start implementation.

Implements KGAPI2::Job.

Definition at line 164 of file taskfetchjob.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kgapi

KGAPI2::TaskFetchJob

Properties

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ completedMax

◆ completedMin

◆ dueMax

◆ dueMin

◆ fetchCompleted

◆ fetchDeleted

◆ fetchOnlyUpdated

Constructor & Destructor Documentation

◆ TaskFetchJob() [1/2]

◆ TaskFetchJob() [2/2]

◆ ~TaskFetchJob()

Member Function Documentation

◆ completedMax()

◆ completedMin()

◆ dueMax()

◆ dueMin()

◆ fetchCompleted()

◆ fetchDeleted()

◆ fetchOnlyUpdated()

◆ handleReplyWithItems()

◆ setCompletedMax()

◆ setCompletedMin()

◆ setDueMax()

◆ setDueMin()

◆ setFetchCompleted()

◆ setFetchDeleted()

◆ setFetchOnlyUpdated()

◆ start()