Kgapi

relation.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 * A person's relation to another person.
29 *
30 * @see https://developers.google.com/people/api/rest/v1/people#relation
31 * @since 5.23.0
32 **/
33class KGAPIPEOPLE_EXPORT Relation
34{
35public:
36 /** Constructs a new Relation **/
37 explicit Relation();
38 Relation(const Relation &);
39 Relation(Relation &&) noexcept;
40 Relation &operator=(const Relation &);
41 Relation &operator=(Relation &&) noexcept;
42 /** Destructor. **/
44
45 bool operator==(const Relation &) const;
46 bool operator!=(const Relation &) const;
47
48 [[nodiscard]] static Relation fromJSON(const QJsonObject &);
49 [[nodiscard]] static QList<Relation> fromJSONArray(const QJsonArray &data);
50 [[nodiscard]] QJsonValue toJSON() const;
51
52 /** The person's relation to the other person. The type can be custom or one of these predefined values: * `spouse` * `child` * `mother` * `father` *
53 * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner` **/
54 [[nodiscard]] QString type() const;
55 /** Sets value of the type property. **/
56 void setType(const QString &value);
57
58 /** The name of the other person this relation refers to. **/
59 [[nodiscard]] QString person() const;
60 /** Sets value of the person property. **/
61 void setPerson(const QString &value);
62
63 /** 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
64 * header. **/
65 [[nodiscard]] QString formattedType() const;
66
67 /** Metadata about the relation. **/
68 [[nodiscard]] FieldMetadata metadata() const;
69 /** Sets value of the metadata property. **/
70 void setMetadata(const FieldMetadata &value);
71
72private:
73 class Private;
75}; // Relation
76
77} // namespace KGAPI2::People
Metadata about a field.
A person's relation to another person.
Definition relation.h:34
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:11:01 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.