KDAV 5.109.0
Public Member Functions | List of all members
KDAV::DavCollectionModifyJob

A job that modifies a DAV collection. More...

#include <KDAV/DavCollectionModifyJob>

Public Member Functions

 DavCollectionModifyJob (const DavUrl &url, QObject *parent=nullptr)
 Creates a new DAV collection modify job.
 
void removeProperty (const QString &property, const QString &ns)
 Sets the property that shall be removed by the job.
 
void setProperty (const QString &property, const QString &value, const QString &ns=QString())
 Sets the property that shall be modified by the job.
 
void start () override
 Starts the job.
 
- Public Member Functions inherited from KDAV::DavJobBase
 DavJobBase (QObject *parent=nullptr)
 
bool canRetryLater () const
 Check if the job can be retried later.
 
Error davError () const
 Returns a instance of the KDAV:Error to be able to translate the error.
 
bool hasConflict () const
 Check if the job failed because of a conflict.
 
int latestResponseCode () const
 Get the latest response code.
 

Additional Inherited Members

- Protected Member Functions inherited from KDAV::DavJobBase
 DavJobBase (DavJobBasePrivate *dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from KDAV::DavJobBase
std::unique_ptr< DavJobBasePrivate > d_ptr
 

Detailed Description

A job that modifies a DAV collection.

This job is used to modify a property of a DAV collection on the DAV server.

Constructor & Destructor Documentation

◆ DavCollectionModifyJob()

KDAV::DavCollectionModifyJob::DavCollectionModifyJob ( const DavUrl url,
QObject *  parent = nullptr 
)
explicit

Creates a new DAV collection modify job.

Parameters
urlThe DAV URL that identifies the collection.
parentThe parent object.

Member Function Documentation

◆ removeProperty()

void KDAV::DavCollectionModifyJob::removeProperty ( const QString &  property,
const QString &  ns 
)

Sets the property that shall be removed by the job.

Parameters
propertyThe name of the property.
nsThe XML namespace that shall be used for the property name.

◆ setProperty()

void KDAV::DavCollectionModifyJob::setProperty ( const QString &  property,
const QString &  value,
const QString &  ns = QString() 
)

Sets the property that shall be modified by the job.

Parameters
propertyThe name of the property.
valueThe value of the property.
nsThe XML namespace that shall be used for the property name.

◆ start()

void KDAV::DavCollectionModifyJob::start ( )
override

Starts the job.