Kgapi

externalid.h
1/*
2 * SPDX-FileCopyrightText: 2021 Daniel Vrátil <dvratil@kde.org>
3 * SPDX-FileCopyrightText: 2022 Claudio Cambra <claudio.cambra@kde.org>
4 *
5 * SPDX-License-Identifier: LGPL-2.1-only
6 * SPDX-License-Identifier: LGPL-3.0-only
7 * SPDX-License-Identifier: LicenseRef-KDE-Accepted-LGPL
8 */
9
10#pragma once
11
12#include <QSharedDataPointer>
13#include "kgapipeople_export.h"
14
15#include <QString>
16
17#include <optional>
18
19class QJsonObject;
20class QJsonValue;
21class QJsonArray;
22
23namespace KGAPI2::People
24{
25class FieldMetadata;
26
27/**
28 * An identifier from an external entity related to the person.
29 *
30 * @see https://developers.google.com/people/api/rest/v1/people#externalid
31 * @since 5.23.0
32 **/
33class KGAPIPEOPLE_EXPORT ExternalId
34{
35public:
36 /** Constructs a new ExternalId **/
37 explicit ExternalId();
38 ExternalId(const ExternalId &);
39 ExternalId(ExternalId &&) noexcept;
40 ExternalId &operator=(const ExternalId &);
41 ExternalId &operator=(ExternalId &&) noexcept;
42 /** Destructor. **/
44
45 bool operator==(const ExternalId &) const;
46 bool operator!=(const ExternalId &) const;
47
48 [[nodiscard]] static ExternalId fromJSON(const QJsonObject &obj);
49 [[nodiscard]] static QList<ExternalId> fromJSONArray(const QJsonArray &data);
50 [[nodiscard]] QJsonValue toJSON() const;
51
52 /** The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
53 * **/
54 [[nodiscard]] QString type() const;
55 /** Sets value of the type property. **/
56 void setType(const QString &value);
57
58 /** Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. **/
59 [[nodiscard]] QString formattedType() const;
60
61 /** The value of the external ID. **/
62 [[nodiscard]] QString value() const;
63 /** Sets value of the value property. **/
64 void setValue(const QString &value);
65
66 /** Metadata about the external ID. **/
67 [[nodiscard]] FieldMetadata metadata() const;
68 /** Sets value of the metadata property. **/
69 void setMetadata(const FieldMetadata &value);
70
71private:
72 class Private;
74}; // ExternalId
75
76} // namespace KGAPI2::People
An identifier from an external entity related to the person.
Definition externalid.h:34
Metadata about a field.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:11:00 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.