<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactfetchbyidrequest.cpp -->
<title>Qt Mobility 1.2: QContactFetchByIdRequest Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcontacts.html">QtContacts</a></li>
<li>QContactFetchByIdRequest</li>
</ul>
</div>
</div>
<div class="content mainContent">
<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>
<h1 class="title">QContactFetchByIdRequest Class Reference</h1>
<!-- $$$QContactFetchByIdRequest-brief -->
<p>The QContactFetchByIdRequest class allows a client to asynchronously request contacts from a contacts store manager, given a list of contact IDs. <a href="#details">More...</a></p>
<!-- @@@QContactFetchByIdRequest -->
<pre class="cpp"> <span class="preprocessor">#include <QContactFetchByIdRequest></span></pre><p><b>Inherits: </b><a href="qcontactabstractrequest.html">QContactAbstractRequest</a>.</p>
<ul>
<li><a href="qcontactfetchbyidrequest-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.html#QContactFetchByIdRequest">QContactFetchByIdRequest</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.html#dtor.QContactFetchByIdRequest">~QContactFetchByIdRequest</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContact> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.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="qcontactfetchbyidrequest.html#errorMap">errorMap</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFetchHint </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.html#fetchHint">fetchHint</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QContactLocalId> </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.html#localIds">localIds</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.html#setFetchHint">setFetchHint</a></b> ( const QContactFetchHint & <i>fetchHint</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactfetchbyidrequest.html#setLocalIds">setLocalIds</a></b> ( const QList<QContactLocalId> & <i>localIds</i> )</td></tr>
</table>
<ul>
<li class="fn">9 public functions inherited from <a href="qcontactabstractrequest.html#public-functions">QContactAbstractRequest</a></li>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">3 public slots inherited from <a href="qcontactabstractrequest.html#public-slots">QContactAbstractRequest</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="qcontactabstractrequest.html#signals">QContactAbstractRequest</a></li>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QContactFetchByIdRequest-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactFetchByIdRequest class allows a client to asynchronously request contacts from a contacts store manager, given a list of contact IDs.</p>
<p>The contacts fetched by the backend should have a one-to-one correspondence to the IDs passed into this class. That is, the nth contact in the returned list should have an ID which is equal to the nth ID in the list of IDs. Any invalid ID should correspond to an empty <a href="qcontact.html">QContact</a>.</p>
<p>For a QContactFetchByIdRequest, the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal will be emitted when the resultant contacts (which may be retrieved by calling <a href="qcontactfetchbyidrequest.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>
<!-- @@@QContactFetchByIdRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContactFetchByIdRequest[overload1]$$$QContactFetchByIdRequestQObject* -->
<h3 class="fn"><a name="QContactFetchByIdRequest"></a>QContactFetchByIdRequest::<span class="name">QContactFetchByIdRequest</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new contact fetch request whose parent is the specified <i>parent</i></p>
<!-- @@@QContactFetchByIdRequest -->
<!-- $$$~QContactFetchByIdRequest[overload1]$$$~QContactFetchByIdRequest -->
<h3 class="fn"><a name="dtor.QContactFetchByIdRequest"></a>QContactFetchByIdRequest::<span class="name">~QContactFetchByIdRequest</span> ()</h3>
<p>Frees any memory used by this request</p>
<!-- @@@~QContactFetchByIdRequest -->
<!-- $$$contacts[overload1]$$$contacts -->
<h3 class="fn"><a name="contacts"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qcontact.html">QContact</a></span>> QContactFetchByIdRequest::<span class="name">contacts</span> () const</h3>
<p>Returns the list of contacts retrieved by this request</p>
<!-- @@@contacts -->
<!-- $$$errorMap[overload1]$$$errorMap -->
<h3 class="fn"><a name="errorMap"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qmap.html">QMap</a></span><<span class="type">int</span>, <span class="type"><a href="qcontactmanager.html#Error-enum">QContactManager::Error</a></span>> QContactFetchByIdRequest::<span class="name">errorMap</span> () const</h3>
<p>Returns the map of input definition list indices to errors which occurred</p>
<!-- @@@errorMap -->
<!-- $$$fetchHint[overload1]$$$fetchHint -->
<h3 class="fn"><a name="fetchHint"></a><span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> QContactFetchByIdRequest::<span class="name">fetchHint</span> () const</h3>
<p>Returns the fetch hint which may be used by the backend to optimize contact retrieval. A client should not make changes to a contact which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the contact back to the manager (as the "new" restricted contact will replace the previously saved contact in the backend).</p>
<p><b>See also </b><a href="qcontactfetchbyidrequest.html#setFetchHint">setFetchHint</a>() and <a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@fetchHint -->
<!-- $$$localIds[overload1]$$$localIds -->
<h3 class="fn"><a name="localIds"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qcontactid.html#QContactLocalId-typedef">QContactLocalId</a></span>> QContactFetchByIdRequest::<span class="name">localIds</span> () const</h3>
<p>Returns the list of ids of the contacts that the backend should retrieve.</p>
<p><b>See also </b><a href="qcontactfetchbyidrequest.html#setLocalIds">setLocalIds</a>().</p>
<!-- @@@localIds -->
<!-- $$$setFetchHint[overload1]$$$setFetchHintconstQContactFetchHint& -->
<h3 class="fn"><a name="setFetchHint"></a><span class="type">void</span> QContactFetchByIdRequest::<span class="name">setFetchHint</span> ( const <span class="type"><a href="qcontactfetchhint.html">QContactFetchHint</a></span> & <i>fetchHint</i> )</h3>
<p>Sets the fetch hint which may be used by the backend to optimize contact retrieval to <i>fetchHint</i>. A client should not make changes to a contact which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the contact back to the manager (as the "new" restricted contact will replace the previously saved contact in the backend).</p>
<p><b>See also </b><a href="qcontactfetchbyidrequest.html#fetchHint">fetchHint</a>() and <a href="qcontactfetchhint.html">QContactFetchHint</a>.</p>
<!-- @@@setFetchHint -->
<!-- $$$setLocalIds[overload1]$$$setLocalIdsconstQList<QContactLocalId>& -->
<h3 class="fn"><a name="setLocalIds"></a><span class="type">void</span> QContactFetchByIdRequest::<span class="name">setLocalIds</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qcontactid.html#QContactLocalId-typedef">QContactLocalId</a></span>> & <i>localIds</i> )</h3>
<p>Sets the list of ids of the contacts that the backend should retrieve to <i>localIds</i>.</p>
<p><b>See also </b><a href="qcontactfetchbyidrequest.html#localIds">localIds</a>().</p>
<!-- @@@setLocalIds -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used 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.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
720
