File indexing completed on 2024-05-12 05:22:24

 /*
  * This file is part of LibKGAPI library
  *
  * SPDX-FileCopyrightText: 2013 Daniel Vrátil <dvratil@redhat.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
  */
 
 #pragma once
 
 #include "fetchjob.h"
 #include "kgapilatitude_export.h"
 #include "latitude.h"
 
 namespace KGAPI2
 {
 
 /**
  * @brief A job to fetch all past locations from user's account on Google Latitude
  *
  * @author Daniel Vrátil <dvratil@redhat.com>
  * @since 2.0
  */
 class KGAPILATITUDE_DEPRECATED_EXPORT LocationFetchHistoryJob : public KGAPI2::FetchJob
 {
     Q_OBJECT
 
     /**
      * @brief Granularity of the results
      *
      * Specifies how precise the results should be. By default, Latitude::City
      * granularity is used.
      *
      * This property can be modified only when the job is not running.
      *
      * @see setGranularity, granularity
      */
     Q_PROPERTY(Latitude::Granularity granularity READ granularity WRITE setGranularity)
 
     /**
      * @brief Maximum number of results to fetch
      *
      * Specifies up to how many locations should the job fetch. Default value is
      * 0, which means that the job will fetch all available locations.
      *
      * This property can be modified only when the job is not running.
      *
      * @see setMaxResults, maxResults
      */
     Q_PROPERTY(int maxResults READ maxResults WRITE setMaxResults)
 
     /**
      * @brief Oldest location to fetch
      *
      * Specifies timestamp of recording of the oldest location to be fetched.
      *
      * This property can be modified only when the job is not running.
      *
      * @see minTimestamp, setMinTimestamp
      */
     Q_PROPERTY(qlonglong minTimestamp READ minTimestamp WRITE setMinTimestamp)
 
     /**
      * @brief Newest location to fetch
      *
      * Specifies timestamp of recording of the newest location to be fetched.
      *
      * This property can be modified only when the job is not running.
      *
      * @see maxTimestamp, setMaxTimestamp
      */
     Q_PROPERTY(qlonglong maxTimestamp READ maxTimestamp WRITE setMaxTimestamp)
 
 public:
     /**
      * @brief Constructs a job that will fetch all past user's locations from
      *        Google Latitude service
      *
      * @param account Account to authenticate the requests
      * @param parent
      */
     explicit LocationFetchHistoryJob(const AccountPtr &account, QObject *parent = nullptr);
 
     /**
      * @brief Destructor
      */
     ~LocationFetchHistoryJob() override;
 
     /**
      * @brief Returns granularity of the requested locations.
      */
     [[nodiscard]] Latitude::Granularity granularity() const;
 
     /**
      * @brief Sets granularity of the requested results. By default it's City.
      *
      * @param granularity
      */
     void setGranularity(Latitude::Granularity granularity);
 
     /**
      * @brief Returns maximum number of locations the job will fetch
      */
     int maxResults() const;
 
     /**
      * @brief Sets maximum number of locations to fetch
      *
      * @param results Maximum number of results or 0 to fetch all locations.
      */
     void setMaxResults(int results);
 
     /**
      * @brief Returns lower date limit for fetched locations.
      */
     [[nodiscard]] qlonglong minTimestamp() const;
 
     /**
      * @brief Sets lower date limit for locations to fetch.
      *
      * @param minTimestamp
      */
     void setMinTimestamp(qlonglong minTimestamp);
 
     /**
      * @brief Returns upper date limit for fetched locations.
      */
     [[nodiscard]] qlonglong maxTimestamp() const;
 
     /**
      * @brief Sets upper date limit for locations to fetch.
      *
      * @param maxTimestamp
      */
     void setMaxTimestamp(qlonglong maxTimestamp);
 
 protected:
     /**
      * @brief KGAPI2::Job::start implementation
      */
     void start() override;
 
     /**
      * @brief KGAPI2::Job::handleReplyWithItems
      *
      * @param reply
      * @param rawData
      */
     ObjectsList handleReplyWithItems(const QNetworkReply *reply, const QByteArray &rawData) override;
 
 private:
     class Private;
     Private *const d;
     friend class Private;
 };
 
 } // namespace KGAPI2