aboutsummaryrefslogtreecommitdiff
path: root/src/QXmppPresence.h
blob: 408e0f72799e756c347005575a1f74d339f9a7d1 (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * Copyright (C) 2008-2010 The QXmpp developers
 *
 * Author:
 *  Manjeet Dahiya
 *
 * Source:
 *  http://code.google.com/p/qxmpp
 *
 * This file is a part of QXmpp library.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 */


#ifndef QXMPPPRESENCE_H
#define QXMPPPRESENCE_H

#include "QXmppStanza.h"

/// \brief The QXmppPresence class represents an XMPP presence stanza.
///
/// \ingroup Stanzas
class QXmppPresence : public QXmppStanza
{
public:
    enum Type
    {
        Error = 0,
        Available,
        Unavailable,
        Subscribe,
        Subscribed,
        Unsubscribe,
        Unsubscribed,
        Probe
    };

    // XEP-0153: vCard-Based Avatars
    enum VCardUpdateType
    {
        VCardUpdateNone = 0,
        PhotoNotAdvertized,
        PhotoAdvertised,
        PhotoNotReady
    };

    class Status
    {
    public:
        enum Type
        {
            Offline = 0, 
            Online, 
            Away, 
            XA, 
            DND, 
            Chat,
            Invisible 
        };

        Status(QXmppPresence::Status::Type type = QXmppPresence::Status::Online,
            const QString statusText = "", int priority = 0);

        QXmppPresence::Status::Type type() const;
        void setType(QXmppPresence::Status::Type);

        QString statusText() const;
        void setStatusText(const QString&);

        int priority() const;
        void setPriority(int);

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

        // deprecated in release 0.2.0
        // deprecated accessors, use the form without "get" instead
        int Q_DECL_DEPRECATED getPriority() const;
        QString Q_DECL_DEPRECATED getStatusText() const;
        QXmppPresence::Status::Type Q_DECL_DEPRECATED getType() const;
        /// \endcond

    private:
        QString getTypeStr() const;
        void setTypeFromStr(const QString&);

        QXmppPresence::Status::Type m_type;
        QString m_statusText;
        int m_priority;
    };

    QXmppPresence(QXmppPresence::Type type = QXmppPresence::Available, 
        const QXmppPresence::Status& status = QXmppPresence::Status());
    ~QXmppPresence();

    QXmppPresence::Type type() const;
    void setType(QXmppPresence::Type);

    QXmppPresence::Status& status();
    const QXmppPresence::Status& status() const;
    void setStatus(const QXmppPresence::Status&);

    void parse(const QDomElement &element);
    void toXml(QXmlStreamWriter *writer) const;

    QByteArray photoHash() const;
    void setPhotoHash(const QByteArray&);
    VCardUpdateType vCardUpdateType();
    void setVCardUpdateType(VCardUpdateType type);

    // deprecated in release 0.2.0
    // deprecated accessors, use the form without "get" instead
    /// \cond
    QXmppPresence::Type Q_DECL_DEPRECATED getType() const;
    QXmppPresence::Status Q_DECL_DEPRECATED & getStatus();
    const QXmppPresence::Status Q_DECL_DEPRECATED & getStatus() const;
    /// \endcond

private:
    QString getTypeStr() const;
    void setTypeFromStr(const QString&);

    Type m_type;
    QXmppPresence::Status m_status;


    /// XEP-0153: vCard-Based Avatars

    /// m_photoHash: the SHA1 hash of the avatar image data itself (not the base64-encoded version)
    /// in accordance with RFC 3174
    QByteArray m_photoHash;
    VCardUpdateType m_vCardUpdateType;
};

#endif // QXMPPPRESENCE_H