KContacts::Impp Class

class KContacts::Impp

Class that holds a IMPP for a contact. More...

Header: #include <KContacts/Impp>
CMake: find_package(KF6 REQUIRED COMPONENTS Contacts)
target_link_libraries(mytarget PRIVATE KF6::Contacts)
Since: 4.14.5
In QML: impp

Public Types

Properties

Public Functions

Impp()
Impp(const QUrl &address)
QUrl address() const
(since 5.12) bool isPreferred() const
bool isValid() const
(since 5.12) QString serviceIcon() const
(since 5.12) QString serviceLabel() const
(since 5.12) QString serviceType() const
void setAddress(const QUrl &address)
(since 5.12) void setPreferred(bool preferred)
QString toString() const
bool operator!=(const KContacts::Impp &other) const
bool operator==(const KContacts::Impp &other) const

Static Public Members

(since 5.12) QString serviceIcon(const QString &serviceType)
(since 5.12) QString serviceLabel(const QString &serviceType)
(since 5.12) QList<QString> serviceTypes()
QDataStream &operator<<(QDataStream &stream, const KContacts::Impp &object)
QDataStream &operator>>(QDataStream &stream, KContacts::Impp &object)

Detailed Description

IMPP stands for "Instant Messaging and Presence Protocol". This field is defined in the vCard 3.0 extension RFC 4770 and is part of vCard 4.0 (RFC 6350).

Member Type Documentation

Impp::List

Property Documentation

address : QUrl

Access functions:

QUrl address() const
void setAddress(const QUrl &address)

isPreferred : bool

Access functions:

bool isPreferred() const
void setPreferred(bool preferred)

[read-only] isValid : const bool

Access functions:

bool isValid() const

[read-only] serviceIcon : const QString

Access functions:

QString serviceIcon() const
QString serviceIcon(const QString &serviceType)

[read-only] serviceLabel : const QString

Access functions:

QString serviceLabel() const
QString serviceLabel(const QString &serviceType)

[read-only] serviceType : const QString

Access functions:

QString serviceType() const

Member Function Documentation

Impp::Impp()

Impp::Impp(const QUrl &address)

QUrl Impp::address() const

Note: Getter function for property address.

See also setAddress().

[since 5.12] bool Impp::isPreferred() const

Returns whether this is the preferred messaging address.

Note: Getter function for property isPreferred.

This function was introduced in 5.12.

bool Impp::isValid() const

Note: Getter function for property isValid.

[since 5.12] QString Impp::serviceIcon() const

Returns the name of an icon representing the service type.

Note: Getter function for property serviceIcon.

This function was introduced in 5.12.

[static, since 5.12] QString Impp::serviceIcon(const QString &serviceType)

Returns an icon name representing the given IM service.

Note: Getter function for property serviceIcon.

This function was introduced in 5.12.

[since 5.12] QString Impp::serviceLabel() const

Returns a translated label for the service type.

Note: Getter function for property serviceLabel.

This function was introduced in 5.12.

[static, since 5.12] QString Impp::serviceLabel(const QString &serviceType)

Returns a translated name of the given IM service.

Note: Getter function for property serviceLabel.

This function was introduced in 5.12.

[since 5.12] QString Impp::serviceType() const

Returns the messaging service this address is for. This is equivalent to address().scheme().

Note: Getter function for property serviceType.

This function was introduced in 5.12.

[static, since 5.12] QList<QString> Impp::serviceTypes()

List all known service types.

Don't use these strings directly for display, instead use serviceLabel and serviceIcon.

This function was introduced in 5.12.

void Impp::setAddress(const QUrl &address)

Note: Setter function for property address.

See also address().

[since 5.12] void Impp::setPreferred(bool preferred)

Sets that this is the preferred messaging address.

Note: Setter function for property isPreferred.

This function was introduced in 5.12.

See also isPreferred().

QString Impp::toString() const

bool Impp::operator!=(const KContacts::Impp &other) const

bool Impp::operator==(const KContacts::Impp &other) const

Related Non-Members

QDataStream &operator<<(QDataStream &stream, const KContacts::Impp &object)

QDataStream &operator>>(QDataStream &stream, KContacts::Impp &object)