File indexing completed on 2024-05-12 05:22:26

0001 /*
0002  * SPDX-FileCopyrightText: 2021 Daniel Vrátil <dvratil@kde.org>
0003  * SPDX-FileCopyrightText: 2022 Claudio Cambra <claudio.cambra@kde.org>
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-only
0006  * SPDX-License-Identifier: LGPL-3.0-only
0007  * SPDX-License-Identifier: LicenseRef-KDE-Accepted-LGPL
0008  */
0009 
0010 #pragma once
0011 
0012 #include <QSharedDataPointer>
0013 #include "kgapipeople_export.h"
0014 
0015 #include <QString>
0016 
0017 #include <optional>
0018 
0019 class QJsonObject;
0020 class QJsonValue;
0021 class QJsonArray;
0022 
0023 namespace KGAPI2::People
0024 {
0025 class FieldMetadata;
0026 
0027 /**
0028  * An identifier from an external entity related to the person.
0029  *
0030  * @see https://developers.google.com/people/api/rest/v1/people#externalid
0031  * @since 5.23.0
0032  **/
0033 class KGAPIPEOPLE_EXPORT ExternalId
0034 {
0035 public:
0036     /** Constructs a new ExternalId **/
0037     explicit ExternalId();
0038     ExternalId(const ExternalId &);
0039     ExternalId(ExternalId &&) noexcept;
0040     ExternalId &operator=(const ExternalId &);
0041     ExternalId &operator=(ExternalId &&) noexcept;
0042     /** Destructor. **/
0043     ~ExternalId();
0044 
0045     bool operator==(const ExternalId &) const;
0046     bool operator!=(const ExternalId &) const;
0047 
0048     [[nodiscard]] static ExternalId fromJSON(const QJsonObject &obj);
0049     [[nodiscard]] static QList<ExternalId> fromJSONArray(const QJsonArray &data);
0050     [[nodiscard]] QJsonValue toJSON() const;
0051 
0052     /** The type of the external ID. The type can be custom or one of these predefined values: * `account` * `customer` * `loginId` * `network` * `organization`
0053      * **/
0054     [[nodiscard]] QString type() const;
0055     /** Sets value of the type property. **/
0056     void setType(const QString &value);
0057 
0058     /** Output only. The type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale. **/
0059     [[nodiscard]] QString formattedType() const;
0060 
0061     /** The value of the external ID. **/
0062     [[nodiscard]] QString value() const;
0063     /** Sets value of the value property. **/
0064     void setValue(const QString &value);
0065 
0066     /** Metadata about the external ID. **/
0067     [[nodiscard]] FieldMetadata metadata() const;
0068     /** Sets value of the metadata property. **/
0069     void setMetadata(const FieldMetadata &value);
0070 
0071 private:
0072     class Private;
0073     QSharedDataPointer<Private> d;
0074 }; // ExternalId
0075 
0076 } // namespace KGAPI2::People