Changeset 134:250a1041a437 for wokkel/iwokkel.py

Timestamp:

Aug 3, 2011, 8:48:50 PM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

wokkel-muc-client-support-24

Parents:

133:2ea562934152 (diff), 104:7de2ae0a6a88 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge in trunk changes.

Files:

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

wokkel/iwokkel.py

@@ -1 @@
-# Copyright (c) Ralph Meijer.
+# Copyright (c) 2003-2008 Ralph Meijer
 # See LICENSE for details.
 
@@ -770 +770 @@
 
 
-    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.
-        """
+
+class IMUCClient(Interface):
+    """
+    Multi-User Chat Client
+
+    A client interface to XEP-045 : http://xmpp.org/extensions/xep-0045.html
+
+    """
+
+    def receivedSubject(room, subject):
+        """
+        A subject is received when you join a room and when the subject is changed. This
+        method is triggered by one of those two events.
+
+        @param room: The room the subject was accepted for.
+        @type room: L{muc.Room}
+
+        @param subject: The subject of the given room.
+        @type subject: C{unicode}
+        """
+
+
+    def receivedHistory(room, user, message, history, frm=None):
+        """
+        Past messages from a chat room has been received. This occurs when you join a room.
+
+
+        """
+
+
+    def configure(room_jid, fields=[]):
+        """Configure a room. When a user has administration privledges they can configure 
+        a room. 
+
+        @param room_jid: A XMPP entity for the room.
+        @type room_jid: L{jid.JID}
+
+        @param fields: A list of fields to change or add to the room's configuration.
+        @type fields: C{list}
+
+        """
+
+    def getConfigureForm(room_jid):
+        """
+        In order to know the fields to change in a room you will need to get the form.
+        
+        @param room_jid: The room you want the configuration form from.
+        @type room_jid: L{jid.JID}
+
+        """
+
+    def join(server, room, nick):
+        """
+        Join a multi-user chat room. 
+
+        @param server: The server the room is on.
+        @type server: C{str}
+
+        @param room: The room name.
+        @type room: C{str}
+        
+        @param nick: The nick name you want when you join the room.
+        @type nick: C{str}
+
+        """
+
+
+    def leave(room_jid):
+        """
+        Leave a multi-user chat room.
+
+        @param room_jid: The room you want the configuration form from.
+        @type room_jid: L{jid.JID}
+
+        """
+
+    def userJoinedRoom(room, user):
+        """User has joined the room.
+
+        @param room: The room the user joined.
+        @type  room: L{muc.Room}
+
+        @param user: The user that joined the room.
+        @type  user: L{muc.User}
+
+        """
+   
+
+    def groupChat(to, message, children=None):
+        """Send a groupchat message to a room.
+
+        """
+
+
+    def chat(to, message, children=None):
+        """
+
+        """
+
+
+    def password(to, password):
+        """
+        """
+    
+    def register(to, fields=[]):
+        """
+        """
+
+
+    def subject(to, subject):
+        """
+        """
+
+    def voice(to):
+        """
+        """
+
+
+    def history(to, message_list):
+        """
+        """
+
+    def ban(to, ban_jid, frm, reason=None):
+        """
+        """
+
+
+    def kick(to, kick_jid, frm, reason=None):
+        """
+        """