Akonadi::CollectionQuotaAttribute Class

class Akonadi::CollectionQuotaAttribute

Attribute that provides quota information for a collection. More...

Header:	`#include <Akonadi/CollectionQuotaAttribute>`
CMake:	`find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)` `target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore)`
Inherits:	Akonadi::Attribute

List of all members, including inherited members

Public Functions

	CollectionQuotaAttribute()
	CollectionQuotaAttribute(qint64 currentValue, qint64 maxValue)
virtual	~CollectionQuotaAttribute() override
qint64	currentValue() const
qint64	maximumValue() const
void	setCurrentValue(qint64 value)
void	setMaximumValue(qint64 value)

Reimplemented Public Functions

virtual Akonadi::Attribute *	clone() const override
virtual void	deserialize(const QByteArray &data) override
virtual QByteArray	serialized() const override
virtual QByteArray	type() const override

Detailed Description

This attribute class provides quota information (e.g. current fill value and maximum fill value) for an Akonadi collection.

Example:

 using namespace Akonadi;

 const Collection collection = collectionFetchJob->collections().at(0);
 if ( collection.hasAttribute<CollectionQuotaAttribute>() ) {
   const CollectionQuotaAttribute *attribute = collection.attribute<CollectionQuotaAttribute>();
   qDebug() << "current value" << attribute->currentValue();
 }

Author: Kevin Ottens <ervin@kde.org>

Member Function Documentation

`[explicit]` CollectionQuotaAttribute::CollectionQuotaAttribute()

Creates a new collection quota attribute.

CollectionQuotaAttribute::CollectionQuotaAttribute(qint64 currentValue, qint64 maxValue)

Creates a new collection quota attribute with initial values.

currentValue The current quota value in bytes. maxValue The maximum quota value in bytes.

`[override virtual noexcept]` CollectionQuotaAttribute::~CollectionQuotaAttribute()

Destroys the collection quota attribute.

`[override virtual]` Akonadi::Attribute *CollectionQuotaAttribute::clone() const

Reimplements: Attribute::clone() const.

qint64 CollectionQuotaAttribute::currentValue() const

Returns the current quota value in bytes.

See also setCurrentValue().

`[override virtual]` void CollectionQuotaAttribute::deserialize(const QByteArray &data)

Reimplements: Attribute::deserialize(const QByteArray &data).

qint64 CollectionQuotaAttribute::maximumValue() const

Returns the maximum quota value in bytes.

See also setMaximumValue().

`[override virtual]` QByteArray CollectionQuotaAttribute::serialized() const

Reimplements: Attribute::serialized() const.

void CollectionQuotaAttribute::setCurrentValue(qint64 value)

Sets the current quota value for the collection.

value The current quota value in bytes.

See also currentValue().

void CollectionQuotaAttribute::setMaximumValue(qint64 value)

Sets the maximum quota value for the collection.

value The maximum quota value in bytes.

See also maximumValue().

`[override virtual]` QByteArray CollectionQuotaAttribute::type() const

Reimplements: Attribute::type() const.

Contents