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

A job that lists all DAV items inside a DAV collection. More...

#include <KDAV/DavItemsListJob>

Public Member Functions

 DavItemsListJob (const DavUrl &url, const std::shared_ptr< EtagCache > &cache, QObject *parent=nullptr)
 Creates a new DAV items list job.
 
DavItem::List changedItems () const
 Returns the list of items that were changed on the server.
 
QStringList deletedItems () const
 Returns the list of items URLs that were not seen in the backend.
 
DavItem::List items () const
 Returns the list of items seen including identifier URL and ETag information.
 
void setContentMimeTypes (const QStringList &types)
 Limits the mime types of the items requested.
 
void setTimeRange (const QString &start, const QString &end)
 Sets the start and end time to list items for.
 
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 lists all DAV items inside a DAV collection.

Constructor & Destructor Documentation

◆ DavItemsListJob()

KDAV::DavItemsListJob::DavItemsListJob ( const DavUrl url,
const std::shared_ptr< EtagCache > &  cache,
QObject *  parent = nullptr 
)

Creates a new DAV items list job.

Parameters
urlThe URL of the DAV collection.
parentThe parent object.

Member Function Documentation

◆ changedItems()

DavItem::List KDAV::DavItemsListJob::changedItems ( ) const

Returns the list of items that were changed on the server.

◆ deletedItems()

QStringList KDAV::DavItemsListJob::deletedItems ( ) const

Returns the list of items URLs that were not seen in the backend.

As this is based on the ETag cache this may contain dependent items.

◆ items()

DavItem::List KDAV::DavItemsListJob::items ( ) const

Returns the list of items seen including identifier URL and ETag information.

◆ setContentMimeTypes()

void KDAV::DavItemsListJob::setContentMimeTypes ( const QStringList &  types)

Limits the mime types of the items requested.

If no mime type is given then all will be requested.

Parameters
typesThe list of mime types to include

◆ setTimeRange()

void KDAV::DavItemsListJob::setTimeRange ( const QString &  start,
const QString &  end 
)

Sets the start and end time to list items for.

Parameters
startThe range start, in format "date with UTC time"
endThe range end, in format "date with UTC time"

◆ start()

void KDAV::DavItemsListJob::start ( )
override

Starts the job.