Table of Contents

Class: WordsClientInterface Twisted-0.19.0/twisted/words/service.py

A client to a perspective on the twisted.words service.

I attach to that participant with Participant.attached(), and detatch with Participant.detached().

Methods   
memberJoined
memberLeft
notifyStatusChanged
receiveContactList
receiveDirectMessage
receiveGroupMembers
receiveGroupMessage
setGroupMetadata
  memberJoined 
memberJoined (
        self,
        member,
        group,
        )

Tells me a member has joined a group.

  memberLeft 
memberLeft (
        self,
        member,
        group,
        )

Tells me a member has left a group.

  notifyStatusChanged 
notifyStatusChanged (
        self,
        name,
        status,
        )

Notify me of a change in status of one of my contacts.

  receiveContactList 
receiveContactList ( self,  contactList )

Receive a list of contacts and their status.

The list is composed of 2-tuples, of the form (contactName, contactStatus)

  receiveDirectMessage 
receiveDirectMessage (
        self,
        sender,
        message,
        metadata=None,
        )

Receive a message from someone named sender. metadata is a dict of special flags. So far 'style': emote is defined. Note that metadata must be optional.

  receiveGroupMembers 
receiveGroupMembers (
        self,
        names,
        group,
        )

Receive a list of members in a group.

names is a list of participant names in the group named group.

  receiveGroupMessage 
receiveGroupMessage (
        self,
        sender,
        group,
        message,
        metadata=None,
        )

Receive a message from sender directed to a group. metadata is a dict of special flags. So far 'style': emote is defined. Note that metadata must be optional.

  setGroupMetadata 
setGroupMetadata (
        self,
        metadata,
        name,
        )

Some metadata on a group has been set.

XXX: Should this be receiveGroupMetadata(name, metedata)?


Table of Contents

This document was automatically generated on Sun Jul 14 19:53:46 2002 by HappyDoc version 2.0