KGAPI2::People::PersonMetadata

Search for usage in LXR

KGAPI2::People::PersonMetadata Class Reference

#include <personmetadata.h>

Public Types

enum class  ObjectType { OBJECT_TYPE_UNSPECIFIED , PERSON , PAGE }
 

Public Member Functions

 PersonMetadata ()
 
 PersonMetadata (const PersonMetadata &)
 
 PersonMetadata (PersonMetadata &&) noexcept
 
 ~PersonMetadata ()
 
void addSource (const Source &value)
 
void clearSources ()
 
bool deleted () const
 
QList< QStringlinkedPeopleResourceNames () const
 
PersonMetadata::ObjectType objectType () const
 
bool operator!= (const PersonMetadata &) const
 
PersonMetadataoperator= (const PersonMetadata &)
 
PersonMetadataoperator= (PersonMetadata &&) noexcept
 
bool operator== (const PersonMetadata &) const
 
QList< QStringpreviousResourceNames () const
 
void removeSource (const Source &value)
 
void setSources (const QList< Source > &value)
 
QList< Sourcesources () const
 
QJsonValue toJSON () const
 

Static Public Member Functions

static PersonMetadata fromJSON (const QJsonObject &)
 

Detailed Description

The metadata about a person.

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

Definition at line 33 of file personmetadata.h.

Member Enumeration Documentation

◆ ObjectType

Enumerator
OBJECT_TYPE_UNSPECIFIED 

Unspecified.

PERSON 

Person.

PAGE 

Currents Page.

Definition at line 36 of file personmetadata.h.

Constructor & Destructor Documentation

◆ PersonMetadata()

KGAPI2::People::PersonMetadata::PersonMetadata ( )
explicit

Constructs a new PersonMetadata.

Definition at line 52 of file personmetadata.cpp.

◆ ~PersonMetadata()

KGAPI2::People::PersonMetadata::~PersonMetadata ( )
default

Destructor.

Member Function Documentation

◆ addSource()

void KGAPI2::People::PersonMetadata::addSource ( const Source & value)

Appends the given value to the list of sources.

Definition at line 99 of file personmetadata.cpp.

◆ clearSources()

void KGAPI2::People::PersonMetadata::clearSources ( )

Clears the list of sources.

Definition at line 109 of file personmetadata.cpp.

◆ deleted()

bool KGAPI2::People::PersonMetadata::deleted ( ) const
nodiscard

Output only.

True if the person resource has been deleted. Populated only for people.connections.list and otherContacts.list sync requests.

Definition at line 85 of file personmetadata.cpp.

◆ fromJSON()

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

Definition at line 114 of file personmetadata.cpp.

◆ linkedPeopleResourceNames()

QList< QString > KGAPI2::People::PersonMetadata::linkedPeopleResourceNames ( ) const
nodiscard

Output only.

Resource names of people linked to this resource.

Definition at line 73 of file personmetadata.cpp.

◆ objectType()

PersonMetadata::PersonMetadata::ObjectType KGAPI2::People::PersonMetadata::objectType ( ) const
nodiscard

Output only.

DEPRECATED (Please use person.metadata.sources.profileMetadata.objectType instead) The type of the person object.

Definition at line 77 of file personmetadata.cpp.

◆ operator!=()

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

Definition at line 68 of file personmetadata.cpp.

◆ operator==()

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

Definition at line 63 of file personmetadata.cpp.

◆ previousResourceNames()

QList< QString > KGAPI2::People::PersonMetadata::previousResourceNames ( ) const
nodiscard

Output only.

Any former resource names this person has had. Populated only for people.connections.list requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.

Definition at line 81 of file personmetadata.cpp.

◆ removeSource()

void KGAPI2::People::PersonMetadata::removeSource ( const Source & value)

Removes the given value from the list of sources if it exists.

Definition at line 104 of file personmetadata.cpp.

◆ setSources()

void KGAPI2::People::PersonMetadata::setSources ( const QList< Source > & value)

Sets value of the sources property.

Definition at line 94 of file personmetadata.cpp.

◆ sources()

QList< Source > KGAPI2::People::PersonMetadata::sources ( ) const
nodiscard

The sources of data for the person.

Definition at line 89 of file personmetadata.cpp.

◆ toJSON()

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

Definition at line 139 of file personmetadata.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 Fri Nov 29 2024 11:54:35 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.