Akonadi::EntityAnnotationsAttribute Class

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

Public Functions

EntityAnnotationsAttribute()
EntityAnnotationsAttribute(const QMap<QByteArray, QByteArray> &annotations)
QMap<QByteArray, QByteArray> annotations() const
bool contains(const QByteArray &key) const
void insert(const QByteArray &key, const QString &value)
void setAnnotations(const QMap<QByteArray, QByteArray> &annotations)
QString value(const QByteArray &key) const

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

An attribute for annotations.

The attribute is inspired by RFC5257(IMAP ANNOTATION) and RFC5464(IMAP METADATA), but serves the purpose of RFC5257.

For a private note annotation the entry name is: /private/comment for a shared note: /shared/comment

Member Function Documentation

[explicit constexpr noexcept] EntityAnnotationsAttribute::EntityAnnotationsAttribute()

[explicit] EntityAnnotationsAttribute::EntityAnnotationsAttribute(const QMap<QByteArray, QByteArray> &annotations)

QMap<QByteArray, QByteArray> EntityAnnotationsAttribute::annotations() const

See also setAnnotations().

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

Reimplements: Attribute::clone() const.

bool EntityAnnotationsAttribute::contains(const QByteArray &key) const

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

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

void EntityAnnotationsAttribute::insert(const QByteArray &key, const QString &value)

[override virtual] QByteArray EntityAnnotationsAttribute::serialized() const

Reimplements: Attribute::serialized() const.

void EntityAnnotationsAttribute::setAnnotations(const QMap<QByteArray, QByteArray> &annotations)

See also annotations().

[override virtual] QByteArray EntityAnnotationsAttribute::type() const

Reimplements: Attribute::type() const.

QString EntityAnnotationsAttribute::value(const QByteArray &key) const