KGAPI2::People::EmailAddress

Search for usage in LXR

KGAPI2::People::EmailAddress Class Reference

#include <emailaddress.h>

Public Member Functions

 EmailAddress ()
 
 EmailAddress (const EmailAddress &)
 
 EmailAddress (EmailAddress &&) noexcept
 
 ~EmailAddress ()
 
QString displayName () const
 
QString formattedType () const
 
FieldMetadata metadata () const
 
bool operator!= (const EmailAddress &) const
 
EmailAddressoperator= (const EmailAddress &)
 
EmailAddressoperator= (EmailAddress &&) noexcept
 
bool operator== (const EmailAddress &) const
 
void setDisplayName (const QString &value)
 
void setMetadata (const FieldMetadata &value)
 
void setType (const QString &value)
 
void setValue (const QString &value)
 
QJsonValue toJSON () const
 
KContacts::Email toKContactsEmail () const
 
QString type () const
 
QString value () const
 

Static Public Member Functions

static EmailAddress fromJSON (const QJsonObject &obj)
 
static QList< EmailAddressfromJSONArray (const QJsonArray &data)
 
static EmailAddress fromKContactsEmail (const KContacts::Email &email)
 
static QList< EmailAddressfromKContactsEmailList (const QList< KContacts::Email > &emailList)
 

Detailed Description

A person's email address.

See also
https://developers.google.com/people/api/rest/v1/people#emailaddress
Since
5.23.0

Definition at line 38 of file emailaddress.h.

Constructor & Destructor Documentation

◆ EmailAddress()

KGAPI2::People::EmailAddress::EmailAddress ( )
explicit

Constructs a new EmailAddress.

Definition at line 54 of file emailaddress.cpp.

◆ ~EmailAddress()

KGAPI2::People::EmailAddress::~EmailAddress ( )
default

Destructor.

Member Function Documentation

◆ displayName()

QString KGAPI2::People::EmailAddress::displayName ( ) const
nodiscard

The display name of the email.

Definition at line 102 of file emailaddress.cpp.

◆ formattedType()

QString KGAPI2::People::EmailAddress::formattedType ( ) const
nodiscard

Output only.

The type of the email address translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.

Definition at line 111 of file emailaddress.cpp.

◆ fromJSON()

EmailAddress KGAPI2::People::EmailAddress::fromJSON ( const QJsonObject & obj)
staticnodiscard

Definition at line 116 of file emailaddress.cpp.

◆ fromJSONArray()

QList< EmailAddress > KGAPI2::People::EmailAddress::fromJSONArray ( const QJsonArray & data)
staticnodiscard

Definition at line 132 of file emailaddress.cpp.

◆ fromKContactsEmail()

EmailAddress KGAPI2::People::EmailAddress::fromKContactsEmail ( const KContacts::Email & email)
staticnodiscard

Definition at line 177 of file emailaddress.cpp.

◆ fromKContactsEmailList()

QList< EmailAddress > KGAPI2::People::EmailAddress::fromKContactsEmailList ( const QList< KContacts::Email > & emailList)
staticnodiscard

Definition at line 198 of file emailaddress.cpp.

◆ metadata()

FieldMetadata KGAPI2::People::EmailAddress::metadata ( ) const
nodiscard

Metadata about the email address.

Definition at line 84 of file emailaddress.cpp.

◆ operator!=()

bool KGAPI2::People::EmailAddress::operator!= ( const EmailAddress & other) const

Definition at line 70 of file emailaddress.cpp.

◆ operator==()

bool KGAPI2::People::EmailAddress::operator== ( const EmailAddress & other) const

Definition at line 65 of file emailaddress.cpp.

◆ setDisplayName()

void KGAPI2::People::EmailAddress::setDisplayName ( const QString & value)

Sets value of the displayName property.

Definition at line 107 of file emailaddress.cpp.

◆ setMetadata()

void KGAPI2::People::EmailAddress::setMetadata ( const FieldMetadata & value)

Sets value of the metadata property.

Definition at line 89 of file emailaddress.cpp.

◆ setType()

void KGAPI2::People::EmailAddress::setType ( const QString & value)

Sets value of the type property.

Definition at line 98 of file emailaddress.cpp.

◆ setValue()

void KGAPI2::People::EmailAddress::setValue ( const QString & value)

Sets value of the value property.

Definition at line 80 of file emailaddress.cpp.

◆ toJSON()

QJsonValue KGAPI2::People::EmailAddress::toJSON ( ) const
nodiscard

Definition at line 147 of file emailaddress.cpp.

◆ toKContactsEmail()

KContacts::Email KGAPI2::People::EmailAddress::toKContactsEmail ( ) const
nodiscard

Definition at line 159 of file emailaddress.cpp.

◆ type()

QString KGAPI2::People::EmailAddress::type ( ) const
nodiscard

The type of the email address.

The type can be custom or one of these predefined values: * home * work * other

Definition at line 93 of file emailaddress.cpp.

◆ value()

QString KGAPI2::People::EmailAddress::value ( ) const
nodiscard

The email address.

Definition at line 75 of file emailaddress.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 Sat Dec 21 2024 17:00:12 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.