Package twisted :: Package words :: Module service
[frames | no frames]

Module twisted.words.service

Twisted Words Service objects. Chat and messaging for Twisted.

Twisted words is a general-purpose chat and instant messaging system designed to be a suitable replacement both for Instant Messenger systems and conferencing systems like IRC.

Currently it provides presence notification, web-based account creation, and a simple group-chat abstraction.

Stability: incendiary

Maintainer: Maintainer: Glyph Lefkowitz

Future Plans: Woah boy. This module is incredibly unstable. It has an incredible deficiency of features. There are also several features which are pretty controvertial. As far as stability goes, it is lucky that the current interfaces are really simple: at least the uppermost external ones will almost certainly be preserved, but there is a lot of plumbing work.

First of all the fact that users must have accounts generated through a web interface to sign in is a serious annoyance, especially to people who are familiar with IRC's semantics. The following features are proposed to mitigate this annoyance:

There is no plan to make it possible to log-in without an account. This is simply a broken behavior of IRC; all possible convenience features that mimic this should be integrated, but authentication is an important part of chat.

There are also certain things that are just missing. Then there's a whole bunch of things that would be nice to have.
Classes
Group This class represents a group of people engaged in a chat session with one another.
IWordsClient A client to a perspective on the twisted.words service.
IWordsPolicy  
NormalPolicy  
Participant  
Service I am a chat service.
Transcript I am a transcript of a conversation between multiple parties.
WordsClient  

Exceptions
NotInCollectionError  
NotInGroupError  
UserNonexistantError  
WordsError  
WrongStatusError  

Variable Summary
int AWAY = 2                                                                     
int OFFLINE = 0                                                                     
int ONLINE = 1                                                                     
list statuses = ['Offline', 'Online', 'Away']

Variable Details

AWAY

Type:
int
Value:
2                                                                     

OFFLINE

Type:
int
Value:
0                                                                     

ONLINE

Type:
int
Value:
1                                                                     

statuses

Type:
list
Value:
['Offline', 'Online', 'Away']                                          

Generated by Epydoc 2.0 on Sat May 15 20:08:19 2004 http://epydoc.sf.net