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
41class SyncDBusInterface : public QObject
42{
43 Q_OBJECT
44 Q_CLASSINFO("D-Bus Interface", "com.meego.msyncd")
45
46public:
47
48signals:
71 void syncStatus(QString aProfileName, int aStatus,
72 QString aMessage, int aMoreDetails);
73
88
89 void transferProgress(QString aProfileName, int aTransferDatabase,
90 int aTransferType, QString aMimeType, int aCommittedItems);
91
104 void signalProfileChanged(QString aProfileName, int aChangeType, QString aProfileAsXml);
105
106
113
120
127
134
142 void resultsAvailable(QString aProfileName, QString aResultsAsXml);
143
161 void statusChanged(unsigned int aAccountId, int aNewStatus, int aFailedReason, qlonglong aPrevSyncTime,
162 qlonglong aNextSyncTime);
163
168 bool isConnectivityAvailable(int connectivityType);
169
179 void syncedExternallyStatus(uint aAccountId, const QString &aClientProfileName, bool aState);
180
181public slots:
196 virtual bool startSync(QString aProfileId) = 0;
197
206 virtual Q_NOREPLY void abortSync(QString aProfileId) = 0;
207
214 virtual bool removeProfile(QString aProfileId) = 0;
215
224 virtual bool updateProfile(QString aProfileAsXml) = 0;
225
242 virtual bool requestStorages(QStringList aStorageNames) = 0;
243
251 virtual Q_NOREPLY void releaseStorages(QStringList aStorageNames) = 0;
252
258 virtual QStringList runningSyncs() = 0;
259
264 virtual bool getBackUpRestoreState() = 0;
265
279 virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml) = 0;
280
287 virtual bool saveSyncResults(QString aProfileId, QString aSyncResults) = 0;
288
293 virtual QString getLastSyncResult(const QString &aProfileId) = 0;
294
301 virtual QStringList allVisibleSyncProfiles() = 0;
302
311 virtual QString syncProfile(const QString &aProfileId) = 0;
312
322 virtual QStringList syncProfilesByKey(const QString &aKey, const QString &aValue) = 0;
323
329 virtual QStringList profilesByType(const QString &aType) = 0;
330
336 virtual QStringList syncProfilesByType(const QString &aType) = 0;
337
342 virtual Q_NOREPLY void start(unsigned int aAccountId) = 0;
343
348 virtual Q_NOREPLY void stop(unsigned int aAccountId) = 0;
349
355
369 virtual int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime) = 0;
370
379 virtual Q_NOREPLY void isSyncedExternally(unsigned int aAccountId, const QString aClientProfileName) = 0;
380
386 virtual QString createSyncProfileForAccount(uint aAccountId) = 0;
387};
388
389}
390
391#endif // SYNCDBUSINTERFACE_H
Defines a D-Bus interface for the sync daemon.
Definition msyncd/SyncDBusInterface.h:42
void backupDone()
Notifies about Backup done.
virtual bool startSync(QString aProfileId)=0
Requests to starts synchronizing using a profile with the given name.
virtual QList< unsigned int > syncingAccounts()=0
Returns the list of account IDs for which sync is ongoing.
void signalProfileChanged(QString aProfileName, int aChangeType, QString aProfileAsXml)
Notifies about a change in profile.
virtual QString createSyncProfileForAccount(uint aAccountId)=0
Create a sync profile for the account if it does not exists.
virtual QStringList allVisibleSyncProfiles()=0
Gets all visible sync profiles.
bool isConnectivityAvailable(int connectivityType)
Returns the connectivity state of a specific medium like bluetooth, USB or network.
virtual Q_NOREPLY void abortSync(QString aProfileId)=0
Stops synchronizing the profile with the given name.
void statusChanged(unsigned int aAccountId, int aNewStatus, int aFailedReason, qlonglong aPrevSyncTime, qlonglong aNextSyncTime)
Notifies sync status change for a set of account Ids.
virtual bool saveSyncResults(QString aProfileId, QString aSyncResults)=0
Save SyncResults to log.xml file.
virtual bool getBackUpRestoreState()=0
This function returns true if backup/restore in progress else false.
virtual QStringList syncProfilesByKey(const QString &aKey, const QString &aValue)=0
Gets a sync profiles matching the key-value.
virtual Q_NOREPLY void releaseStorages(QStringList aStorageNames)=0
Releases the given storages so that sync daemon can again use them freely.
void backupInProgress()
Notifies about Backup start.
virtual bool requestStorages(QStringList aStorageNames)=0
Requests sync daemon to reserve storages for the caller.
virtual QString getLastSyncResult(const QString &aProfileId)=0
To get lastSyncResult.
virtual QStringList syncProfilesByType(const QString &aType)=0
Gets a profiles matching the profile type.
virtual bool updateProfile(QString aProfileAsXml)=0
This function should be called when sync profile information has been changed by someone else than th...
void syncStatus(QString aProfileName, int aStatus, QString aMessage, int aMoreDetails)
Notifies about a change in synchronization status.
virtual QStringList runningSyncs()=0
Gets the list of profile names of currently running syncs.
void restoreInProgress()
Notifies about Restore start.
virtual QString syncProfile(const QString &aProfileId)=0
Gets a sync profile.
virtual bool removeProfile(QString aProfileId)=0
This function should be called when sync profile has to be deleted.
virtual Q_NOREPLY void start(unsigned int aAccountId)=0
Starts sync for all profiles matching the given account ID.
virtual Q_NOREPLY void stop(unsigned int aAccountId)=0
Stops sync for all profiles matching the given account ID.
void syncedExternallyStatus(uint aAccountId, const QString &aClientProfileName, bool aState)
Notifies sync externally status for an account and client profile.
virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml)=0
sets the schedule for a profile
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...
void transferProgress(QString aProfileName, int aTransferDatabase, int aTransferType, QString aMimeType, int aCommittedItems)
Notifies about progress in transferring items.
void restoreDone()
Notifies about Restore Done.
void resultsAvailable(QString aProfileName, QString aResultsAsXml)
Notifies about the availability of Results for a recent sync.
virtual int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime)=0
Returns the status of the sync for the given account Id.
virtual QStringList profilesByType(const QString &aType)=0
Gets all profiles matching the profile type.
Definition SyncBackupAdaptor.h:40