Libkdav2

davmultigetprotocol.h
1 /*
2  Copyright (c) 2010 GrĂ©gory Oestreicher <[email protected]>
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program; if not, write to the Free Software
16  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 */
18 
19 #ifndef KDAV2_DAVMULTIGETPROTOCOL_H
20 #define KDAV2_DAVMULTIGETPROTOCOL_H
21 
22 #include "kpimkdav2_export.h"
23 
24 #include "davprotocolbase.h"
25 
26 namespace KDAV2
27 {
28 
29 /**
30  * @short Base class for protocols that implement multiget capabilities
31  */
32 class KPIMKDAV2_EXPORT DavMultigetProtocol : public DavProtocolBase
33 {
34 public:
35  /**
36  * Destroys the DAV protocol
37  */
38  virtual ~DavMultigetProtocol();
39 
40  /**
41  * Returns the XML document that represents a MULTIGET DAV query to
42  * list all DAV resources with the given @p urls.
43  */
44  virtual XMLQueryBuilder::Ptr itemsReportQuery(const QStringList &urls) const = 0;
45 
46  /**
47  * Returns the namespace used by protocol-specific elements found in responses.
48  */
49  virtual QString responseNamespace() const = 0;
50 
51  /**
52  * Returns the tag name of data elements found in responses.
53  */
54  virtual QString dataTagName() const = 0;
55 };
56 
57 }
58 
59 #endif
Base class for protocols that implement multiget capabilities.
Base class for various DAV groupware dialects.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Aug 15 2022 04:07:29 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.