<?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>Akonadi.AgentInstance</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>AgentInstance Class Reference</h1> <code>from PyKDE4.akonadi import *</code> <p> Namespace: <a href="../akonadi/Akonadi.html">Akonadi</a><br /> <h2>Detailed Description</h2> <p>A representation of an agent instance. </p> <p> The agent instance is a representation of a running agent process. It provides information about the instance and a reference to the AgentType of that instance. </p> <p> All available agent instances can be retrieved from the AgentManager. </p> <p> <pre class="fragment"> Akonadi.AgentInstance.List instances = Akonadi.AgentManager.self()->instances(); foreach ( const Akonadi.AgentInstance &instance, instances ) { qDebug() << "Name:" << instance.name() << "(" << instance.identifier() << ")"; } </pre> </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Tobias Koenig <tokoe@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="#Status">Status</a> </td><td class="memItemRight" valign="bottom">{ Idle, Running, Broken }</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="#AgentInstance">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AgentInstance">__init__</a> (self, <a href="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abortCurrentTask">abortCurrentTask</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#configure">configure</a> (self, QWidget parent=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#identifier">identifier</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isOnline">isOnline</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isValid">isValid</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="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#progress">progress</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reconfigure">reconfigure</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#restart">restart</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setIsOnline">setIsOnline</a> (self, bool online)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </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="../akonadi/Akonadi.AgentInstance.html#Status">Akonadi.AgentInstance.Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#status">status</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#statusMessage">statusMessage</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#synchronize">synchronize</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#synchronizeCollectionTree">synchronizeCollectionTree</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../akonadi/Akonadi.AgentType.html">Akonadi.AgentType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#type">type</a> (self)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="AgentInstance"></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>Creates a new agent instance object. </p></div></div><a class="anchor" name="AgentInstance"></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="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</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"><p>Creates an agent instance from an <b>other</b> agent instance. </p></div></div><a class="anchor" name="abortCurrentTask"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> abortCurrentTask</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>Tell the agent to abort its current operation. <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4 </dd></dl> </p></div></div><a class="anchor" name="configure"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> configure</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">QWidget </td> <td class="paramname"><em>parent=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Triggers the agent instance to show its configuration dialog. </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>parent</em> </td><td> Parent window for the configuration dialog. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="identifier"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString identifier</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 the unique identifier of the agent instance. </p></div></div><a class="anchor" name="isOnline"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isOnline</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 whether the agent instance is online currently. </p></div></div><a class="anchor" name="isValid"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isValid</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 whether the agent instance object is valid. </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>Returns the user visible name of the agent instance. </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="../akonadi/Akonadi.AgentInstance.html">Akonadi.AgentInstance</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"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p></div></div><a class="anchor" name="progress"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int progress</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 the progress of the agent instance in percent, or -1 if no progress information are available. </p></div></div><a class="anchor" name="reconfigure"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> reconfigure</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>Tell the agent that its configuration has been changed remotely via D-Bus </p></div></div><a class="anchor" name="restart"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> restart</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>Restart the agent process. </p></div></div><a class="anchor" name="setIsOnline"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setIsOnline</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>online</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Sets <b>online</b> status of the agent instance. </p></div></div><a class="anchor" name="setName"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> 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 user visible <b>name</b> of the agent instance. </p></div></div><a class="anchor" name="status"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.AgentInstance.html#Status">Akonadi.AgentInstance.Status</a> status</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 the status of the agent instance. </p></div></div><a class="anchor" name="statusMessage"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString statusMessage</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 textual presentation of the status of the agent instance. </p></div></div><a class="anchor" name="synchronize"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> synchronize</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>Triggers the agent instance to start synchronization. </p></div></div><a class="anchor" name="synchronizeCollectionTree"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> synchronizeCollectionTree</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>Triggers a synchronization of the collection tree by the given agent instance. </p></div></div><a class="anchor" name="type"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../akonadi/Akonadi.AgentType.html">Akonadi.AgentType</a> type</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 the agent type of this instance. </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Status"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Status</td> </tr> </table> </div> <div class="memdoc"><p>Describes the status of the agent instance. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Idle</em> = 0</td><td><tr><td valign="top"><em>Running</em> </td><td><tr><td valign="top"><em>Broken</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>