Package pyxmpp :: Package jabber :: Module delay
[show private | hide private]
[frames | no frames]

Module pyxmpp.jabber.delay

Delayed delivery mark (jabber:x:delay) handling.

Normative reference:
  - `JEP 91 <http://www.jabber.org/jeps/jep-0091.html>`__

Classes
Delay Delayed delivery tag.

Function Summary
  get_delay(stanza)
Get the oldest jabber:x:delay elements from the stanza.
  get_delays(stanza)
Get jabber:x:delay elements from the stanza.

Variable Summary
str __revision__ = '$Id: delay.py 621 2006-01-01 19:23:56Z j...
str DELAY_NS = 'jabber:x:delay'

Imported modules:
datetime, libxml2, time
Imported classes:
JID, StanzaPayloadObject
Imported functions:
datetime_local_to_utc, datetime_utc_to_local, from_utf8, get_node_ns_uri, to_utf8
Function Details

get_delay(stanza)

Get the oldest jabber:x:delay elements from the stanza.

:Parameters:
    - `stanza`: a, probably delayed, stanza.
:Types:
    - `stanza`: `pyxmpp.stanza.Stanza`

The return value, if not `None`, contains a quite reliable
timestamp of a delayed (e.g. from offline storage) message.

:return: the oldest delay tag of the stanza or `None`.
:returntype: `Delay`

get_delays(stanza)

Get jabber:x:delay elements from the stanza.

:Parameters:
    - `stanza`: a, probably delayed, stanza.
:Types:
    - `stanza`: `pyxmpp.stanza.Stanza`

:return: list of delay tags sorted by the timestamp.
:returntype: `list` of `Delay`

Variable Details

__revision__

Type:
str
Value:
'$Id: delay.py 621 2006-01-01 19:23:56Z jajcus $'                      

DELAY_NS

Type:
str
Value:
'jabber:x:delay'                                                       

Generated by Epydoc 2.1 on Wed May 31 22:37:05 2006 http://epydoc.sf.net