KDAV 5.109.0
Signals | Public Member Functions | List of all members
KDAV::DavCollectionsFetchJob

A job that fetches all DAV collection. More...

#include <KDAV/DavCollectionsFetchJob>

Signals

void collectionDiscovered (KDAV::Protocol protocol, const QString &collectionUrl, const QString &configuredUrl)
 This signal is emitted every time a new collection has been discovered.
 

Public Member Functions

 DavCollectionsFetchJob (const DavUrl &url, QObject *parent=nullptr)
 Creates a new DAV collections fetch job.
 
DavCollection::List collections () const
 Returns the list of fetched DAV collections.
 
DavUrl davUrl () const
 Return the DavUrl used by this 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 fetches all DAV collection.

This job is used to fetch all DAV collection that are available under a certain DAV URL.

Constructor & Destructor Documentation

◆ DavCollectionsFetchJob()

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

Creates a new DAV collections fetch job.

Parameters
urlThe DAV URL of the DAV collection whose sub collections shall be fetched.
parentThe parent object.

Member Function Documentation

◆ collectionDiscovered

void KDAV::DavCollectionsFetchJob::collectionDiscovered ( KDAV::Protocol  protocol,
const QString &  collectionUrl,
const QString &  configuredUrl 
)
signal

This signal is emitted every time a new collection has been discovered.

Parameters
collectionUrlThe URL of the discovered collection
configuredUrlThe URL given to the job

◆ collections()

DavCollection::List KDAV::DavCollectionsFetchJob::collections ( ) const

Returns the list of fetched DAV collections.

◆ davUrl()

DavUrl KDAV::DavCollectionsFetchJob::davUrl ( ) const

Return the DavUrl used by this job.

◆ start()

void KDAV::DavCollectionsFetchJob::start ( )
override

Starts the job.