Changeset 93:8f0856ddc616 for wokkel/iwokkel.py

Timestamp:

Feb 12, 2011, 10:58:46 PM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Add support for managing affiliations of Publish-Subscribe nodes, server-side.

File:

• wokkel/iwokkel.py (modified) (2 diffs)

wokkel/iwokkel.py

@@ -1 @@
-# Copyright (c) 2003-2008 Ralph Meijer
+# Copyright (c) 2003-2011 Ralph Meijer
 # See LICENSE for details.
 
@@ -768 +768 @@
         @rtype: L{defer.Deferred}
         """
+
+
+    def affiliationsGet(request):
+        """
+        Called when a affiliations retrieval request (owner) has been received.
+
+        @param request: The publish-subscribe request.
+        @type request: L{wokkel.pubsub.PubSubRequest}
+        @return: A deferred that fires with a C{dict} of affiliations with the
+            entity as key (L{JID}) and the affiliation state as value
+            (C{unicode}).  The affiliation can be C{u'owner'}, C{u'publisher'},
+            or C{u'outcast'}.
+        @rtype: L{defer.Deferred}
+
+        @note: Affiliations are always on the bare JID. An implementation of
+        this method MUST NOT return JIDs with a resource part.
+        """
+
+
+    def affiliationsSet(request):
+        """
+        Called when a affiliations modify request has been received.
+
+        @param request: The publish-subscribe request.
+        @type request: L{wokkel.pubsub.PubSubRequest}
+        @return: A deferred that fires with C{None} when the affiliation
+            changes were succesfully processed..
+        @rtype: L{defer.Deferred}
+
+        @note: Affiliations are always on the bare JID. The JIDs in
+        L{wokkel.pubsub.PubSubRequest.affiliations} are already stripped of
+        any resource.
+        """