Libkdav2

davcollectionfetchjob.h
1 /*
2  Copyright (c) 2010 Tobias Koenig <[email protected]>
3  Copyright (c) 2018 RĂ©mi Nicole <[email protected]>
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License
16  along with this program; if not, write to the Free Software
17  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef KDAV2_DAVCOLLECTIONFETCHJOB_H
21 #define KDAV2_DAVCOLLECTIONFETCHJOB_H
22 
23 #include "kpimkdav2_export.h"
24 
25 #include "davcollection.h"
26 #include "davjobbase.h"
27 #include "davurl.h"
28 
29 namespace KDAV2
30 {
31 
32 /**
33  * @short A job that fetches a DAV collection from the DAV server.
34  */
35 class KPIMKDAV2_EXPORT DavCollectionFetchJob : public DavJobBase
36 {
37  Q_OBJECT
38 
39 public:
40  /**
41  * Creates a new dav collection fetch job.
42  *
43  * @param item The collection that shall be fetched.
44  * @param parent The parent object.
45  */
46  DavCollectionFetchJob(const DavCollection &collection, QObject *parent = nullptr);
47 
48  /**
49  * Starts the job.
50  */
51  void start() Q_DECL_OVERRIDE;
52 
53  /**
54  * Returns the fetched collection including current etag information.
55  */
56  DavCollection collection() const;
57 
58 private Q_SLOTS:
59  void davJobFinished(KJob *);
60 
61 private:
62  DavCollection mCollection;
63 };
64 
65 }
66 
67 #endif
Q_SCRIPTABLE Q_NOREPLY void start()
A helper class to store information about DAV collection.
Definition: davcollection.h:49
base class for the jobs used by the resource.
Definition: davjobbase.h:37
A job that fetches a DAV collection from the DAV server.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Aug 10 2022 04:09:53 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.