KContacts::ContactGroup::ContactReference

Search for usage in LXR

KContacts::ContactGroup::ContactReference Class Reference

#include <contactgroup.h>

Public Types

typedef QList< 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 39 of file contactgroup.h.

Member Typedef Documentation

◆ List

A list of contact references.

Definition at line 45 of file contactgroup.h.

Constructor & Destructor Documentation

◆ ContactReference() [1/3]

ContactGroup::ContactReference::ContactReference ( )

Creates an empty contact reference.

Definition at line 39 of file contactgroup.cpp.

◆ ContactReference() [2/3]

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

Creates a contact reference from an other reference.

Definition at line 44 of file contactgroup.cpp.

◆ ContactReference() [3/3]

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

Creates a contact reference for the given contact uid.

Definition at line 49 of file contactgroup.cpp.

◆ ~ContactReference()

ContactGroup::ContactReference::~ContactReference ( )

Destroys the contact reference.

Definition at line 55 of file contactgroup.cpp.

Member Function Documentation

◆ custom()

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 99 of file contactgroup.cpp.

◆ gid()

QString ContactGroup::ContactReference::gid ( ) const

Returns the contact GID of the contact reference.

Since
4.12

Definition at line 74 of file contactgroup.cpp.

◆ insertCustom()

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 89 of file contactgroup.cpp.

◆ operator=()

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

Definition at line 104 of file contactgroup.cpp.

◆ operator==()

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

Definition at line 113 of file contactgroup.cpp.

◆ preferredEmail()

QString ContactGroup::ContactReference::preferredEmail ( ) const

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

Definition at line 84 of file contactgroup.cpp.

◆ removeCustom()

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

Removes the custom entry with the given key.

Definition at line 94 of file contactgroup.cpp.

◆ setGid()

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 69 of file contactgroup.cpp.

◆ setPreferredEmail()

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

Sets the preferred email address.

Definition at line 79 of file contactgroup.cpp.

◆ setUid()

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 59 of file contactgroup.cpp.

◆ uid()

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 64 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-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:39:36 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.