/* * This file is part of buteo-sync-plugins package * * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). * * Contact: Sateesh Kavuri * * 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 CONTACTSBACKEND_H_ #define CONTACTSBACKEND_H_ #include #include #include #include #include #include using namespace QtContacts; using namespace QtVersit; #define QContactLocalId QContactId enum VCARD_VERSION { VCARD_VERSION21, VCARD_VERSION30 }; struct ContactsStatus { QString id; QContactManager::Error errorCode; }; //! \brief Harmattan Contact storage plugin backend interface class /// /// This class interfaces with the backend implementation of contact manager on harmattan /// device class ContactsBackend { public: /*! * \brief Constructor * @param aVerType */ ContactsBackend(QVersitDocument::VersitType aVerType, const QString &syncTarget, const QString &originId); /*! * \brief Destructor */ ~ContactsBackend(); /*! * \brief Searches for available storage plugins and sets the manager to that plugin * @return */ bool init(); /*! * \brief releases the resources held. * @return */ bool uninit(); /*! * \brief Return ids of all contacts retrieved from the backend * @return List of contact IDs */ QList getAllContactIds(); /*! * \brief Return all new contacts ids in a QList of QStrings * @param aTimeStamp Timestamp of the oldest contact ID to be returned * @return List of contact IDs */ QList getAllNewContactIds(const QDateTime& aTimeStamp); /*! * \brief Return all modified contact ids in a QList of QStrings * @param aTimeStamp Timestamp of the oldest contact ID to be returned * @return List of contact IDs */ QList getAllModifiedContactIds(const QDateTime& aTimeStamp); /*! * \brief Return all deleted contacts ids in a QList of QStrings * @param aTimeStamp Timestamp of the oldest contact ID to be returned * @return List of contact IDs */ QList getAllDeletedContactIds(const QDateTime& aTimeStamp); /*! * \brief Get contact data for a given gontact ID as a QContact object * @param aContactId The ID of the contact * @param aContact The returned data of the contact */ void getContact(const QContactLocalId& aContactId, QContact& aContact); /*! * \brief Get multiple contacts at once as vcards * @param aContactIDs List of contact IDs to be returned * @param aContactData Returned contact data */ void getContacts(const QList &aContactIDs, QMap& aContactData ); /*! * \brief Get multiple contacts at once as QContact objects * @param aContactIds List of contact IDs * @param aContacts List of returned contact data */ void getContacts(const QList& aContactIds, QList& aContacts); /*! * \brief Batch addition of contacts * @param aContactDataList Contact data * @param aStatusMap Returned status data * @return Errors */ bool addContacts( const QStringList &aContactDataList, QMap &aStatusMap ); // Functions for modifying contacts /*! * \brief Modify a contact that whose data and ID are given as Input * @param id Contact ID * @param contactdata Contact data * @return Error */ QContactManager::Error modifyContact(const QString &id, const QString &contactdata); /*! * \brief Batch modification * @param aContactDataList Contact data * @param aContactsIdList Contact IDs * @return Errors */ QMap modifyContacts(const QStringList &aContactDataList, const QStringList &aContactsIdList); /*! * \brief Batch deletion of contacts * @param aContactIDList Contact IDs * @return Errors */ QMap deleteContacts(const QStringList &aContactIDList); /*! * \brief Tells if batch updates are enabled * @return True if enabled, false if not */ inline bool batchUpdatesEnabled() { return true; } /*! * \brief Returns the last time the contact was modified * @param aContactId Id of the contact * @return Timestamp of contact's last modification time */ QDateTime lastModificationTime(const QContactLocalId &aContactId); /*! \brief Return creation time of single contact * * @param aContact Contact * @return Creation time */ QDateTime getCreationTime( const QContact& aContact ); /*! \brief Returns creation times of the contacts * * @param aContactIds Ids of the contacts * @return Creation times */ QList getCreationTimes( const QList& aContactIds ); /*! \brief Converts a QContact to a VCard * * @param aContact Contact * @return VCard */ QString convertQContactToVCard(const QContact &aContact); private: // functions QMap convertQContactListToVCardList \ (const QList &aContactList); QList convertVCardListToVersitDocumentList \ (const QStringList &aVCardList); void prepareContactSave(QList *contactList); /*! * \brief Returns contact IDs specified by event type and timestamp * @param aEventType Added/changed/removed contacts * @param aTimeStamp Contacts older than aTimeStamp are filtered out * @param aIdList Returned contact IDs */ void getSpecifiedContactIds(const QContactChangeLogFilter::EventType aEventType, const QDateTime &aTimeStamp, QList &aIdList); private: // data QContactManager *iReadMgr; ///< A pointer to contact manager QContactManager *iWriteMgr; ///< A pointer to contact manager QVersitDocument::VersitType iVCardVer; ///< VCard Version type to operate on QString iSyncTarget; ///< syncTarget to use for contact details QString iOriginId; ///< origin meta-data ID to use for contact details }; #endif /* CONTACTSBACKEND_H_ */