KGAPI2::People::Residence

Search for usage in LXR

KGAPI2::People::Residence Class Reference

#include <residence.h>

Public Member Functions

 Residence ()
 
 Residence (const Residence &)
 
 Residence (Residence &&) noexcept
 
 ~Residence ()
 
bool current () const
 
FieldMetadata metadata () const
 
bool operator!= (const Residence &) const
 
Residenceoperator= (const Residence &)
 
Residenceoperator= (Residence &&) noexcept
 
bool operator== (const Residence &) const
 
void setCurrent (bool value)
 
void setMetadata (const FieldMetadata &value)
 
void setValue (const QString &value)
 
QJsonValue toJSON () const
 
QString value () const
 

Static Public Member Functions

static Residence fromJSON (const QJsonObject &)
 

Detailed Description

DEPRECATED: Please use person.locations instead.

A person's past or current residence.

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

Definition at line 32 of file residence.h.

Constructor & Destructor Documentation

◆ Residence()

KGAPI2::People::Residence::Residence ( )
explicit

Constructs a new Residence.

Definition at line 48 of file residence.cpp.

◆ ~Residence()

KGAPI2::People::Residence::~Residence ( )
default

Destructor.

Member Function Documentation

◆ current()

bool KGAPI2::People::Residence::current ( ) const
nodiscard

True if the residence is the person's current residence; false if the residence is a past residence.

Definition at line 87 of file residence.cpp.

◆ fromJSON()

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

Definition at line 97 of file residence.cpp.

◆ metadata()

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

Metadata about the residence.

Definition at line 78 of file residence.cpp.

◆ operator!=()

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

Definition at line 64 of file residence.cpp.

◆ operator==()

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

Definition at line 59 of file residence.cpp.

◆ setCurrent()

void KGAPI2::People::Residence::setCurrent ( bool value)

Sets value of the current property.

Definition at line 92 of file residence.cpp.

◆ setMetadata()

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

Sets value of the metadata property.

Definition at line 83 of file residence.cpp.

◆ setValue()

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

Sets value of the value property.

Definition at line 74 of file residence.cpp.

◆ toJSON()

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

Definition at line 103 of file residence.cpp.

◆ value()

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

The address of the residence.

Definition at line 69 of file residence.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 Mon Nov 18 2024 12:17:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.