kauthactionreply.h

Go to the documentation of this file.

/*
*   Copyright (C) 2008 Nicola Gigante <nicola.gigante@gmail.com>
*   Copyright (C) 2009 Dario Freddi <drf@kde.org>
*
*   This program 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 program 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 General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public License
*   along with this program; if not, write to the
*   Free Software Foundation, Inc.,
*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .
*/

#ifndef ACTION_REPLY_H
#define ACTION_REPLY_H

#include <QtCore/QString>
#include <QtCore/QVariant>
#include <QtCore/QMap>
#include <QtCore/QDataStream>

#include <kdecore_export.h>
namespace KAuth
{

class KDECORE_EXPORT ActionReply
{
    class Private;
    Private * const d;

public:
    enum Type {
        KAuthError, 
        HelperError, 
        Success 
    };

    static const ActionReply SuccessReply; 
    static const ActionReply HelperErrorReply; 

    static const ActionReply NoResponderReply; 
    static const ActionReply NoSuchActionReply; 
    static const ActionReply InvalidActionReply; 
    static const ActionReply AuthorizationDeniedReply; 
    static const ActionReply UserCancelledReply; 
    static const ActionReply HelperBusyReply; 
    static const ActionReply DBusErrorReply; 

    enum Error {
        NoError = 0, 
        NoResponder, 
        NoSuchAction, 
        InvalidAction, 
        AuthorizationDenied, 
        UserCancelled, 
        HelperBusy, 
        DBusError 
    };

    ActionReply();

    ActionReply(Type type);

    ActionReply(int errorCode);

    ActionReply(const ActionReply &reply);

    virtual ~ActionReply();

    void setData(const QVariantMap &data);

    QVariantMap data() const;

    void addData(const QString &key, const QVariant &value);

    Type type() const;

    void setType(Type type);

    bool succeeded() const;

    bool failed() const;

    int errorCode() const;

    void setErrorCode(int errorCode);

    QString errorDescription() const;

    void setErrorDescription(const QString &error);

    QByteArray serialized() const;

    static ActionReply deserialize(const QByteArray &data);

    ActionReply &operator=(const ActionReply &reply);

    bool operator==(const ActionReply &reply) const;

    bool operator!=(const ActionReply &reply) const;

    friend QDataStream &operator<<(QDataStream &, const ActionReply &);

    friend QDataStream &operator>>(QDataStream &, ActionReply &);

};

} // namespace Auth

#endif