Ignore:
Location:
wokkel
Files:
2 added
1 edited

Legend:

Unmodified
Added
Removed
  • wokkel/iwokkel.py

    r59 r130  
    768768        @rtype: L{defer.Deferred}
    769769        """
     770
     771
     772
     773class IMUCClient(Interface):
     774    """
     775    Multi-User Chat Client
     776
     777    A client interface to XEP-045 : http://xmpp.org/extensions/xep-0045.html
     778
     779    """
     780
     781    def receivedSubject(room, subject):
     782        """
     783        A subject is received when you join a room and when the subject is changed. This
     784        method is triggered by one of those two events.
     785
     786        @param room: The room the subject was accepted for.
     787        @type room: L{muc.Room}
     788
     789        @param subject: The subject of the given room.
     790        @type subject: C{unicode}
     791        """
     792
     793
     794    def receivedHistory(room, user, message, history, frm=None):
     795        """
     796        Past messages from a chat room has been received. This occurs when you join a room.
     797
     798
     799        """
     800
     801
     802    def configure(room_jid, fields=[]):
     803        """Configure a room. When a user has administration privledges they can configure
     804        a room.
     805
     806        @param room_jid: A XMPP entity for the room.
     807        @type room_jid: L{jid.JID}
     808
     809        @param fields: A list of fields to change or add to the room's configuration.
     810        @type fields: C{list}
     811
     812        """
     813
     814    def getConfigureForm(room_jid):
     815        """
     816        In order to know the fields to change in a room you will need to get the form.
     817       
     818        @param room_jid: The room you want the configuration form from.
     819        @type room_jid: L{jid.JID}
     820
     821        """
     822
     823    def join(server, room, nick):
     824        """
     825        Join a multi-user chat room.
     826
     827        @param server: The server the room is on.
     828        @type server: C{str}
     829
     830        @param room: The room name.
     831        @type room: C{str}
     832       
     833        @param nick: The nick name you want when you join the room.
     834        @type nick: C{str}
     835
     836        """
     837
     838
     839    def leave(room_jid):
     840        """
     841        Leave a multi-user chat room.
     842
     843        @param room_jid: The room you want the configuration form from.
     844        @type room_jid: L{jid.JID}
     845
     846        """
     847
     848    def userJoinedRoom(room, user):
     849        """User has joined the room.
     850
     851        @param room: The room the user joined.
     852        @type  room: L{muc.Room}
     853
     854        @param user: The user that joined the room.
     855        @type  user: L{muc.User}
     856
     857        """
     858   
     859
     860    def groupChat(to, message, children=None):
     861        """Send a groupchat message to a room.
     862
     863        """
     864
     865
     866    def chat(to, message, children=None):
     867        """
     868
     869        """
     870
     871
     872    def password(to, password):
     873        """
     874        """
     875   
     876    def register(to, fields=[]):
     877        """
     878        """
     879
     880
     881    def subject(to, subject):
     882        """
     883        """
     884
     885    def voice(to):
     886        """
     887        """
     888
     889
     890    def history(to, message_list):
     891        """
     892        """
     893
     894    def ban(to, ban_jid, frm, reason=None):
     895        """
     896        """
     897
     898
     899    def kick(to, kick_jid, frm, reason=None):
     900        """
     901        """
Note: See TracChangeset for help on using the changeset viewer.