/usr/share/qt5/doc/qtcontacts/qcontactsaverequest.html is in qtpim5-doc-html 5.0~git20140515~29475884-0ubuntu24~7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactsaverequest.cpp -->
<title>QContactSaveRequest Class | Qt 5.0</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.0</td><td >QContactSaveRequest</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.0.0 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QContactSaveRequest Class</h1>
<!-- $$$QContactSaveRequest-brief -->
<p>The <a href="qcontactsaverequest.html">QContactSaveRequest</a> class allows a client to asynchronously request that certain contacts be saved to a contacts store. <a href="#details">More...</a></p>
<!-- @@@QContactSaveRequest -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactSaveRequest></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qcontactabstractrequest.html">QContactAbstractRequest</a></td></tr></table></div><ul>
<li><a href="qcontactsaverequest-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#QContactSaveRequest">QContactSaveRequest</a></b>(QObject *<i>parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#dtor.QContactSaveRequest">~QContactSaveRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContact> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#contacts">contacts</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMap<int, QContactManager::Error> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#errorMap">errorMap</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#setContact">setContact</a></b>(const QContact &<i>contact</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#setContacts">setContacts</a></b>(const QList<QContact> &<i>contacts</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#setStorageLocation">setStorageLocation</a></b>(QContactAbstractRequest::StorageLocation <i>storageLocation</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#setTypeMask">setTypeMask</a></b>(const QList<QContactDetail::DetailType> &<i>typeMask</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactAbstractRequest::StorageLocation </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#storageLocation">storageLocation</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactDetail::DetailType> </td><td class="memItemRight bottomAlign"><b><a href="qcontactsaverequest.html#typeMask">typeMask</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">9 public functions inherited from <a href="qcontactabstractrequest.html#public-functions">QContactAbstractRequest</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 public slots inherited from <a href="qcontactabstractrequest.html#public-slots">QContactAbstractRequest</a></li>
<li class="fn">2 signals inherited from <a href="qcontactabstractrequest.html#signals">QContactAbstractRequest</a></li>
</ul>
<a name="details"></a>
<!-- $$$QContactSaveRequest-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactsaverequest.html">QContactSaveRequest</a> class allows a client to asynchronously request that certain contacts be saved to a contacts store.</p>
<p>For a <a href="qcontactsaverequest.html">QContactSaveRequest</a>, the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal will be emitted when either the individual item errors (which may be retrieved by calling <a href="qcontactsaverequest.html#errorMap">errorMap</a>()), or the resultant contacts (which may be retrieved by calling <a href="qcontactsaverequest.html#contacts">contacts</a>()), are updated, as well as if the overall operation error (which may be retrieved by calling <a href="qcontactabstractrequest.html#error">error</a>()) is updated.</p>
<p>Please see the class documentation of <a href="qcontactabstractrequest.html">QContactAbstractRequest</a> for more information about the usage of request classes and ownership semantics.</p>
</div>
<!-- @@@QContactSaveRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactSaveRequest[overload1]$$$QContactSaveRequestQObject* -->
<h3 class="fn" id="QContactSaveRequest"><a name="QContactSaveRequest"></a>QContactSaveRequest::<span class="name">QContactSaveRequest</span>(<span class="type">QObject</span> *<i>parent</i> = 0)</h3>
<p>Constructs a new contact save request whose parent is the specified <i>parent</i></p>
<!-- @@@QContactSaveRequest -->
<!-- $$$~QContactSaveRequest[overload1]$$$~QContactSaveRequest -->
<h3 class="fn" id="dtor.QContactSaveRequest"><a name="dtor.QContactSaveRequest"></a>QContactSaveRequest::<span class="name">~QContactSaveRequest</span>()</h3>
<p>Frees any memory used by this request</p>
<!-- @@@~QContactSaveRequest -->
<!-- $$$contacts[overload1]$$$contacts -->
<h3 class="fn" id="contacts"><a name="contacts"></a><span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> QContactSaveRequest::<span class="name">contacts</span>() const</h3>
<p>Returns the list of contacts which will be saved if called prior to calling <code>start()</code>, otherwise returns the list of contacts with their ids set appropriately (successfully saved new contacts will have an id assigned).</p>
<p><b>See also </b><a href="qcontactsaverequest.html#setContacts">setContacts</a>().</p>
<!-- @@@contacts -->
<!-- $$$errorMap[overload1]$$$errorMap -->
<h3 class="fn" id="errorMap"><a name="errorMap"></a><span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> QContactSaveRequest::<span class="name">errorMap</span>() const</h3>
<p>Returns the map of input contact list indices to errors which occurred</p>
<!-- @@@errorMap -->
<!-- $$$setContact[overload1]$$$setContactconstQContact& -->
<h3 class="fn" id="setContact"><a name="setContact"></a><span class="type">void</span> QContactSaveRequest::<span class="name">setContact</span>(const <span class="type"><a href="qcontact.html">QContact</a></span> &<i>contact</i>)</h3>
<p>Sets the contact to be saved to <i>contact</i>. Equivalent to calling:</p>
<pre class="cpp">
setContacts(<span class="type">QList</span><span class="operator"><</span><span class="type"><a href="qcontact.html">QContact</a></span><span class="operator">></span>() <span class="operator"><</span><span class="operator"><</span> contact);
</pre>
<!-- @@@setContact -->
<!-- $$$setContacts[overload1]$$$setContactsconstQList<QContact>& -->
<h3 class="fn" id="setContacts"><a name="setContacts"></a><span class="type">void</span> QContactSaveRequest::<span class="name">setContacts</span>(const <span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> &<i>contacts</i>)</h3>
<p>Sets the list of contacts to be saved to <i>contacts</i></p>
<p><b>See also </b><a href="qcontactsaverequest.html#contacts">contacts</a>().</p>
<!-- @@@setContacts -->
<!-- $$$setStorageLocation[overload1]$$$setStorageLocationQContactAbstractRequest::StorageLocation -->
<h3 class="fn" id="setStorageLocation"><a name="setStorageLocation"></a><span class="type">void</span> QContactSaveRequest::<span class="name">setStorageLocation</span>(<span class="type"><a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocation</a></span> <i>storageLocation</i>)</h3>
<p>Sets the <i>storageLocation</i> where the new contacts will be saved to.</p>
<p>This is ignored for contacts which have already been saved. Instead, those contacts are saved back to the storage location where they were originally stored.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocation</a> and <a href="qcontactsaverequest.html#storageLocation">storageLocation</a>().</p>
<!-- @@@setStorageLocation -->
<!-- $$$setTypeMask[overload1]$$$setTypeMaskconstQList<QContactDetail::DetailType>& -->
<h3 class="fn" id="setTypeMask"><a name="setTypeMask"></a><span class="type">void</span> QContactSaveRequest::<span class="name">setTypeMask</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactdetail.html#DetailType-enum">QContactDetail::DetailType</a></span>> &<i>typeMask</i>)</h3>
<p>Set the list of definitions to restrict saving to <i>typeMask</i>. This allows you to perform partial save (and remove) operations on existing contacts.</p>
<p>If <i>typeMask</i> is empty (the default), no restrictions will apply, and the passed in contacts will be saved as is. Otherwise, only details whose types are in the <a href="qcontactsaverequest.html#typeMask">typeMask</a> will be saved. If a type is present in the list, but there are no corresponding details in the contact passed into this request, any existing details in the manager for that contact will be removed.</p>
<p>This is useful if you've used a fetch hint to fetch a partial contact from a manager so that you can save changes to the details you actually fetched without removing the details you didn't.</p>
<p>Additionally, when performing synchronization operations with other managers that don't support the full range of details, you can restrict the update operation to only those details so that you don't lose the extra details that are supported in this manager.</p>
<p><b>Note: </b>Some managers do not support partial updates natively, in which case the <a href="qtcontacts-qmlmodule.html">QtContacts</a> framework will emulate the functionality (fetching the whole contact, applying the new restricted details, and saving the contact back).</p><p><b>See also </b><a href="qcontactsaverequest.html#typeMask">typeMask</a>().</p>
<!-- @@@setTypeMask -->
<!-- $$$storageLocation[overload1]$$$storageLocation -->
<h3 class="fn" id="storageLocation"><a name="storageLocation"></a><span class="type"><a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocation</a></span> QContactSaveRequest::<span class="name">storageLocation</span>() const</h3>
<p>Returns the storage location where the contacts will be saved to.</p>
<p>This is ignored for contacts which have already been saved. Instead, those contacts are saved back to the storage location where they were originally stored.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#StorageLocation-enum">QContactAbstractRequest::StorageLocation</a> and <a href="qcontactsaverequest.html#setStorageLocation">setStorageLocation</a>().</p>
<!-- @@@storageLocation -->
<!-- $$$typeMask[overload1]$$$typeMask -->
<h3 class="fn" id="typeMask"><a name="typeMask"></a><span class="type">QList</span><<span class="type"><a href="qcontactdetail.html#DetailType-enum">QContactDetail::DetailType</a></span>> QContactSaveRequest::<span class="name">typeMask</span>() const</h3>
<p>Returns the list of definitions that this request will operate on.</p>
<p>If the list is empty, the request will operate on all details.</p>
<p><b>See also </b><a href="qcontactsaverequest.html#setTypeMask">setTypeMask</a>().</p>
<!-- @@@typeMask -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|