Added missing comments.
[situare] / src / engine / contactmanagerprivate.h
1 #ifndef CONTACTMANAGERPRIVATE_H
2 #define CONTACTMANAGERPRIVATE_H
3
4 #include <QObject>
5
6 #include <QContactManager>
7
8 class ContactManager;
9
10 QTM_USE_NAMESPACE
11
12 /**
13 * @brief Manages phone address book contacts.
14 */
15 class ContactManagerPrivate : public QObject
16 {
17     Q_OBJECT
18
19 public:
20     /**
21     * @brief Constructor
22     *
23     * @param parent QObject
24     */
25     ContactManagerPrivate(QObject *parent = 0);
26
27 /*******************************************************************************
28 * MEMBER FUNCTIONS AND SLOTS
29 ******************************************************************************/
30     /**
31     * @brief Returns contact's guid from contact's facebook ID.
32     *
33     * @param facebookId contact's facebook ID
34     * @return contact guid
35     */
36     QString contactGuid(const QString &facebookId) const;
37
38     /**
39     * @brief Requests contact guids.
40     *
41     * Guid is a globally unique ID of a contact, which can be used with
42     * other datastores.
43     */
44     void requestContactGuids();
45
46 private:
47     /**
48     * @brief Parses Facebook id from account URI.
49     *
50     * @param accountUri Accounts universal resource identifier.
51     * @return Facebook ID or empty if cannot parse the ID.
52     */
53     QString parseFacebookId(const QString &accountUri) const;
54
55 /******************************************************************************
56 * DATA MEMBERS
57 ******************************************************************************/
58 private:
59     ContactManager *m_parent;               ///< Parent
60     QContactManager *m_manager;             ///< Contact manager
61     QHash<QString, QString> m_contactGuids; ///< List of contact GUIDS
62 };
63
64 #endif // CONTACTMANAGERPRIVATE_H