KDAV 5.109.0
Public Types | Public Member Functions | List of all members
KDAV::DavCollection

A helper class to store information about DAV collection. More...

#include <KDAV/DavCollection>

Public Types

enum  ContentType {
  Events = 1 , Todos = 2 , Contacts = 4 , FreeBusy = 8 ,
  Journal = 16 , Calendar = 32
}
 Describes the possible content type of the DAV collection. More...
 
typedef QFlags< ContentTypeContentTypes
 
typedef QVector< DavCollectionList
 Defines a list of DAV collection objects.
 

Public Member Functions

 DavCollection ()
 Creates an empty DAV collection.
 
 DavCollection (const DavCollection &other)
 
 DavCollection (const DavUrl &url, const QString &displayName, ContentTypes contentTypes)
 Creates a new DAV collection.
 
 DavCollection (DavCollection &&)
 
QColor color () const
 Return the color of the collection, or an empty string if none was provided by the backend.
 
ContentTypes contentTypes () const
 Returns the possible content types of the collection.
 
QString CTag () const
 Returns this collection CTag.
 
QString displayName () const
 Returns the display name of the collection.
 
DavCollectionoperator= (const DavCollection &other)
 
DavCollectionoperator= (DavCollection &&)
 
Privileges privileges () const
 Returns the privileges on this collection.
 
void setColor (const QColor &color)
 Sets the color for this collection.
 
void setContentTypes (ContentTypes types)
 Sets the possible content types of the collection.
 
void setCTag (const QString &ctag)
 Sets this collection CTag.
 
void setDisplayName (const QString &name)
 Sets the display name of the collection.
 
void setPrivileges (Privileges privs)
 Sets the privileges on this collection.
 
void setUrl (const DavUrl &url)
 Sets the url that identifies the collection.
 
DavUrl url () const
 Returns the URL that identifies the collection.
 

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.

Member Typedef Documentation

◆ List

Defines a list of DAV collection objects.

Member Enumeration Documentation

◆ 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.

Constructor & Destructor Documentation

◆ DavCollection() [1/2]

KDAV::DavCollection::DavCollection ( )

Creates an empty DAV collection.

◆ DavCollection() [2/2]

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

Creates a new DAV collection.

Parameters
urlThe URL that identifies the collection.
displayNameThe display name of the collection.
contentTypesThe possible content types of the collection.

Member Function Documentation

◆ color()

QColor KDAV::DavCollection::color ( ) const

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

◆ contentTypes()

ContentTypes KDAV::DavCollection::contentTypes ( ) const

Returns the possible content types of the collection.

◆ CTag()

QString KDAV::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

◆ displayName()

QString KDAV::DavCollection::displayName ( ) const

Returns the display name of the collection.

◆ privileges()

Privileges KDAV::DavCollection::privileges ( ) const

Returns the privileges on this collection.

◆ setColor()

void KDAV::DavCollection::setColor ( const QColor &  color)

Sets the color for this collection.

◆ setContentTypes()

void KDAV::DavCollection::setContentTypes ( ContentTypes  types)

Sets the possible content types of the collection.

◆ setCTag()

void KDAV::DavCollection::setCTag ( const QString &  ctag)

◆ setDisplayName()

void KDAV::DavCollection::setDisplayName ( const QString &  name)

Sets the display name of the collection.

◆ setPrivileges()

void KDAV::DavCollection::setPrivileges ( Privileges  privs)

Sets the privileges on this collection.

◆ setUrl()

void KDAV::DavCollection::setUrl ( const DavUrl url)

Sets the url that identifies the collection.

◆ url()

DavUrl KDAV::DavCollection::url ( ) const

Returns the URL that identifies the collection.