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/classQXmppConfiguration.html | |
| parent | ef6125a784d3b5205e92d01edf3c348cc4a473a4 (diff) | |
| download | qxmpp-93adc6aec9ba4671884d9692308b239d3064e553.tar.gz | |
add doc html
Diffstat (limited to 'doc/html/classQXmppConfiguration.html')
| -rw-r--r-- | doc/html/classQXmppConfiguration.html | 946 |
1 files changed, 946 insertions, 0 deletions
diff --git a/doc/html/classQXmppConfiguration.html b/doc/html/classQXmppConfiguration.html new file mode 100644 index 00000000..f99f94ae --- /dev/null +++ b/doc/html/classQXmppConfiguration.html @@ -0,0 +1,946 @@ +<!-- 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: QXmppConfiguration 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>QXmppConfiguration Class Reference</h1><!-- doxytag: class="QXmppConfiguration" --> +<p>The <a class="el" href="classQXmppConfiguration.html" title="The QXmppConfiguration class holds configuration options.">QXmppConfiguration</a> class holds configuration options. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="QXmppConfiguration_8h_source.html">QXmppConfiguration.h</a>></code></p> + +<p><a href="classQXmppConfiguration-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="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18">StreamSecurityMode</a> { <a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18aaf3bb1e91fd95070ad94a10371b32771">TLSEnabled</a> = 0, +<a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18a1af5a23c6977c4f7d639a8a8bfe3ec19">TLSDisabled</a>, +<a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18a3cb02f5970640730f94f516ae3924d47">TLSRequired</a> + }</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">NonSASLAuthMechanism</a> { <a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2a1edaa0616b19f8d6f7a711f37f672762">NonSASLPlain</a> = 0, +<a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2a97f33f490ab3d0bfdf717037551a62a3">NonSASLDigest</a> + }</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">SASLAuthMechanism</a> { <a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11a3a7552e191236404ed92c4208e119fc9">SASLPlain</a> = 0, +<a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11a84c03aaffee784130c781c74eca3c417">SASLDigestMD5</a>, +<a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11a124eafd393640edc3a4860dd711c8e74">SASLAnonymous</a> + }</td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd68380ad2353139a8c29087c40e4dcc"></a><!-- doxytag: member="QXmppConfiguration::QXmppConfiguration" ref="acd68380ad2353139a8c29087c40e4dcc" args="()" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#acd68380ad2353139a8c29087c40e4dcc">QXmppConfiguration</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classQXmppConfiguration.html" title="The QXmppConfiguration class holds configuration options.">QXmppConfiguration</a> object. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#ae507ac0321a6524f137cf092974110a5">~QXmppConfiguration</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a5109714e0bb5ad69f0e8dde063e54811">host</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a80250a8b1f040328fbb3f9e4d640867b">domain</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#aeca9614e66fb88a6967ebe6381e25fb7">port</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a50a49cee480278ddadbb6c6880a731cd">user</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#aba4bdb037e964e154223e729edaffe36">passwd</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#ad6969bdce483c31e1196ffb0cca800f3">resource</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a9733276982f4b55517e4ea739d7039a2">jid</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a00c6b1ca3a1008f214f0258f6736c9ba">jidBare</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a03cdbc1bdaee40204b55efe84f363c0a">autoAcceptSubscriptions</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a8b9aad6cb544bfc51529772d1ed7d0ab">autoReconnectionEnabled</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a60226ec21c25409f04b3f5971738e30b">useSASLAuthentication</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a5b23c1bfbf43052c1de403d423967418">ignoreSslErrors</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18">QXmppConfiguration::StreamSecurityMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#ad9154f1c774a12a74692b5c1d2576ad8">streamSecurityMode</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a4a2c891017fc79544a439ce6ce48fc71">nonSASLAuthMechanism</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#acf8e2a0bf51da53af72f1f689232082c">sASLAuthMechanism</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QNetworkProxy </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a8e70297c7ea0650cd6461d2fb623e483">networkProxy</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a0ba375a5272d8c43f44ac5347ea8570a">keepAliveInterval</a> () const </td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a6d47839bca9fbcebb1fe3ce2f5fce6fd">setKeepAliveInterval</a> (int secs)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a486b7e0f462d22645ce3a9af2f1bc760"></a><!-- doxytag: member="QXmppConfiguration::keepAliveTimeout" ref="a486b7e0f462d22645ce3a9af2f1bc760" args="() const " --> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a486b7e0f462d22645ce3a9af2f1bc760">keepAliveTimeout</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the keep alive timeout in seconds. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#acd5867aea24580d8aa0647750a420020">setKeepAliveTimeout</a> (int secs)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a97320e5239f46770edcd457301b41809">setHost</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a716050cec0aa3fc11e6f4fbfb1e6d4a1">setDomain</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#af6d5a5df2a2100302fef321298bb0d0b">setPort</a> (int)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a8cd27e7f2f584b6faa59a0f5cb1ee6b4">setUser</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a4d0d631bb97fb895c0b777c1b54650b6">setPasswd</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a1194a37607906daa26bbefae8e28a43f">setResource</a> (const QString &)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#ab3702f9b38d6e97338f27e2d94089ce4">setAutoAcceptSubscriptions</a> (bool)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#af1b4829231216e457803e46e784c25ba">setAutoReconnectionEnabled</a> (bool)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a4c9542ac86f8305e6cea4f2ad0366fb5">setUseSASLAuthentication</a> (bool)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#af6075135d8735c7c6b95d7538a2c7245">setIgnoreSslErrors</a> (bool)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a299a81b1f6187b3be2d8bdc063b1f732">setStreamSecurityMode</a> (<a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18">QXmppConfiguration::StreamSecurityMode</a> mode)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a9dfd3f8b383c5996ff4906e5d3d62807">setNonSASLAuthMechanism</a> (<a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a>)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a964dd39de84d326d8e60278db789ee85">setSASLAuthMechanism</a> (<a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a>)</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQXmppConfiguration.html#a57e5382b3283912576e2953742529cb5">setNetworkProxy</a> (const QNetworkProxy &proxy)</td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>The <a class="el" href="classQXmppConfiguration.html" title="The QXmppConfiguration class holds configuration options.">QXmppConfiguration</a> class holds configuration options. </p> +<p>It can be passed to <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a> to specify the options when connecting to an XMPP server.</p> +<p>It is a container of all the settings, configuration required for connecting to an XMPP server. E.g. server name, username, port, type of authentication mechanism, type of security used by stream (encryption), etc.. </p> +<hr/><h2>Member Enumeration Documentation</h2> +<a class="anchor" id="acdc5d816a74551209d5c50557e90fda2"></a><!-- doxytag: member="QXmppConfiguration::NonSASLAuthMechanism" ref="acdc5d816a74551209d5c50557e90fda2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>An enumeration for various Non-SASL authentication mechanisms available. The server may or may not allow QXmppConfiguration::Plain mechanism. So specifying the mechanism is just a hint to the library. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="acdc5d816a74551209d5c50557e90fda2a1edaa0616b19f8d6f7a711f37f672762"></a><!-- doxytag: member="NonSASLPlain" ref="acdc5d816a74551209d5c50557e90fda2a1edaa0616b19f8d6f7a711f37f672762" args="" -->NonSASLPlain</em> </td><td> +<p>Plain. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="acdc5d816a74551209d5c50557e90fda2a97f33f490ab3d0bfdf717037551a62a3"></a><!-- doxytag: member="NonSASLDigest" ref="acdc5d816a74551209d5c50557e90fda2a97f33f490ab3d0bfdf717037551a62a3" args="" -->NonSASLDigest</em> </td><td> +<p>Digest (default). </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="afae07ce22ff50481eaa0ebff91c21d11"></a><!-- doxytag: member="QXmppConfiguration::SASLAuthMechanism" ref="afae07ce22ff50481eaa0ebff91c21d11" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>An enumeration for various SASL authentication mechanisms available. The server may or may not allow any particular mechanism. So depending upon the availability of mechanisms on the server the library will choose a mechanism. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="afae07ce22ff50481eaa0ebff91c21d11a3a7552e191236404ed92c4208e119fc9"></a><!-- doxytag: member="SASLPlain" ref="afae07ce22ff50481eaa0ebff91c21d11a3a7552e191236404ed92c4208e119fc9" args="" -->SASLPlain</em> </td><td> +<p>Plain. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="afae07ce22ff50481eaa0ebff91c21d11a84c03aaffee784130c781c74eca3c417"></a><!-- doxytag: member="SASLDigestMD5" ref="afae07ce22ff50481eaa0ebff91c21d11a84c03aaffee784130c781c74eca3c417" args="" -->SASLDigestMD5</em> </td><td> +<p>Digest MD5 (default). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="afae07ce22ff50481eaa0ebff91c21d11a124eafd393640edc3a4860dd711c8e74"></a><!-- doxytag: member="SASLAnonymous" ref="afae07ce22ff50481eaa0ebff91c21d11a124eafd393640edc3a4860dd711c8e74" args="" -->SASLAnonymous</em> </td><td> +<p>Anonymous. </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<a class="anchor" id="a7c6e193a68beb792038c066cfc574a18"></a><!-- doxytag: member="QXmppConfiguration::StreamSecurityMode" ref="a7c6e193a68beb792038c066cfc574a18" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18">QXmppConfiguration::StreamSecurityMode</a></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>An enumeration for type of the Security Mode that is stream is encrypted or not. The server may or may not have TLS feature. Server may force the encryption. Depending upon all this user can specify following options. </p> +<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" id="a7c6e193a68beb792038c066cfc574a18aaf3bb1e91fd95070ad94a10371b32771"></a><!-- doxytag: member="TLSEnabled" ref="a7c6e193a68beb792038c066cfc574a18aaf3bb1e91fd95070ad94a10371b32771" args="" -->TLSEnabled</em> </td><td> +<p>Encryption is used if available (default). </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a7c6e193a68beb792038c066cfc574a18a1af5a23c6977c4f7d639a8a8bfe3ec19"></a><!-- doxytag: member="TLSDisabled" ref="a7c6e193a68beb792038c066cfc574a18a1af5a23c6977c4f7d639a8a8bfe3ec19" args="" -->TLSDisabled</em> </td><td> +<p>No encryption is server allows. </p> +</td></tr> +<tr><td valign="top"><em><a class="anchor" id="a7c6e193a68beb792038c066cfc574a18a3cb02f5970640730f94f516ae3924d47"></a><!-- doxytag: member="TLSRequired" ref="a7c6e193a68beb792038c066cfc574a18a3cb02f5970640730f94f516ae3924d47" args="" -->TLSRequired</em> </td><td> +<p>Encryption is a must otherwise connection would not be established </p> +</td></tr> +</table> +</dd> +</dl> + +</div> +</div> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="ae507ac0321a6524f137cf092974110a5"></a><!-- doxytag: member="QXmppConfiguration::~QXmppConfiguration" ref="ae507ac0321a6524f137cf092974110a5" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QXmppConfiguration::~QXmppConfiguration </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="classQXmppConfiguration.html" title="The QXmppConfiguration class holds configuration options.">QXmppConfiguration</a> object. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a03cdbc1bdaee40204b55efe84f363c0a"></a><!-- doxytag: member="QXmppConfiguration::autoAcceptSubscriptions" ref="a03cdbc1bdaee40204b55efe84f363c0a" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppConfiguration::autoAcceptSubscriptions </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the auto-accept-subscriptions-request configuration.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>boolean value true means that auto-accept-subscriptions-request is enabled else disabled for false </dd></dl> + +</div> +</div> +<a class="anchor" id="a8b9aad6cb544bfc51529772d1ed7d0ab"></a><!-- doxytag: member="QXmppConfiguration::autoReconnectionEnabled" ref="a8b9aad6cb544bfc51529772d1ed7d0ab" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppConfiguration::autoReconnectionEnabled </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the auto-reconnect-on-disconnection-on-error configuration.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>boolean value true means that auto-reconnect is enabled else disabled for false </dd></dl> + +</div> +</div> +<a class="anchor" id="a80250a8b1f040328fbb3f9e4d640867b"></a><!-- doxytag: member="QXmppConfiguration::domain" ref="a80250a8b1f040328fbb3f9e4d640867b" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::domain </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the domain name.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>domain name </dd></dl> + +</div> +</div> +<a class="anchor" id="a5109714e0bb5ad69f0e8dde063e54811"></a><!-- doxytag: member="QXmppConfiguration::host" ref="a5109714e0bb5ad69f0e8dde063e54811" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::host </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the host name.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>host name </dd></dl> + +</div> +</div> +<a class="anchor" id="a5b23c1bfbf43052c1de403d423967418"></a><!-- doxytag: member="QXmppConfiguration::ignoreSslErrors" ref="a5b23c1bfbf43052c1de403d423967418" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppConfiguration::ignoreSslErrors </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns whether SSL errors (such as certificate validation errors) are to be ignored when connecting to the XMPP server. </p> + +</div> +</div> +<a class="anchor" id="a9733276982f4b55517e4ea739d7039a2"></a><!-- doxytag: member="QXmppConfiguration::jid" ref="a9733276982f4b55517e4ea739d7039a2" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::jid </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the jabber id (jid).</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>jabber id (jid) (e.g. "qxmpp.test1@gmail.com/resource" or <a href="mailto:qxmpptest@jabber.org">qxmpptest@jabber.org</a>/QXmpp156) </dd></dl> + +</div> +</div> +<a class="anchor" id="a00c6b1ca3a1008f214f0258f6736c9ba"></a><!-- doxytag: member="QXmppConfiguration::jidBare" ref="a00c6b1ca3a1008f214f0258f6736c9ba" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::jidBare </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the bare jabber id (jid), without the resource identifier.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>bare jabber id (jid) (e.g. "qxmpp.test1@gmail.com" or <a href="mailto:qxmpptest@jabber.org">qxmpptest@jabber.org</a>) </dd></dl> + +</div> +</div> +<a class="anchor" id="a0ba375a5272d8c43f44ac5347ea8570a"></a><!-- doxytag: member="QXmppConfiguration::keepAliveInterval" ref="a0ba375a5272d8c43f44ac5347ea8570a" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int QXmppConfiguration::keepAliveInterval </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the keep alive interval in seconds.</p> +<p>The default value is 60 seconds. </p> + +</div> +</div> +<a class="anchor" id="a8e70297c7ea0650cd6461d2fb623e483"></a><!-- doxytag: member="QXmppConfiguration::networkProxy" ref="a8e70297c7ea0650cd6461d2fb623e483" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QNetworkProxy QXmppConfiguration::networkProxy </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the specified network proxy. The default value is QNetworkProxy::DefaultProxy that is the proxy is determined based on the application proxy set using QNetworkProxy::setApplicationProxy(). </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>QNetworkProxy </dd></dl> + +</div> +</div> +<a class="anchor" id="a4a2c891017fc79544a439ce6ce48fc71"></a><!-- doxytag: member="QXmppConfiguration::nonSASLAuthMechanism" ref="a4a2c891017fc79544a439ce6ce48fc71" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a> QXmppConfiguration::nonSASLAuthMechanism </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the Non-SASL authentication mechanism configuration.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="aba4bdb037e964e154223e729edaffe36"></a><!-- doxytag: member="QXmppConfiguration::passwd" ref="aba4bdb037e964e154223e729edaffe36" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::passwd </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the password.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>password </dd></dl> + +</div> +</div> +<a class="anchor" id="aeca9614e66fb88a6967ebe6381e25fb7"></a><!-- doxytag: member="QXmppConfiguration::port" ref="aeca9614e66fb88a6967ebe6381e25fb7" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int QXmppConfiguration::port </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the port number.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>port number </dd></dl> + +</div> +</div> +<a class="anchor" id="ad6969bdce483c31e1196ffb0cca800f3"></a><!-- doxytag: member="QXmppConfiguration::resource" ref="ad6969bdce483c31e1196ffb0cca800f3" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::resource </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the resource identifier.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>resource identifier </dd></dl> + +</div> +</div> +<a class="anchor" id="acf8e2a0bf51da53af72f1f689232082c"></a><!-- doxytag: member="QXmppConfiguration::sASLAuthMechanism" ref="acf8e2a0bf51da53af72f1f689232082c" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a> QXmppConfiguration::sASLAuthMechanism </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the SASL authentication mechanism configuration.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ab3702f9b38d6e97338f27e2d94089ce4"></a><!-- doxytag: member="QXmppConfiguration::setAutoAcceptSubscriptions" ref="ab3702f9b38d6e97338f27e2d94089ce4" args="(bool)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setAutoAcceptSubscriptions </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>value</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the auto-accept-subscriptions-request configuration.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>boolean value true means that auto-accept-subscriptions-request is enabled else disabled for false </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af1b4829231216e457803e46e784c25ba"></a><!-- doxytag: member="QXmppConfiguration::setAutoReconnectionEnabled" ref="af1b4829231216e457803e46e784c25ba" args="(bool)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setAutoReconnectionEnabled </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>value</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the auto-reconnect-on-disconnection-on-error configuration.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>boolean value true means that auto-reconnect is enabled else disabled for false </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a716050cec0aa3fc11e6f4fbfb1e6d4a1"></a><!-- doxytag: member="QXmppConfiguration::setDomain" ref="a716050cec0aa3fc11e6f4fbfb1e6d4a1" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setDomain </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>domain</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the domain name.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>domain</em> </td><td>Domain name e.g. "gmail.com" and "jabber.org". </td></tr> + </table> + </dd> +</dl> +<dl class="note"><dt><b>Note:</b></dt><dd>host name and domain name can be different for google domain name is gmail.com and host name is talk.google.com </dd></dl> + +</div> +</div> +<a class="anchor" id="a97320e5239f46770edcd457301b41809"></a><!-- doxytag: member="QXmppConfiguration::setHost" ref="a97320e5239f46770edcd457301b41809" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setHost </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>host</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the host name.</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> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af6075135d8735c7c6b95d7538a2c7245"></a><!-- doxytag: member="QXmppConfiguration::setIgnoreSslErrors" ref="af6075135d8735c7c6b95d7538a2c7245" args="(bool)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setIgnoreSslErrors </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>value</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Specifies whether SSL errors (such as certificate validation errors) are to be ignored when connecting to an XMPP server. </p> + +</div> +</div> +<a class="anchor" id="a6d47839bca9fbcebb1fe3ce2f5fce6fd"></a><!-- doxytag: member="QXmppConfiguration::setKeepAliveInterval" ref="a6d47839bca9fbcebb1fe3ce2f5fce6fd" args="(int secs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setKeepAliveInterval </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>secs</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Specifies the interval in seconds at which keep alive (ping) packets will be sent to the server.</p> +<p>If set to zero, no keep alive packets will be sent.</p> +<p>The default value is 60 seconds. </p> + +</div> +</div> +<a class="anchor" id="acd5867aea24580d8aa0647750a420020"></a><!-- doxytag: member="QXmppConfiguration::setKeepAliveTimeout" ref="acd5867aea24580d8aa0647750a420020" args="(int secs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setKeepAliveTimeout </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>secs</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Specifies the maximum time in seconds to wait for a keep alive response from the server before considering we are disconnected.</p> +<p>If set to zero or a value larger than the keep alive interval, no timeout will occur. </p> + +</div> +</div> +<a class="anchor" id="a57e5382b3283912576e2953742529cb5"></a><!-- doxytag: member="QXmppConfiguration::setNetworkProxy" ref="a57e5382b3283912576e2953742529cb5" args="(const QNetworkProxy &proxy)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setNetworkProxy </td> + <td>(</td> + <td class="paramtype">const QNetworkProxy & </td> + <td class="paramname"> <em>proxy</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Specifies the network proxy used for the connection made by <a class="el" href="classQXmppClient.html" title="The QXmppClient class is the main class for using QXmpp.">QXmppClient</a>. The default value is QNetworkProxy::DefaultProxy that is the proxy is determined based on the application proxy set using QNetworkProxy::setApplicationProxy(). </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>proxy</em> </td><td>QNetworkProxy </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a9dfd3f8b383c5996ff4906e5d3d62807"></a><!-- doxytag: member="QXmppConfiguration::setNonSASLAuthMechanism" ref="a9dfd3f8b383c5996ff4906e5d3d62807" args="(QXmppConfiguration::NonSASLAuthMechanism)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setNonSASLAuthMechanism </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a> </td> + <td class="paramname"> <em>mech</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Hints the library the Non-SASL authentication mechanism to be used for authentication.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mech</em> </td><td><a class="el" href="classQXmppConfiguration.html#acdc5d816a74551209d5c50557e90fda2">QXmppConfiguration::NonSASLAuthMechanism</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a4d0d631bb97fb895c0b777c1b54650b6"></a><!-- doxytag: member="QXmppConfiguration::setPasswd" ref="a4d0d631bb97fb895c0b777c1b54650b6" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setPasswd </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>passwd</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the password.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>passwd</em> </td><td>Password for the specified username </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af6d5a5df2a2100302fef321298bb0d0b"></a><!-- doxytag: member="QXmppConfiguration::setPort" ref="af6d5a5df2a2100302fef321298bb0d0b" args="(int)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setPort </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>port</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the port number.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <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> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a1194a37607906daa26bbefae8e28a43f"></a><!-- doxytag: member="QXmppConfiguration::setResource" ref="a1194a37607906daa26bbefae8e28a43f" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setResource </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>resource</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the resource identifier.</p> +<p>Multiple resources (e.g., devices or locations) may connect simultaneously to a server on behalf of each authorized client, with each resource differentiated by the resource identifier of an XMPP address (e.g. node/home vs. node/work)</p> +<p>The default value is "QXmpp".</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>resource</em> </td><td>Resource identifier of the client in connection. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a964dd39de84d326d8e60278db789ee85"></a><!-- doxytag: member="QXmppConfiguration::setSASLAuthMechanism" ref="a964dd39de84d326d8e60278db789ee85" args="(QXmppConfiguration::SASLAuthMechanism)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setSASLAuthMechanism </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a> </td> + <td class="paramname"> <em>mech</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Hints the library the SASL authentication mechanism to be used for authentication.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mech</em> </td><td><a class="el" href="classQXmppConfiguration.html#afae07ce22ff50481eaa0ebff91c21d11">QXmppConfiguration::SASLAuthMechanism</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a299a81b1f6187b3be2d8bdc063b1f732"></a><!-- doxytag: member="QXmppConfiguration::setStreamSecurityMode" ref="a299a81b1f6187b3be2d8bdc063b1f732" args="(QXmppConfiguration::StreamSecurityMode mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setStreamSecurityMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18">QXmppConfiguration::StreamSecurityMode</a> </td> + <td class="paramname"> <em>mode</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Specifies the specified security mode for the stream. The default value is <a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18aaf3bb1e91fd95070ad94a10371b32771" title="Encryption is used if available (default).">QXmppConfiguration::TLSEnabled</a>. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>StreamSecurityMode </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a8cd27e7f2f584b6faa59a0f5cb1ee6b4"></a><!-- doxytag: member="QXmppConfiguration::setUser" ref="a8cd27e7f2f584b6faa59a0f5cb1ee6b4" args="(const QString &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setUser </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>user</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Sets the username.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <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> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a4c9542ac86f8305e6cea4f2ad0366fb5"></a><!-- doxytag: member="QXmppConfiguration::setUseSASLAuthentication" ref="a4c9542ac86f8305e6cea4f2ad0366fb5" args="(bool)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void QXmppConfiguration::setUseSASLAuthentication </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>useSASL</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the type of authentication system specified by the user. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>useSASL</em> </td><td>to hint to use SASL authentication system if available. false will specify to use NonSASL XEP-0078: Non-SASL Authentication If the specified one is not availbe, library will use the othe one </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ad9154f1c774a12a74692b5c1d2576ad8"></a><!-- doxytag: member="QXmppConfiguration::streamSecurityMode" ref="ad9154f1c774a12a74692b5c1d2576ad8" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18">QXmppConfiguration::StreamSecurityMode</a> QXmppConfiguration::streamSecurityMode </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the specified security mode for the stream. The default value is <a class="el" href="classQXmppConfiguration.html#a7c6e193a68beb792038c066cfc574a18aaf3bb1e91fd95070ad94a10371b32771" title="Encryption is used if available (default).">QXmppConfiguration::TLSEnabled</a>. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>StreamSecurityMode </dd></dl> + +</div> +</div> +<a class="anchor" id="a50a49cee480278ddadbb6c6880a731cd"></a><!-- doxytag: member="QXmppConfiguration::user" ref="a50a49cee480278ddadbb6c6880a731cd" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString QXmppConfiguration::user </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the username.</p> +<dl class="return"><dt><b>Returns:</b></dt><dd>username </dd></dl> + +</div> +</div> +<a class="anchor" id="a60226ec21c25409f04b3f5971738e30b"></a><!-- doxytag: member="QXmppConfiguration::useSASLAuthentication" ref="a60226ec21c25409f04b3f5971738e30b" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool QXmppConfiguration::useSASLAuthentication </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> +<p>Returns the type of authentication system specified by the user. </p> +<dl class="return"><dt><b>Returns:</b></dt><dd>true if SASL was specified else false. If the specified system is not available QXmpp will resort to the other one. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="QXmppConfiguration_8h_source.html">QXmppConfiguration.h</a></li> +<li>QXmppConfiguration.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> |