Ignore:
Timestamp:
Feb 20, 2008, 3:44:44 PM (14 years ago)
Author:
Ralph Meijer <ralphm@…>
Branch:
default
Convert:
svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@41
Message:

Add support for receiving notifications for item retraction, node deletion and purging.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wokkel/iwokkel.py

    r10 r13  
    138138    def itemsReceived(recipient, service, nodeIdentifier, items):
    139139        """
    140         Called when items have been received from a node.
     140        Called when an items notification has been received for a node.
     141
     142        An item can be an element named C{item} or C{retract}. Respectively,
     143        they signal an item being published or retracted, optionally
     144        accompanied with an item identifier in the C{id} attribute.
    141145
    142146        @param recipient: The entity to which the notification was sent.
     
    148152        @param items: List of received items as domish elements.
    149153        @type items: C{list} of L{domish.Element}
     154        """
     155
     156    def deleteReceived(recipient, service, nodeIdentifier, items):
     157        """
     158        Called when a deletion notification has been received for a node.
     159
     160        @param recipient: The entity to which the notification was sent.
     161        @type recipient: L{jid.JID}
     162        @param service: The entity from which the notification was received.
     163        @type service: L{jid.JID}
     164        @param nodeIdentifier: Identifier of the node that has been deleted.
     165        @type nodeIdentifier: C{unicode}
     166        """
     167
     168    def purgeReceived(recipient, service, nodeIdentifier, items):
     169        """
     170        Called when a purge notification has been received for a node.
     171
     172        Upon receiving this notification all items associated should be
     173        considered retracted.
     174
     175        @param recipient: The entity to which the notification was sent.
     176        @type recipient: L{jid.JID}
     177        @param service: The entity from which the notification was received.
     178        @type service: L{jid.JID}
     179        @param nodeIdentifier: Identifier of the node that has been purged.
     180        @type nodeIdentifier: C{unicode}
    150181        """
    151182
Note: See TracChangeset for help on using the changeset viewer.