/usr/share/qt5/doc/qtcontacts/qcontactglobalpresence.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcontactdetails.cpp -->
<title>QContactGlobalPresence 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 >QContactGlobalPresence</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="#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">QContactGlobalPresence Class</h1>
<!-- $$$QContactGlobalPresence-brief -->
<p>The <a href="qcontactglobalpresence.html">QContactGlobalPresence</a> class provides aggregated presence information for a contact, synthesized or supplied by the backend. <a href="#details">More...</a></p>
<!-- @@@QContactGlobalPresence -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QContactGlobalPresence></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qcontactdetail.html">QContactDetail</a></td></tr></table></div><ul>
<li><a href="qcontactglobalpresence-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="qcontactglobalpresence.html#GlobalPresenceField-enum">GlobalPresenceField</a></b> { FieldTimestamp, FieldNickname, FieldPresenceState, FieldPresenceStateText, FieldPresenceStateImageUrl, FieldCustomMessage }</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"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#customMessage">customMessage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#nickname">nickname</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactPresence::PresenceState </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#presenceState">presenceState</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#presenceStateImageUrl">presenceStateImageUrl</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#presenceStateText">presenceStateText</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#setCustomMessage">setCustomMessage</a></b>(const QString &<i>customMessage</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#setNickname">setNickname</a></b>(const QString &<i>nickname</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#setPresenceState">setPresenceState</a></b>(QContactPresence::PresenceState <i>presenceState</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#setPresenceStateImageUrl">setPresenceStateImageUrl</a></b>(const QUrl &<i>presenceStateImageUrl</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#setPresenceStateText">setPresenceStateText</a></b>(const QString &<i>presenceStateText</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#setTimestamp">setTimestamp</a></b>(const QDateTime &<i>updateTimestamp</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDateTime </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#timestamp">timestamp</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">22 public functions inherited from <a href="qcontactdetail.html#public-functions">QContactDetail</a></li>
</ul>
<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 DetailType </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#Type-var">Type</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QContactFilter </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#match">match</a></b>(QContactPresence::PresenceState <i>state</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QContactGlobalPresence-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcontactglobalpresence.html">QContactGlobalPresence</a> class provides aggregated presence information for a contact, synthesized or supplied by the backend.</p>
</div>
<!-- @@@QContactGlobalPresence -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$GlobalPresenceField$$$FieldTimestamp$$$FieldNickname$$$FieldPresenceState$$$FieldPresenceStateText$$$FieldPresenceStateImageUrl$$$FieldCustomMessage -->
<h3 class="fn" id="GlobalPresenceField-enum"><a name="GlobalPresenceField-enum"></a>enum QContactGlobalPresence::<span class="name">GlobalPresenceField</span></h3>
<p>This enumeration defines the fields supported by <a href="qcontactglobalpresence.html">QContactGlobalPresence</a>.</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>QContactGlobalPresence::FieldTimestamp</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The value stored in this field contains the timestamp value.</td></tr>
<tr><td class="topAlign"><code>QContactGlobalPresence::FieldNickname</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The value stored in this field contains the nickname value.</td></tr>
<tr><td class="topAlign"><code>QContactGlobalPresence::FieldPresenceState</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The value stored in this field contains the presence state enumeration value.</td></tr>
<tr><td class="topAlign"><code>QContactGlobalPresence::FieldPresenceStateText</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The value stored in this field contains the presence state description value.</td></tr>
<tr><td class="topAlign"><code>QContactGlobalPresence::FieldPresenceStateImageUrl</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The value stored in this field contains the presence state image URL.</td></tr>
<tr><td class="topAlign"><code>QContactGlobalPresence::FieldCustomMessage</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">The value stored in this field contains the user-entered custom presence message.</td></tr>
</table></div>
<p><b>See also </b><a href="qcontactglobalpresence.html#setTimestamp">setTimestamp</a>(), <a href="qcontactglobalpresence.html#timestamp">timestamp</a>(), <a href="qcontactglobalpresence.html#setNickname">setNickname</a>(), <a href="qcontactglobalpresence.html#nickname">nickname</a>(), <a href="qcontactglobalpresence.html#setPresenceState">setPresenceState</a>(), <a href="qcontactglobalpresence.html#presenceState">presenceState</a>(), <a href="qcontactglobalpresence.html#setPresenceStateText">setPresenceStateText</a>(), <a href="qcontactglobalpresence.html#presenceStateText">presenceStateText</a>(), <a href="qcontactglobalpresence.html#setPresenceStateImageUrl">setPresenceStateImageUrl</a>(), <a href="qcontactglobalpresence.html#presenceStateImageUrl">presenceStateImageUrl</a>(), <a href="qcontactglobalpresence.html#setCustomMessage">setCustomMessage</a>(), and <a href="qcontactglobalpresence.html#customMessage">customMessage</a>().</p>
<!-- @@@GlobalPresenceField -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$customMessage[overload1]$$$customMessage -->
<h3 class="fn" id="customMessage"><a name="customMessage"></a><span class="type">QString</span> QContactGlobalPresence::<span class="name">customMessage</span>() const</h3>
<p>Returns the custom status message from the contact for the aggregate presence detail.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setCustomMessage">setCustomMessage</a>().</p>
<!-- @@@customMessage -->
<!-- $$$match[overload1]$$$matchQContactPresence::PresenceState -->
<h3 class="fn" id="match"><a name="match"></a><code>[static] </code><span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> QContactGlobalPresence::<span class="name">match</span>(<span class="type">QContactPresence::PresenceState</span> <i>state</i>)</h3>
<p>Returns a filter which matches any contact whose global presence state is listed as <i>state</i>.</p>
<!-- @@@match -->
<!-- $$$nickname[overload1]$$$nickname -->
<h3 class="fn" id="nickname"><a name="nickname"></a><span class="type">QString</span> QContactGlobalPresence::<span class="name">nickname</span>() const</h3>
<p>Returns the last-known nickname used by the contact during communications via any online account about which this detail aggregates presence information.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setNickname">setNickname</a>().</p>
<!-- @@@nickname -->
<!-- $$$presenceState[overload1]$$$presenceState -->
<h3 class="fn" id="presenceState"><a name="presenceState"></a><span class="type">QContactPresence::PresenceState</span> QContactGlobalPresence::<span class="name">presenceState</span>() const</h3>
<p>Returns the aggregate presence state of any online accounts about which this detail aggregates presence information.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceState">setPresenceState</a>().</p>
<!-- @@@presenceState -->
<!-- $$$presenceStateImageUrl[overload1]$$$presenceStateImageUrl -->
<h3 class="fn" id="presenceStateImageUrl"><a name="presenceStateImageUrl"></a><span class="type">QUrl</span> QContactGlobalPresence::<span class="name">presenceStateImageUrl</span>() const</h3>
<p>Returns the last-known status image url of the contact.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceStateImageUrl">setPresenceStateImageUrl</a>().</p>
<!-- @@@presenceStateImageUrl -->
<!-- $$$presenceStateText[overload1]$$$presenceStateText -->
<h3 class="fn" id="presenceStateText"><a name="presenceStateText"></a><span class="type">QString</span> QContactGlobalPresence::<span class="name">presenceStateText</span>() const</h3>
<p>Returns the text corresponding to the current presence state.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceStateText">setPresenceStateText</a>().</p>
<!-- @@@presenceStateText -->
<!-- $$$setCustomMessage[overload1]$$$setCustomMessageconstQString& -->
<h3 class="fn" id="setCustomMessage"><a name="setCustomMessage"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setCustomMessage</span>(const <span class="type">QString</span> &<i>customMessage</i>)</h3>
<p>Sets the custom status message from the contact for the aggregate presence detail, to <i>customMessage</i>.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#customMessage">customMessage</a>().</p>
<!-- @@@setCustomMessage -->
<!-- $$$setNickname[overload1]$$$setNicknameconstQString& -->
<h3 class="fn" id="setNickname"><a name="setNickname"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setNickname</span>(const <span class="type">QString</span> &<i>nickname</i>)</h3>
<p>Sets the last-known nickname used by the contact during communications via any online account about which this detail aggregates presence information to <i>nickname</i>.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#nickname">nickname</a>().</p>
<!-- @@@setNickname -->
<!-- $$$setPresenceState[overload1]$$$setPresenceStateQContactPresence::PresenceState -->
<h3 class="fn" id="setPresenceState"><a name="setPresenceState"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setPresenceState</span>(<span class="type">QContactPresence::PresenceState</span> <i>presenceState</i>)</h3>
<p>Sets the presence state of this aggregate detail according to the presence information available from the presence providers which this detail aggregates to the given <i>presenceState</i>.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#presenceState">presenceState</a>().</p>
<!-- @@@setPresenceState -->
<!-- $$$setPresenceStateImageUrl[overload1]$$$setPresenceStateImageUrlconstQUrl& -->
<h3 class="fn" id="setPresenceStateImageUrl"><a name="setPresenceStateImageUrl"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setPresenceStateImageUrl</span>(const <span class="type">QUrl</span> &<i>presenceStateImageUrl</i>)</h3>
<p>Sets the last-known status image url of the contact to <i>presenceStateImageUrl</i>.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#presenceStateImageUrl">presenceStateImageUrl</a>().</p>
<!-- @@@setPresenceStateImageUrl -->
<!-- $$$setPresenceStateText[overload1]$$$setPresenceStateTextconstQString& -->
<h3 class="fn" id="setPresenceStateText"><a name="setPresenceStateText"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setPresenceStateText</span>(const <span class="type">QString</span> &<i>presenceStateText</i>)</h3>
<p>Sets the text corresponding to the presence state to <i>presenceStateText</i>. This function is generally called by presence providers to allow custom naming of states, or to allow finer grained state reporting than is provided by the presence state API.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#presenceStateText">presenceStateText</a>().</p>
<!-- @@@setPresenceStateText -->
<!-- $$$setTimestamp[overload1]$$$setTimestampconstQDateTime& -->
<h3 class="fn" id="setTimestamp"><a name="setTimestamp"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setTimestamp</span>(const <span class="type">QDateTime</span> &<i>updateTimestamp</i>)</h3>
<p>Sets the update timestamp of the global presence detail to be <i>updateTimestamp</i>.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#timestamp">timestamp</a>().</p>
<!-- @@@setTimestamp -->
<!-- $$$timestamp[overload1]$$$timestamp -->
<h3 class="fn" id="timestamp"><a name="timestamp"></a><span class="type">QDateTime</span> QContactGlobalPresence::<span class="name">timestamp</span>() const</h3>
<p>Returns the timestamp at which the data in the global presence detail was valid.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setTimestamp">setTimestamp</a>().</p>
<!-- @@@timestamp -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$Type -->
<h3 class="fn" id="Type-var"><a name="Type-var"></a>const <span class="type"><a href="qcontactdetail.html#DetailType-enum">DetailType</a></span> QContactGlobalPresence::<span class="name">Type</span></h3>
<p>The enum constant for the type identifier of <a href="qcontactglobalpresence.html">QContactGlobalPresence</a> details.</p>
<!-- @@@Type -->
</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>
|