KDAV2::DavProtocolBase
#include <davprotocolbase.h>
Public Member Functions | |
virtual | ~DavProtocolBase () |
virtual DavCollection::ContentTypes | collectionContentTypes (const QDomElement &propstat) const =0 |
virtual XMLQueryBuilder::Ptr | collectionsQuery () const =0 |
virtual QString | collectionsXQuery () const =0 |
virtual QVector< XMLQueryBuilder::Ptr > | itemsQueries () const =0 |
virtual QString | principalHomeSet () const |
virtual QString | principalHomeSetNS () const |
virtual bool | supportsCTags () const =0 |
virtual bool | supportsPrincipals () const =0 |
virtual bool | useMultiget () const =0 |
virtual bool | useReport () const =0 |
Detailed Description
Base class for various DAV groupware dialects.
This class provides an interface to query the DAV dialect specific features and abstract them.
The functionality is implemented in:
- CaldavProtocol
- CarddavProtocol
- GroupdavProtocol
Definition at line 66 of file davprotocolbase.h.
Constructor & Destructor Documentation
◆ ~DavProtocolBase()
|
virtual |
Destroys the dav protocol base.
Definition at line 43 of file davprotocolbase.cpp.
Member Function Documentation
◆ collectionContentTypes()
|
pure virtual |
Returns the possible content types for the collection that is described by the passed propstat
element of a PROPFIND result.
◆ collectionsQuery()
|
pure virtual |
Returns the XML document that represents the DAV query to list all available DAV collections.
◆ collectionsXQuery()
|
pure virtual |
Returns the XQuery string that filters out the relevant XML elements from the result returned by the query that is provided by collectionQuery().
◆ itemsQueries()
|
pure virtual |
Returns a list of XML documents that represent DAV queries to list all available DAV resources inside a specific DAV collection.
◆ principalHomeSet()
|
virtual |
Returns the home set that this protocol supports.
Definition at line 47 of file davprotocolbase.cpp.
◆ principalHomeSetNS()
|
virtual |
Returns the namespace of the home set.
Definition at line 52 of file davprotocolbase.cpp.
◆ supportsCTags()
|
pure virtual |
Return whether the dav protocol dialect supports CTags.
If true, it must fetch them in the collectionsQuery().
◆ supportsPrincipals()
|
pure virtual |
Returns whether the dav protocol dialect supports principal queries.
If true, it must return the home set it provides access to with principalHomeSet() and the home set namespace with principalHomeSetNS();
◆ useMultiget()
|
pure virtual |
Returns whether the dav protocol dialect supports the MULTIGET command.
If MULTIGET is supported, the content of all dav resources can be fetched in ResourceBase::retrieveItems() already and there is no need to call ResourceBase::retrieveItem() for every single dav resource.
Protocols that have MULTIGET capabilities must inherit from DavMultigetProtocol instead of this class.
◆ useReport()
|
pure virtual |
Returns whether the dav protocol dialect supports the REPORT command to query all resources of a collection.
If not, PROPFIND command will be used instead.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 22 2024 12:04:40 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.