KGAPI2::People::Address

Search for usage in LXR

KGAPI2::People::Address Class Reference

#include <address.h>

Public Member Functions

 Address ()
 
 Address (Address &&) noexcept
 
 Address (const Address &)
 
 ~Address ()
 
QString city () const
 
QString country () const
 
QString countryCode () const
 
QString extendedAddress () const
 
QString formattedType () const
 
QString formattedValue () const
 
FieldMetadata metadata () const
 
bool operator!= (const Address &) const
 
Addressoperator= (Address &&) noexcept
 
Addressoperator= (const Address &)
 
bool operator== (const Address &) const
 
QString poBox () const
 
QString postalCode () const
 
QString region () const
 
void setCity (const QString &value)
 
void setCountry (const QString &value)
 
void setCountryCode (const QString &value)
 
void setExtendedAddress (const QString &value)
 
void setFormattedValue (const QString &value)
 
void setMetadata (const FieldMetadata &value)
 
void setPoBox (const QString &value)
 
void setPostalCode (const QString &value)
 
void setRegion (const QString &value)
 
void setStreetAddress (const QString &value)
 
void setType (const QString &value)
 
QString streetAddress () const
 
QJsonValue toJSON () const
 
QString type () const
 

Static Public Member Functions

static Address fromJSON (const QJsonObject &obj)
 
static QList< AddressfromJSONArray (const QJsonArray &data)
 

Detailed Description

A person's physical address.

May be a P.O. box or street address. All fields are optional.

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

Definition at line 34 of file address.h.

Constructor & Destructor Documentation

◆ Address()

KGAPI2::People::Address::Address ( )
explicit

Constructs a new Address.

Definition at line 58 of file address.cpp.

◆ ~Address()

KGAPI2::People::Address::~Address ( )
default

Destructor.

Member Function Documentation

◆ city()

QString KGAPI2::People::Address::city ( ) const

The city of the address.

Definition at line 83 of file address.cpp.

◆ country()

QString KGAPI2::People::Address::country ( ) const

The country of the address.

Definition at line 173 of file address.cpp.

◆ countryCode()

QString KGAPI2::People::Address::countryCode ( ) const

The ISO 3166-1 alpha-2 country code of the address.

Definition at line 101 of file address.cpp.

◆ extendedAddress()

QString KGAPI2::People::Address::extendedAddress ( ) const

The extended address of the address; for example, the apartment number.

Definition at line 146 of file address.cpp.

◆ formattedType()

QString KGAPI2::People::Address::formattedType ( ) const

Output only.

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

Definition at line 79 of file address.cpp.

◆ formattedValue()

QString KGAPI2::People::Address::formattedValue ( ) const

The unstructured value of the address.

If this is not set by the user it will be automatically constructed from structured values.

Definition at line 137 of file address.cpp.

◆ fromJSON()

Address KGAPI2::People::Address::fromJSON ( const QJsonObject & obj)
static

Definition at line 183 of file address.cpp.

◆ fromJSONArray()

QList< Address > KGAPI2::People::Address::fromJSONArray ( const QJsonArray & data)
static

Definition at line 204 of file address.cpp.

◆ metadata()

FieldMetadata KGAPI2::People::Address::metadata ( ) const

Metadata about the address.

Definition at line 92 of file address.cpp.

◆ operator!=()

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

Definition at line 74 of file address.cpp.

◆ operator==()

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

Definition at line 69 of file address.cpp.

◆ poBox()

QString KGAPI2::People::Address::poBox ( ) const

The P.O.

box of the address.

Definition at line 119 of file address.cpp.

◆ postalCode()

QString KGAPI2::People::Address::postalCode ( ) const

The postal code of the address.

Definition at line 110 of file address.cpp.

◆ region()

QString KGAPI2::People::Address::region ( ) const

The region of the address; for example, the state or province.

Definition at line 155 of file address.cpp.

◆ setCity()

void KGAPI2::People::Address::setCity ( const QString & value)

Sets value of the city property.

Definition at line 88 of file address.cpp.

◆ setCountry()

void KGAPI2::People::Address::setCountry ( const QString & value)

Sets value of the country property.

Definition at line 178 of file address.cpp.

◆ setCountryCode()

void KGAPI2::People::Address::setCountryCode ( const QString & value)

Sets value of the countryCode property.

Definition at line 106 of file address.cpp.

◆ setExtendedAddress()

void KGAPI2::People::Address::setExtendedAddress ( const QString & value)

Sets value of the extendedAddress property.

Definition at line 151 of file address.cpp.

◆ setFormattedValue()

void KGAPI2::People::Address::setFormattedValue ( const QString & value)

Sets value of the formattedValue property.

Definition at line 142 of file address.cpp.

◆ setMetadata()

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

Sets value of the metadata property.

Definition at line 97 of file address.cpp.

◆ setPoBox()

void KGAPI2::People::Address::setPoBox ( const QString & value)

Sets value of the poBox property.

Definition at line 124 of file address.cpp.

◆ setPostalCode()

void KGAPI2::People::Address::setPostalCode ( const QString & value)

Sets value of the postalCode property.

Definition at line 115 of file address.cpp.

◆ setRegion()

void KGAPI2::People::Address::setRegion ( const QString & value)

Sets value of the region property.

Definition at line 160 of file address.cpp.

◆ setStreetAddress()

void KGAPI2::People::Address::setStreetAddress ( const QString & value)

Sets value of the streetAddress property.

Definition at line 169 of file address.cpp.

◆ setType()

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

Sets value of the type property.

Definition at line 133 of file address.cpp.

◆ streetAddress()

QString KGAPI2::People::Address::streetAddress ( ) const

The street address.

Definition at line 164 of file address.cpp.

◆ toJSON()

QJsonValue KGAPI2::People::Address::toJSON ( ) const

Definition at line 218 of file address.cpp.

◆ type()

QString KGAPI2::People::Address::type ( ) const

The type of the address.

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

Definition at line 128 of file address.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 Apr 27 2024 22:14:20 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.