QXmppMessage.h

/*
 * Copyright (C) 2008-2019 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 QXMPPMESSAGE_H
#define QXMPPMESSAGE_H

#include <QDateTime>
#include "QXmppStanza.h"

class QXmppMessagePrivate;

/// \brief The QXmppMessage class represents an XMPP message.
///
/// \ingroup Stanzas

class QXMPP_EXPORT QXmppMessage : public QXmppStanza
{
public:
    /// This enum described a message type.
    enum Type
    {
        Error = 0,
        Normal,
        Chat,
        GroupChat,
        Headline
    };

    /// This enum describes a chat state as defined by XEP-0085: Chat State
    /// Notifications.
    enum State
    {
        None = 0,   ///< The message does not contain any chat state information.
        Active,     ///< User is actively participating in the chat session.
        Inactive,   ///< User has not been actively participating in the chat session.
        Gone,       ///< User has effectively ended their participation in the chat session.
        Composing,  ///< User is composing a message.
        Paused      ///< User had been composing but now has stopped.
    };

    /// This enum describes a chat marker as defined by XEP-0333: Chat Markers.
    enum Marker {
        NoMarker = 0,
        Received,
        Displayed,
        Acknowledged
    };

    /// This enum describes different end-to-end encryption methods. These can
    /// be used to mark a message explicitly as encrypted with a specific
    /// algothim. See XEP-0380: Explicit Message Encryption for details.
    enum EncryptionMethod {
        NoEncryption,      ///< No encryption
        UnknownEncryption, ///< Unknown encryption
        OTR,               ///< XEP-0364: Current Off-the-Record Messaging Usage
        LegacyOpenPGP,     ///< XEP-0027: Current Jabber OpenPGP Usage
        OX,                ///< XEP-0373: OpenPGP for XMPP
        OMEMO              ///< XEP-0384: OMEMO Encryption
    };

    QXmppMessage(const QString& from = QString(), const QString& to = QString(),
                 const QString& body = QString(), const QString& thread = QString());

    QXmppMessage(const QXmppMessage &other);
    ~QXmppMessage();

    QXmppMessage& operator=(const QXmppMessage &other);

    QString body() const;
    void setBody(const QString&);

    bool isAttentionRequested() const;
    void setAttentionRequested(bool requested);

    bool isReceiptRequested() const;
    void setReceiptRequested(bool requested);

    QString mucInvitationJid() const;
    void setMucInvitationJid(const QString &jid);

    QString mucInvitationPassword() const;
    void setMucInvitationPassword(const QString &password);

    QString mucInvitationReason() const;
    void setMucInvitationReason(const QString &reason);

    QString receiptId() const;
    void setReceiptId(const QString &id);

    QDateTime stamp() const;
    void setStamp(const QDateTime &stamp);

    QXmppMessage::State state() const;
    void setState(QXmppMessage::State);

    QString subject() const;
    void setSubject(const QString&);

    QString thread() const;
    void setThread(const QString&);

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

    QString xhtml() const;
    void setXhtml(const QString &xhtml);

    // XEP-0333: Chat Markers
    bool isMarkable() const;
    void setMarkable(const bool);

    QString markedId() const;
    void setMarkerId(const QString&);

    QString markedThread() const;
    void setMarkedThread(const QString&);

    Marker marker() const;
    void setMarker(const Marker);

    // XEP-0280: Message Carbons
    bool isPrivate() const;
    void setPrivate(const bool);

    bool isXmppStanza() const;

    // XEP-0066: Out of Band Data
    QString outOfBandUrl() const;
    void setOutOfBandUrl(const QString&);

    // XEP-0308: Last Message Correction
    QString replaceId() const;
    void setReplaceId(const QString&);

    // XEP-0367: Message Attaching
    QString attachId() const;
    void setAttachId(const QString&);

    // XEP-0369: Mediated Information eXchange (MIX)
    QString mixUserJid() const;
    void setMixUserJid(const QString&);

    QString mixUserNick() const;
    void setMixUserNick(const QString&);

    // XEP-0380: Explicit Message Encryption
    EncryptionMethod encryptionMethod() const;
    void setEncryptionMethod(EncryptionMethod);
    QString encryptionMethodNs() const;
    void setEncryptionMethodNs(const QString&);

    QString encryptionName() const;
    void setEncryptionName(const QString&);

    // XEP-0382: Spoiler messages
    bool isSpoiler() const;
    void setIsSpoiler(bool);

    QString spoilerHint() const;
    void setSpoilerHint(const QString&);

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

private:
    QSharedDataPointer<QXmppMessagePrivate> d;
};

#endif // QXMPPMESSAGE_H