SyncClientInterface.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * 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.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
 
#ifndef SYNCCLIENTINTERFACE_H
#define SYNCCLIENTINTERFACE_H
 
#include <QObject>
#include <QString>
#include <QSharedPointer>
#include <Profile.h>
#include <SyncProfile.h>
#include <SyncResults.h>
#include <SyncSchedule.h>
 
class QDBusPendingCallWatcher;
 
namespace Buteo {
 
class SyncClientInterfacePrivate;

class SyncClientInterface: public QObject
{
    Q_OBJECT
 
public:
    SyncClientInterface();

    ~SyncClientInterface();

    bool startSync(const QString &aProfileId) const;

    QDBusPendingCallWatcher* requestSync(const QString &aProfileId, QObject *aParent = nullptr) const;

    void abortSync(const QString &aProfileId) const;

    QStringList getRunningSyncList() const;

    QDBusPendingCallWatcher* requestRunningSyncList(QObject *aParent = nullptr) const;

    bool setSyncSchedule(const QString &aProfileId, const SyncSchedule &aSchedule);

    bool saveSyncResults(const QString &aProfileId, const Buteo::SyncResults &aSyncResults);

    bool removeProfile(const QString &aProfileId) const;

    bool updateProfile(const Buteo::SyncProfile &aSyncProfile);

    bool  getBackUpRestoreState();

    bool isValid() const;

    Buteo::SyncResults getLastSyncResult(const QString &aProfileId);

    QList<QString /*profileAsXml*/> allVisibleSyncProfiles();

    QDBusPendingCallWatcher* requestAllVisibleSyncProfiles(QObject *aParent = nullptr) const;

    QString syncProfile(const QString &aProfileId);

    QStringList syncProfilesByKey(const QString &aKey, const QString &aValue);

    QDBusPendingCallWatcher* requestSyncProfilesByKey(const QString &aKey, const QString &aValue, QObject *aParent = nullptr) const;

    QStringList profilesByType(const QString &aType);

    QDBusPendingCallWatcher* requestProfilesByType(const QString &aProfileId, QObject *aParent = nullptr) const;

    QStringList syncProfilesByType(const QString &aType);

    static QSharedPointer<SyncClientInterface> sharedInstance();
 
signals:
    void isValidChanged();

    void backupInProgress ();

    void backupDone();

    void restoreInProgress();

    void restoreDone();

    void profileChanged(QString aProfileId, int aChangeType, QString aChangedProfile);

    void resultsAvailable(QString aProfileId, Buteo::SyncResults aResults);

    void syncStatus(QString aProfileId, int aStatus,
                    QString aMessage, int aStatusDetails);

    void transferProgress(QString aProfileId, int aTransferDatabase,
                          int aTransferType, QString aMimeType, int aCommittedItems);
 
private:
    SyncClientInterfacePrivate *d_ptr;
};
 
}
 
#endif