KDAV::DavCollection Class
class KDAV::DavCollectionA helper class to store information about DAV collection. More...
| Header: | #include <KDAV/DavCollection> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS DAV)target_link_libraries(mytarget PRIVATE KF6::DAV) |
Public Types
| enum | ContentType { Events, Todos, Contacts, FreeBusy, Journal, Calendar } |
| flags | ContentTypes |
| List |
Public Functions
| DavCollection() | |
| DavCollection(const KDAV::DavUrl &url, const QString &displayName, KDAV::DavCollection::ContentTypes contentTypes) | |
| QString | CTag() const |
| QColor | color() const |
| KDAV::DavCollection::ContentTypes | contentTypes() const |
| QString | displayName() const |
| KDAV::Privileges | privileges() const |
| void | setCTag(const QString &ctag) |
| void | setColor(const QColor &color) |
| void | setContentTypes(KDAV::DavCollection::ContentTypes types) |
| void | setDisplayName(const QString &name) |
| void | setPrivileges(KDAV::Privileges privs) |
| void | setUrl(const KDAV::DavUrl &url) |
| KDAV::DavUrl | url() const |
Detailed Description
This class is used as container to transfer information about DAV collections between the Akonadi resource and the DAV jobs.
Member Type Documentation
enum DavCollection::ContentType
flags DavCollection::ContentTypes
Describes the possible content type of the DAV collection.
| Constant | Value | Description |
|---|---|---|
KDAV::DavCollection::Events | 1 | The collection can contain event DAV resources. |
KDAV::DavCollection::Todos | 2 | The collection can contain todo DAV resources. |
KDAV::DavCollection::Contacts | 4 | The collection can contain contact DAV resources. |
KDAV::DavCollection::FreeBusy | 8 | The collection can contain free/busy information. |
KDAV::DavCollection::Journal | 16 | The collection can contain journal DAV resources. |
KDAV::DavCollection::Calendar | 32 | The collection can contain anything calendar-related. |
The ContentTypes type is a typedef for QFlags<ContentType>. It stores an OR combination of ContentType values.
DavCollection::List
Defines a list of DAV collection objects.
Member Function Documentation
DavCollection::DavCollection()
Creates an empty DAV collection.
DavCollection::DavCollection(const KDAV::DavUrl &url, const QString &displayName, KDAV::DavCollection::ContentTypes contentTypes)
Creates a new DAV collection.
url The URL that identifies the collection.
displayName The display name of the collection.
contentTypes The possible content types of the collection.
QString DavCollection::CTag() const
Returns this collection CTag. The returned value will be empty if no CTag was found.
See also setCTag() and https://github.com/apple/ccs-calendarserver/blob/master/doc/Extensions/caldav-ctag.txt.
QColor DavCollection::color() const
Return the color of the collection, or an empty string if none was provided by the backend.
See also setColor().
KDAV::DavCollection::ContentTypes DavCollection::contentTypes() const
Returns the possible content types of the collection.
See also setContentTypes().
QString DavCollection::displayName() const
Returns the display name of the collection.
See also setDisplayName().
KDAV::Privileges DavCollection::privileges() const
Returns the privileges on this collection.
See also setPrivileges().
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.
void DavCollection::setColor(const QColor &color)
Sets the color for this collection
See also color().
void DavCollection::setContentTypes(KDAV::DavCollection::ContentTypes types)
Sets the possible content types of the collection.
See also contentTypes().
void DavCollection::setDisplayName(const QString &name)
Sets the display name of the collection.
See also displayName().
void DavCollection::setPrivileges(KDAV::Privileges privs)
Sets the privileges on this collection.
See also privileges().
void DavCollection::setUrl(const KDAV::DavUrl &url)
Sets the url that identifies the collection.
See also url().
KDAV::DavUrl DavCollection::url() const
Returns the URL that identifies the collection.
See also setUrl().