KDAV::DavCollection Class Reference

#include <KDAV/DavCollection>

Public Types
enum	ContentType {   Events = 1 , Todos = 2 , Contacts = 4 , FreeBusy = 8 ,   Journal = 16 , Calendar = 32 }
typedef QFlags< ContentType >	ContentTypes
typedef QList< DavCollection >	List

Public Member Functions
	DavCollection ()
	DavCollection (const DavCollection &other)
	DavCollection (const DavUrl &url, const QString &displayName, ContentTypes contentTypes)
	DavCollection (DavCollection &&)
QColor	color () const
ContentTypes	contentTypes () const
QString	CTag () const
QString	displayName () const
DavCollection &	operator= (const DavCollection &other)
DavCollection &	operator= (DavCollection &&)
Privileges	privileges () const
void	setColor (const QColor &color)
void	setContentTypes (ContentTypes types)
void	setCTag (const QString &ctag)
void	setDisplayName (const QString &name)
void	setPrivileges (Privileges privs)
void	setUrl (const DavUrl &url)
DavUrl	url () const

Detailed Description

A helper class to store information about DAV collection.

This class is used as container to transfer information about DAV collections between the Akonadi resource and the DAV jobs.

Definition at line 37 of file davcollection.h.

Member Typedef Documentation

ContentTypes

QFlags< ContentType > KDAV::DavCollection::ContentTypes

Definition at line 56 of file davcollection.h.

List

QList<DavCollection> KDAV::DavCollection::List

Defines a list of DAV collection objects.

Definition at line 43 of file davcollection.h.

Member Enumeration Documentation

ContentType

enum KDAV::DavCollection::ContentType

Describes the possible content type of the DAV collection.

Enumerator
Events	The collection can contain event DAV resources.
Todos	The collection can contain todo DAV resources.
Contacts	The collection can contain contact DAV resources.
FreeBusy	The collection can contain free/busy information.
Journal	The collection can contain journal DAV resources.
Calendar	The collection can contain anything calendar-related.

Definition at line 48 of file davcollection.h.

Constructor & Destructor Documentation

DavCollection() [1/2]

DavCollection::DavCollection

(

)

Creates an empty DAV collection.

Definition at line 26 of file davcollection.cpp.

DavCollection() [2/2]

DavCollection::DavCollection	(	const DavUrl &	url,
		const QString &	displayName,
		ContentTypes	contentTypes )

Creates a new DAV collection.

Parameters

url	The URL that identifies the collection.
displayName	The display name of the collection.
contentTypes	The possible content types of the collection.

Definition at line 31 of file davcollection.cpp.

Member Function Documentation

color()

QColor DavCollection::color

(

)

const

Return the color of the collection, or an empty string if none was provided by the backend.

Definition at line 81 of file davcollection.cpp.

contentTypes()

DavCollection::ContentTypes DavCollection::contentTypes

(

)

const

Returns the possible content types of the collection.

Definition at line 91 of file davcollection.cpp.

CTag()

QString DavCollection::CTag

(

)

const

Returns this collection CTag.

The returned value will be empty if no CTag was found.

See also

https://github.com/apple/ccs-calendarserver/blob/master/doc/Extensions/caldav-ctag.txt

Definition at line 51 of file davcollection.cpp.

displayName()

QString DavCollection::displayName

(

)

const

Returns the display name of the collection.

Definition at line 71 of file davcollection.cpp.

privileges()

Privileges DavCollection::privileges

(

)

const

Returns the privileges on this collection.

Definition at line 101 of file davcollection.cpp.

setColor()

void DavCollection::setColor

(

const QColor &

color

)

Sets the color for this collection.

Definition at line 76 of file davcollection.cpp.

setContentTypes()

void DavCollection::setContentTypes

(

ContentTypes

types

)

Sets the possible content types of the collection.

Definition at line 86 of file davcollection.cpp.

setCTag()

void DavCollection::setCTag

(

const QString &

ctag

)

Sets this collection CTag.

See also

https://github.com/apple/ccs-calendarserver/blob/master/doc/Extensions/caldav-ctag.txt

Definition at line 46 of file davcollection.cpp.

setDisplayName()

void DavCollection::setDisplayName

(

const QString &

name

)

Sets the display name of the collection.

Definition at line 66 of file davcollection.cpp.

setPrivileges()

void DavCollection::setPrivileges

(

Privileges

privs

)

Sets the privileges on this collection.

Definition at line 96 of file davcollection.cpp.

setUrl()

void DavCollection::setUrl

(

const DavUrl &

url

)

Sets the url that identifies the collection.

Definition at line 56 of file davcollection.cpp.

url()

DavUrl DavCollection::url

(

)

const

Returns the URL that identifies the collection.

Definition at line 61 of file davcollection.cpp.

---

The documentation for this class was generated from the following files:

• davcollection.h
• davcollection.cpp