aboutsummaryrefslogtreecommitdiff
path: root/src/base/QXmppPubSubAffiliation.h
blob: e74db0e699b86f76a333937ba6d57e767acd1cb4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// SPDX-FileCopyrightText: 2020 Linus Jahn <lnj@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#ifndef QXMPPPUBSUBAFFILIATION_H
#define QXMPPPUBSUBAFFILIATION_H

#include "QXmppGlobal.h"

#include <QMetaType>
#include <QSharedDataPointer>

class QXmppPubSubAffiliationPrivate;
class QDomElement;
class QXmlStreamWriter;

class QXMPP_EXPORT QXmppPubSubAffiliation
{
public:
    ///
    /// This enum describes the type of the affiliation of the user with the
    /// node.
    ///
    enum Affiliation {
        None,         ///< No affiliation, but may subscribe.
        Member,       ///< Active member, is subscribed, can read.
        Outcast,      ///< Cannot subscribe, cannot read, 'banned'.
        Owner,        ///< Highest privileges, can read, publish & configure.
        Publisher,    ///< May read and publish, but cannot configure node.
        PublishOnly,  ///< Can only publish, cannot subscribe.
    };

    QXmppPubSubAffiliation(Affiliation = None,
                           const QString &node = {},
                           const QString &jid = {});
    QXmppPubSubAffiliation(const QXmppPubSubAffiliation &);
    QXmppPubSubAffiliation(QXmppPubSubAffiliation &&);
    ~QXmppPubSubAffiliation();

    QXmppPubSubAffiliation &operator=(const QXmppPubSubAffiliation &);
    QXmppPubSubAffiliation &operator=(QXmppPubSubAffiliation &&);

    Affiliation type() const;
    void setType(Affiliation type);

    QString node() const;
    void setNode(const QString &node);

    QString jid() const;
    void setJid(const QString &jid);

    static bool isAffiliation(const QDomElement &);

    /// \cond
    void parse(const QDomElement &);
    void toXml(QXmlStreamWriter *) const;
    /// \endcond

private:
    QSharedDataPointer<QXmppPubSubAffiliationPrivate> d;
};

Q_DECLARE_METATYPE(QXmppPubSubAffiliation)
Q_DECLARE_METATYPE(QXmppPubSubAffiliation::Affiliation)

#endif  // QXMPPPUBSUBAFFILIATION_H