<?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" />
<!-- qcontactdetails.cpp -->
<title>Qt Mobility 1.2: QContactGlobalPresence 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>QContactGlobalPresence</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="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContactGlobalPresence Class Reference</h1>
<!-- $$$QContactGlobalPresence-brief -->
<p>The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend. <a href="#details">More...</a></p>
<!-- @@@QContactGlobalPresence -->
<pre class="cpp"> <span class="preprocessor">#include <QContactGlobalPresence></span></pre><p><b>Inherits: </b><a href="qcontactdetail.html">QContactDetail</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qcontactglobalpresence-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"> 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>
<ul>
<li class="fn">29 public functions inherited from <a href="qcontactdetail.html#public-functions">QContactDetail</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#DefinitionName-var">DefinitionName</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#FieldCustomMessage-var">FieldCustomMessage</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#FieldNickname-var">FieldNickname</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#FieldPresenceState-var">FieldPresenceState</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#FieldPresenceStateImageUrl-var">FieldPresenceStateImageUrl</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#FieldPresenceStateText-var">FieldPresenceStateText</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qcontactglobalpresence.html#FieldTimestamp-var">FieldTimestamp</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>
<a name="details"></a>
<!-- $$$QContactGlobalPresence-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend.</p>
<p>This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project.</p>
</div>
<!-- @@@QContactGlobalPresence -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$customMessage[overload1]$$$customMessage -->
<h3 class="fn"><a name="customMessage"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setCustomMessage">setCustomMessage</a>().</p>
<!-- @@@customMessage -->
<!-- $$$match[overload1]$$$matchQContactPresence::PresenceState -->
<h3 class="fn"><a name="match"></a><span class="type"><a href="qcontactfilter.html">QContactFilter</a></span> QContactGlobalPresence::<span class="name">match</span> ( <span class="type"><a href="qcontactpresence.html#PresenceState-enum">QContactPresence::PresenceState</a></span> <i>state</i> )<tt> [static]</tt></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"><a name="nickname"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setNickname">setNickname</a>().</p>
<!-- @@@nickname -->
<!-- $$$presenceState[overload1]$$$presenceState -->
<h3 class="fn"><a name="presenceState"></a><span class="type"><a href="qcontactpresence.html#PresenceState-enum">QContactPresence::PresenceState</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceState">setPresenceState</a>().</p>
<!-- @@@presenceState -->
<!-- $$$presenceStateImageUrl[overload1]$$$presenceStateImageUrl -->
<h3 class="fn"><a name="presenceStateImageUrl"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qurl.html">QUrl</a></span> QContactGlobalPresence::<span class="name">presenceStateImageUrl</span> () const</h3>
<p>Returns the last-known status image url of the contact.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceStateImageUrl">setPresenceStateImageUrl</a>().</p>
<!-- @@@presenceStateImageUrl -->
<!-- $$$presenceStateText[overload1]$$$presenceStateText -->
<h3 class="fn"><a name="presenceStateText"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QContactGlobalPresence::<span class="name">presenceStateText</span> () const</h3>
<p>Returns the text corresponding to the current presence state.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceStateText">setPresenceStateText</a>().</p>
<!-- @@@presenceStateText -->
<!-- $$$setCustomMessage[overload1]$$$setCustomMessageconstQString& -->
<h3 class="fn"><a name="setCustomMessage"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setCustomMessage</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#customMessage">customMessage</a>().</p>
<!-- @@@setCustomMessage -->
<!-- $$$setNickname[overload1]$$$setNicknameconstQString& -->
<h3 class="fn"><a name="setNickname"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setNickname</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#nickname">nickname</a>().</p>
<!-- @@@setNickname -->
<!-- $$$setPresenceState[overload1]$$$setPresenceStateQContactPresence::PresenceState -->
<h3 class="fn"><a name="setPresenceState"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setPresenceState</span> ( <span class="type"><a href="qcontactpresence.html#PresenceState-enum">QContactPresence::PresenceState</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#presenceState">presenceState</a>().</p>
<!-- @@@setPresenceState -->
<!-- $$$setPresenceStateImageUrl[overload1]$$$setPresenceStateImageUrlconstQUrl& -->
<h3 class="fn"><a name="setPresenceStateImageUrl"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setPresenceStateImageUrl</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qurl.html">QUrl</a></span> & <i>presenceStateImageUrl</i> )</h3>
<p>Sets the last-known status image url of the contact to <i>presenceStateImageUrl</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#presenceStateImageUrl">presenceStateImageUrl</a>().</p>
<!-- @@@setPresenceStateImageUrl -->
<!-- $$$setPresenceStateText[overload1]$$$setPresenceStateTextconstQString& -->
<h3 class="fn"><a name="setPresenceStateText"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setPresenceStateText</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#presenceStateText">presenceStateText</a>().</p>
<!-- @@@setPresenceStateText -->
<!-- $$$setTimestamp[overload1]$$$setTimestampconstQDateTime& -->
<h3 class="fn"><a name="setTimestamp"></a><span class="type">void</span> QContactGlobalPresence::<span class="name">setTimestamp</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></span> & <i>updateTimestamp</i> )</h3>
<p>Sets the update timestamp of the global presence detail to be <i>updateTimestamp</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#timestamp">timestamp</a>().</p>
<!-- @@@setTimestamp -->
<!-- $$$timestamp[overload1]$$$timestamp -->
<h3 class="fn"><a name="timestamp"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qdatetime.html">QDateTime</a></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>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setTimestamp">setTimestamp</a>().</p>
<!-- @@@timestamp -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$DefinitionName -->
<h3 class="fn"><a name="DefinitionName-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">DefinitionName</span></h3>
<p>The string constant for the definition name of <a href="qcontactglobalpresence.html">QContactGlobalPresence</a> details.</p>
<!-- @@@DefinitionName -->
<!-- $$$FieldCustomMessage -->
<h3 class="fn"><a name="FieldCustomMessage-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">FieldCustomMessage</span></h3>
<p>The field key constant for the user-entered custom presence message.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setCustomMessage">setCustomMessage</a>() and <a href="qcontactglobalpresence.html#customMessage">customMessage</a>().</p>
<!-- @@@FieldCustomMessage -->
<!-- $$$FieldNickname -->
<h3 class="fn"><a name="FieldNickname-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">FieldNickname</span></h3>
<p>The field key constant for the nickname value.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setNickname">setNickname</a>() and <a href="qcontactglobalpresence.html#nickname">nickname</a>().</p>
<!-- @@@FieldNickname -->
<!-- $$$FieldPresenceState -->
<h3 class="fn"><a name="FieldPresenceState-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">FieldPresenceState</span></h3>
<p>The field key constant for the presence state enumeration value.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceState">setPresenceState</a>() and <a href="qcontactglobalpresence.html#presenceState">presenceState</a>().</p>
<!-- @@@FieldPresenceState -->
<!-- $$$FieldPresenceStateImageUrl -->
<h3 class="fn"><a name="FieldPresenceStateImageUrl-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">FieldPresenceStateImageUrl</span></h3>
<p>The field key constant for the presence state image URL.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceStateImageUrl">setPresenceStateImageUrl</a>() and <a href="qcontactglobalpresence.html#presenceStateImageUrl">presenceStateImageUrl</a>().</p>
<!-- @@@FieldPresenceStateImageUrl -->
<!-- $$$FieldPresenceStateText -->
<h3 class="fn"><a name="FieldPresenceStateText-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">FieldPresenceStateText</span></h3>
<p>The field key constant for the presence state description value.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setPresenceStateText">setPresenceStateText</a>() and <a href="qcontactglobalpresence.html#presenceStateText">presenceStateText</a>().</p>
<!-- @@@FieldPresenceStateText -->
<!-- $$$FieldTimestamp -->
<h3 class="fn"><a name="FieldTimestamp-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QContactGlobalPresence::<span class="name">FieldTimestamp</span></h3>
<p>The field key constant for the timestamp value.</p>
<p><b>See also </b><a href="qcontactglobalpresence.html#setTimestamp">setTimestamp</a>() and <a href="qcontactglobalpresence.html#timestamp">timestamp</a>().</p>
<!-- @@@FieldTimestamp -->
</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
>
732
