|
|
Methods
|
|
|
|
|
|
__del__
|
__del__ ( self )
|
|
|
__init__
|
__init__ (
self,
hostname,
port,
userid,
password,
)
|
|
|
cast
|
cast ( self, message )
Broadcast a message to all users online.
|
|
|
disp
|
disp ( self, disposition )
Change user's disposition. Can be one of
(ONLINE|AWAY|NA|OCCUPIED|DND|PRIVACY).
Currently only ONLINE and AWAY are supported.
|
Exceptions
|
|
WackyProtocolError( self, 'DISP', disposition, response )
|
|
|
|
info
|
info ( self, uid )
Get information about a user.
|
Exceptions
|
|
WackyProtocolError( self, 'INFO', uid, response )
|
|
|
|
mail
|
mail ( self, email )
Set the email address for the current user.
|
Exceptions
|
|
WackyProtocolError( self, 'MAIL', email, response )
|
|
|
|
mesg
|
mesg (
self,
uid,
message,
)
Send a message to a single user.
|
Exceptions
|
|
WackyProtocolError( self, 'MESG', uid, message, response )
|
|
|
|
nick
|
nick ( self, nickname )
Set the nickname for the current user.
USER PREFERENCE COMMANDS
|
Exceptions
|
|
WackyProtocolError( self, 'NICK', nickname, response )
|
|
|
|
passwd
|
passwd ( self, newPassword )
Change the password for the current user.
|
Exceptions
|
|
WackyProtocolError( self, 'PASS', response )
|
|
|
|
poll
|
poll ( self )
Poll the server for new messages (check the incoming socket
queue). If there are any unsolicited messages for which
handlers are registered, those handlers will be called.
|
|
|
quit
|
quit ( self )
Disconnect from the server.
PROTOCOL METHODS
|
|
|
registerMessageHandler
|
registerMessageHandler (
self,
message,
handler,
)
Let the user tell us how to handle certain messages.
METHODS THE USER MIGHT WANT TO CALL
|
Exceptions
|
|
ValueError('Message (%s) must be one of :%s' %( message, self._MESSAGES ) )
|
|
|
|
stat
|
stat ( self )
Returns a list of users that are logged on to the
system right now.
|
|