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

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  * A person's relation to another person.
0029  *
0030  * @see https://developers.google.com/people/api/rest/v1/people#relation
0031  * @since 5.23.0
0032  **/
0033 class KGAPIPEOPLE_EXPORT Relation
0034 {
0035 public:
0036     /** Constructs a new Relation **/
0037     explicit Relation();
0038     Relation(const Relation &);
0039     Relation(Relation &&) noexcept;
0040     Relation &operator=(const Relation &);
0041     Relation &operator=(Relation &&) noexcept;
0042     /** Destructor. **/
0043     ~Relation();
0044 
0045     bool operator==(const Relation &) const;
0046     bool operator!=(const Relation &) const;
0047 
0048     [[nodiscard]] static Relation fromJSON(const QJsonObject &);
0049     [[nodiscard]] static QList<Relation> fromJSONArray(const QJsonArray &data);
0050     [[nodiscard]] QJsonValue toJSON() const;
0051 
0052     /** The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` *
0053      * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` **/
0054     [[nodiscard]] QString type() const;
0055     /** Sets value of the type property. **/
0056     void setType(const QString &value);
0057 
0058     /** The name of the other person this relation refers to. **/
0059     [[nodiscard]] QString person() const;
0060     /** Sets value of the person property. **/
0061     void setPerson(const QString &value);
0062 
0063     /** Output only. The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP
0064      * header. **/
0065     [[nodiscard]] QString formattedType() const;
0066 
0067     /** Metadata about the relation. **/
0068     [[nodiscard]] FieldMetadata metadata() const;
0069     /** Sets value of the metadata property. **/
0070     void setMetadata(const FieldMetadata &value);
0071 
0072 private:
0073     class Private;
0074     QSharedDataPointer<Private> d;
0075 }; // Relation
0076 
0077 } // namespace KGAPI2::People