• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. KDE PIM
  3. Libkdav2
  • KDE Home
  • Contact Us

Quick Links

Skip menu "Libkdav2"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • File List
  • Related Pages

Class Picker

About

The KDav library

Maintainer
The KDE Community
Supported platforms
Linux
Community
IRC: #kontact on Freenode
Mailing list: kde-pim
Use with CMake
find_package()
target_link_libraries(yourapp KPimKDAV)
Use with QMake
QT += PimKDAV 
Clone
git clone git://anongit.kde.org/kdav2.git
Browse source
Libkdav2 on cgit.kde.org

Libkdav2

  • View on LXR
  • KDAV2
  • DavProtocolBase
Public Member Functions | List of all members
KDAV2::DavProtocolBase Class Referenceabstract

#include <davprotocolbase.h>

Inheritance diagram for KDAV2::DavProtocolBase:
Inheritance graph
[legend]

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::~DavProtocolBase ( )
virtual

Destroys the dav protocol base.

Definition at line 43 of file davprotocolbase.cpp.

Member Function Documentation

virtual DavCollection::ContentTypes KDAV2::DavProtocolBase::collectionContentTypes ( const QDomElement &  propstat) const
pure virtual

Returns the possible content types for the collection that is described by the passed propstat element of a PROPFIND result.

virtual XMLQueryBuilder::Ptr KDAV2::DavProtocolBase::collectionsQuery ( ) const
pure virtual

Returns the XML document that represents the DAV query to list all available DAV collections.

virtual QString KDAV2::DavProtocolBase::collectionsXQuery ( ) const
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().

virtual QVector<XMLQueryBuilder::Ptr> KDAV2::DavProtocolBase::itemsQueries ( ) const
pure virtual

Returns a list of XML documents that represent DAV queries to list all available DAV resources inside a specific DAV collection.

QString DavProtocolBase::principalHomeSet ( ) const
virtual

Returns the home set that this protocol supports.

Definition at line 47 of file davprotocolbase.cpp.

QString DavProtocolBase::principalHomeSetNS ( ) const
virtual

Returns the namespace of the home set.

Definition at line 52 of file davprotocolbase.cpp.

virtual bool KDAV2::DavProtocolBase::supportsCTags ( ) const
pure virtual

Return whether the dav protocol dialect supports CTags.

If true, it must fetch them in the collectionsQuery().

virtual bool KDAV2::DavProtocolBase::supportsPrincipals ( ) const
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();

virtual bool KDAV2::DavProtocolBase::useMultiget ( ) const
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.

virtual bool KDAV2::DavProtocolBase::useReport ( ) const
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:
  • davprotocolbase.h
  • davprotocolbase.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Thu Dec 12 2019 02:52:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal