QXmppPresence.h

/*
 * Copyright (C) 2008-2020 The QXmpp developers
 *
 * Author:
 *  Manjeet Dahiya
 *
 * Source:
 *  https://github.com/qxmpp-project/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 "QXmppMucIq.h"
#include "QXmppStanza.h"
 
class QXmppPresencePrivate;
 
class QXMPP_EXPORT QXmppPresence : public QXmppStanza
{
public:
    enum Type {
        Error = 0,     
        Available,     
        Unavailable,   
        Subscribe,     
        Subscribed,    
        Unsubscribe,   
        Unsubscribed,  
        Probe          
    };
 
    enum AvailableStatusType {
        Online = 0,  
        Away,        
        XA,          
        DND,         
        Chat,        
        Invisible    
    };
 
    enum VCardUpdateType {
        VCardUpdateNone = 0,    
        VCardUpdateNoPhoto,     
        VCardUpdateValidPhoto,  
        VCardUpdateNotReady     
 
    };
 
    QXmppPresence(QXmppPresence::Type type = QXmppPresence::Available);
    QXmppPresence(const QXmppPresence &other);
    ~QXmppPresence() override;
 
    QXmppPresence &operator=(const QXmppPresence &other);
 
    bool isXmppStanza() const override;
 
    AvailableStatusType availableStatusType() const;
    void setAvailableStatusType(AvailableStatusType type);
 
    int priority() const;
    void setPriority(int priority);
 
    QXmppPresence::Type type() const;
    void setType(QXmppPresence::Type);
 
    QString statusText() const;
    void setStatusText(const QString &statusText);
 
    // XEP-0045: Multi-User Chat
    QXmppMucItem mucItem() const;
    void setMucItem(const QXmppMucItem &item);
 
    QString mucPassword() const;
    void setMucPassword(const QString &password);
 
    QList<int> mucStatusCodes() const;
    void setMucStatusCodes(const QList<int> &codes);
 
    bool isMucSupported() const;
    void setMucSupported(bool supported);
 
    // XEP-0153: vCard-Based Avatars
    QByteArray photoHash() const;
    void setPhotoHash(const QByteArray &);
 
    VCardUpdateType vCardUpdateType() const;
    void setVCardUpdateType(VCardUpdateType type);
 
    // XEP-0115: Entity Capabilities
    QString capabilityHash() const;
    void setCapabilityHash(const QString &);
 
    QString capabilityNode() const;
    void setCapabilityNode(const QString &);
 
    QByteArray capabilityVer() const;
    void setCapabilityVer(const QByteArray &);
 
    QStringList capabilityExt() const;
 
    // XEP-0319: Last User Interaction in Presence
    QDateTime lastUserInteraction() const;
    void setLastUserInteraction(const QDateTime &);
 
    // XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements
    QString mixUserJid() const;
    void setMixUserJid(const QString &);
 
    QString mixUserNick() const;
    void setMixUserNick(const QString &);
 
    void parse(const QDomElement &element) override;
    void toXml(QXmlStreamWriter *writer) const override;
 
private:
    void parseExtension(const QDomElement &element, QXmppElementList &unknownElements);
 
    QSharedDataPointer<QXmppPresencePrivate> d;
};
 
#endif  // QXMPPPRESENCE_H