<?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>KSambaShareData</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.9 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>KSambaShareData Class Reference</h1> <code>from PyKDE4.kio import *</code> <p> <h2>Detailed Description</h2> <p>This class represents a Samba user share. It is possible to share a directory with one or more different names, update the share details or remove. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Rodrigo Belem <rclbelem@gmail.com> </dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7 </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="#GuestPermission">GuestPermission</a> </td><td class="memItemRight" valign="bottom">{ GuestsNotAllowed, GuestsAllowed }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#UserShareError">UserShareError</a> </td><td class="memItemRight" valign="bottom">{ UserShareOk, UserShareExceedMaxShares, UserShareNameOk, UserShareNameInvalid, UserShareNameInUse, UserSharePathOk, UserSharePathInvalid, UserSharePathNotExists, UserSharePathNotDirectory, UserSharePathNotAbsolute, UserSharePathNotAllowed, UserShareAclOk, UserShareAclInvalid, UserShareAclUserNotValid, UserShareCommentOk, UserShareGuestsOk, UserShareGuestsInvalid, UserShareGuestsNotAllowed, UserShareSystemError }</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="#KSambaShareData">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KSambaShareData">__init__</a> (self, <a href="../kio/KSambaShareData.html">KSambaShareData</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#acl">acl</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#comment">comment</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#GuestPermission">KSambaShareData.GuestPermission</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#guestPermission">guestPermission</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#name">name</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator !=">operator !=</a> (self, <a href="../kio/KSambaShareData.html">KSambaShareData</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator ==">operator ==</a> (self, <a href="../kio/KSambaShareData.html">KSambaShareData</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#path">path</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#remove">remove</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#save">save</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAcl">setAcl</a> (self, QString acl)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setComment">setComment</a> (self, QString comment)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setGuestPermission">setGuestPermission</a> (self, <a href="../kio/KSambaShareData.html#GuestPermission">KSambaShareData.GuestPermission</a> permission=KSambaShareData.GuestsNotAllowed)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setName">setName</a> (self, QString name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPath">setPath</a> (self, QString path)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KSambaShareData"></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"></div></div><a class="anchor" name="KSambaShareData"></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/KSambaShareData.html">KSambaShareData</a> </td> <td class="paramname"><em>other</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="acl"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString acl</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>Returns a containing a string describing the permission added to the users, such as "[DOMAIN\]username1:X,[DOMAIN\]username2:X,...". X stands for "F" (full control), "R" (read-only) and "D" (deny). By dafault the acl is Everyone:R. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the share acl. </dd></dl> </p></div></div><a class="anchor" name="comment"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString comment</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the share comment. </dd></dl> </p></div></div><a class="anchor" name="guestPermission"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#GuestPermission">KSambaShareData.GuestPermission</a> guestPermission</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> whether guest access to the share is allowed or not. </dd></dl> </p></div></div><a class="anchor" name="name"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString name</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the share name. </dd></dl> </p></div></div><a class="anchor" name="operator !="></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator !=</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/KSambaShareData.html">KSambaShareData</a> </td> <td class="paramname"><em>other</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="operator =="></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator ==</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/KSambaShareData.html">KSambaShareData</a> </td> <td class="paramname"><em>other</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="path"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString path</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> the share path. </dd></dl> </p></div></div><a class="anchor" name="remove"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> remove</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>Unshare the folder held by the object. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareOk if the share was removed. </dd></dl> </p></div></div><a class="anchor" name="save"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> save</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>Share the folder with the information that has been set. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareOk if the share was added. </dd></dl> </p></div></div><a class="anchor" name="setAcl"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> setAcl</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">QString </td> <td class="paramname"><em>acl</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the acl to the share. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>acl</em> </td><td> the acl that will be given to the share. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareAclOk if the acl is valid. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareAclInvalid if the acl has invalid format. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareAclUserNotValid if one of the users in the acl is invalid. </dd></dl> </p></div></div><a class="anchor" name="setComment"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> setComment</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">QString </td> <td class="paramname"><em>comment</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the comment for the share. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>comment</em> </td><td> the comment that will be given to the share. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareCommentOk always. </dd></dl> </p></div></div><a class="anchor" name="setGuestPermission"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> setGuestPermission</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/KSambaShareData.html#GuestPermission">KSambaShareData.GuestPermission</a> </td> <td class="paramname"><em>permission=KSambaShareData.GuestsNotAllowed</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Flags if guest is allowed or not to access the share. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>permission</em> </td><td> the permission that will be given to the share. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareGuestsOk if the permission was set. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareGuestsNotAllowed if the system does not allow guest access to the shares. </dd></dl> </p></div></div><a class="anchor" name="setName"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> setName</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">QString </td> <td class="paramname"><em>name</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets the share name. If the share name is changed and valid it will remove the existing share and will create a new share. The share name cannot use a name of a system user or containing the forbidden characters '%, <, >, *, ?, |, /, \, +, =, ;, :, ",,. To check if the name is available or valid use the method KSambaShare.isShareNameAvailable(). </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>name</em> </td><td> the name that will be given to the share. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareNameOk if the name is valid. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareNameInvalid if the name contains invalid characters. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserShareNameInUse if the name is already in use by another shared folder or a by a system user. </dd></dl> </p></div></div><a class="anchor" name="setPath"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../kio/KSambaShareData.html#UserShareError">KSambaShareData.UserShareError</a> setPath</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">QString </td> <td class="paramname"><em>path</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the path for the share. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>path</em> </td><td> the path that will be given to the share. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserSharePathOk if valid. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserSharePathInvalid if the path is in invalid format. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserSharePathNotExists if the path does not exists. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserSharePathNotDirectory if the path points to file instead of a directory. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserSharePathNotAbsolute if the path is not is absolute form. </dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> UserSharePathNotAllowed if the path is not owner by the user. </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="GuestPermission"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">GuestPermission</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>GuestsNotAllowed</em> </td><td><tr><td valign="top"><em>GuestsAllowed</em> </td><td></table> </dl> </div></div><p><a class="anchor" name="UserShareError"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">UserShareError</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UserShareOk</em> </td><td><tr><td valign="top"><em>UserShareExceedMaxShares</em> </td><td><tr><td valign="top"><em>UserShareNameOk</em> </td><td><tr><td valign="top"><em>UserShareNameInvalid</em> </td><td><tr><td valign="top"><em>UserShareNameInUse</em> </td><td><tr><td valign="top"><em>UserSharePathOk</em> </td><td><tr><td valign="top"><em>UserSharePathInvalid</em> </td><td><tr><td valign="top"><em>UserSharePathNotExists</em> </td><td><tr><td valign="top"><em>UserSharePathNotDirectory</em> </td><td><tr><td valign="top"><em>UserSharePathNotAbsolute</em> </td><td><tr><td valign="top"><em>UserSharePathNotAllowed</em> </td><td><tr><td valign="top"><em>UserShareAclOk</em> </td><td><tr><td valign="top"><em>UserShareAclInvalid</em> </td><td><tr><td valign="top"><em>UserShareAclUserNotValid</em> </td><td><tr><td valign="top"><em>UserShareCommentOk</em> </td><td><tr><td valign="top"><em>UserShareGuestsOk</em> </td><td><tr><td valign="top"><em>UserShareGuestsInvalid</em> </td><td><tr><td valign="top"><em>UserShareGuestsNotAllowed</em> </td><td><tr><td valign="top"><em>UserShareSystemError</em> </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>