<?xml version="1.0" encoding="UTF-8"?> <!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" lang="en" xml:lang="en"> <head> <title>KIO.AuthInfo</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.4 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>AuthInfo Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> Namespace: KIO.AuthInfo<br /> <h2>Detailed Description</h2> <p>This class is intended to make it easier to prompt for, cache and retrieve authorization information. </p> <p> When using this class to cache, retrieve or prompt authentication information, you only need to set the necessary attributes. For example, to check whether a password is already cached, the only required information is the URL of the resource and optionally whether or not a path match should be performed. Similarly, to prompt for password you only need to optionally set the prompt, username (if already supplied), comment and commentLabel fields. </p> <p> <em>SPECIAL NOTE:</em> If you extend this class to add additional parameters do not forget to overload the stream insertion and extraction operators ("<<" and ">>") so that the added data can be correctly serialzed. </p> <p> A two way messaging class for passing authentication information. <dl class="author" compact><dt><b>Author:</b></dt><dd> Dawit Alemayehu <adawit@kde.org> </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#FieldFlags">FieldFlags</a> </td><td class="memItemRight" valign="bottom">{ ExtraFieldNoFlags, ExtraFieldReadOnly, ExtraFieldMandatory }</td></tr> <tr><td colspan="2"><br><h2>Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varcaption">caption</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varcomment">comment</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varcommentLabel">commentLabel</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#vardigestInfo">digestInfo</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#varkeepPassword">keepPassword</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varpassword">password</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varprompt">prompt</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#varreadOnly">readOnly</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varrealmValue">realmValue</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varurl">url</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#varusername">username</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#varverifyPath">verifyPath</a></td></tr><tr><td colspan="2"><br><h2>Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AuthInfo">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AuthInfo">__init__</a> (self, <a href="../kio/KIO.AuthInfo.html">KIO.AuthInfo</a> info)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getExtraField">getExtraField</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fieldName)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.AuthInfo.html#FieldFlags">KIO.AuthInfo.FieldFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#getExtraFieldFlags">getExtraFieldFlags</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fieldName)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isModified">isModified</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#registerMetaTypes">registerMetaTypes</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setExtraField">setExtraField</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fieldName, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> value)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setExtraFieldFlags">setExtraFieldFlags</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fieldName, <a href="../kio/KIO.AuthInfo.html#FieldFlags">KIO.AuthInfo.FieldFlags</a> flags)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModified">setModified</a> (self, bool flag)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="AuthInfo"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Default constructor. </p></div></div><a class="anchor" name="AuthInfo"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.AuthInfo.html">KIO.AuthInfo</a> </td> <td class="paramname"><em>info</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Copy constructor. </p></div></div><a class="anchor" name="getExtraField"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> getExtraField</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>fieldName</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Get Extra Field Value Check QVariant.isValid() to find out if the field exists. <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="getExtraFieldFlags"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KIO.AuthInfo.html#FieldFlags">KIO.AuthInfo.FieldFlags</a> getExtraFieldFlags</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>fieldName</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Get Extra Field Flags <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="isModified"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isModified</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Use this method to check if the object was modified. <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the object has been modified </dd></dl> </p></div></div><a class="anchor" name="registerMetaTypes"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> registerMetaTypes</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Register the meta-types for AuthInfo. This is called from AuthInfo's constructor but needed by daemons on the DBus such as kpasswdserver. <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3 </dd></dl> </p></div></div><a class="anchor" name="setExtraField"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setExtraField</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>fieldName</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qvariant.html">QVariant</a> </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set Extra Field Value. Currently supported extra-fields: "domain" (QString), "anonymous" (bool) Setting it to an invalid QVariant() will disable the field. Extra Fields are disabled by default. <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="setExtraFieldFlags"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setExtraFieldFlags</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td> <td class="paramname"><em>fieldName</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../kio/KIO.AuthInfo.html#FieldFlags">KIO.AuthInfo.FieldFlags</a> </td> <td class="paramname"><em>flags</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set Extra Field Flags <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p></div></div><a class="anchor" name="setModified"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setModified</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>flag</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Use this method to indicate that this object has been modified. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>flag</em> </td><td> true to mark the object as modified, false to clear </td></tr> </table></dl> <p> </p></div></div><hr><h2>Attribute Documentation</h2><a class="anchor" name="varcaption"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varcomment"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> comment</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varcommentLabel"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> commentLabel</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="vardigestInfo"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> digestInfo</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varkeepPassword"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">bool keepPassword</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varpassword"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> password</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varprompt"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> prompt</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varreadOnly"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">bool readOnly</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varrealmValue"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> realmValue</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varurl"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> url</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varusername"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> username</td> </tr> </table> </div> <div class="memdoc"></div></div><p><a class="anchor" name="varverifyPath"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">bool verifyPath</td> </tr> </table> </div> <div class="memdoc"></div></div><p><hr><h2>Enumeration Documentation</h2><a class="anchor" name="FieldFlags"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">FieldFlags</td> </tr> </table> </div> <div class="memdoc"><p>Flags for extra fields <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1 </dd></dl> </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ExtraFieldNoFlags</em> = 0</td><td><tr><td valign="top"><em>ExtraFieldReadOnly</em> = 1<<1</td><td><tr><td valign="top"><em>ExtraFieldMandatory</em> = 1<<2</td><td></table> </dl> </div></div><p> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div></div> </body> </html>