specialcollectionsrequestjob.h

/*
    SPDX-FileCopyrightText: 2009 Constantin Berzan <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef AKONADI_SPECIALCOLLECTIONSREQUESTJOB_H
#define AKONADI_SPECIALCOLLECTIONSREQUESTJOB_H

#include "akonadicore_export.h"
#include "collection.h"
#include "specialcollections.h"
#include "transactionsequence.h"

#include <QVariant>

namespace Akonadi
{

class SpecialCollectionsRequestJobPrivate;

class AKONADICORE_EXPORT SpecialCollectionsRequestJob : public TransactionSequence
{
    Q_OBJECT

public:

    ~SpecialCollectionsRequestJob() override;

    void requestDefaultCollection(const QByteArray &type);

    void requestCollection(const QByteArray &type, const AgentInstance &instance);

    Q_REQUIRED_RESULT Collection collection() const;

protected:
    explicit SpecialCollectionsRequestJob(SpecialCollections *collections, QObject *parent = nullptr);

    void setDefaultResourceType(const QString &type);

    void setDefaultResourceOptions(const QVariantMap &options);

    void setTypes(const QList<QByteArray> &types);

    void setNameForTypeMap(const QMap<QByteArray, QString> &map);

    void setIconForTypeMap(const QMap<QByteArray, QString> &map);

    /* reimpl */
    void doStart() override;
    /* reimpl */
    void slotResult(KJob *job) override;

private:
    //@cond PRIVATE
    friend class SpecialCollectionsRequestJobPrivate;
    friend class DefaultResourceJobPrivate;

    SpecialCollectionsRequestJobPrivate *const d;

    Q_PRIVATE_SLOT(d, void releaseLock())
    Q_PRIVATE_SLOT(d, void resourceScanResult(KJob *))
    Q_PRIVATE_SLOT(d, void collectionCreateResult(KJob *))
    //@endcond
};

} // namespace Akonadi

#endif // AKONADI_SPECIALCOLLECTIONSREQUESTJOB_H