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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TelepathyQt4: Tp::PendingContactAttributes Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1"> </td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a> ·
<a href="classes.html">
<font color="#004faf">All Classes</font></a> ·
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a> ·
<a href="modules.html">
<font color="#004faf">Modules</font></a> ·
<a href="functions.html">
<font color="#004faf">Functions</font></a> ·
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1PendingContactAttributes.html">PendingContactAttributes</a>
</div>
<div class="contents">
<h1>Tp::PendingContactAttributes Class Reference<br/>
<small>
[<a class="el" href="group__clientconn.html">Connection proxies</a>]</small>
</h1><!-- doxytag: class="Tp::PendingContactAttributes" --><!-- doxytag: inherits="Tp::PendingOperation" -->
<p>Class containing the parameters of and the reply to an asynchronous request for raw contact attributes, as used in the <a class="el" href="classTp_1_1Connection.html#a8e1f5c9531963e0ee38a8ed6915d0b05">Connection::contactAttributes()</a> low-level convenience method wrapping the Client::ConnectionInterfaceContactsInterface::GetContactAttributes() D-Bus method.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="pending-contact-attributes_8h_source.html">TelepathyQt4/PendingContactAttributes</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1PendingOperation.html">Tp::PendingOperation</a>.</p>
<p><a href="classTp_1_1PendingContactAttributes-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1PendingContactAttributes.html#a6955ad38883a04b599d12b269e4e4789">~PendingContactAttributes</a> ()
<li><a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> <a class="el" href="classTp_1_1PendingContactAttributes.html#a84508852a763e941cf714a21583e8f16">connection</a> () const
<li>const UIntList & <a class="el" href="classTp_1_1PendingContactAttributes.html#a53d775cd9fa163889ef4fc98e51cee11">contactsRequested</a> () const
<li>const QStringList & <a class="el" href="classTp_1_1PendingContactAttributes.html#a313df63e7b4773a4208c0fe3242a899e">interfacesRequested</a> () const
<li>bool <a class="el" href="classTp_1_1PendingContactAttributes.html#acf0d47bd44c1dfc70d72e4ea4af780ec">shouldReference</a> () const
<li><a class="el" href="classTp_1_1ReferencedHandles.html">ReferencedHandles</a> <a class="el" href="classTp_1_1PendingContactAttributes.html#a076602d693d8ecd8f166ff50713310ae">validHandles</a> () const
<li>UIntList <a class="el" href="classTp_1_1PendingContactAttributes.html#a0419dabebe76ec42b539c37b07d5562a">invalidHandles</a> () const
<li>ContactAttributesMap <a class="el" href="classTp_1_1PendingContactAttributes.html#af1970cbdb567bd860044f38cbf2d1d9d">attributes</a> () const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class containing the parameters of and the reply to an asynchronous request for raw contact attributes, as used in the <a class="el" href="classTp_1_1Connection.html#a8e1f5c9531963e0ee38a8ed6915d0b05">Connection::contactAttributes()</a> low-level convenience method wrapping the Client::ConnectionInterfaceContactsInterface::GetContactAttributes() D-Bus method. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6955ad38883a04b599d12b269e4e4789"></a><!-- doxytag: member="Tp::PendingContactAttributes::~PendingContactAttributes" ref="a6955ad38883a04b599d12b269e4e4789" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::PendingContactAttributes::~PendingContactAttributes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a84508852a763e941cf714a21583e8f16"></a><!-- doxytag: member="Tp::PendingContactAttributes::connection" ref="a84508852a763e941cf714a21583e8f16" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> Tp::PendingContactAttributes::connection </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> object through which the request was made.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="a53d775cd9fa163889ef4fc98e51cee11"></a><!-- doxytag: member="Tp::PendingContactAttributes::contactsRequested" ref="a53d775cd9fa163889ef4fc98e51cee11" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const UIntList & Tp::PendingContactAttributes::contactsRequested </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the contacts for which attributes were requested.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a list with the handles of the contacts. </dd></dl>
</div>
</div>
<a class="anchor" id="a313df63e7b4773a4208c0fe3242a899e"></a><!-- doxytag: member="Tp::PendingContactAttributes::interfacesRequested" ref="a313df63e7b4773a4208c0fe3242a899e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QStringList & Tp::PendingContactAttributes::interfacesRequested </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the interfaces the corresponding attributes of which were requested.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a list of D-Bus interface names. </dd></dl>
</div>
</div>
<a class="anchor" id="acf0d47bd44c1dfc70d72e4ea4af780ec"></a><!-- doxytag: member="Tp::PendingContactAttributes::shouldReference" ref="acf0d47bd44c1dfc70d72e4ea4af780ec" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::PendingContactAttributes::shouldReference </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether it was requested that the contact handles should be referenced in addition to fetching their attributes. This corresponds to the <code>reference</code> argument to <a class="el" href="classTp_1_1Connection.html#a8e1f5c9531963e0ee38a8ed6915d0b05">Connection::contactAttributes()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether the handles should be referenced or not. </dd></dl>
</div>
</div>
<a class="anchor" id="a076602d693d8ecd8f166ff50713310ae"></a><!-- doxytag: member="Tp::PendingContactAttributes::validHandles" ref="a076602d693d8ecd8f166ff50713310ae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1ReferencedHandles.html">ReferencedHandles</a> Tp::PendingContactAttributes::validHandles </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If referencing the handles was requested (as indicated by <a class="el" href="classTp_1_1PendingContactAttributes.html#acf0d47bd44c1dfc70d72e4ea4af780ec">shouldReference()</a>), returns the now-referenced handles resulting from the operation. If the operation has not (yet) finished successfully (<a class="el" href="classTp_1_1PendingOperation.html#adb775a9b977ebb85e1ee0473669f45b0">isFinished()</a> returns <code>false</code>), or referencing was not requested, the return value is undefined.</p>
<p>Even if referencing was requested, the list will not always contain all of the handles in <a class="el" href="classTp_1_1PendingContactAttributes.html#a53d775cd9fa163889ef4fc98e51cee11">contactsRequested()</a>, only the ones which were valid. The valid handles will be in the same order as in <a class="el" href="classTp_1_1PendingContactAttributes.html#a53d775cd9fa163889ef4fc98e51cee11">contactsRequested()</a>, though.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classTp_1_1ReferencedHandles.html" title="Helper container for safe management of handle lifetimes. Every handle in a ReferencedHandles...">ReferencedHandles</a> instance containing the handles. </dd></dl>
</div>
</div>
<a class="anchor" id="a0419dabebe76ec42b539c37b07d5562a"></a><!-- doxytag: member="Tp::PendingContactAttributes::invalidHandles" ref="a0419dabebe76ec42b539c37b07d5562a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UIntList Tp::PendingContactAttributes::invalidHandles </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the handles which were found to be invalid while processing the operation. If the operation has not (yet) finished successfully (<a class="el" href="classTp_1_1PendingOperation.html#adb775a9b977ebb85e1ee0473669f45b0">isFinished()</a> returns <code>false</code>), the return value is undefined.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list with the invalid handles. </dd></dl>
</div>
</div>
<a class="anchor" id="af1970cbdb567bd860044f38cbf2d1d9d"></a><!-- doxytag: member="Tp::PendingContactAttributes::attributes" ref="af1970cbdb567bd860044f38cbf2d1d9d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ContactAttributesMap Tp::PendingContactAttributes::attributes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a dictionary mapping the valid contact handles in <a class="el" href="classTp_1_1PendingContactAttributes.html#a53d775cd9fa163889ef4fc98e51cee11">contactsRequested()</a> (when also referencing, this means the contents of <a class="el" href="classTp_1_1PendingContactAttributes.html#a076602d693d8ecd8f166ff50713310ae">validHandles()</a>) to contact attributes. If the operation has not (yet) finished successfully (<a class="el" href="classTp_1_1PendingOperation.html#adb775a9b977ebb85e1ee0473669f45b0">isFinished()</a> returns <code>false</code>), the return value is undefined.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Mapping from handles to variant maps containing the attributes. </dd></dl>
</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>
|