KGAPI2::Drive::AboutFetchJob Class Reference

#include <aboutfetchjob.h>

Inheritance diagram for KGAPI2::Drive::AboutFetchJob:

Properties
bool	includeSubscribed
qlonglong	maxChangeIdCount
qlonglong	startChangeId
Properties inherited from KGAPI2::Job
bool	isRunning
int	maxTimeout
Properties inherited from QObject
	objectName

Public Member Functions
	AboutFetchJob (const AccountPtr &account, QObject *parent=nullptr)
AboutPtr	aboutData () const
bool	includeSubscribed () const
qlonglong	maxChangeIdCount () const
void	setIncludeSubscribed (bool includeSubscribed)
void	setMaxChangeIdCount (qlonglong maxChangeIdCount)
void	setStartChangeId (qlonglong startChangeId)
qlonglong	startChangeId () const
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
KGAPI2::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
Public Types inherited from QObject
typedef	QObjectList
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)

Detailed Description

A fetch job that retrieves DriveAbout data.

Definition at line 23 of file aboutfetchjob.h.

Property Documentation

includeSubscribed

bool KGAPI2::Drive::AboutFetchJob::includeSubscribed

readwrite

Whether to include shared and public files to change IDs count.

When calculating the number of remaining change IDs, whether to include shared files and public files the user has opened. When set to false, this counts only change IDs for owned files and any shared or public files that the user has explicitly added to a folder in Drive.

Default value is true.

This property can be modified only when the job is not running.

Definition at line 39 of file aboutfetchjob.h.

maxChangeIdCount

qlonglong KGAPI2::Drive::AboutFetchJob::maxChangeIdCount

readwrite

Maximum number of remaining change IDs to count.

Default value is 0, i.e. no limit

This property can be modified only when the job is not running.

Definition at line 48 of file aboutfetchjob.h.

startChangeId

qlonglong KGAPI2::Drive::AboutFetchJob::startChangeId

readwrite

Change ID to start counting from when calculating number of remaining change IDs.

Default value is 0, i.e. first ID

This property can be modified only when the job is not running.

Definition at line 58 of file aboutfetchjob.h.

Constructor & Destructor Documentation

AboutFetchJob()

AboutFetchJob::AboutFetchJob ( const AccountPtr & account, QObject * parent = nullptr )

explicit

Constructs a new fetch job.

The account must be authenticated with one of the following scopes:

• https://www.googleapis.com/auth/drive.readonly.metadata
• https://www.googleapis.com/auth/drive.readonly
• https://www.googleapis.com/auth/drive
• https://www.googleapis.com/auth/drive.file
• https://www.googleapis.com/auth/drive.metadata.readonly

Parameters

account	Account to authenticate the request with
parent

Definition at line 35 of file aboutfetchjob.cpp.

~AboutFetchJob()

AboutFetchJob::~AboutFetchJob ( )

override

Definition at line 41 of file aboutfetchjob.cpp.

Member Function Documentation

aboutData()

AboutPtr AboutFetchJob::aboutData ( ) const

nodiscard

Returns the retrieved DriveAbout object.

This method can only be called after the job has emitted finished()

Definition at line 91 of file aboutfetchjob.cpp.

handleReplyWithItems()

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

overrideprotectedvirtual

KGAPI2::Job::handleReply implementation.

Parameters

reply
rawData

Reimplemented from KGAPI2::FetchJob.

Definition at line 108 of file aboutfetchjob.cpp.

includeSubscribed()

bool AboutFetchJob::includeSubscribed ( ) const

nodiscard

Returns whether to include shared and public files to change IDs count.

Definition at line 56 of file aboutfetchjob.cpp.

maxChangeIdCount()

qlonglong AboutFetchJob::maxChangeIdCount ( ) const

nodiscard

Returns maximum number of remaining change IDs to count.

Definition at line 71 of file aboutfetchjob.cpp.

setIncludeSubscribed()

void AboutFetchJob::setIncludeSubscribed

(

bool

includeSubscribed

)

Sets whether to include shared and public files to change IDs count.

Parameters

includeSubscribed

Definition at line 46 of file aboutfetchjob.cpp.

setMaxChangeIdCount()

void AboutFetchJob::setMaxChangeIdCount

(

qlonglong

maxChangeIdCount

)

Sets maximum number of remaining change IDs to count.

Parameters

maxChangeIdCount

Definition at line 61 of file aboutfetchjob.cpp.

setStartChangeId()

void AboutFetchJob::setStartChangeId

(

qlonglong

startChangeId

)

Sets change ID to start counting from when calculating number of remaining change IDs.

Parameters

startChangeId

Definition at line 76 of file aboutfetchjob.cpp.

start()

void AboutFetchJob::start ( )

overrideprotectedvirtual

KGAPI2::Job::start implementation.

Implements KGAPI2::Job.

Definition at line 100 of file aboutfetchjob.cpp.

startChangeId()

qlonglong AboutFetchJob::startChangeId ( ) const

nodiscard

Returns change ID to start counting from when calculating number of remaining change IDs.

Definition at line 86 of file aboutfetchjob.cpp.

---

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

• aboutfetchjob.h
• aboutfetchjob.cpp