1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtContacts module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL21$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 or version 3 as published by the Free
20** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22** following information to ensure the GNU Lesser General Public License
23** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25**
26** As a special exception, The Qt Company gives you certain additional
27** rights. These rights are described in The Qt Company LGPL Exception
28** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29**
30** $QT_END_LICENSE$
31**
32****************************************************************************/
33
34#include "qcontactrelationshipsaverequest.h"
35
36#include "qcontactrequests_p.h"
37
38QT_BEGIN_NAMESPACE_CONTACTS
39
40/*!
41 \class QContactRelationshipSaveRequest
42 \brief The QContactRelationshipSaveRequest class allows a client to asynchronously
43 request that certain groups be saved to a contacts store.
44
45 For a QContactRelationshipSaveRequest, the resultsAvailable() signal will be emitted when
46 either the individual item errors (which may be retrieved by calling errorMap()), or the resultant
47 relationships (which may be retrieved by calling relationships()), are updated, as well as if
48 the overall operation error (which may be retrieved by calling error()) is updated.
49
50 Please see the class documentation of QContactAbstractRequest for more information about
51 the usage of request classes and ownership semantics.
52
53
54 \inmodule QtContacts
55
56 \ingroup contacts-requests
57 */
58
59/*! Constructs a new relationship save request whose parent is the specified \a parent */
60QContactRelationshipSaveRequest::QContactRelationshipSaveRequest(QObject* parent)
61 : QContactAbstractRequest(new QContactRelationshipSaveRequestPrivate, parent)
62{
63}
64
65/*! Frees any memory used by this request */
66QContactRelationshipSaveRequest::~QContactRelationshipSaveRequest()
67{
68}
69
70/*!
71 Sets the relationship to save to be \a contactRelationship.
72 Equivalent to calling:
73 \code
74 setRelationships(QList<QContactRelationship>() << contactRelationships);
75 \endcode
76 */
77void QContactRelationshipSaveRequest::setRelationship(const QContactRelationship& contactRelationship)
78{
79 Q_D(QContactRelationshipSaveRequest);
80 QMutexLocker ml(&d->m_mutex);
81 d->m_relationships.clear();
82 d->m_relationships.append(t: contactRelationship);
83}
84
85/*! Sets the relationships to save to be \a contactRelationships
86*/
87void QContactRelationshipSaveRequest::setRelationships(const QList<QContactRelationship>& contactRelationships)
88{
89 Q_D(QContactRelationshipSaveRequest);
90 QMutexLocker ml(&d->m_mutex);
91 d->m_relationships = contactRelationships;
92}
93
94/*! Returns the list of relationships that will be saved if called prior to calling \c start(),
95 otherwise returns the list of relationships as they were saved in the contacts store
96*/
97QList<QContactRelationship> QContactRelationshipSaveRequest::relationships() const
98{
99 Q_D(const QContactRelationshipSaveRequest);
100 QMutexLocker ml(&d->m_mutex);
101 return d->m_relationships;
102}
103
104/*! Returns the map of input relationship list indices to errors which occurred
105*/
106QMap<int, QContactManager::Error> QContactRelationshipSaveRequest::errorMap() const
107{
108 Q_D(const QContactRelationshipSaveRequest);
109 QMutexLocker ml(&d->m_mutex);
110 return d->m_errors;
111}
112
113#include "moc_qcontactrelationshipsaverequest.cpp"
114
115QT_END_NAMESPACE_CONTACTS
116

source code of qtpim/src/contacts/requests/qcontactrelationshipsaverequest.cpp