Buteo Synchronization Framework: SyncDBusInterface.h Source File

Buteo Synchronization Framework

msyncd/SyncDBusInterface.h
1/*
2 * This file is part of buteo-syncfw package
3 *
4 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
5 * Copyright (C) 2015 Jolla Ltd.
6 *
7 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * version 2.1 as published by the Free Software Foundation.
12 *
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 *
23 */
24#ifndef SYNCDBUSINTERFACE_H
25#define SYNCDBUSINTERFACE_H
26
27#include <QtDBus>
28#include <QObject>
29#include <QString>
30#include <QList>
31
32namespace Buteo {
33
41 class SyncDBusInterface : public QObject
42{
43 Q_OBJECT
44 Q_CLASSINFO("D-Bus Interface", "com.meego.msyncd")
45
46public:
47
48signals:
49
72 void syncStatus(QString aProfileName, int aStatus,
73 QString aMessage, int aMoreDetails);
74
90 void transferProgress(QString aProfileName, int aTransferDatabase,
91 int aTransferType, QString aMimeType, int aCommittedItems);
92
105 void signalProfileChanged(QString aProfileName, int aChangeType, QString aProfileAsXml);
106
107
113 void backupInProgress ();
114
120 void backupDone();
121
127 void restoreInProgress();
128
134 void restoreDone();
135
143 void resultsAvailable(QString aProfileName, QString aResultsAsXml);
144
162 void statusChanged(unsigned int aAccountId, int aNewStatus, int aFailedReason, qlonglong aPrevSyncTime,
163 qlonglong aNextSyncTime);
164
169 bool isConnectivityAvailable(int connectivityType);
170
180 void syncedExternallyStatus(uint aAccountId, const QString &aClientProfileName, bool aState);
181
182public slots:
183
198 virtual bool startSync(QString aProfileId) = 0;
199
208 virtual Q_NOREPLY void abortSync(QString aProfileId) = 0;
209
216 virtual bool removeProfile(QString aProfileId) = 0;
217
226 virtual bool updateProfile(QString aProfileAsXml) = 0;
227
244 virtual bool requestStorages(QStringList aStorageNames) = 0;
245
253 virtual Q_NOREPLY void releaseStorages(QStringList aStorageNames) = 0;
254
260 virtual QStringList runningSyncs() = 0;
261
262
267 virtual bool getBackUpRestoreState() = 0;
268
269
283 virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml) = 0;
284
291 virtual bool saveSyncResults(QString aProfileId, QString aSyncResults) = 0;
292
297 virtual QString getLastSyncResult(const QString &aProfileId) = 0;
298
305 virtual QStringList allVisibleSyncProfiles() = 0;
306
315 virtual QString syncProfile(const QString &aProfileId) = 0;
316
326 virtual QStringList syncProfilesByKey(const QString &aKey, const QString &aValue) = 0;
327
333 virtual QStringList syncProfilesByType(const QString &aType) = 0;
334
339 virtual Q_NOREPLY void start(unsigned int aAccountId) = 0;
340
345 virtual Q_NOREPLY void stop(unsigned int aAccountId) = 0;
346
351 virtual QList<unsigned int> syncingAccounts() = 0;
352
366 virtual int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime) = 0;
367
376 virtual Q_NOREPLY void isSyncedExternally(unsigned int aAccountId, const QString aClientProfileName) = 0;
377
383 virtual QString createSyncProfileForAccount(uint aAccountId) = 0;
384};
385
386}
387
388#endif // SYNCDBUSINTERFACE_H
Buteo::SyncDBusInterface
Defines a D-Bus interface for the sync daemon.
Definition: msyncd/SyncDBusInterface.h:42
Buteo::SyncDBusInterface::backupDone
void backupDone()
Notifies about Backup done.
Definition: moc_SyncDBusInterface.cpp:430
Buteo::SyncDBusInterface::startSync
virtual bool startSync(QString aProfileId)=0
Requests to starts synchronizing using a profile with the given name.
Buteo::SyncDBusInterface::syncingAccounts
virtual QList< unsigned int > syncingAccounts()=0
Returns the list of account IDs for which sync is ongoing.
Buteo::SyncDBusInterface::signalProfileChanged
void signalProfileChanged(QString aProfileName, int aChangeType, QString aProfileAsXml)
Notifies about a change in profile.
Definition: moc_SyncDBusInterface.cpp:417
Buteo::SyncDBusInterface::createSyncProfileForAccount
virtual QString createSyncProfileForAccount(uint aAccountId)=0
Create a sync profile for the account if it does not exists.
Buteo::SyncDBusInterface::allVisibleSyncProfiles
virtual QStringList allVisibleSyncProfiles()=0
Gets all visible sync profiles.
Buteo::SyncDBusInterface::isConnectivityAvailable
bool isConnectivityAvailable(int connectivityType)
Returns the connectivity state of a specific medium like bluetooth, USB or network.
Definition: moc_SyncDBusInterface.cpp:462
Buteo::SyncDBusInterface::abortSync
virtual Q_NOREPLY void abortSync(QString aProfileId)=0
Stops synchronizing the profile with the given name.
Buteo::SyncDBusInterface::statusChanged
void statusChanged(unsigned int aAccountId, int aNewStatus, int aFailedReason, qlonglong aPrevSyncTime, qlonglong aNextSyncTime)
Notifies sync status change for a set of account Ids.
Definition: moc_SyncDBusInterface.cpp:455
Buteo::SyncDBusInterface::saveSyncResults
virtual bool saveSyncResults(QString aProfileId, QString aSyncResults)=0
Save SyncResults to log.xml file.
Buteo::SyncDBusInterface::getBackUpRestoreState
virtual bool getBackUpRestoreState()=0
This function returns true if backup/restore in progress else false.
Buteo::SyncDBusInterface::syncProfilesByKey
virtual QStringList syncProfilesByKey(const QString &aKey, const QString &aValue)=0
Gets a sync profiles matching the key-value.
Buteo::SyncDBusInterface::releaseStorages
virtual Q_NOREPLY void releaseStorages(QStringList aStorageNames)=0
Releases the given storages so that sync daemon can again use them freely.
Buteo::SyncDBusInterface::backupInProgress
void backupInProgress()
Notifies about Backup start.
Definition: moc_SyncDBusInterface.cpp:424
Buteo::SyncDBusInterface::requestStorages
virtual bool requestStorages(QStringList aStorageNames)=0
Requests sync daemon to reserve storages for the caller.
Buteo::SyncDBusInterface::getLastSyncResult
virtual QString getLastSyncResult(const QString &aProfileId)=0
To get lastSyncResult.
Buteo::SyncDBusInterface::syncProfilesByType
virtual QStringList syncProfilesByType(const QString &aType)=0
Gets a profiles matching the profile type.
Buteo::SyncDBusInterface::updateProfile
virtual bool updateProfile(QString aProfileAsXml)=0
This function should be called when sync profile information has been changed by someone else than th...
Buteo::SyncDBusInterface::syncStatus
void syncStatus(QString aProfileName, int aStatus, QString aMessage, int aMoreDetails)
Notifies about a change in synchronization status.
Definition: moc_SyncDBusInterface.cpp:403
Buteo::SyncDBusInterface::runningSyncs
virtual QStringList runningSyncs()=0
Gets the list of profile names of currently running syncs.
Buteo::SyncDBusInterface::restoreInProgress
void restoreInProgress()
Notifies about Restore start.
Definition: moc_SyncDBusInterface.cpp:436
Buteo::SyncDBusInterface::syncProfile
virtual QString syncProfile(const QString &aProfileId)=0
Gets a sync profile.
Buteo::SyncDBusInterface::removeProfile
virtual bool removeProfile(QString aProfileId)=0
This function should be called when sync profile has to be deleted.
Buteo::SyncDBusInterface::start
virtual Q_NOREPLY void start(unsigned int aAccountId)=0
Starts sync for all profiles matching the given account ID.
Buteo::SyncDBusInterface::stop
virtual Q_NOREPLY void stop(unsigned int aAccountId)=0
Stops sync for all profiles matching the given account ID.
Buteo::SyncDBusInterface::syncedExternallyStatus
void syncedExternallyStatus(uint aAccountId, const QString &aClientProfileName, bool aState)
Notifies sync externally status for an account and client profile.
Definition: moc_SyncDBusInterface.cpp:471
Buteo::SyncDBusInterface::setSyncSchedule
virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml)=0
sets the schedule for a profile
Buteo::SyncDBusInterface::isSyncedExternally
virtual Q_NOREPLY void isSyncedExternally(unsigned int aAccountId, const QString aClientProfileName)=0
Queries the sync externally status of a given account, 'syncedExternallyStatus' signal is emitted wit...
Buteo::SyncDBusInterface::transferProgress
void transferProgress(QString aProfileName, int aTransferDatabase, int aTransferType, QString aMimeType, int aCommittedItems)
Notifies about progress in transferring items.
Definition: moc_SyncDBusInterface.cpp:410
Buteo::SyncDBusInterface::restoreDone
void restoreDone()
Notifies about Restore Done.
Definition: moc_SyncDBusInterface.cpp:442
Buteo::SyncDBusInterface::resultsAvailable
void resultsAvailable(QString aProfileName, QString aResultsAsXml)
Notifies about the availability of Results for a recent sync.
Definition: moc_SyncDBusInterface.cpp:448
Buteo::SyncDBusInterface::status
virtual int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime)=0
Returns the status of the sync for the given account Id.
QList
Definition: SyncBackupAdaptor.h:40