KContacts::ContactGroup::ContactReference

KContacts::ContactGroup::ContactReference Class Reference

#include <contactgroup.h>

Public Types

typedef QVector< ContactReferenceList
 

Public Member Functions

 ContactReference ()
 
 ContactReference (const ContactReference &other)
 
 ContactReference (const QString &uid)
 
 ~ContactReference ()
 
QString custom (const QString &key) const
 
QString gid () const
 
void insertCustom (const QString &key, const QString &value)
 
ContactReferenceoperator= (const ContactReference &other)
 
bool operator== (const ContactReference &other) const
 
QString preferredEmail () const
 
void removeCustom (const QString &key)
 
void setGid (const QString &gid)
 
void setPreferredEmail (const QString &email)
 
void setUid (const QString &uid)
 
QString uid () const
 

Detailed Description

This class represents a contact reference.

Definition at line 52 of file contactgroup.h.

Member Typedef Documentation

A list of contact references.

Definition at line 58 of file contactgroup.h.

Constructor & Destructor Documentation

ContactGroup::ContactReference::ContactReference ( )

Creates an empty contact reference.

Definition at line 53 of file contactgroup.cpp.

ContactGroup::ContactReference::ContactReference ( const ContactReference other)

Creates a contact reference from an other reference.

Definition at line 58 of file contactgroup.cpp.

ContactGroup::ContactReference::ContactReference ( const QString uid)

Creates a contact reference for the given contact uid.

Definition at line 63 of file contactgroup.cpp.

ContactGroup::ContactReference::~ContactReference ( )

Destroys the contact reference.

Definition at line 69 of file contactgroup.cpp.

Member Function Documentation

QString ContactGroup::ContactReference::custom ( const QString key) const

Returns the value for the given key, or an empty string if the entry for that key does not exists.

Definition at line 113 of file contactgroup.cpp.

QString ContactGroup::ContactReference::gid ( ) const

Returns the contact GID of the contact reference.

Since
4.12

Definition at line 88 of file contactgroup.cpp.

void ContactGroup::ContactReference::insertCustom ( const QString key,
const QString value 
)

Inserts a custom entry.

If an entry with the same key already exists, it is overwritten.

Parameters
keyThe unique key.
valueThe value.

Definition at line 103 of file contactgroup.cpp.

ContactGroup::ContactReference & ContactGroup::ContactReference::operator= ( const ContactReference other)

Definition at line 118 of file contactgroup.cpp.

bool ContactGroup::ContactReference::operator== ( const ContactReference other) const

Definition at line 128 of file contactgroup.cpp.

QString ContactGroup::ContactReference::preferredEmail ( ) const

Returns the preferred email address, or an empty string if no preferred email address is set.

Definition at line 98 of file contactgroup.cpp.

void ContactGroup::ContactReference::removeCustom ( const QString key)

Removes the custom entry with the given key.

Definition at line 108 of file contactgroup.cpp.

void ContactGroup::ContactReference::setGid ( const QString gid)

Sets the contact gid of the contact reference.

Parameters
gidglobally unique identifier of the contact to reference
Since
4.12

Definition at line 83 of file contactgroup.cpp.

void ContactGroup::ContactReference::setPreferredEmail ( const QString email)

Sets the preferred email address.

Definition at line 93 of file contactgroup.cpp.

void ContactGroup::ContactReference::setUid ( const QString uid)

Sets the contact uid of the contact reference.

Parameters
uididentifier of the contact to reference
Note
That is the Akonadi Item ID of the contact that is referenced here.

Definition at line 73 of file contactgroup.cpp.

QString ContactGroup::ContactReference::uid ( ) const

Returns the contact uid of the contact reference.

Note
That is the Akonadi Item ID of the contact that is referenced here.

Definition at line 78 of file contactgroup.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 30 2020 23:02:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.