diff options
| author | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
|---|---|---|
| committer | Manjeet Dahiya <manjeetdahiya@gmail.com> | 2010-08-21 19:15:30 +0000 |
| commit | 93adc6aec9ba4671884d9692308b239d3064e553 (patch) | |
| tree | a5906e560045c841577473a9118ef06a39950a73 /doc/html/classQXmppClient.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppClient.html')
| -rw-r--r-- | doc/html/classQXmppClient.html | 873 |
1 files changed, 873 insertions, 0 deletions
diff --git a/doc/html/classQXmppClient.html b/doc/html/classQXmppClient.html new file mode 100644 index 00000000..51fba53b --- /dev/null +++ b/doc/html/classQXmppClient.html @@ -0,0 +1,873 @@ +<!-- This comment will put IE 6, 7 and 8 in quirks mode --> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>QXmpp: QXmppClient Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javaScript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body onload='searchBox.OnSelectItem(0);'> +<!-- Generated by Doxygen 1.6.1 --> +<script type="text/javascript"><!-- +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +--></script> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <img id="MSearchSelect" src="search/search.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </div> + </li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>QXmppClient Class Reference<br/> +<small> +[<a class="el" href="group__Core.html">Core</a>]</small> +</h1><!-- doxytag: class="QXmppClient" --> +<p>The <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a> class is the main class for using QXmpp. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppClient_8h_source.html">QXmppClient.h</a>></code></p> + +<p><a href="classQXmppClient-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47a">Error</a> { <a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47aac48e9688ca9dce21676283ada1172863">SocketError</a>, +<a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47aa9b8aabc7956d082a04b4d0ed879564aa">KeepAliveError</a>, +<a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47aa29f30662c97dc09858f1d7e80eb1825a">XmppStreamError</a> + }</td></tr> +<tr><td colspan="2"><h2>Public Slots</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ae1c78c51b831a69ee0369ec66ce98d6f">sendPacket</a> (const QXmppPacket &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a44d230e24954da4a05e661318494fce4">sendMessage</a> (const QString &bareJid, const QString &message)</td></tr> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a46e84c5280564cdc2d60307309f97b92">connected</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ad0451ed72955dba436c7b97ad2c9ac82">disconnected</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a2bac100e40a909c860a3397643349937">error</a> (<a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47a">QXmppClient::Error</a>)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a175cae14ccfa293659d6514d92401d64">elementReceived</a> (const QDomElement &element, bool &handled)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a23ece134b6e4b6b37e7d4f2bd10425d4">messageReceived</a> (const <a class="el" href="classQXmppMessage.html">QXmppMessage</a> &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ad80d3cb7b9d53a69e0caa711e5558123">presenceReceived</a> (const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a5b1f500be64f6bd7e957fa9b80766e37">iqReceived</a> (const <a class="el" href="classQXmppIq.html">QXmppIq</a> &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39e3779864a9dabf939a69ab1d24c81f"></a><!-- doxytag: member="QXmppClient::discoveryIqReceived" ref="a39e3779864a9dabf939a69ab1d24c81f" args="(const QXmppDiscoveryIq &)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a39e3779864a9dabf939a69ab1d24c81f">discoveryIqReceived</a> (const QXmppDiscoveryIq &)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Notifies that an XMPP service discovery iq stanza is received. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2636ab4591d9b7ca3e03538893fcf29d"></a><!-- doxytag: member="QXmppClient::logMessage" ref="a2636ab4591d9b7ca3e03538893fcf29d" args="(QXmppLogger::MessageType type, const QString &msg)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a2636ab4591d9b7ca3e03538893fcf29d">logMessage</a> (<a class="el" href="classQXmppLogger.html#a932dbbd4f70a1e9c0ff8f452e61fc9b8">QXmppLogger::MessageType</a> type, const QString &msg)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is emitted to send logging messages. <br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a6ba469fd893d18ae14a709c5d040b623">QXmppClient</a> (QObject *parent=0)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ac3827e343aa04eefe030d9307b273f08">~QXmppClient</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a8221c7a98bf2c31cf7ddcf6541388cca">connectToServer</a> (const QString &host, const QString &user, const QString &passwd, const QString &domain, int port=5222, const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> &initialPresence=<a class="el" href="classQXmppPresence.html">QXmppPresence</a>())</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#aa8b3655f9bb2306e8f4877852e1e772b">connectToServer</a> (const QString &host, const QString &bareJid, const QString &passwd, int port=5222, const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> &initialPresence=<a class="el" href="classQXmppPresence.html">QXmppPresence</a>())</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#afebe3b0955b81c6dd0e738db328cf06b">connectToServer</a> (const <a class="el" href="classQXmppConfiguration.html">QXmppConfiguration</a> &, const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> &initialPresence=<a class="el" href="classQXmppPresence.html">QXmppPresence</a>())</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a685f42452acbba55f3b15669fa76282d">disconnectFromServer</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#adf54b0085d8a7fc81c05973973fa4a04">isConnected</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppPresence.html">QXmppPresence</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a2f7f555d11d5c45772d31d66834d7610">clientPresence</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ad47d8d9bd5e44dd2566ff0d726b1e71b">setClientPresence</a> (const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> &presence)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppConfiguration.html">QXmppConfiguration</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a1cd44e6c54b54be4bf50cf3559786476">configuration</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a449857024d10b08c017041b5f5ffe41b"></a><!-- doxytag: member="QXmppClient::logger" ref="a449857024d10b08c017041b5f5ffe41b" args="()" --> +<a class="el" href="classQXmppLogger.html">QXmppLogger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a449857024d10b08c017041b5f5ffe41b">logger</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classQXmppLogger.html" title="The QXmppLogger class represents a sink for logging messages.">QXmppLogger</a> associated with the current <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a>. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa799549089f2ecbe9796f53d0f7be6d2"></a><!-- doxytag: member="QXmppClient::setLogger" ref="aa799549089f2ecbe9796f53d0f7be6d2" args="(QXmppLogger *logger)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#aa799549089f2ecbe9796f53d0f7be6d2">setLogger</a> (<a class="el" href="classQXmppLogger.html">QXmppLogger</a> *logger)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="classQXmppLogger.html" title="The QXmppLogger class represents a sink for logging messages.">QXmppLogger</a> associated with the current <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a>. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QAbstractSocket::SocketError </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a2b044b37ce88a2f2e65833b3d6e57a9f">socketError</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QXmppStanza::Error::Condition </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#af3a18178f3349e668f09ee46ba7d48db">xmppStreamError</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppArchiveManager.html">QXmppArchiveManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a07e34258b8348c50e5304a246440bb7e">archiveManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppCallManager.html">QXmppCallManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#af208295658cf758592f5f1973a00b713">callManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppMucManager.html">QXmppMucManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a7c98ef26efed422be5e051d5f9fb611f">mucManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppRosterManager.html">QXmppRosterManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a6a0bb409bad66a4f5ea91056ee190ad4">rosterManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppTransferManager.html">QXmppTransferManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a0c6d81a05ce970ce72fd74afe31b9c95">transferManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppVCardManager.html">QXmppVCardManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ab0db5aa6c6727d606497d8e3e84a3bf4">vCardManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QXmppReconnectionManager * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#a90b0733ffa8b3d8a3922cb54bc6426cc">reconnectionManager</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppClient.html#ab1cdd29f5faeade87e097076125e6752">setReconnectionManager</a> (QXmppReconnectionManager *)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a> class is the main class for using QXmpp. </p> +<p>It provides the user all the required functionality to connect to the server and perform operations afterwards.</p> +<p>This class will provide the handle/reference to <a class="el" href="classQXmppRosterManager.html" title="The QXmppRosterManager class provides access to a connected client's roster.">QXmppRosterManager</a> (roster management), <a class="el" href="classQXmppVCardManager.html" title="The QXmppVCardManager gets/sets XMPP vCards. It is an implentation of XEP-0054: vcard-temp...">QXmppVCardManager</a> (vCard manager), QXmppReconnectionManager (reconnection mechanism) and <a class="el" href="classQXmppTransferManager.html" title="The QXmppTransferManager class provides support for sending and receiving files.">QXmppTransferManager</a> (file transfers).</p> +<p>By default, a reconnection mechanism exists, which makes sure of reconnecting to the server on disconnections due to an error. User can have a custom reconnection mechanism as well.</p> +<p>For removing QXmpp dependency in QtGui, use DEFINES += QXMPP_NO_GUI in the source.pro file and build as usual. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="a7c2851d07cc33119752abc6ec8ffc47a"></a><!-- doxytag: member="QXmppClient::Error" ref="a7c2851d07cc33119752abc6ec8ffc47a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47a">QXmppClient::Error</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>An enumeration for type of error. Error could come due a TCP socket or XML stream or due to various stanzas. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a7c2851d07cc33119752abc6ec8ffc47aac48e9688ca9dce21676283ada1172863"></a><!-- doxytag: member="SocketError" ref="a7c2851d07cc33119752abc6ec8ffc47aac48e9688ca9dce21676283ada1172863" args="" -->SocketError</em> </td><td> +<p>Error due to TCP socket. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a7c2851d07cc33119752abc6ec8ffc47aa9b8aabc7956d082a04b4d0ed879564aa"></a><!-- doxytag: member="KeepAliveError" ref="a7c2851d07cc33119752abc6ec8ffc47aa9b8aabc7956d082a04b4d0ed879564aa" args="" -->KeepAliveError</em> </td><td> +<p>Error due to no response to a keep alive. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a7c2851d07cc33119752abc6ec8ffc47aa29f30662c97dc09858f1d7e80eb1825a"></a><!-- doxytag: member="XmppStreamError" ref="a7c2851d07cc33119752abc6ec8ffc47aa29f30662c97dc09858f1d7e80eb1825a" args="" -->XmppStreamError</em> </td><td> +<p>Error due to XML stream. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a6ba469fd893d18ae14a709c5d040b623"></a><!-- doxytag: member="QXmppClient::QXmppClient" ref="a6ba469fd893d18ae14a709c5d040b623" args="(QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppClient::QXmppClient </td> + <td>(</td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Creates a <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a> object. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td>is passed to the QObject's constructor. The default value is 0. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ac3827e343aa04eefe030d9307b273f08"></a><!-- doxytag: member="QXmppClient::~QXmppClient" ref="ac3827e343aa04eefe030d9307b273f08" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppClient::~QXmppClient </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Destructor, destroys the <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a> object. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a07e34258b8348c50e5304a246440bb7e"></a><!-- doxytag: member="QXmppClient::archiveManager" ref="a07e34258b8348c50e5304a246440bb7e" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppArchiveManager.html">QXmppArchiveManager</a> & QXmppClient::archiveManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the reference to <a class="el" href="classQXmppArchiveManager.html" title="The QXmppArchiveManager class makes it possible to access message archives as defined...">QXmppArchiveManager</a>, implementation of XEP-0136. <a href="http://xmpp.org/extensions/xep-0136.html">http://xmpp.org/extensions/xep-0136.html</a> </p> + +</div> +</div> +<a class="anchor" id="af208295658cf758592f5f1973a00b713"></a><!-- doxytag: member="QXmppClient::callManager" ref="af208295658cf758592f5f1973a00b713" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppCallManager.html">QXmppCallManager</a> & QXmppClient::callManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the reference to <a class="el" href="classQXmppCallManager.html" title="The QXmppCallManager class provides support for making and receiving voice calls...">QXmppCallManager</a>, implementation of XEP-0166. <a href="http://xmpp.org/extensions/xep-0166.html">http://xmpp.org/extensions/xep-0166.html</a> </p> + +</div> +</div> +<a class="anchor" id="a2f7f555d11d5c45772d31d66834d7610"></a><!-- doxytag: member="QXmppClient::clientPresence" ref="a2f7f555d11d5c45772d31d66834d7610" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppPresence.html">QXmppPresence</a> QXmppClient::clientPresence </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the client's current presence. </p> + +</div> +</div> +<a class="anchor" id="a1cd44e6c54b54be4bf50cf3559786476"></a><!-- doxytag: member="QXmppClient::configuration" ref="a1cd44e6c54b54be4bf50cf3559786476" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppConfiguration.html">QXmppConfiguration</a> & QXmppClient::configuration </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns a modifiable reference to the current configuration of <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a>. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to the QXmppClient's configuration for the connection. </dd></dl> + +</div> +</div> +<a class="anchor" id="a46e84c5280564cdc2d60307309f97b92"></a><!-- doxytag: member="QXmppClient::connected" ref="a46e84c5280564cdc2d60307309f97b92" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::connected </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when the client connects successfully to the XMPP server i.e. when a successful XMPP connection is established. XMPP Connection involves following sequential steps:</p> +<ul> +<li>TCP socket connection</li> +<li>Client sends start stream</li> +<li>Server sends start stream</li> +<li>TLS negotiation (encryption)</li> +<li>Authentication</li> +<li>Resource binding</li> +<li>Session establishment</li> +</ul> +<p>After all these steps a successful XMPP connection is established and <a class="el" href="classQXmppClient.html#a46e84c5280564cdc2d60307309f97b92">connected()</a> signal is emitted.</p> +<p>After the <a class="el" href="classQXmppClient.html#a46e84c5280564cdc2d60307309f97b92">connected()</a> signal is emitted QXmpp will send the roster request to the server. On receiving the roster, QXmpp will emit <a class="el" href="classQXmppRosterManager.html#a978cf900248b0ef144460bb52052ded8">QXmppRosterManager::rosterReceived()</a>. After this signal, <a class="el" href="classQXmppRosterManager.html" title="The QXmppRosterManager class provides access to a connected client's roster.">QXmppRosterManager</a> object gets populated and you can use <a class="el" href="classQXmppClient.html#a6a0bb409bad66a4f5ea91056ee190ad4">rosterManager()</a> to get the handle of <a class="el" href="classQXmppRosterManager.html" title="The QXmppRosterManager class provides access to a connected client's roster.">QXmppRosterManager</a> object. </p> + +</div> +</div> +<a class="anchor" id="afebe3b0955b81c6dd0e738db328cf06b"></a><!-- doxytag: member="QXmppClient::connectToServer" ref="afebe3b0955b81c6dd0e738db328cf06b" args="(const QXmppConfiguration &, const QXmppPresence &initialPresence=QXmppPresence())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::connectToServer </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppConfiguration.html">QXmppConfiguration</a> & </td> + <td class="paramname"> <em>config</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> & </td> + <td class="paramname"> <em>initialPresence</em> = <code><a class="el" href="classQXmppPresence.html">QXmppPresence</a>()</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Attempts to connect to the XMPP server. Server details and other configurations are specified using the config parameter. Use signals <a class="el" href="classQXmppClient.html#a46e84c5280564cdc2d60307309f97b92">connected()</a>, <a class="el" href="classQXmppClient.html#a2bac100e40a909c860a3397643349937">error(QXmppClient::Error)</a> and <a class="el" href="classQXmppClient.html#ad0451ed72955dba436c7b97ad2c9ac82">disconnected()</a> to know the status of the connection. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>Specifies the configuration object for connecting the XMPP server. This contains the host name, user, passwd etc. See <a class="el" href="classQXmppConfiguration.html" title="The QXmppConfiguration class holds configuration options.">QXmppConfiguration</a> for details. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>initialPresence</em> </td><td>The initial presence which will be set for this user after establishing the session. The default value is QXmppPresence::Available </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="aa8b3655f9bb2306e8f4877852e1e772b"></a><!-- doxytag: member="QXmppClient::connectToServer" ref="aa8b3655f9bb2306e8f4877852e1e772b" args="(const QString &host, const QString &bareJid, const QString &passwd, int port=5222, const QXmppPresence &initialPresence=QXmppPresence())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::connectToServer </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>host</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>bareJid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>passwd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>port</em> = <code>5222</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> & </td> + <td class="paramname"> <em>initialPresence</em> = <code><a class="el" href="classQXmppPresence.html">QXmppPresence</a>()</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Overloaded function. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>host name of the XMPP server where connection has to be made (e.g. "jabber.org" and "talk.google.com"). It can also be an IP address in the form of a string (e.g. "192.168.1.25"). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bareJid</em> </td><td>BareJid of the account at the specified XMPP server. (e.g. "qxmpp.test1@gmail.com" or <a href="mailto:qxmpptest@jabber.org">qxmpptest@jabber.org</a>.) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>passwd</em> </td><td>Password for the specified username </td></tr> + <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>Port number at which the XMPP server is listening. The default value is 5222. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>initialPresence</em> </td><td>The initial presence which will be set for this user after establishing the session. The default value is QXmppPresence::Available </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a8221c7a98bf2c31cf7ddcf6541388cca"></a><!-- doxytag: member="QXmppClient::connectToServer" ref="a8221c7a98bf2c31cf7ddcf6541388cca" args="(const QString &host, const QString &user, const QString &passwd, const QString &domain, int port=5222, const QXmppPresence &initialPresence=QXmppPresence())" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::connectToServer </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>host</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>user</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>passwd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>domain</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>port</em> = <code>5222</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> & </td> + <td class="paramname"> <em>initialPresence</em> = <code><a class="el" href="classQXmppPresence.html">QXmppPresence</a>()</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Overloaded function. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>host name of the XMPP server where connection has to be made (e.g. "jabber.org" and "talk.google.com"). It can also be an IP address in the form of a string (e.g. "192.168.1.25"). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>Username of the account at the specified XMPP server. It should be the name without the domain name. E.g. "qxmpp.test1" and not "qxmpp.test1@gmail.com" </td></tr> + <tr><td valign="top"></td><td valign="top"><em>passwd</em> </td><td>Password for the specified username </td></tr> + <tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>Domain name e.g. "gmail.com" and "jabber.org". </td></tr> + <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>Port number at which the XMPP server is listening. The default value is 5222. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>initialPresence</em> </td><td>The initial presence which will be set for this user after establishing the session. The default value is QXmppPresence::Available </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ad0451ed72955dba436c7b97ad2c9ac82"></a><!-- doxytag: member="QXmppClient::disconnected" ref="ad0451ed72955dba436c7b97ad2c9ac82" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::disconnected </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when the XMPP connection disconnects. </p> + +</div> +</div> +<a class="anchor" id="a685f42452acbba55f3b15669fa76282d"></a><!-- doxytag: member="QXmppClient::disconnectFromServer" ref="a685f42452acbba55f3b15669fa76282d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::disconnectFromServer </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Disconnects the client and the current presence of client changes to QXmppPresence::Unavailable and status text changes to "Logged out".</p> +<dl class="note"><dt><b>Note:</b></dt><dd>Make sure that the clientPresence is changed to QXmppPresence::Available, if you are again calling <a class="el" href="classQXmppClient.html#a8221c7a98bf2c31cf7ddcf6541388cca">connectToServer()</a> after calling the <a class="el" href="classQXmppClient.html#a685f42452acbba55f3b15669fa76282d">disconnectFromServer()</a> function. </dd></dl> + +</div> +</div> +<a class="anchor" id="a175cae14ccfa293659d6514d92401d64"></a><!-- doxytag: member="QXmppClient::elementReceived" ref="a175cae14ccfa293659d6514d92401d64" args="(const QDomElement &element, bool &handled)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::elementReceived </td> + <td>(</td> + <td class="paramtype">const QDomElement & </td> + <td class="paramname"> <em>element</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool & </td> + <td class="paramname"> <em>handled</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when a raw XML element is received. You can connect to this signal if you want to handle raw XML elements yourself.</p> +<p>WARNING: this signal is experimental and you can seriously disrupt packet handling when using it, so use with care and at your own risk.</p> +<p>Set 'handled' to true if you handled the element yourself and you wish to bypass normal handling for the element. If you do this, QXmpp will do absolutely no processing itself, so do not expect the usual signals to be emitted. </p> + +</div> +</div> +<a class="anchor" id="a2bac100e40a909c860a3397643349937"></a><!-- doxytag: member="QXmppClient::error" ref="a2bac100e40a909c860a3397643349937" args="(QXmppClient::Error)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::error </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47a">QXmppClient::Error</a> </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>This signal is emitted when the XMPP connection encounters any error. The <a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47a">QXmppClient::Error</a> parameter specifies the type of error occurred. It could be due to TCP socket or the xml stream or the stanza. Depending upon the type of error occurred use the respective get function to know the error. </p> + +</div> +</div> +<a class="anchor" id="a5b1f500be64f6bd7e957fa9b80766e37"></a><!-- doxytag: member="QXmppClient::iqReceived" ref="a5b1f500be64f6bd7e957fa9b80766e37" args="(const QXmppIq &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::iqReceived </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppIq.html">QXmppIq</a> & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Notifies that an XMPP iq stanza is received. The <a class="el" href="classQXmppIq.html" title="The QXmppIq class is the base class for all IQs.">QXmppIq</a> parameter contains the details of the iq sent to this client. IQ stanzas provide a structured request-response mechanism. Roster management, setting-getting vCards etc is done using iq stanzas. </p> + +</div> +</div> +<a class="anchor" id="adf54b0085d8a7fc81c05973973fa4a04"></a><!-- doxytag: member="QXmppClient::isConnected" ref="adf54b0085d8a7fc81c05973973fa4a04" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppClient::isConnected </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns true if the client is connected to the XMPP server. </p> + +</div> +</div> +<a class="anchor" id="a23ece134b6e4b6b37e7d4f2bd10425d4"></a><!-- doxytag: member="QXmppClient::messageReceived" ref="a23ece134b6e4b6b37e7d4f2bd10425d4" args="(const QXmppMessage &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::messageReceived </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppMessage.html">QXmppMessage</a> & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Notifies that an XMPP message stanza is received. The <a class="el" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a> parameter contains the details of the message sent to this client. In other words whenever someone sends you a message this signal is emitted. </p> + +</div> +</div> +<a class="anchor" id="a7c98ef26efed422be5e051d5f9fb611f"></a><!-- doxytag: member="QXmppClient::mucManager" ref="a7c98ef26efed422be5e051d5f9fb611f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppMucManager.html">QXmppMucManager</a> & QXmppClient::mucManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the reference to <a class="el" href="classQXmppMucManager.html" title="The QXmppMucManager class makes it possible to interact with multi-user chat rooms...">QXmppMucManager</a>, implementation of XEP-0045. <a href="http://xmpp.org/extensions/xep-045.html">http://xmpp.org/extensions/xep-045.html</a> </p> + +</div> +</div> +<a class="anchor" id="ad80d3cb7b9d53a69e0caa711e5558123"></a><!-- doxytag: member="QXmppClient::presenceReceived" ref="ad80d3cb7b9d53a69e0caa711e5558123" args="(const QXmppPresence &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::presenceReceived </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Notifies that an XMPP presence stanza is received. The <a class="el" href="classQXmppPresence.html" title="The QXmppPresence class represents an XMPP presence stanza.">QXmppPresence</a> parameter contains the details of the presence sent to this client. This signal is emitted when someone login/logout or when someone's status changes Busy, Idle, Invisible etc. </p> + +</div> +</div> +<a class="anchor" id="a90b0733ffa8b3d8a3922cb54bc6426cc"></a><!-- doxytag: member="QXmppClient::reconnectionManager" ref="a90b0733ffa8b3d8a3922cb54bc6426cc" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppReconnectionManager * QXmppClient::reconnectionManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Function to get reconnection manager. By default there exists a reconnection manager. See QXmppReconnectionManager for more details of the reconnection mechanism.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to QXmppReconnectionManager </dd></dl> + +</div> +</div> +<a class="anchor" id="a6a0bb409bad66a4f5ea91056ee190ad4"></a><!-- doxytag: member="QXmppClient::rosterManager" ref="a6a0bb409bad66a4f5ea91056ee190ad4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppRosterManager.html">QXmppRosterManager</a> & QXmppClient::rosterManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the reference to <a class="el" href="classQXmppRosterManager.html" title="The QXmppRosterManager class provides access to a connected client's roster.">QXmppRosterManager</a> object of the client. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to the roster object of the connected client. Use this to get the list of friends in the roster and their presence information. </dd></dl> + +</div> +</div> +<a class="anchor" id="a44d230e24954da4a05e661318494fce4"></a><!-- doxytag: member="QXmppClient::sendMessage" ref="a44d230e24954da4a05e661318494fce4" args="(const QString &bareJid, const QString &message)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::sendMessage </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>bareJid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>message</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Utility function to send message to all the resources associated with the specified bareJid.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>bareJid</em> </td><td>bareJid of the receiving entity </td></tr> + <tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>Message string to be sent. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ae1c78c51b831a69ee0369ec66ce98d6f"></a><!-- doxytag: member="QXmppClient::sendPacket" ref="ae1c78c51b831a69ee0369ec66ce98d6f" args="(const QXmppPacket &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppClient::sendPacket </td> + <td>(</td> + <td class="paramtype">const QXmppPacket & </td> + <td class="paramname"> <em>packet</em></td> + <td> ) </td> + <td><code> [slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>After successfully connecting to the server use this function to send stanzas to the server. This function can solely be used to send various kind of stanzas to the server. QXmppPacket is a parent class of all the stanzas <a class="el" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a>, <a class="el" href="classQXmppPresence.html" title="The QXmppPresence class represents an XMPP presence stanza.">QXmppPresence</a>, <a class="el" href="classQXmppIq.html" title="The QXmppIq class is the base class for all IQs.">QXmppIq</a>, QXmppBind, <a class="el" href="classQXmppRosterIq.html" title="The QXmppRosterIq class represents a roster IQ.">QXmppRosterIq</a>, QXmppSession and <a class="el" href="classQXmppVCard.html" title="Represents the XMPP vCard.">QXmppVCard</a>.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>Returns true if the packet was sent, false otherwise.</dd></dl> +<p>Following code snippet illustrates how to send a message using this function: </p> +<div class="fragment"><pre class="fragment"> <a class="code" href="classQXmppMessage.html" title="The QXmppMessage class represents an XMPP message.">QXmppMessage</a> message(from, to, message); + client.sendPacket(message); +</pre></div><dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>A valid XMPP stanza. It can be an iq, a message or a presence stanza. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ad47d8d9bd5e44dd2566ff0d726b1e71b"></a><!-- doxytag: member="QXmppClient::setClientPresence" ref="ad47d8d9bd5e44dd2566ff0d726b1e71b" args="(const QXmppPresence &presence)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppClient::setClientPresence </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classQXmppPresence.html">QXmppPresence</a> & </td> + <td class="paramname"> <em>presence</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Changes the presence of the connected client.</p> +<p>The connection to the server will be updated accordingly:</p> +<ul> +<li>If the presence type is QXmppPresence::Unavailable, the connection to the server will be closed.</li> +</ul> +<ul> +<li>Otherwise, the connection to the server will be established as needed.</li> +</ul> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>presence</em> </td><td><a class="el" href="classQXmppPresence.html" title="The QXmppPresence class represents an XMPP presence stanza.">QXmppPresence</a> object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ab1cdd29f5faeade87e097076125e6752"></a><!-- doxytag: member="QXmppClient::setReconnectionManager" ref="ab1cdd29f5faeade87e097076125e6752" args="(QXmppReconnectionManager *)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppClient::setReconnectionManager </td> + <td>(</td> + <td class="paramtype">QXmppReconnectionManager * </td> + <td class="paramname"> <em>reconnectionManager</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the user defined reconnection manager.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if all the signal-slot connections are made correctly. </dd></dl> + +</div> +</div> +<a class="anchor" id="a2b044b37ce88a2f2e65833b3d6e57a9f"></a><!-- doxytag: member="QXmppClient::socketError" ref="a2b044b37ce88a2f2e65833b3d6e57a9f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QAbstractSocket::SocketError QXmppClient::socketError </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the socket error if <a class="el" href="classQXmppClient.html#a2bac100e40a909c860a3397643349937">error()</a> is <a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47aac48e9688ca9dce21676283ada1172863" title="Error due to TCP socket.">QXmppClient::SocketError</a>. </p> + +</div> +</div> +<a class="anchor" id="a0c6d81a05ce970ce72fd74afe31b9c95"></a><!-- doxytag: member="QXmppClient::transferManager" ref="a0c6d81a05ce970ce72fd74afe31b9c95" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppTransferManager.html">QXmppTransferManager</a> & QXmppClient::transferManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the reference to <a class="el" href="classQXmppTransferManager.html" title="The QXmppTransferManager class provides support for sending and receiving files.">QXmppTransferManager</a>, implementation of:</p> +<p>XEP-0047: In-Band Bytestreams XEP-0095: Stream Initiation XEP-0096: SI File Transfer </p> + +</div> +</div> +<a class="anchor" id="ab0db5aa6c6727d606497d8e3e84a3bf4"></a><!-- doxytag: member="QXmppClient::vCardManager" ref="ab0db5aa6c6727d606497d8e3e84a3bf4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppVCardManager.html">QXmppVCardManager</a> & QXmppClient::vCardManager </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the reference to <a class="el" href="classQXmppVCardManager.html" title="The QXmppVCardManager gets/sets XMPP vCards. It is an implentation of XEP-0054: vcard-temp...">QXmppVCardManager</a>, implimentation of XEP-0054. <a href="http://xmpp.org/extensions/xep-0054.html">http://xmpp.org/extensions/xep-0054.html</a> </p> + +</div> +</div> +<a class="anchor" id="af3a18178f3349e668f09ee46ba7d48db"></a><!-- doxytag: member="QXmppClient::xmppStreamError" ref="af3a18178f3349e668f09ee46ba7d48db" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppStanza::Error::Condition QXmppClient::xmppStreamError </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the XMPP stream error if <a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47a">QXmppClient::Error</a> is <a class="el" href="classQXmppClient.html#a7c2851d07cc33119752abc6ec8ffc47aa29f30662c97dc09858f1d7e80eb1825a" title="Error due to XML stream.">QXmppClient::XmppStreamError</a>. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppClient_8h_source.html">QXmppClient.h</a></li> +<li>QXmppClient.cpp</li> +</ul> +</div> +<!--- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 22 00:44:23 2010 for QXmpp by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |