Akonadi::EntityAnnotationsAttribute Class Reference

#include <entityannotationsattribute.h>

Inheritance diagram for Akonadi::EntityAnnotationsAttribute:

Public Member Functions
	EntityAnnotationsAttribute (const QMap< QByteArray, QByteArray > &annotations)
QMap< QByteArray, QByteArray >	annotations () const
Attribute *	clone () const override
bool	contains (const QByteArray &key) const
void	deserialize (const QByteArray &data) override
void	insert (const QByteArray &key, const QString &value)
QByteArray	serialized () const override
void	setAnnotations (const QMap< QByteArray, QByteArray > &annotations)
QByteArray	type () const override
QString	value (const QByteArray &key) const
Public Member Functions inherited from Akonadi::Attribute
virtual	~Attribute ()

Additional Inherited Members
Public Types inherited from Akonadi::Attribute
using	List = QList<Attribute *>
Protected Member Functions inherited from Akonadi::Attribute
	Attribute (const Attribute &)=default

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

Since

4.13

Definition at line 30 of file entityannotationsattribute.h.

Constructor & Destructor Documentation

EntityAnnotationsAttribute()

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

explicit

Definition at line 15 of file entityannotationsattribute.cpp.

Member Function Documentation

annotations()

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

nodiscard

Definition at line 25 of file entityannotationsattribute.cpp.

clone()

Akonadi::Attribute * EntityAnnotationsAttribute::clone ( ) const

overridevirtual

Creates a copy of this attribute.

Implements Akonadi::Attribute.

Definition at line 51 of file entityannotationsattribute.cpp.

contains()

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

nodiscard

Definition at line 40 of file entityannotationsattribute.cpp.

deserialize()

void EntityAnnotationsAttribute::deserialize ( const QByteArray & data )

overridevirtual

Sets the data of this attribute, using the same encoding as returned by toByteArray().

Parameters

data	The encoded attribute data.

Implements Akonadi::Attribute.

Definition at line 71 of file entityannotationsattribute.cpp.

insert()

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

Definition at line 30 of file entityannotationsattribute.cpp.

serialized()

QByteArray EntityAnnotationsAttribute::serialized ( ) const

nodiscardoverridevirtual

Returns a QByteArray representation of the attribute which will be storaged.

This can be raw binary data, no encoding needs to be applied.

Implements Akonadi::Attribute.

Definition at line 56 of file entityannotationsattribute.cpp.

setAnnotations()

void EntityAnnotationsAttribute::setAnnotations

(

const QMap< QByteArray, QByteArray > &

annotations

)

Definition at line 20 of file entityannotationsattribute.cpp.

type()

QByteArray EntityAnnotationsAttribute::type ( ) const

nodiscardoverridevirtual

Returns the type of the attribute.

Implements Akonadi::Attribute.

Definition at line 45 of file entityannotationsattribute.cpp.

value()

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

nodiscard

Definition at line 35 of file entityannotationsattribute.cpp.

---

The documentation for this class was generated from the following files:

• entityannotationsattribute.h
• entityannotationsattribute.cpp