KGAPI2::ContactFetchJob

#include <contactfetchjob.h>

Inheritance diagram for KGAPI2::ContactFetchJob:

Properties

bool fetchDeleted
 
quint64 fetchOnlyUpdated
 
QString filter
 
- Properties inherited from KGAPI2::Job
bool isRunning
 
int maxTimeout
 
- Properties inherited from QObject
 objectName
 

Public Member Functions

 ContactFetchJob (const AccountPtr &account, QObject *parent=nullptr)
 
 ContactFetchJob (const QString &contactId, const AccountPtr &account, QObject *parent=nullptr)
 
 ~ContactFetchJob () override
 
bool fetchDeleted () const
 
quint64 fetchOnlyUpdated ()
 
QString filter () const
 
void setFetchDeleted (bool fetchDeleted)
 
void setFetchOnlyUpdated (quint64 timestamp)
 
void setFilter (const QString &query)
 
- 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 contacts from user's addressbook on Google Contacts.

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

Definition at line 23 of file contactfetchjob.h.

Property Documentation

bool ContactFetchJob::fetchDeleted
readwrite

Whether to fetch deleted contacts as well.

When a contact is deleted in Google Contacts, it's stored as a placeholder on Google server and can still be retrieved. Such event will have KGAPI2::Contact::deleted set to true.

By default, the job will fetch deleted contacts.

This property does not have any effect when fetching a specific contact and can be modified only when the job is not running.

See also
setFetchDeleted, fetchDeleted

Definition at line 41 of file contactfetchjob.h.

quint64 ContactFetchJob::fetchOnlyUpdated
readwrite

Timestamp to fetch only contacts modified since then.

When set, this job will only fetch contacts that have been modified since given timestamp.

By default the timestamp is 0 and all contacts are fetched.

This property does not have any effect when fetching a specific contact and can be modified only when the job is not running.

See also
setFetchOnlyUpdated, fetchOnlyUpdated

Definition at line 56 of file contactfetchjob.h.

QString ContactFetchJob::filter
readwrite

A filter to fetch only contacts matching thefulltext search.

By default the property is empty and no filter is applied.

This property does not have any effect when fetching a specific contact and can be modified only when the job is not running.

See also
setFilter, filter

Definition at line 69 of file contactfetchjob.h.

Constructor & Destructor Documentation

ContactFetchJob::ContactFetchJob ( const AccountPtr account,
QObject parent = nullptr 
)
explicit

Constructs a job that will fetch all contacts from user's addressbook.

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

Parameters
accountAccount to authenticate the request
parent

Definition at line 58 of file contactfetchjob.cpp.

ContactFetchJob::ContactFetchJob ( const QString contactId,
const AccountPtr account,
QObject parent = nullptr 
)

Constructs a job that will fetch a contact with given contactId from user's addressbook.

Note that fetchOnlyUpdated filter is not applied in this case.

Parameters
contactIdID of contact to fetch
accountAccount to authenticate the request
parent

Definition at line 64 of file contactfetchjob.cpp.

ContactFetchJob::~ContactFetchJob ( )
override

Destructor.

Definition at line 71 of file contactfetchjob.cpp.

Member Function Documentation

bool KGAPI2::ContactFetchJob::fetchDeleted ( ) const

Returns whether deleted contacts are fetched.

quint64 KGAPI2::ContactFetchJob::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.
QString KGAPI2::ContactFetchJob::filter ( ) const

Returns fulltext filter string.

ObjectsList ContactFetchJob::handleReplyWithItems ( const QNetworkReply reply,
const QByteArray rawData 
)
overrideprotectedvirtual

KGAPI2::Job::handleReply implementation.

Parameters
reply
rawData

Reimplemented from KGAPI2::FetchJob.

Definition at line 142 of file contactfetchjob.cpp.

void ContactFetchJob::setFetchDeleted ( bool  fetchDeleted)

Sets whether to fetch deleted contacts.

Parameters
fetchDeleted

Definition at line 81 of file contactfetchjob.cpp.

void ContactFetchJob::setFetchOnlyUpdated ( quint64  timestamp)

Sets the job to fetch only events modified since timestamp.

Parameters
timestamp

Definition at line 96 of file contactfetchjob.cpp.

void ContactFetchJob::setFilter ( const QString query)

Sets fulltext filter.

Parameters
query

Definition at line 111 of file contactfetchjob.cpp.

void ContactFetchJob::start ( )
overrideprotectedvirtual

KGAPI2::Job::start implementation.

Implements KGAPI2::Job.

Definition at line 121 of file contactfetchjob.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 Tue Oct 20 2020 23:15:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.