Akonadi::CollectionIdentificationAttribute

Search for usage in LXR

Akonadi::CollectionIdentificationAttribute Class Reference

#include <collectionidentificationattribute.h>

Inheritance diagram for Akonadi::CollectionIdentificationAttribute:

Public Member Functions

 CollectionIdentificationAttribute (const QByteArray &identifier=QByteArray(), const QByteArray &folderNamespace=QByteArray(), const QByteArray &name=QByteArray(), const QByteArray &organizationUnit=QByteArray(), const QByteArray &mail=QByteArray())
 
Attributeclone () const override
 
QByteArray collectionNamespace () const
 
void deserialize (const QByteArray &data) override
 
QByteArray identifier () const
 
QByteArray mail () const
 
QByteArray name () const
 
QByteArray ou () const
 
QByteArray serialized () const override
 
void setCollectionNamespace (const QByteArray &ns)
 
void setIdentifier (const QByteArray &identifier)
 
void setMail (const QByteArray &)
 
void setName (const QByteArray &)
 
void setOu (const QByteArray &)
 
QByteArray type () const override
 
- 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

Attribute that stores additional information on a collection that can be used for searching.

Additional indexed properties that can be used for searching.

Author
Christian Mollekopf molle.nosp@m.kopf.nosp@m.@kola.nosp@m.bsys.nosp@m..com
Since
4.15

Definition at line 26 of file collectionidentificationattribute.h.

Constructor & Destructor Documentation

◆ CollectionIdentificationAttribute()

CollectionIdentificationAttribute::CollectionIdentificationAttribute ( const QByteArray & identifier = QByteArray(),
const QByteArray & folderNamespace = QByteArray(),
const QByteArray & name = QByteArray(),
const QByteArray & organizationUnit = QByteArray(),
const QByteArray & mail = QByteArray() )
explicit

Definition at line 26 of file collectionidentificationattribute.cpp.

Member Function Documentation

◆ clone()

Akonadi::Attribute * CollectionIdentificationAttribute::clone ( ) const
overridevirtual

Creates a copy of this attribute.

Implements Akonadi::Attribute.

Definition at line 97 of file collectionidentificationattribute.cpp.

◆ collectionNamespace()

QByteArray CollectionIdentificationAttribute::collectionNamespace ( ) const

Definition at line 87 of file collectionidentificationattribute.cpp.

◆ deserialize()

void CollectionIdentificationAttribute::deserialize ( const QByteArray & data)
overridevirtual

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

Parameters
dataThe encoded attribute data.

Implements Akonadi::Attribute.

Definition at line 113 of file collectionidentificationattribute.cpp.

◆ identifier()

QByteArray CollectionIdentificationAttribute::identifier ( ) const

Definition at line 47 of file collectionidentificationattribute.cpp.

◆ mail()

QByteArray CollectionIdentificationAttribute::mail ( ) const

Definition at line 57 of file collectionidentificationattribute.cpp.

◆ name()

QByteArray CollectionIdentificationAttribute::name ( ) const

Definition at line 77 of file collectionidentificationattribute.cpp.

◆ ou()

QByteArray CollectionIdentificationAttribute::ou ( ) const

Definition at line 67 of file collectionidentificationattribute.cpp.

◆ serialized()

QByteArray CollectionIdentificationAttribute::serialized ( ) const
overridevirtual

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 102 of file collectionidentificationattribute.cpp.

◆ setCollectionNamespace()

void CollectionIdentificationAttribute::setCollectionNamespace ( const QByteArray & ns)

Sets a namespace the collection is in.

Initially used are:

  • "person" for a collection shared by a person.
  • "shared" for a collection shared by a person.

Definition at line 82 of file collectionidentificationattribute.cpp.

◆ setIdentifier()

void CollectionIdentificationAttribute::setIdentifier ( const QByteArray & identifier)

Sets an identifier for the collection.

Definition at line 42 of file collectionidentificationattribute.cpp.

◆ setMail()

void CollectionIdentificationAttribute::setMail ( const QByteArray & mail)

Definition at line 52 of file collectionidentificationattribute.cpp.

◆ setName()

void CollectionIdentificationAttribute::setName ( const QByteArray & name)

Definition at line 72 of file collectionidentificationattribute.cpp.

◆ setOu()

void CollectionIdentificationAttribute::setOu ( const QByteArray & ou)

Definition at line 62 of file collectionidentificationattribute.cpp.

◆ type()

QByteArray CollectionIdentificationAttribute::type ( ) const
overridevirtual

Returns the type of the attribute.

Implements Akonadi::Attribute.

Definition at line 92 of file collectionidentificationattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:58:18 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.