/usr/include/libkgapi2/contacts/contactfetchjob.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 | /*
* 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_CONTACTFETCHJOB_H
#define LIBKGAPI2_CONTACTFETCHJOB_H
#include <libkgapi2/fetchjob.h>
#include <libkgapi2/libkgapi2_export.h>
namespace KGAPI2 {
/**
* @brief A job to fetch contacts from user's addressbook on Google Contacts
*
* @author Daniel Vrátil <dvratil@redhat.com>
* @since 2.0
*/
class LIBKGAPI2_EXPORT ContactFetchJob : public KGAPI2::FetchJob
{
Q_OBJECT
/**
* @brief 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 @p 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 setFetchDeleted, fetchDeleted
*/
Q_PROPERTY(bool fetchDeleted READ fetchDeleted WRITE setFetchDeleted)
/**
* @brief 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 setFetchOnlyUpdated, fetchOnlyUpdated
*/
Q_PROPERTY(quint64 fetchOnlyUpdated READ fetchOnlyUpdated WRITE setFetchOnlyUpdated)
/**
* @brief A filter to fetch only contats 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 setFilter, filter
*/
Q_PROPERTY(QString filter READ filter WRITE setFilter)
public:
/**
* @brief 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.
*
* @param account Account to authenticate the request
* @param parent
*/
explicit ContactFetchJob(const AccountPtr &account, QObject* parent = 0);
/**
* @brief Constructs a job that will fetch a contact with given @p contactId
* from user's addressbook
*
* Note that fetchOnlyUpdated filter is not applied in this case.
*
* @param contactId ID of contact to fetch
* @param account Account to authenticate the request
* @param parent
*/
ContactFetchJob(const QString &contactId, const AccountPtr &account, QObject* parent = 0);
/**
* @brief Destructor
*/
virtual ~ContactFetchJob();
/**
* @brief Returns whether deleted contacts are fetched.
*/
bool fetchDeleted() const;
/**
* @brief Sets whether to fetch deleted contacts
*
* @param fetchDeleted
*/
void setFetchDeleted(bool fetchDeleted);
/**
* @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 fulltext filter.
*
* @param query
*/
void setFilter(const QString &query);
/**
* @brief Returns fulltext filter string
*/
QString filter() const;
protected:
/**
* @brief KGAPI2::Job::start implementation
*/
virtual void start();
/**
* @brief KGAPI2::Job::handleReply 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_CONTACTFETCHJOB_H
|