/usr/share/qt5/doc/qtcontacts/qcontactabstractrequest.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactabstractrequest.cpp -->
<title>QContactAbstractRequest 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 >QContactAbstractRequest</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="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</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">QContactAbstractRequest Class</h1>
<!-- $$$QContactAbstractRequest-brief -->
<p>The <a href="qcontactabstractrequest.html">QContactAbstractRequest</a> class provides a mechanism for asynchronous requests to be made of a manager if it supports them. <a href="#details">More...</a></p>
<!-- @@@QContactAbstractRequest -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactAbstractRequest></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qcontactfetchbyidrequest.html">QContactFetchByIdRequest</a>, <a href="qcontactfetchrequest.html">QContactFetchRequest</a>, <a href="qcontactidfetchrequest.html">QContactIdFetchRequest</a>, <a href="qcontactrelationshipfetchrequest.html">QContactRelationshipFetchRequest</a>, <a href="qcontactrelationshipremoverequest.html">QContactRelationshipRemoveRequest</a>, <a href="qcontactrelationshipsaverequest.html">QContactRelationshipSaveRequest</a>, <a href="qcontactremoverequest.html">QContactRemoveRequest</a>, and <a href="qcontactsaverequest.html">QContactSaveRequest</a></p>
</td></tr></table></div><ul>
<li><a href="qcontactabstractrequest-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="qcontactabstractrequest.html#RequestType-enum">RequestType</a></b> { InvalidRequest, ContactFetchRequest, ContactIdFetchRequest, ContactRemoveRequest, ..., ContactFetchByIdRequest }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#State-enum">State</a></b> { InactiveState, ActiveState, CanceledState, FinishedState }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#StorageLocation-enum">StorageLocation</a></b> { UserDataStorage, SystemStorage }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#StorageLocation-enum">StorageLocations</a></b></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="qcontactabstractrequest.html#dtor.QContactAbstractRequest">~QContactAbstractRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactManager::Error </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#isActive">isActive</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#isCanceled">isCanceled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#isFinished">isFinished</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#isInactive">isInactive</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactManager *</td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#manager">manager</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#setManager">setManager</a></b>(QContactManager *<i>manager</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#state">state</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> RequestType </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#type">type</a></b>() const</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#cancel">cancel</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#start">start</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#waitForFinished">waitForFinished</a></b>(int <i>msecs</i> = 0)</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="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactabstractrequest.html#stateChanged">stateChanged</a></b>(QContactAbstractRequest::State <i>newState</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QContactAbstractRequest-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactabstractrequest.html">QContactAbstractRequest</a> class provides a mechanism for asynchronous requests to be made of a manager if it supports them.</p>
<p>It allows a client to asynchronously request some functionality of a particular <a href="qcontactmanager.html">QContactManager</a>. Instances of the class will emit signals when the state of the request changes, or when more results become available.</p>
<p>Clients should not attempt to create instances of this class directly, but should instead use the use-case-specific classes derived from this class.</p>
<p>All such request classes have a similar interface: clients set the parameters of the asynchronous call, including which manager the request will be made of, and then call the <a href="qcontactabstractrequest.html#start">start</a>() slot of the request. The manager will then enqueue or begin to process the request, at which point the request's state will transition from <code>InactiveState</code> to <code>ActiveState</code>. After any state transition, the request will emit the <a href="qcontactabstractrequest.html#stateChanged">stateChanged</a>() signal. The manager may periodically update the request with results, at which point the request will emit the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal. These results are not guaranteed to have a stable ordering. Error information is considered a result, so some requests will emit the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal even if no results are possible from the request (for example, a contact remove request) when the manager updates the request with information about any errors which may have occurred.</p>
<p>Please see the class documentation of each of the use-case-specific classes derived from this class for information about how to retrieve the results of a request (including error information). In all cases, those functions are synchronous, and will return the cached result set with which the manager has updated the request instance if the <a href="qcontactabstractrequest.html#resultsAvailable">resultsAvailable</a>() signal has been emitted.</p>
<p>Clients can choose which signals they wish to handle from a request. If the client is not interested in interim results, they can choose to handle only the <a href="qcontactabstractrequest.html#stateChanged">stateChanged</a>() signal, and in the slot to which that signal is connected, check whether the state has changed to either <code>FinishedState</code> or <code>CanceledState</code> (both of which signify that the manager has finished handling the request, and that the request will not be updated with any more results). If the client is not interested in any results (including error information), they may choose to delete the request after calling <a href="qcontactabstractrequest.html#start">start</a>(), or simply not connect the request's signals to any slots.</p>
<p>If the request is allocated via operator new, the client must delete the request when they are no longer using it in order to avoid leaking memory. That is, the client retains ownership of the request.</p>
<p>The client may delete a heap-allocated request in various ways: by deleting it directly (but not within a slot connected to a signal emitted by the request), or by using the deleteLater() slot to schedule the request for deletion when control returns to the event loop (from within a slot connected to a signal emitted by the request, for example <a href="qcontactabstractrequest.html#stateChanged">stateChanged</a>()).</p>
<p>An active request may be deleted by the client, but the client will not receive any notifications about whether the request succeeded or not, nor any results of the request.</p>
<p>Because clients retain ownership of any request object, and may delete a request object at any time, manager engine implementors must be careful to ensure that they do not assume that a request has not been deleted at some point during processing of a request, particularly if the engine has a multithreaded implementation. It is suggested that engine implementors read the <a href="contactsengines.html">Qt Contacts Manager Engines</a> documentation for more information on this topic.</p>
</div>
<!-- @@@QContactAbstractRequest -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$RequestType$$$InvalidRequest$$$ContactFetchRequest$$$ContactIdFetchRequest$$$ContactRemoveRequest$$$ContactSaveRequest$$$RelationshipFetchRequest$$$RelationshipRemoveRequest$$$RelationshipSaveRequest$$$ContactFetchByIdRequest -->
<h3 class="fn" id="RequestType-enum"><a name="RequestType-enum"></a>enum QContactAbstractRequest::<span class="name">RequestType</span></h3>
<p>Enumerates the various possible types of asynchronous requests</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>QContactAbstractRequest::InvalidRequest</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">An invalid request</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::ContactFetchRequest</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">A request to fetch a list of contacts</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::ContactIdFetchRequest</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">A request to fetch a list of contact ids</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::ContactRemoveRequest</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">A request to remove a list of contacts</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::ContactSaveRequest</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">A request to save a list of contacts</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::RelationshipFetchRequest</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">A request to fetch relationships between contacts</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::RelationshipRemoveRequest</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">A request to remove any relationships which match the request criteria</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::RelationshipSaveRequest</code></td><td class="topAlign tblval"><code>7</code></td><td class="topAlign">A request to save a list of relationships</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::ContactFetchByIdRequest</code></td><td class="topAlign tblval"><code>8</code></td><td class="topAlign">A request to fetch a list of contacts given a list of ids</td></tr>
</table></div>
<!-- @@@RequestType -->
<!-- $$$State$$$InactiveState$$$ActiveState$$$CanceledState$$$FinishedState -->
<h3 class="fn" id="State-enum"><a name="State-enum"></a>enum QContactAbstractRequest::<span class="name">State</span></h3>
<p>Enumerates the various states that a request may be in at any given time</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>QContactAbstractRequest::InactiveState</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Operation not yet started</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::ActiveState</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Operation started, not yet finished</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::CanceledState</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Operation is finished due to cancellation</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::FinishedState</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Operation successfully completed</td></tr>
</table></div>
<!-- @@@State -->
<!-- $$$StorageLocation$$$UserDataStorage$$$SystemStorage -->
<h3 class="flags" id="StorageLocation-enum"><a name="StorageLocation-enum"></a>enum QContactAbstractRequest::<span class="name">StorageLocation</span><br/>flags QContactAbstractRequest::<span class="name">StorageLocations</span></h3>
<p>Enumerates the different storage locations for a request.</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>QContactAbstractRequest::UserDataStorage</code></td><td class="topAlign tblval"><code>0x1</code></td><td class="topAlign">A storage location where user data is stored.</td></tr>
<tr><td class="topAlign"><code>QContactAbstractRequest::SystemStorage</code></td><td class="topAlign tblval"><code>0x2</code></td><td class="topAlign">A storage location where system files are stored.</td></tr>
</table></div>
<p>Depending on the backend implementation, the access rights for different storage locations might vary.</p>
<p>The StorageLocations type is a typedef for <a href="">QFlags</a><StorageLocation>. It stores an OR combination of StorageLocation values.</p>
<!-- @@@StorageLocation -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QContactAbstractRequest[overload1]$$$~QContactAbstractRequest -->
<h3 class="fn" id="dtor.QContactAbstractRequest"><a name="dtor.QContactAbstractRequest"></a>QContactAbstractRequest::<span class="name">~QContactAbstractRequest</span>()</h3>
<p>Cleans up the memory used by this request</p>
<!-- @@@~QContactAbstractRequest -->
<!-- $$$cancel[overload1]$$$cancel -->
<h3 class="fn" id="cancel"><a name="cancel"></a><code>[slot] </code><span class="type">bool</span> QContactAbstractRequest::<span class="name">cancel</span>()</h3>
<p>Attempts to cancel the request. Returns false if the request is not in the <code>QContactAbstractRequest::Active</code> state, or if the request is unable to be cancelled by the manager engine; otherwise returns true.</p>
<!-- @@@cancel -->
<!-- $$$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> QContactAbstractRequest::<span class="name">error</span>() const</h3>
<p>Returns the overall error of the most recent asynchronous operation</p>
<!-- @@@error -->
<!-- $$$isActive[overload1]$$$isActive -->
<h3 class="fn" id="isActive"><a name="isActive"></a><span class="type">bool</span> QContactAbstractRequest::<span class="name">isActive</span>() const</h3>
<p>Returns true if the request is in the <a href="qcontactabstractrequest.html#State-enum">QContactAbstractRequest::ActiveState</a> state; returns false otherwise.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#state">state</a>(), <a href="qcontactabstractrequest.html#isInactive">isInactive</a>(), <a href="qcontactabstractrequest.html#isCanceled">isCanceled</a>(), and <a href="qcontactabstractrequest.html#isFinished">isFinished</a>().</p>
<!-- @@@isActive -->
<!-- $$$isCanceled[overload1]$$$isCanceled -->
<h3 class="fn" id="isCanceled"><a name="isCanceled"></a><span class="type">bool</span> QContactAbstractRequest::<span class="name">isCanceled</span>() const</h3>
<p>Returns true if the request is in the <a href="qcontactabstractrequest.html#State-enum">QContactAbstractRequest::CanceledState</a>; returns false otherwise.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#state">state</a>(), <a href="qcontactabstractrequest.html#isActive">isActive</a>(), <a href="qcontactabstractrequest.html#isInactive">isInactive</a>(), and <a href="qcontactabstractrequest.html#isFinished">isFinished</a>().</p>
<!-- @@@isCanceled -->
<!-- $$$isFinished[overload1]$$$isFinished -->
<h3 class="fn" id="isFinished"><a name="isFinished"></a><span class="type">bool</span> QContactAbstractRequest::<span class="name">isFinished</span>() const</h3>
<p>Returns true if the request is in the <a href="qcontactabstractrequest.html#State-enum">QContactAbstractRequest::FinishedState</a>; returns false otherwise.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#state">state</a>(), <a href="qcontactabstractrequest.html#isActive">isActive</a>(), <a href="qcontactabstractrequest.html#isInactive">isInactive</a>(), and <a href="qcontactabstractrequest.html#isCanceled">isCanceled</a>().</p>
<!-- @@@isFinished -->
<!-- $$$isInactive[overload1]$$$isInactive -->
<h3 class="fn" id="isInactive"><a name="isInactive"></a><span class="type">bool</span> QContactAbstractRequest::<span class="name">isInactive</span>() const</h3>
<p>Returns true if the request is in the <a href="qcontactabstractrequest.html#State-enum">QContactAbstractRequest::InactiveState</a> state; returns false otherwise.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#state">state</a>(), <a href="qcontactabstractrequest.html#isActive">isActive</a>(), <a href="qcontactabstractrequest.html#isCanceled">isCanceled</a>(), and <a href="qcontactabstractrequest.html#isFinished">isFinished</a>().</p>
<!-- @@@isInactive -->
<!-- $$$manager[overload1]$$$manager -->
<h3 class="fn" id="manager"><a name="manager"></a><span class="type"><a href="qcontactmanager.html">QContactManager</a></span> *QContactAbstractRequest::<span class="name">manager</span>() const</h3>
<p>Returns a pointer to the manager of which this request instance requests operations</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#setManager">setManager</a>().</p>
<!-- @@@manager -->
<!-- $$$resultsAvailable[overload1]$$$resultsAvailable -->
<h3 class="fn" id="resultsAvailable"><a name="resultsAvailable"></a><code>[signal] </code><span class="type">void</span> QContactAbstractRequest::<span class="name">resultsAvailable</span>()</h3>
<p>This signal is emitted when new results are available. Results can include the operation error which may be accessed via <a href="qcontactabstractrequest.html#error">error</a>(), or derived-class-specific results which are accessible through the derived class API.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#error">error</a>().</p>
<!-- @@@resultsAvailable -->
<!-- $$$setManager[overload1]$$$setManagerQContactManager* -->
<h3 class="fn" id="setManager"><a name="setManager"></a><span class="type">void</span> QContactAbstractRequest::<span class="name">setManager</span>(<span class="type"><a href="qcontactmanager.html">QContactManager</a></span> *<i>manager</i>)</h3>
<p>Sets the manager of which this request instance requests operations to <i>manager</i></p>
<p>If the request is currently active, this function will return without updating the <i>manager</i> object.</p>
<p><b>See also </b><a href="qcontactabstractrequest.html#manager">manager</a>().</p>
<!-- @@@setManager -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn" id="start"><a name="start"></a><code>[slot] </code><span class="type">bool</span> QContactAbstractRequest::<span class="name">start</span>()</h3>
<p>Attempts to start the request. Returns false if the request is not in the <code>QContactAbstractRequest::Inactive</code>, <code>QContactAbstractRequest::Finished</code> or <code>QContactAbstractRequest::Cancelled</code> states, or if the request was unable to be performed by the manager engine; otherwise returns true.</p>
<!-- @@@start -->
<!-- $$$state[overload1]$$$state -->
<h3 class="fn" id="state"><a name="state"></a><span class="type"><a href="qcontactabstractrequest.html#State-enum">State</a></span> QContactAbstractRequest::<span class="name">state</span>() const</h3>
<p>Returns the current state of the request.</p>
<!-- @@@state -->
<!-- $$$stateChanged[overload1]$$$stateChangedQContactAbstractRequest::State -->
<h3 class="fn" id="stateChanged"><a name="stateChanged"></a><code>[signal] </code><span class="type">void</span> QContactAbstractRequest::<span class="name">stateChanged</span>(<span class="type"><a href="qcontactabstractrequest.html#State-enum">QContactAbstractRequest::State</a></span> <i>newState</i>)</h3>
<p>This signal is emitted when the state of the request is changed. The new state of the request will be contained in <i>newState</i>.</p>
<!-- @@@stateChanged -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn" id="type"><a name="type"></a><span class="type"><a href="qcontactabstractrequest.html#RequestType-enum">RequestType</a></span> QContactAbstractRequest::<span class="name">type</span>() const</h3>
<p>Returns the type of this asynchronous request</p>
<!-- @@@type -->
<!-- $$$waitForFinished[overload1]$$$waitForFinishedint -->
<h3 class="fn" id="waitForFinished"><a name="waitForFinished"></a><code>[slot] </code><span class="type">bool</span> QContactAbstractRequest::<span class="name">waitForFinished</span>(<span class="type">int</span> <i>msecs</i> = 0)</h3>
<p>Blocks until the request has been completed by the manager engine, or until <i>msecs</i> milliseconds has elapsed. If <i>msecs</i> is zero or negative, this function will block until the request is complete, regardless of how long it takes. Returns true if the request was cancelled or completed successfully within the given period, otherwise false. Some backends are unable to support this operation safely, and will return false immediately.</p>
<p>Note that any signals generated while waiting for the request to complete may be queued and delivered some time after this function has returned, when the calling thread's event loop is dispatched. If your code depends on your slots being invoked, you may need to process events after calling this function.</p>
<!-- @@@waitForFinished -->
</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>
|