KContacts::ContactGroup::ContactReference Class
class KContacts::ContactGroup::ContactReferencePublic Types
Public Functions
ContactReference() | |
ContactReference(const QString &uid) | |
ContactReference(const KContacts::ContactGroup::ContactReference &other) | |
~ContactReference() | |
QString | custom(const QString &key) const |
(since 4.12) QString | gid() const |
void | insertCustom(const QString &key, const QString &value) |
QString | preferredEmail() const |
void | removeCustom(const QString &key) |
(since 4.12) 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
Member Type Documentation
ContactReference::List
A list of contact references.
Member Function Documentation
ContactReference::ContactReference()
Creates an empty contact reference.
ContactReference::ContactReference(const QString &uid)
Creates a contact reference for the given contact uid.
ContactReference::ContactReference(const KContacts::ContactGroup::ContactReference &other)
Creates a contact reference from an other reference.
[noexcept]
ContactReference::~ContactReference()
Destroys the contact reference.
QString 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.
[since 4.12]
QString ContactReference::gid() const
Returns the contact GID of the contact reference.
This function was introduced in 4.12.
See also setGid().
void ContactReference::insertCustom(const QString &key, const QString &value)
Inserts a custom entry. If an entry with the same key already exists, it is overwritten.
key The unique key.
value The value.
QString ContactReference::preferredEmail() const
Returns the preferred email address, or an empty string if no preferred email address is set.
See also setPreferredEmail().
void ContactReference::removeCustom(const QString &key)
Removes the custom entry with the given key.
[since 4.12]
void ContactReference::setGid(const QString &gid)
Sets the contact gid of the contact reference.
gid globally unique identifier of the contact to reference
This function was introduced in 4.12.
See also gid().
void ContactReference::setPreferredEmail(const QString &email)
Sets the preferred email address.
See also preferredEmail().
void ContactReference::setUid(const QString &uid)
Sets the contact uid of the contact reference.
uid identifier of the contact to reference
Note: That is the Akonadi Item ID of the contact that is referenced here.
See also uid().
QString 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.
See also setUid().