<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>pyxmpp.jabber.delay.Delay</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="pyxmpp-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://pyxmpp.jajcus.net/">PyXMPP</a></th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="pyxmpp-module.html">Package pyxmpp</a> :: <a href="pyxmpp.jabber-module.html">Package jabber</a> :: <a href="pyxmpp.jabber.delay-module.html">Module delay</a> :: Class Delay </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" onclick="toggle_private();">hide private</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Delay</h1><p class="nomargin-top"><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay">source code</a></span></p> <pre class="base-tree"> object --+ | <a href="pyxmpp.objects.StanzaPayloadObject-class.html">objects.StanzaPayloadObject</a> --+ | <strong class="uidshort">Delay</strong> </pre> <hr /> <p>Delayed delivery tag.</p> <p>Represents 'jabber:x:delay' (JEP-0091) element of a Jabber stanza.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyxmpp.jabber.delay.Delay-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">node_or_datetime</span>, <span class="summary-sig-arg">delay_from</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">reason</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">utc</span>=<span class="summary-sig-default">True</span>)</span><br /> Initialize the Delay object.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyxmpp.jabber.delay.Delay-class.html#from_xml" class="summary-sig-name">from_xml</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">xmlnode</span>)</span><br /> Initialize Delay object from an XML node.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.from_xml">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyxmpp.jabber.delay.Delay-class.html#complete_xml_element" class="summary-sig-name">complete_xml_element</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">xmlnode</span>, <span class="summary-sig-arg">_unused</span>)</span><br /> Complete the XML node with <code class="link">self</code> content.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.complete_xml_element">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code class="link">datetime.datetime</code></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyxmpp.jabber.delay.Delay-class.html#get_datetime_local" class="summary-sig-name">get_datetime_local</a>(<span class="summary-sig-arg">self</span>)</span><br /> Get the timestamp as a local time.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.get_datetime_local">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code class="link">datetime.datetime</code></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyxmpp.jabber.delay.Delay-class.html#get_datetime_utc" class="summary-sig-name">get_datetime_utc</a>(<span class="summary-sig-arg">self</span>)</span><br /> Get the timestamp as a UTC.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.get_datetime_utc">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyxmpp.jabber.delay.Delay-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> str(x)</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.__str__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="__cmp__"></a><span class="summary-sig-name">__cmp__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">other</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.__cmp__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxmpp.objects.StanzaPayloadObject-class.html">objects.StanzaPayloadObject</a></code></b>: <code><a href="pyxmpp.objects.StanzaPayloadObject-class.html#as_xml">as_xml</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__format__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__sizeof__</code>, <code>__subclasshook__</code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Class Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">: <code class="link">unicode</code></span> </td><td class="summary"> <a name="xml_element_name"></a><span class="summary-name">xml_element_name</span> = <code title="'x'"><code class="variable-quote">'</code><code class="variable-string">x</code><code class="variable-quote">'</code></code><br /> : name for the XML element provided by the class. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">: <code class="link">unicode</code></span> </td><td class="summary"> <a name="xml_element_namespace"></a><span class="summary-name">xml_element_namespace</span> = <code title="'jabber:x:delay'"><code class="variable-quote">'</code><code class="variable-string">jabber:x:delay</code><code class="variable-quote">'</code></code><br /> : namespace URI for the XML element provided by the class. </td> </tr> </table> <!-- ==================== INSTANCE VARIABLES ==================== --> <a name="section-InstanceVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Instance Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceVariables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="delay_from"></a><span class="summary-name">delay_from</span><br /> : the "from" value of the delay element </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="reason"></a><span class="summary-name">reason</span><br /> : the "reason" (content) of the delay element </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="timestamp"></a><span class="summary-name">timestamp</span><br /> : the UTC timestamp as naive datetime object </td> </tr> </table> <!-- ==================== PROPERTIES ==================== --> <a name="section-Properties"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Properties</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Properties" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__class__</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Method Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-MethodDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">node_or_datetime</span>, <span class="sig-arg">delay_from</span>=<span class="sig-default">None</span>, <span class="sig-arg">reason</span>=<span class="sig-default">None</span>, <span class="sig-arg">utc</span>=<span class="sig-default">True</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.__init__">source code</a></span> </td> </tr></table> Initialize the Delay object. <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>node_or_datetime</code></strong> (: <code class="link">libxml2.xmlNode</code> or <code class="link">datetime.datetime</code>) - : an XML node to parse or the timestamp.</li> <li><strong class="pname"><code>delay_from</code></strong> (: <a href="pyxmpp.jid.JID-class.html" class="link">pyxmpp.JID</a>) - : JID of the entity which adds the delay mark (when <code class="link">node_or_datetime</code> is a timestamp).</li> <li><strong class="pname"><code>reason</code></strong> (: <code class="link">unicode</code>) - : reason of the delay (when <code class="link">node_or_datetime</code> is a timestamp).</li> <li><strong class="pname"><code>utc</code></strong> (: <code class="link">bool</code>) - : if <code class="link">True</code> then the timestamp is assumed to be UTC, otherwise it is assumed to be local time.</li> </ul></dd> <dt>Overrides: object.__init__ </dt> </dl> </td></tr></table> </div> <a name="from_xml"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">from_xml</span>(<span class="sig-arg">self</span>, <span class="sig-arg">xmlnode</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.from_xml">source code</a></span> </td> </tr></table> Initialize Delay object from an XML node. <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>xmlnode</code></strong> (: <code class="link">libxml2.xmlNode</code>) - : the jabber:x:delay XML element.</li> </ul></dd> </dl> </td></tr></table> </div> <a name="complete_xml_element"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">complete_xml_element</span>(<span class="sig-arg">self</span>, <span class="sig-arg">xmlnode</span>, <span class="sig-arg">_unused</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.complete_xml_element">source code</a></span> </td> </tr></table> <p>Complete the XML node with <code class="link">self</code> content.</p> <p>Should be overriden in classes derived from <a href="pyxmpp.objects.StanzaPayloadObject-class.html" class="link">StanzaPayloadObject</a>.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>xmlnode</code></strong> (: <code class="link">libxml2.xmlNode</code>) - : XML node with the element being built. It has already right name and namespace, but no attributes or content.</li> <li><strong class="pname"><code>_unused</code></strong> (: <code class="link">libxml2.xmlDoc</code>) - : document to which the element belongs.</li> </ul></dd> <dt>Overrides: <a href="pyxmpp.objects.StanzaPayloadObject-class.html#complete_xml_element">objects.StanzaPayloadObject.complete_xml_element</a> </dt> </dl> </td></tr></table> </div> <a name="get_datetime_local"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">get_datetime_local</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.get_datetime_local">source code</a></span> </td> </tr></table> Get the timestamp as a local time. <dl class="fields"> <dt>Returns: <code class="link">datetime.datetime</code></dt> <dd>the timestamp of the delay element represented in the local timezone.</dd> </dl> </td></tr></table> </div> <a name="get_datetime_utc"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">get_datetime_utc</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.get_datetime_utc">source code</a></span> </td> </tr></table> Get the timestamp as a UTC. <dl class="fields"> <dt>Returns: <code class="link">datetime.datetime</code></dt> <dd>the timestamp of the delay element represented in UTC.</dd> </dl> </td></tr></table> </div> <a name="__str__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Informal representation operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxmpp.jabber.delay-pysrc.html#Delay.__str__">source code</a></span> </td> </tr></table> <p>str(x)</p> <dl class="fields"> <dt>Overrides: object.__str__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="pyxmpp-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://pyxmpp.jajcus.net/">PyXMPP</a></th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Sun May 8 13:35:01 2011 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>