KGAPI2::People::Nickname Class Reference

#include <nickname.h>

Public Types
enum class	Type {   DEFAULT , MAIDEN_NAME , INITIALS , GPLUS ,   OTHER_NAME , ALTERNATE_NAME , SHORT_NAME }

Public Member Functions
	Nickname ()
	Nickname (const Nickname &)
	Nickname (Nickname &&) noexcept
	~Nickname ()
FieldMetadata	metadata () const
bool	operator!= (const Nickname &) const
Nickname &	operator= (const Nickname &)
Nickname &	operator= (Nickname &&) noexcept
bool	operator== (const Nickname &) const
void	setMetadata (const FieldMetadata &value)
void	setType (Nickname::Type value)
void	setValue (const QString &value)
QJsonValue	toJSON () const
Nickname::Type	type () const
QString	value () const

Static Public Member Functions
static Nickname	fromJSON (const QJsonObject &)
static QList< Nickname >	fromJSONArray (const QJsonArray &data)

Detailed Description

A person's nickname.

See also

https://developers.google.com/people/api/rest/v1/people#nickname

Since

5.23.0

Definition at line 33 of file nickname.h.

Member Enumeration Documentation

Type

enum class KGAPI2::People::Nickname::Type

strong

Enumerator
DEFAULT	Generic nickname.
MAIDEN_NAME	Maiden name or birth family name. Used when the person's family name has changed as a result of marriage.
INITIALS	Initials.
GPLUS	Google+ profile nickname.
OTHER_NAME	A professional affiliation or other name; for example, Dr. Smith.
ALTERNATE_NAME	Alternate name person is known by.
SHORT_NAME	A shorter version of the person's name.

Definition at line 36 of file nickname.h.

Constructor & Destructor Documentation

Nickname()

KGAPI2::People::Nickname::Nickname ( )

explicit

Constructs a new Nickname.

Definition at line 49 of file nickname.cpp.

~Nickname()

KGAPI2::People::Nickname::~Nickname ( )

default

Destructor.

Member Function Documentation

fromJSON()

Nickname KGAPI2::People::Nickname::fromJSON ( const QJsonObject & obj )

staticnodiscard

Definition at line 98 of file nickname.cpp.

fromJSONArray()

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

staticnodiscard

Definition at line 128 of file nickname.cpp.

metadata()

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

nodiscard

Metadata about the nickname.

Definition at line 88 of file nickname.cpp.

operator!=()

bool KGAPI2::People::Nickname::operator!=

(

const Nickname &

other

)

const

Definition at line 65 of file nickname.cpp.

operator==()

bool KGAPI2::People::Nickname::operator==

(

const Nickname &

other

)

const

Definition at line 60 of file nickname.cpp.

setMetadata()

void KGAPI2::People::Nickname::setMetadata

(

const FieldMetadata &

value

)

Sets value of the metadata property.

Definition at line 93 of file nickname.cpp.

setType()

void KGAPI2::People::Nickname::setType

(

Nickname::Type

value

)

Sets value of the type property.

Definition at line 84 of file nickname.cpp.

setValue()

void KGAPI2::People::Nickname::setValue

(

const QString &

value

)

Sets value of the value property.

Definition at line 75 of file nickname.cpp.

toJSON()

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

nodiscard

Definition at line 142 of file nickname.cpp.

type()

Nickname::Nickname::Type KGAPI2::People::Nickname::type ( ) const

nodiscard

The type of the nickname.

Definition at line 79 of file nickname.cpp.

value()

QString KGAPI2::People::Nickname::value ( ) const

nodiscard

The nickname.

Definition at line 70 of file nickname.cpp.

---

The documentation for this class was generated from the following files:

• nickname.h
• nickname.cpp