/usr/share/qt5/doc/qtcontacts/qcontactmanager.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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactmanager.cpp -->
<title>QContactManager 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 >QContactManager</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-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QContactManager Class</h1>
<!-- $$$QContactManager-brief -->
<p>The <a href="qcontactmanager.html">QContactManager</a> class provides an interface which allows clients with access to contact information stored in a particular backend. <a href="#details">More...</a></p>
<!-- @@@QContactManager -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactManager></span>
</td></tr></table></div><ul>
<li><a href="qcontactmanager-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#Error-enum">Error</a></b> { NoError, DoesNotExistError, AlreadyExistsError, InvalidDetailError, ..., MissingPlatformRequirementsError }</td></tr>
</table></div>
<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="qcontactmanager.html#QContactManager">QContactManager</a></b>(const QString &<i>managerName</i> = QString(), const QMap<QString, QString> &<i>parameters</i> = 0, QObject *<i>parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#QContactManager-1">QContactManager</a></b>(const QString &<i>managerName</i>, int <i>implementationVersion</i>, const QMap<QString, QString> &<i>parameters</i> = 0, QObject *<i>parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#QContactManager-2">QContactManager</a></b>(QObject *<i>parent</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#dtor.QContactManager">~QContactManager</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContact </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contact">contact</a></b>(const QContactId &<i>contactId</i>, const QContactFetchHint &<i>fetchHint</i> = QContactFetchHint()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactId> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contactIds">contactIds</a></b>(const QList<QContactSortOrder> &<i>sortOrders</i> = QList<QContactSortOrder> ()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactId> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contactIds-1">contactIds</a></b>(const QContactFilter &<i>filter</i>, const QList<QContactSortOrder> &<i>sortOrders</i> = QList<QContactSortOrder> ()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContact> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contacts">contacts</a></b>(const QList<QContactSortOrder> &<i>sortOrders</i> = QList<QContactSortOrder> (), const QContactFetchHint &<i>fetchHint</i> = QContactFetchHint()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContact> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contacts-1">contacts</a></b>(const QContactFilter &<i>filter</i>, const QList<QContactSortOrder> &<i>sortOrders</i> = QList<QContactSortOrder> (), const QContactFetchHint &<i>fetchHint</i> = QContactFetchHint()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContact> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contacts-2">contacts</a></b>(const QList<QContactId> &<i>contactIds</i>, const QContactFetchHint &<i>fetchHint</i> = QContactFetchHint(), QMap<int, QContactManager::Error> *<i>errorMap</i> = 0) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactManager::Error </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMap<int, QContactManager::Error> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#errorMap">errorMap</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#isFilterSupported">isFilterSupported</a></b>(const QContactFilter &<i>filter</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#isRelationshipTypeSupported">isRelationshipTypeSupported</a></b>(const QString &<i>relationshipType</i>, QContactType::TypeValues <i>contactType</i> = QContactType::TypeContact) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#managerName">managerName</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMap<QString, QString> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#managerParameters">managerParameters</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#managerUri">managerUri</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#managerVersion">managerVersion</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactRelationship> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#relationships">relationships</a></b>(const QContact &<i>participant</i>, QContactRelationship::Role <i>role</i> = QContactRelationship::Either) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactRelationship> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#relationships-1">relationships</a></b>(const QString &<i>relationshipType</i> = QString(), const QContact &<i>participant</i> = QContact(), QContactRelationship::Role <i>role</i> = QContactRelationship::Either) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#removeContact">removeContact</a></b>(const QContactId &<i>contactId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#removeContacts">removeContacts</a></b>(const QList<QContactId> &<i>contactIds</i>, QMap<int, QContactManager::Error> *<i>errorMap</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#removeRelationship">removeRelationship</a></b>(const QContactRelationship &<i>relationship</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#removeRelationships">removeRelationships</a></b>(const QList<QContactRelationship> &<i>relationships</i>, QMap<int, QContactManager::Error> *<i>errorMap</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#saveContact">saveContact</a></b>(QContact *<i>contact</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#saveContacts">saveContacts</a></b>(QList<QContact> *<i>contacts</i>, QMap<int, QContactManager::Error> *<i>errorMap</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#saveContacts-1">saveContacts</a></b>(QList<QContact> *<i>contacts</i>, const QList<QContactDetail::DetailType> &<i>typeMask</i>, QMap<int, QContactManager::Error> *<i>errorMap</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#saveRelationship">saveRelationship</a></b>(QContactRelationship *<i>relationship</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#saveRelationships">saveRelationships</a></b>(QList<QContactRelationship> *<i>relationships</i>, QMap<int, QContactManager::Error> *<i>errorMap</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactId </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#selfContactId">selfContactId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#setSelfContactId">setSelfContactId</a></b>(const QContactId &<i>contactId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactDetail::DetailType> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#supportedContactDetailTypes">supportedContactDetailTypes</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactType::TypeValues> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#supportedContactTypes">supportedContactTypes</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QVariant::Type> </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#supportedDataTypes">supportedDataTypes</a></b>() const</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contactsAdded">contactsAdded</a></b>(const QList<QContactId> &<i>contactIds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contactsChanged">contactsChanged</a></b>(const QList<QContactId> &<i>contactIds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#contactsRemoved">contactsRemoved</a></b>(const QList<QContactId> &<i>contactIds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#dataChanged">dataChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#relationshipsAdded">relationshipsAdded</a></b>(const QList<QContactId> &<i>affectedContactIds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#relationshipsRemoved">relationshipsRemoved</a></b>(const QList<QContactId> &<i>affectedContactIds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#selfContactIdChanged">selfContactIdChanged</a></b>(const QContactId &<i>oldId</i>, const QContactId &<i>newId</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#ParameterSignalDefinitions">ParameterSignalDefinitions</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#ParameterSignalSources">ParameterSignalSources</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#ParameterValueOnlyOtherManagers">ParameterValueOnlyOtherManagers</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#ParameterValueOnlyOtherProcesses">ParameterValueOnlyOtherProcesses</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#availableManagers">availableManagers</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#buildUri">buildUri</a></b>(const QString &<i>managerName</i>, const QMap<QString, QString> &<i>params</i>, int <i>implementationVersion</i> = -1)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactManager *</td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#fromUri">fromUri</a></b>(const QString &<i>managerUri</i>, QObject *<i>parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactmanager.html#parseUri">parseUri</a></b>(const QString &<i>uri</i>, QString *<i>pManagerId</i>, QMap<QString, QString> *<i>pParams</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QContactManager-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactmanager.html">QContactManager</a> class provides an interface which allows clients with access to contact information stored in a particular backend.</p>
<p>This class provides an abstraction of a datastore or aggregation of datastores which contains contact information. It provides methods to retrieve and manipulate contact information and contact relationship information. It also provides metadata and error information reporting.</p>
<p>The functions provided by <a href="qcontactmanager.html">QContactManager</a> are purely synchronous; to access the same functionality in an asynchronous manner, clients should use the use-case-specific classes derived from <a href="qcontactabstractrequest.html">QContactAbstractRequest</a>.</p>
<p>Some functionality provided by <a href="qcontactmanager.html">QContactManager</a> directly is not accessible using the asynchronous API. See the <a href="contactssync.html">synchronous</a> and <a href="contactsasync.html">asynchronous</a> API information in the <a href="contactsclasses.html">Qt Contacts C++ API</a> documentation.</p>
</div>
<!-- @@@QContactManager -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$DoesNotExistError$$$AlreadyExistsError$$$InvalidDetailError$$$InvalidRelationshipError$$$LockedError$$$DetailAccessError$$$PermissionsError$$$OutOfMemoryError$$$NotSupportedError$$$BadArgumentError$$$UnspecifiedError$$$VersionMismatchError$$$LimitReachedError$$$InvalidContactTypeError$$$TimeoutError$$$InvalidStorageLocationError$$$MissingPlatformRequirementsError -->
<h3 class="fn" id="Error-enum"><a name="Error-enum"></a>enum QContactManager::<span class="name">Error</span></h3>
<p>This enum specifies an error that occurred during the most recent operation:</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QContactManager::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The most recent operation was successful</td></tr>
<tr><td class="topAlign"><code>QContactManager::DoesNotExistError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The most recent operation failed because the requested contact does not exist</td></tr>
<tr><td class="topAlign"><code>QContactManager::AlreadyExistsError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The most recent operation failed because the specified contact already exists</td></tr>
<tr><td class="topAlign"><code>QContactManager::InvalidDetailError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The most recent operation failed because the specified contact contains details which do not conform to their definition</td></tr>
<tr><td class="topAlign"><code>QContactManager::InvalidRelationshipError</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The most recent operation failed because the specified relationship is circular or references an invalid local contact</td></tr>
<tr><td class="topAlign"><code>QContactManager::InvalidContactTypeError</code></td><td class="topAlign tblval"><code>14</code></td><td class="topAlign">The most recent operation failed because the contact type specified was not valid for the operation</td></tr>
<tr><td class="topAlign"><code>QContactManager::LockedError</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">The most recent operation failed because the datastore specified is currently locked</td></tr>
<tr><td class="topAlign"><code>QContactManager::DetailAccessError</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">The most recent operation failed because a detail was modified or removed and its access method does not allow that</td></tr>
<tr><td class="topAlign"><code>QContactManager::PermissionsError</code></td><td class="topAlign tblval"><code>7</code></td><td class="topAlign">The most recent operation failed because the caller does not have permission to perform the operation</td></tr>
<tr><td class="topAlign"><code>QContactManager::OutOfMemoryError</code></td><td class="topAlign tblval"><code>8</code></td><td class="topAlign">The most recent operation failed due to running out of memory</td></tr>
<tr><td class="topAlign"><code>QContactManager::VersionMismatchError</code></td><td class="topAlign tblval"><code>12</code></td><td class="topAlign">The most recent operation failed because the backend of the manager is not of the required version</td></tr>
<tr><td class="topAlign"><code>QContactManager::LimitReachedError</code></td><td class="topAlign tblval"><code>13</code></td><td class="topAlign">The most recent operation failed because the limit for that type of object has been reached</td></tr>
<tr><td class="topAlign"><code>QContactManager::NotSupportedError</code></td><td class="topAlign tblval"><code>9</code></td><td class="topAlign">The most recent operation failed because the requested operation is not supported in the specified store</td></tr>
<tr><td class="topAlign"><code>QContactManager::BadArgumentError</code></td><td class="topAlign tblval"><code>10</code></td><td class="topAlign">The most recent operation failed because one or more of the parameters to the operation were invalid</td></tr>
<tr><td class="topAlign"><code>QContactManager::TimeoutError</code></td><td class="topAlign tblval"><code>15</code></td><td class="topAlign">The most recent operation failed because it took longer than expected. It may be possible to try again.</td></tr>
<tr><td class="topAlign"><code>QContactManager::UnspecifiedError</code></td><td class="topAlign tblval"><code>11</code></td><td class="topAlign">The most recent operation failed for an undocumented reason</td></tr>
<tr><td class="topAlign"><code>QContactManager::InvalidStorageLocationError</code></td><td class="topAlign tblval"><code>16</code></td><td class="topAlign">The most recent operation failed due to requested storage location is unavailable or invalid.</td></tr>
<tr><td class="topAlign"><code>QContactManager::MissingPlatformRequirementsError</code></td><td class="topAlign tblval"><code>17</code></td><td class="topAlign">The most recent operation failed due to all storage locations are unavailable.</td></tr>
</table></div>
<!-- @@@Error -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactManager[overload1]$$$QContactManagerconstQString&constQMap<QString,QString>&QObject* -->
<h3 class="fn" id="QContactManager"><a name="QContactManager"></a>QContactManager::<span class="name">QContactManager</span>(const <span class="type">QString</span> &<i>managerName</i> = QString(), const <span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QString</span>> &<i>parameters</i> = 0, <span class="type">QObject</span> *<i>parent</i> = 0)</h3>
<p>Constructs a <a href="qcontactmanager.html">QContactManager</a> whose implementation is identified by <i>managerName</i> with the given <i>parameters</i>.</p>
<p>The <i>parent</i> QObject will be used as the parent of this <a href="qcontactmanager.html">QContactManager</a>.</p>
<p>If an empty <i>managerName</i> is specified, the default implementation for the platform will be used.</p>
<!-- @@@QContactManager -->
<!-- $$$QContactManager$$$QContactManagerconstQString&intconstQMap<QString,QString>&QObject* -->
<h3 class="fn" id="QContactManager-1"><a name="QContactManager-1"></a>QContactManager::<span class="name">QContactManager</span>(const <span class="type">QString</span> &<i>managerName</i>, <span class="type">int</span> <i>implementationVersion</i>, const <span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QString</span>> &<i>parameters</i> = 0, <span class="type">QObject</span> *<i>parent</i> = 0)</h3>
<p>Constructs a <a href="qcontactmanager.html">QContactManager</a> whose backend has the name <i>managerName</i> and version <i>implementationVersion</i>, where the manager is constructed with the provided <i>parameters</i>.</p>
<p>The <i>parent</i> QObject will be used as the parent of this <a href="qcontactmanager.html">QContactManager</a>.</p>
<p>If an empty <i>managerName</i> is specified, the default implementation for the platform will be instantiated. If the specified implementation version is not available, the manager with the name <i>managerName</i> with the default implementation version is instantiated.</p>
<!-- @@@QContactManager -->
<!-- $$$QContactManager$$$QContactManagerQObject* -->
<h3 class="fn" id="QContactManager-2"><a name="QContactManager-2"></a>QContactManager::<span class="name">QContactManager</span>(<span class="type">QObject</span> *<i>parent</i>)</h3>
<p>Constructs a <a href="qcontactmanager.html">QContactManager</a> whose parent QObject is <i>parent</i>. The default implementation for the platform will be created.</p>
<!-- @@@QContactManager -->
<!-- $$$~QContactManager[overload1]$$$~QContactManager -->
<h3 class="fn" id="dtor.QContactManager"><a name="dtor.QContactManager"></a>QContactManager::<span class="name">~QContactManager</span>()</h3>
<p>Frees the memory used by the <a href="qcontactmanager.html">QContactManager</a></p>
<!-- @@@~QContactManager -->
<!-- $$$ParameterSignalDefinitions[overload1]$$$ParameterSignalDefinitions -->
<h3 class="fn" id="ParameterSignalDefinitions"><a name="ParameterSignalDefinitions"></a><code>[static] </code>const <span class="type">QString</span> QContactManager::<span class="name">ParameterSignalDefinitions</span>()</h3>
<p>The string constant for the parameter key which holds the names of detail definitions. If a manager supports suppressing change signals depending on the value given for this construction parameter, clients can request that signals be suppressed if the changes which might otherwise cause a signal to be emitted, involve details whose definition name is not contained in the given list.</p>
<p>That is, if a detail in a contact is changed, but that detail's definition name is not listed in the value for this parameter, the manager will not emit a change signal for that change.</p>
<p>If this parameter is not specified at construction time, changes to any detail of a contact will cause a change signal to be emitted.</p>
<p>The value of this parameter should be a comma (,) separated list of definition names. Any commas which might be part of a definition name must be escaped with a single backslash () character prior to concatenation. Any backslash character which might be part of a definition name must also be escaped with a backslash.</p>
<p>If the parameter (or value given for the parameter) is not supported by the manager, the manager may still be constructed, however the parameter will not be reported to the client if the client calls <a href="qcontactmanager.html#managerParameters">managerParameters</a>() subsequent to manager construction.</p>
<!-- @@@ParameterSignalDefinitions -->
<!-- $$$ParameterSignalSources[overload1]$$$ParameterSignalSources -->
<h3 class="fn" id="ParameterSignalSources"><a name="ParameterSignalSources"></a><code>[static] </code>const <span class="type">QString</span> QContactManager::<span class="name">ParameterSignalSources</span>()</h3>
<p>The string constant for the parameter key which holds the value for signal sources. If a manager supports suppressing change signals depending on the value given for this construction parameter, clients can request that signals be suppressed if the changes which might cause a signal to be emitted do not match particular criteria.</p>
<p>If the parameter (or value given for the parameter) is not supported by the manager, the manager may still be constructed, however the parameter will not be reported to the client if the client calls <a href="qcontactmanager.html#managerParameters">managerParameters</a>() subsequent to manager construction.</p>
<p>The default (assumed) value for this parameter, if this parameter is not given, is that the client wants to be notified of all changes to the data, regardless of the source of the change.</p>
<!-- @@@ParameterSignalSources -->
<!-- $$$ParameterValueOnlyOtherManagers[overload1]$$$ParameterValueOnlyOtherManagers -->
<h3 class="fn" id="ParameterValueOnlyOtherManagers"><a name="ParameterValueOnlyOtherManagers"></a><code>[static] </code>const <span class="type">QString</span> QContactManager::<span class="name">ParameterValueOnlyOtherManagers</span>()</h3>
<p>This value tells the manager to only emit signals for changes which are made in other manager instances. That is, the client wishes to receive change signals when another client (or background service) changes the data as it is stored in the backend, but does not wish to be notified of changes (or side effects) which it has caused itself.</p>
<!-- @@@ParameterValueOnlyOtherManagers -->
<!-- $$$ParameterValueOnlyOtherProcesses[overload1]$$$ParameterValueOnlyOtherProcesses -->
<h3 class="fn" id="ParameterValueOnlyOtherProcesses"><a name="ParameterValueOnlyOtherProcesses"></a><code>[static] </code>const <span class="type">QString</span> QContactManager::<span class="name">ParameterValueOnlyOtherProcesses</span>()</h3>
<p>This value tells the manager to only emit signals for changes which are made in other processes. That is, the client wishes to receive change signals when a client (or background service) in another process changes the data as it is stored in the backend, but does not wish to be notified of changes (or side effects) which were caused in the current client's process, even if those changes were made in a different manager instance to this one.</p>
<!-- @@@ParameterValueOnlyOtherProcesses -->
<!-- $$$availableManagers[overload1]$$$availableManagers -->
<h3 class="fn" id="availableManagers"><a name="availableManagers"></a><code>[static] </code><span class="type">QStringList</span> QContactManager::<span class="name">availableManagers</span>()</h3>
<p>Returns a list of available manager ids that can be used when constructing a <a href="qcontactmanager.html">QContactManager</a>. If an empty id is specified to the constructor, the first value in this list will be used instead.</p>
<p>The QTCONTACTS_MANAGER_OVERRIDE environment variable may be set to override the default engine.</p>
<!-- @@@availableManagers -->
<!-- $$$buildUri[overload1]$$$buildUriconstQString&constQMap<QString,QString>&int -->
<h3 class="fn" id="buildUri"><a name="buildUri"></a><code>[static] </code><span class="type">QString</span> QContactManager::<span class="name">buildUri</span>(const <span class="type">QString</span> &<i>managerName</i>, const <span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QString</span>> &<i>params</i>, <span class="type">int</span> <i>implementationVersion</i> = -1)</h3>
<p>Returns a URI that completely describes a manager implementation, datastore, and the parameters with which to instantiate the manager, from the given <i>managerName</i>, <i>params</i> and an optional <i>implementationVersion</i>. This function is generally useful only if you intend to construct a manager with the <a href="qcontactmanager.html#fromUri">fromUri</a>() function, or wish to construct a contact id manually (for synchronization or other purposes). Most clients will not need to use this function.</p>
<!-- @@@buildUri -->
<!-- $$$contact[overload1]$$$contactconstQContactId&constQContactFetchHint& -->
<h3 class="fn" id="contact"><a name="contact"></a><span class="type"><a href="qcontact.html">QContact</a></span> QContactManager::<span class="name">contact</span>(const <span class="type"><a href="qcontactid.html">QContactId</a></span> &<i>contactId</i>, const <span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> &<i>fetchHint</i> = QContactFetchHint()) const</h3>
<p>Returns the contact in the database identified by <i>contactId</i>.</p>
<p>If the contact does not exist, an empty, default constructed <a href="qcontact.html">QContact</a> will be returned, and the error returned by <a href="qcontactmanager.html#error">error</a>() will be <code>QContactManager::DoesNotExistError</code>.</p>
<p>The <i>fetchHint</i> parameter describes the optimization hints that a manager may take. If the <i>fetchHint</i> is the default constructed hint, all existing details, relationships and action preferences in the matching contact will be returned. If a client makes changes to an contact which has been retrieved with a fetch hint, they should save it back using a partial save, masked by the same set of detail names in order to avoid information loss.</p>
<p><b>See also </b><a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@contact -->
<!-- $$$contactIds[overload1]$$$contactIdsconstQList<QContactSortOrder>& -->
<h3 class="fn" id="contactIds"><a name="contactIds"></a><span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> QContactManager::<span class="name">contactIds</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactsortorder.html">QContactSortOrder</a></span>> &<i>sortOrders</i> = QList<QContactSortOrder> ()) const</h3>
<p>Return the list of contact ids, sorted according to the given list of <i>sortOrders</i></p>
<!-- @@@contactIds -->
<!-- $$$contactIds$$$contactIdsconstQContactFilter&constQList<QContactSortOrder>& -->
<h3 class="fn" id="contactIds-1"><a name="contactIds-1"></a><span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> QContactManager::<span class="name">contactIds</span>(const <span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> &<i>filter</i>, const <span class="type">QList</span><<span class="type"><a href="qcontactsortorder.html">QContactSortOrder</a></span>> &<i>sortOrders</i> = QList<QContactSortOrder> ()) const</h3>
<p>Returns a list of contact ids that match the given <i>filter</i>, sorted according to the given list of <i>sortOrders</i>. Depending on the backend, this filtering operation may involve retrieving all the contacts.</p>
<!-- @@@contactIds -->
<!-- $$$contacts[overload1]$$$contactsconstQList<QContactSortOrder>&constQContactFetchHint& -->
<h3 class="fn" id="contacts"><a name="contacts"></a><span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> QContactManager::<span class="name">contacts</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactsortorder.html">QContactSortOrder</a></span>> &<i>sortOrders</i> = QList<QContactSortOrder> (), const <span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> &<i>fetchHint</i> = QContactFetchHint()) const</h3>
<p>Returns the list of contacts stored in the manager sorted according to the given list of <i>sortOrders</i>.</p>
<p>The <i>fetchHint</i> parameter describes the optimization hints that a manager may take. If the <i>fetchHint</i> is the default constructed hint, all existing details, relationships and action preferences in the matching contact will be returned. If a client makes changes to an contact which has been retrieved with a fetch hint, they should save it back using a partial save, masked by the same set of detail names in order to avoid information loss.</p>
<p><b>See also </b><a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@contacts -->
<!-- $$$contacts$$$contactsconstQContactFilter&constQList<QContactSortOrder>&constQContactFetchHint& -->
<h3 class="fn" id="contacts-1"><a name="contacts-1"></a><span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> QContactManager::<span class="name">contacts</span>(const <span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> &<i>filter</i>, const <span class="type">QList</span><<span class="type"><a href="qcontactsortorder.html">QContactSortOrder</a></span>> &<i>sortOrders</i> = QList<QContactSortOrder> (), const <span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> &<i>fetchHint</i> = QContactFetchHint()) const</h3>
<p>Returns a list of contacts that match the given <i>filter</i>, sorted according to the given list of <i>sortOrders</i>.</p>
<p>Depending on the manager implementation, this filtering operation might be slow and involve retrieving all the contacts and testing them against the supplied filter - see the <a href="qcontactmanager.html#isFilterSupported">isFilterSupported</a>() function.</p>
<p>The <i>fetchHint</i> parameter describes the optimization hints that a manager may take. If the <i>fetchHint</i> is the default constructed hint, all existing details, relationships and action preferences in the matching contact will be returned. If a client makes changes to an contact which has been retrieved with a fetch hint, they should save it back using a partial save, masked by the same set of detail names in order to avoid information loss.</p>
<p><b>See also </b><a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@contacts -->
<!-- $$$contacts$$$contactsconstQList<QContactId>&constQContactFetchHint&QMap<int,QContactManager::Error>* -->
<h3 class="fn" id="contacts-2"><a name="contacts-2"></a><span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> QContactManager::<span class="name">contacts</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>contactIds</i>, const <span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> &<i>fetchHint</i> = QContactFetchHint(), <span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> *<i>errorMap</i> = 0) const</h3>
<p>Returns a list of contacts given a list of ids (<i>contactIds</i>).</p>
<p>Returns the list of contacts with the ids given by <i>contactIds</i>. There is a one-to-one correspondence between the returned contacts and the supplied <i>contactIds</i>.</p>
<p>If there is an invalid id in <i>contactIds</i>, then an empty <a href="qcontact.html">QContact</a> will take its place in the returned list. The <i>errorMap</i> parameter can be supplied to store per-input errors in. In all cases, calling <a href="qcontactmanager.html#errorMap">errorMap</a>() will return the per-input errors for the latest batch function.</p>
<p>The <i>fetchHint</i> parameter describes the optimization hints that a manager may take. If the <i>fetchHint</i> is the default constructed hint, all existing details, relationships and action preferences in the matching contact will be returned. If a client makes changes to an contact which has been retrieved with a fetch hint, they should save it back using a partial save, masked by the same set of detail names in order to avoid information loss.</p>
<p><b>See also </b><a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@contacts -->
<!-- $$$contactsAdded[overload1]$$$contactsAddedconstQList<QContactId>& -->
<h3 class="fn" id="contactsAdded"><a name="contactsAdded"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">contactsAdded</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>contactIds</i>)</h3>
<p>This signal is emitted at some point once the contacts identified by <i>contactIds</i> have been added to a datastore managed by this manager. This signal must not be emitted if the <a href="qcontactmanager.html#dataChanged">dataChanged</a>() signal was previously emitted for these changes.</p>
<!-- @@@contactsAdded -->
<!-- $$$contactsChanged[overload1]$$$contactsChangedconstQList<QContactId>& -->
<h3 class="fn" id="contactsChanged"><a name="contactsChanged"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">contactsChanged</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>contactIds</i>)</h3>
<p>This signal is emitted at some point once the contacts identified by <i>contactIds</i> have been modified in a datastore managed by this manager. This signal must not be emitted if the <a href="qcontactmanager.html#dataChanged">dataChanged</a>() signal was previously emitted for these changes.</p>
<!-- @@@contactsChanged -->
<!-- $$$contactsRemoved[overload1]$$$contactsRemovedconstQList<QContactId>& -->
<h3 class="fn" id="contactsRemoved"><a name="contactsRemoved"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">contactsRemoved</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>contactIds</i>)</h3>
<p>This signal is emitted at some point once the contacts identified by <i>contactIds</i> have been removed from a datastore managed by this manager. This signal must not be emitted if the <a href="qcontactmanager.html#dataChanged">dataChanged</a>() signal was previously emitted for these changes.</p>
<!-- @@@contactsRemoved -->
<!-- $$$dataChanged[overload1]$$$dataChanged -->
<h3 class="fn" id="dataChanged"><a name="dataChanged"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">dataChanged</span>()</h3>
<p>This signal is emitted by the manager if its internal state changes, and it is unable to determine the changes which occurred, or if the manager considers the changes to be radical enough to require clients to reload all data. If this signal is emitted, no other signals will be emitted for the associated changes.</p>
<!-- @@@dataChanged -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span> QContactManager::<span class="name">error</span>() const</h3>
<p>Return the error code of the most recent operation. For batch operations, if the error code is not equal to <code>QContactManager::NoError</code>, detailed per-input errors may be retrieved by calling <a href="qcontactmanager.html#errorMap">errorMap</a>().</p>
<p><b>See also </b><a href="qcontactmanager.html#errorMap">errorMap</a>().</p>
<!-- @@@error -->
<!-- $$$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>> QContactManager::<span class="name">errorMap</span>() const</h3>
<p>Returns per-input error codes for the most recent operation. This function only returns meaningful information if the most recent operation was a batch operation. Each key in the map is the index of the element in the input list for which the error (whose error code is stored in the value for that key in the map) occurred during the batch operation.</p>
<p><b>See also </b><a href="qcontactmanager.html#error">error</a>(), <a href="qcontactmanager.html#contacts">contacts</a>(), <a href="qcontactmanager.html#saveContacts">saveContacts</a>(), <a href="qcontactmanager.html#removeContacts">removeContacts</a>(), <a href="qcontactmanager.html#saveRelationships">saveRelationships</a>(), and <a href="qcontactmanager.html#removeRelationships">removeRelationships</a>().</p>
<!-- @@@errorMap -->
<!-- $$$fromUri[overload1]$$$fromUriconstQString&QObject* -->
<h3 class="fn" id="fromUri"><a name="fromUri"></a><code>[static] </code><span class="type"><a href="qcontactmanager.html#QContactManager">QContactManager</a></span> *QContactManager::<span class="name">fromUri</span>(const <span class="type">QString</span> &<i>managerUri</i>, <span class="type">QObject</span> *<i>parent</i> = 0)</h3>
<p>Constructs a <a href="qcontactmanager.html">QContactManager</a> whose implementation version, manager name and specific parameters are specified in the given <i>managerUri</i>, and whose parent object is <i>parent</i>.</p>
<!-- @@@fromUri -->
<!-- $$$isFilterSupported[overload1]$$$isFilterSupportedconstQContactFilter& -->
<h3 class="fn" id="isFilterSupported"><a name="isFilterSupported"></a><span class="type">bool</span> QContactManager::<span class="name">isFilterSupported</span>(const <span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> &<i>filter</i>) const</h3>
<p>Returns true if the given <i>filter</i> is supported natively by the manager, and false if the filter behaviour would be emulated.</p>
<p>Note: In some cases, the behaviour of an unsupported filter cannot be emulated. For example, a filter that requests contacts that have changed since a given time depends on having that information available. In these cases, the filter will fail.</p>
<!-- @@@isFilterSupported -->
<!-- $$$isRelationshipTypeSupported[overload1]$$$isRelationshipTypeSupportedconstQString&QContactType::TypeValues -->
<h3 class="fn" id="isRelationshipTypeSupported"><a name="isRelationshipTypeSupported"></a><span class="type">bool</span> QContactManager::<span class="name">isRelationshipTypeSupported</span>(const <span class="type">QString</span> &<i>relationshipType</i>, <span class="type">QContactType::TypeValues</span> <i>contactType</i> = QContactType::TypeContact) const</h3>
<p>Returns true if the manager supports the relationship type specified in <i>relationshipType</i> for contacts whose type is the given <i>contactType</i>.</p>
<p>Note that some managers may support the relationship type for a contact in a limited manner (for example, only as the first contact in the relationship, or only as the second contact in the relationship). In this case, it will still return true. It will only return false if the relationship is entirely unsupported for the given type of contact.</p>
<!-- @@@isRelationshipTypeSupported -->
<!-- $$$managerName[overload1]$$$managerName -->
<h3 class="fn" id="managerName"><a name="managerName"></a><span class="type">QString</span> QContactManager::<span class="name">managerName</span>() const</h3>
<p>Returns the manager name for this <a href="qcontactmanager.html">QContactManager</a></p>
<!-- @@@managerName -->
<!-- $$$managerParameters[overload1]$$$managerParameters -->
<h3 class="fn" id="managerParameters"><a name="managerParameters"></a><span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QString</span>> QContactManager::<span class="name">managerParameters</span>() const</h3>
<p>Return the parameters relevant to the creation of this <a href="qcontactmanager.html">QContactManager</a></p>
<!-- @@@managerParameters -->
<!-- $$$managerUri[overload1]$$$managerUri -->
<h3 class="fn" id="managerUri"><a name="managerUri"></a><span class="type">QString</span> QContactManager::<span class="name">managerUri</span>() const</h3>
<p>Return the uri describing this <a href="qcontactmanager.html">QContactManager</a>, consisting of the manager name and any parameters.</p>
<!-- @@@managerUri -->
<!-- $$$managerVersion[overload1]$$$managerVersion -->
<h3 class="fn" id="managerVersion"><a name="managerVersion"></a><span class="type">int</span> QContactManager::<span class="name">managerVersion</span>() const</h3>
<p>Returns the engine backend implementation version number</p>
<!-- @@@managerVersion -->
<!-- $$$parseUri[overload1]$$$parseUriconstQString&QString*QMap<QString,QString>* -->
<h3 class="fn" id="parseUri"><a name="parseUri"></a><code>[static] </code><span class="type">bool</span> QContactManager::<span class="name">parseUri</span>(const <span class="type">QString</span> &<i>uri</i>, <span class="type">QString</span> *<i>pManagerId</i>, <span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QString</span>> *<i>pParams</i>)</h3>
<p>Splits the given <i>uri</i> into the manager, store, and parameters that it describes, and places the information into the memory addressed by <i>pManagerId</i> and <i>pParams</i> respectively. Returns true if <i>uri</i> could be split successfully, otherwise returns false</p>
<!-- @@@parseUri -->
<!-- $$$relationships[overload1]$$$relationshipsconstQContact&QContactRelationship::Role -->
<h3 class="fn" id="relationships"><a name="relationships"></a><span class="type">QList</span><<span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span>> QContactManager::<span class="name">relationships</span>(const <span class="type"><a href="qcontact.html">QContact</a></span> &<i>participant</i>, <span class="type"><a href="qcontactrelationship.html#Role-enum">QContactRelationship::Role</a></span> <i>role</i> = QContactRelationship::Either) const</h3>
<p>Returns a list of relationships in which the contact <i>participant</i> participates in the given <i>role</i>. If <i>participant</i> is empty, <i>role</i> is ignored and all relationships are returned.</p>
<!-- @@@relationships -->
<!-- $$$relationships$$$relationshipsconstQString&constQContact&QContactRelationship::Role -->
<h3 class="fn" id="relationships-1"><a name="relationships-1"></a><span class="type">QList</span><<span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span>> QContactManager::<span class="name">relationships</span>(const <span class="type">QString</span> &<i>relationshipType</i> = QString(), const <span class="type"><a href="qcontact.html">QContact</a></span> &<i>participant</i> = QContact(), <span class="type"><a href="qcontactrelationship.html#Role-enum">QContactRelationship::Role</a></span> <i>role</i> = QContactRelationship::Either) const</h3>
<p>Returns a list of relationships of the given <i>relationshipType</i> in which the contact identified by the given <i>participant</i> participates in the given <i>role</i>. If <i>participant</i> is empty, <i>role</i> is ignored and all relationships of the given <i>relationshipType</i> are returned. If <i>relationshipType</i> is empty, relationships of any type are returned.</p>
<!-- @@@relationships -->
<!-- $$$relationshipsAdded[overload1]$$$relationshipsAddedconstQList<QContactId>& -->
<h3 class="fn" id="relationshipsAdded"><a name="relationshipsAdded"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">relationshipsAdded</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>affectedContactIds</i>)</h3>
<p>This signal is emitted at some point after relationships have been added to the manager which involve the contacts identified by <i>affectedContactIds</i>. This signal must not be emitted if the <a href="qcontactmanager.html#dataChanged">dataChanged</a>() signal was previously emitted for these changes.</p>
<!-- @@@relationshipsAdded -->
<!-- $$$relationshipsRemoved[overload1]$$$relationshipsRemovedconstQList<QContactId>& -->
<h3 class="fn" id="relationshipsRemoved"><a name="relationshipsRemoved"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">relationshipsRemoved</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>affectedContactIds</i>)</h3>
<p>This signal is emitted at some point after relationships have eben removed from the manager which involve the contacts identified by <i>affectedContactIds</i>. This signal must not be emitted if the <a href="qcontactmanager.html#dataChanged">dataChanged</a>() signal was previously emitted for these changes.</p>
<!-- @@@relationshipsRemoved -->
<!-- $$$removeContact[overload1]$$$removeContactconstQContactId& -->
<h3 class="fn" id="removeContact"><a name="removeContact"></a><span class="type">bool</span> QContactManager::<span class="name">removeContact</span>(const <span class="type"><a href="qcontactid.html">QContactId</a></span> &<i>contactId</i>)</h3>
<p>Remove the contact identified by <i>contactId</i> from the database, and also removes any relationships in which the contact was involved. Returns true if the contact was removed successfully, otherwise returns false.</p>
<!-- @@@removeContact -->
<!-- $$$removeContacts[overload1]$$$removeContactsconstQList<QContactId>&QMap<int,QContactManager::Error>* -->
<h3 class="fn" id="removeContacts"><a name="removeContacts"></a><span class="type">bool</span> QContactManager::<span class="name">removeContacts</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactid.html">QContactId</a></span>> &<i>contactIds</i>, <span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> *<i>errorMap</i> = 0)</h3>
<p>Remove every contact whose id is contained in the list of contacts ids <i>contactIds</i>. Returns true if all contacts were removed successfully, otherwise false.</p>
<p>Any contact that was removed successfully will have the relationships in which it was involved removed also.</p>
<p>The <i>errorMap</i> parameter can be supplied to store per-input errors in. In all cases, calling <a href="qcontactmanager.html#errorMap">errorMap</a>() will return the per-input errors for the latest batch function. The <a href="qcontactmanager.html#error">QContactManager::error</a>() function will only return <code>QContactManager::NoError</code> if all contacts were removed successfully.</p>
<p>If the given list of contact ids <i>contactIds</i> is empty, the function will return false and calling <a href="qcontactmanager.html#error">error</a>() will return <code>QContactManager::BadArgumentError</code>. If the list is non-empty and contains ids which do not identify a valid contact in the manager, the function will remove any contacts which are identified by ids in the <i>contactIds</i> list, insert <code>QContactManager::DoesNotExist</code> entries into the <i>errorMap</i> for the indices of invalid ids in the <i>contactIds</i> list, return false, and set the overall operation error to <code>QContactManager::DoesNotExistError</code>.</p>
<p><b>See also </b><a href="qcontactmanager.html#removeContact">QContactManager::removeContact</a>().</p>
<!-- @@@removeContacts -->
<!-- $$$removeRelationship[overload1]$$$removeRelationshipconstQContactRelationship& -->
<h3 class="fn" id="removeRelationship"><a name="removeRelationship"></a><span class="type">bool</span> QContactManager::<span class="name">removeRelationship</span>(const <span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span> &<i>relationship</i>)</h3>
<p>Removes the given <i>relationship</i> from the manager. If the relationship exists in the manager, the relationship will be removed, the error will be set to <code>QContactManager::NoError</code> and this function will return true. If no such relationship exists in the manager, the error will be set to <code>QContactManager::DoesNotExistError</code> and this function will return false.</p>
<!-- @@@removeRelationship -->
<!-- $$$removeRelationships[overload1]$$$removeRelationshipsconstQList<QContactRelationship>&QMap<int,QContactManager::Error>* -->
<h3 class="fn" id="removeRelationships"><a name="removeRelationships"></a><span class="type">bool</span> QContactManager::<span class="name">removeRelationships</span>(const <span class="type">QList</span><<span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span>> &<i>relationships</i>, <span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> *<i>errorMap</i> = 0)</h3>
<p>Removes the given <i>relationships</i> from the database and returns true if the operation was successful. The <i>errorMap</i> parameter can be supplied to store per-input errors in. In all cases, calling <a href="qcontactmanager.html#errorMap">errorMap</a>() will return the per-input errors for the latest batch function.</p>
<!-- @@@removeRelationships -->
<!-- $$$saveContact[overload1]$$$saveContactQContact* -->
<h3 class="fn" id="saveContact"><a name="saveContact"></a><span class="type">bool</span> QContactManager::<span class="name">saveContact</span>(<span class="type"><a href="qcontact.html">QContact</a></span> *<i>contact</i>)</h3>
<p>Adds the given <i>contact</i> to the database if <i>contact</i> has the (default constructed) null id.</p>
<p>If the manager URI of the id of the <i>contact</i> is neither empty nor equal to the URI of this manager, or id of the <i>contact</i> is not null but does not exist in the manager, the operation will fail and calling <a href="qcontactmanager.html#error">error</a>() will return <code>QContactManager::DoesNotExistError</code>.</p>
<p>Alternatively, the function will update the existing contact in the database if <i>contact</i> has a id which is not null and currently exists in the database.</p>
<p>If the <i>contact</i> contains one or more details whose types are not supported by the used engine, the operation will fail and calling <a href="qcontactmanager.html#error">error</a>() will return <code>QContactManager::UnsupportedError</code>.</p>
<p>If the <i>contact</i> has had its relationships reordered, the manager will check to make sure that every relationship that the contact is currently involved in is included in the reordered list, and that no relationships which either do not involve the contact, or have not been saved in the manager are included in the list. If these conditions are not met, the function will return <code>false</code> and calling <a href="qcontactmanager.html#error">error</a>() will return <code>QContactManager::InvalidRelationshipError</code>.</p>
<p>Returns false on failure, or true on success. On successful save of an contact with a null id, its id will be set to a new, non-null id.</p>
<p>The manager is not required to fetch updated details of the contact on save, and as such, clients should fetch a contact if they want the most up-to-date information by calling <a href="qcontactmanager.html#contact">QContactManager::contact</a>().</p>
<p><b>See also </b><a href="qcontactmanager.html#managerUri">managerUri</a>().</p>
<!-- @@@saveContact -->
<!-- $$$saveContacts[overload1]$$$saveContactsQList<QContact>*QMap<int,QContactManager::Error>* -->
<h3 class="fn" id="saveContacts"><a name="saveContacts"></a><span class="type">bool</span> QContactManager::<span class="name">saveContacts</span>(<span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> *<i>contacts</i>, <span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> *<i>errorMap</i> = 0)</h3>
<p>Adds the list of contacts given by <i>contacts</i> list to the database. Returns true if the contacts were saved successfully, otherwise false.</p>
<p>The <i>errorMap</i> parameter can be supplied to store per-input errors in. In all cases, calling <a href="qcontactmanager.html#errorMap">errorMap</a>() will return the per-input errors for the latest batch function. The <a href="qcontactmanager.html#error">QContactManager::error</a>() function will only return <code>QContactManager::NoError</code> if all contacts were saved successfully.</p>
<p>For each newly saved contact that was successful, the id of the contact in the <i>contacts</i> list will be updated with the new value.</p>
<p><b>See also </b><a href="qcontactmanager.html#saveContact">QContactManager::saveContact</a>().</p>
<!-- @@@saveContacts -->
<!-- $$$saveContacts$$$saveContactsQList<QContact>*constQList<QContactDetail::DetailType>&QMap<int,QContactManager::Error>* -->
<h3 class="fn" id="saveContacts-1"><a name="saveContacts-1"></a><span class="type">bool</span> QContactManager::<span class="name">saveContacts</span>(<span class="type">QList</span><<span class="type"><a href="qcontact.html">QContact</a></span>> *<i>contacts</i>, const <span class="type">QList</span><<span class="type"><a href="qcontactdetail.html#DetailType-enum">QContactDetail::DetailType</a></span>> &<i>typeMask</i>, <span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> *<i>errorMap</i> = 0)</h3>
<p>Adds the list of contacts given by <i>contacts</i> list to the database. Returns true if the contacts were saved successfully, otherwise false.</p>
<p>This function accepts a <i>typeMask</i>, which specifies which details of the contacts should be updated. Details with types not included in the typeMask will not be updated or added.</p>
<p>The <i>errorMap</i> parameter can be supplied to store per-input errors in. In all cases, calling <a href="qcontactmanager.html#errorMap">errorMap</a>() will return the per-input errors for the latest batch function. The <a href="qcontactmanager.html#error">QContactManager::error</a>() function will only return <code>QContactManager::NoError</code> if all contacts were saved successfully.</p>
<p>For each newly saved contact that was successful, the id of the contact in the <i>contacts</i> list will be updated with the new value.</p>
<p><b>See also </b><a href="qcontactmanager.html#saveContact">QContactManager::saveContact</a>().</p>
<!-- @@@saveContacts -->
<!-- $$$saveRelationship[overload1]$$$saveRelationshipQContactRelationship* -->
<h3 class="fn" id="saveRelationship"><a name="saveRelationship"></a><span class="type">bool</span> QContactManager::<span class="name">saveRelationship</span>(<span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span> *<i>relationship</i>)</h3>
<p>Saves the given <i>relationship</i> in the database. If the relationship already exists in the database, this function will return <code>false</code> and the error will be set to <code>QContactManager::AlreadyExistsError</code>. If the relationship is saved successfully, this function will return <code>true</code> and error will be set to <code>QContactManager::NoError</code>. Note that relationships cannot be updated directly using this function; in order to update a relationship, you must remove the old relationship, make the required modifications, and then save it.</p>
<p>The given relationship is invalid if it is circular (the first contact is the second contact), or if it references a non-existent local contact (either the first or second contact). If the given <i>relationship</i> is invalid, the function will return <code>false</code> and the error will be set to <code>QContactManager::InvalidRelationshipError</code>. If the given <i>relationship</i> could not be saved in the database (due to backend limitations) the function will return <code>false</code> and error will be set to <code>QContactManager::NotSupportedError</code>.</p>
<!-- @@@saveRelationship -->
<!-- $$$saveRelationships[overload1]$$$saveRelationshipsQList<QContactRelationship>*QMap<int,QContactManager::Error>* -->
<h3 class="fn" id="saveRelationships"><a name="saveRelationships"></a><span class="type">bool</span> QContactManager::<span class="name">saveRelationships</span>(<span class="type">QList</span><<span class="type"><a href="qcontactrelationship.html">QContactRelationship</a></span>> *<i>relationships</i>, <span class="type">QMap</span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> *<i>errorMap</i> = 0)</h3>
<p>Saves the given <i>relationships</i> in the database and returns true if the operation was successful. The <i>errorMap</i> parameter can be supplied to store per-input errors in. In all cases, calling <a href="qcontactmanager.html#errorMap">errorMap</a>() will return the per-input errors for the latest batch function.</p>
<!-- @@@saveRelationships -->
<!-- $$$selfContactId[overload1]$$$selfContactId -->
<h3 class="fn" id="selfContactId"><a name="selfContactId"></a><span class="type"><a href="qcontactid.html">QContactId</a></span> QContactManager::<span class="name">selfContactId</span>() const</h3>
<p>Returns the id of the "self" contact which has previously been set. If no "self" contact has been set, or if the self contact was removed from the manager after being set, or if the backend does not support the concept of a "self" contact, an invalid id will be returned and the error will be set to <code>QContactManager::DoesNotExistError</code>.</p>
<p><b>See also </b><a href="qcontactmanager.html#setSelfContactId">setSelfContactId</a>().</p>
<!-- @@@selfContactId -->
<!-- $$$selfContactIdChanged[overload1]$$$selfContactIdChangedconstQContactId&constQContactId& -->
<h3 class="fn" id="selfContactIdChanged"><a name="selfContactIdChanged"></a><code>[signal] </code><span class="type">void</span> QContactManager::<span class="name">selfContactIdChanged</span>(const <span class="type"><a href="qcontactid.html">QContactId</a></span> &<i>oldId</i>, const <span class="type"><a href="qcontactid.html">QContactId</a></span> &<i>newId</i>)</h3>
<p>This signal is emitted at some point after the id of the self-contact is changed from <i>oldId</i> to <i>newId</i> in the manager. If the <i>newId</i> is the invalid, then the self contact was deleted or no self contact exists. This signal must not be emitted if the <a href="qcontactmanager.html#dataChanged">dataChanged</a>() signal was previously emitted for this change.</p>
<!-- @@@selfContactIdChanged -->
<!-- $$$setSelfContactId[overload1]$$$setSelfContactIdconstQContactId& -->
<h3 class="fn" id="setSelfContactId"><a name="setSelfContactId"></a><span class="type">bool</span> QContactManager::<span class="name">setSelfContactId</span>(const <span class="type"><a href="qcontactid.html">QContactId</a></span> &<i>contactId</i>)</h3>
<p>Sets the id of the "self" contact to the given <i>contactId</i>. Returns true if the "self" contact id was set successfully. If the given <i>contactId</i> does not identify a contact stored in this manager, the error will be set to <code>QContactManager::DoesNotExistError</code> and the function will return false; if the backend does not support the concept of a "self" contact then the error will be set to <code>QContactManager::NotSupportedError</code> and the function will return false.</p>
<p><b>See also </b><a href="qcontactmanager.html#selfContactId">selfContactId</a>().</p>
<!-- @@@setSelfContactId -->
<!-- $$$supportedContactDetailTypes[overload1]$$$supportedContactDetailTypes -->
<h3 class="fn" id="supportedContactDetailTypes"><a name="supportedContactDetailTypes"></a><span class="type">QList</span><<span class="type"><a href="qcontactdetail.html#DetailType-enum">QContactDetail::DetailType</a></span>> QContactManager::<span class="name">supportedContactDetailTypes</span>() const</h3>
<p>Returns the list of contact detail types which are supported by this manager. The returned list can be used by clients to identify incompatibilities between contact objects to be saved and the actual subset of detail types supported by this manager.</p>
<!-- @@@supportedContactDetailTypes -->
<!-- $$$supportedContactTypes[overload1]$$$supportedContactTypes -->
<h3 class="fn" id="supportedContactTypes"><a name="supportedContactTypes"></a><span class="type">QList</span><<span class="type">QContactType::TypeValues</span>> QContactManager::<span class="name">supportedContactTypes</span>() const</h3>
<p>Returns the list of contact types which are supported by this manager. This is a convenience function, equivalent to retrieving the allowable values for the <code>QContactType::FieldType</code> field of the QContactType detail which is valid in this manager.</p>
<!-- @@@supportedContactTypes -->
<!-- $$$supportedDataTypes[overload1]$$$supportedDataTypes -->
<h3 class="fn" id="supportedDataTypes"><a name="supportedDataTypes"></a><span class="type">QList</span><<span class="type">QVariant::Type</span>> QContactManager::<span class="name">supportedDataTypes</span>() const</h3>
<p>Returns the list of data types supported by the manager</p>
<!-- @@@supportedDataTypes -->
</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>
|