KDAV

davitemsfetchjob.h
1/*
2 SPDX-FileCopyrightText: 2010 Grégory Oestreicher <greg@kamago.net>
3
4 Based on DavItemsListJob:
5 SPDX-FileCopyrightText: 2010 Tobias Koenig <tokoe@kde.org>
6
7 SPDX-License-Identifier: LGPL-2.0-or-later
8*/
9
10#ifndef KDAV_DAVITEMSFETCHJOB_H
11#define KDAV_DAVITEMSFETCHJOB_H
12
13#include "kdav_export.h"
14
15#include "davitem.h"
16#include "davjobbase.h"
17#include "davurl.h"
18
19#include <QStringList>
20
21namespace KDAV
22{
23class DavItemsFetchJobPrivate;
24
25/**
26 * @class DavItemsFetchJob davitemsfetchjob.h <KDAV/DavItemsFetchJob>
27 *
28 * @short A job that fetches a list of items from a DAV server using a MULTIGET query.
29 */
30class KDAV_EXPORT DavItemsFetchJob : public DavJobBase
31{
32 Q_OBJECT
33
34public:
35 /**
36 * Creates a new items fetch job.
37 *
38 * @param collectionUrl The DAV collection on which to run the query
39 * @param urls The list of URLs to fetch
40 * @param parent The parent object
41 */
42 DavItemsFetchJob(const DavUrl &collectionUrl, const QStringList &urls, QObject *parent = nullptr);
43
44 /**
45 * Starts the job.
46 */
47 void start() override;
48
49 /**
50 * Returns the list of fetched items
51 */
52 Q_REQUIRED_RESULT DavItem::List items() const;
53
54 /**
55 * Return the item found at @p url
56 */
57 Q_REQUIRED_RESULT DavItem item(const QString &url) const;
58
59private:
60 Q_DECLARE_PRIVATE(DavItemsFetchJob)
61};
62}
63
64#endif
A helper class to store information about DAV resources.
Definition davitem.h:39
A job that fetches a list of items from a DAV server using a MULTIGET query.
base class for the jobs used by the resource.
Definition davjobbase.h:27
A helper class to combine URL and protocol of a DAV URL.
Definition davurl.h:27
Q_SCRIPTABLE Q_NOREPLY void start()
The KDAV namespace.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:52:04 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.