Home | Trees | Index | Help |
---|
Package twisted :: Package im :: Module tocsupport :: Class TOCProto |
|
AbstractClientMixin
--+ |BaseProtocol
--+ | | |Protocol
--+ | | |TOCClient
--+ | TOCProto
Method Summary | |
---|---|
__init__(self,
account,
chatui,
logonDeferred)
| |
add_buddy(self,
buddies)
(inherited from TOCClient )
| |
add_deny(self,
users)
(inherited from TOCClient )
| |
add_permit(self,
users)
(inherited from TOCClient )
| |
addContact(self,
name)
| |
change away state message := the message, or '' to come back from awayness (inherited from TOCClient )
| |
accept an invite to a chat room roomid := the AIM id for the room (inherited from TOCClient )
| |
invite a user[s] to the chat room roomid := the AIM id for the room usernames := either a string (one username) or a list (more than one) message := the message to invite them with (inherited from TOCClient )
| |
join a chat room exchange := should almost always be 4 roomname := room name (inherited from TOCClient )
| |
leave a chat room. (inherited from TOCClient )
| |
send a message to a chatroom roomid := the AIM id for the room message := the message to send (inherited from TOCClient )
| |
whisper to another user in a chatroom roomid := the AIM id for the room user := the user to whisper to message := the message to send (inherited from TOCClient )
| |
a message was sent to the room roomid := the AIM id for the room username := the user who sent the message message := the message | |
someone whispered to us in a chatroom roomid := the AIM for the room username := the user who whispered to us message := the message | |
we were invited to a chat room roomid := the AIM id for the room roomname := the name of the room username := the user who invited us message := the invite message | |
we just joined a chat room roomid := the AIM id for the room roomname := the name for the room users := a list of the users already in the room | |
we left the room roomid := the AIM id for the room | |
chatUpdate(self,
roomid,
member,
inroom)
| |
(Deprecated) (inherited from Protocol )
| |
connectionLost(self,
other)
(inherited from AbstractClientMixin )
| |
connectionMade(self)
(inherited from AbstractClientMixin )
| |
Called whenever data is received. (inherited from TOCClient )
| |
del_buddy(self,
buddies)
(inherited from TOCClient )
| |
del_deny(self,
users)
(inherited from TOCClient )
| |
del_permit(self,
users)
(inherited from TOCClient )
| |
warn a user user := the user to warn anon := if true, an anonymous warning (inherited from TOCClient )
| |
getGroupConversation(self,
name,
hide)
| |
getPerson(self,
name)
| |
called when we get a configuration from the server mode := permit/deny mode buddylist := current buddylist permit := permit list deny := deny list | |
called when an error is received code := error code args := misc. | |
called when you receive an IM username := the user who the IM is from message := the message autoreply := true if the message is an autoreply from an away message | |
called when we get warned newamount := the current warning level username := the user who warned us, or '' if it's anonymous | |
change idle state idletime := the seconds that the user has been away, or 0 if they're back (inherited from TOCClient )
| |
return our away status (inherited from TOCClient )
| |
tests to see if a flap is actually on the buffer (inherited from TOCClient )
| |
joinGroup(self,
name)
| |
modeData(self,
flap)
(inherited from TOCClient )
| |
modeSendNick(self,
flap)
(inherited from TOCClient )
| |
called when we are first online | |
readFlap(self)
(inherited from TOCClient )
| |
we received part of a file from a file transfer file := the name of the file chunk := the chunk of data sofar := how much data we've gotten so far total := the total amount of data | |
rvous_accept(self,
cookie)
(inherited from TOCClient )
| |
rvous_cancel(self,
cookie)
(inherited from TOCClient )
| |
we were asked for a rondevouz type := the type of rondevous. | |
send a message user := the user to send to message := the message autoreply := true if the message is an autoreply (good for away messages) (inherited from TOCClient )
| |
sendFlap(self,
type,
data)
(inherited from TOCClient )
| |
set the server configuration mode := permit mode buddylist := buddy list permit := permit list deny := deny list (inherited from TOCClient )
| |
called to finish the setup, and signon to the network (inherited from TOCClient )
| |
CHAT_IN:<room id>:<username>:<whisper T/F>:<message> whisper isn't used (inherited from TOCClient )
| |
CHAT_INVITE:<room name>:<room id>:<username>:<message> (inherited from TOCClient )
| |
CHAT_JOIN:<room id>:<room name> (inherited from TOCClient )
| |
CHAT_LEFT:<room id> (inherited from TOCClient )
| |
CHAT_UPDATE_BUDDY:<room id>:<in room? T/F>:<user 1>:<user 2>... (inherited from TOCClient )
| |
CONFIG:<config> format of config data: (inherited from TOCClient )
| |
ERROR:<error code>:<misc. (inherited from TOCClient )
| |
EVILED:<current warning level>:<user who warned us> (inherited from TOCClient )
| |
tocGET_FILE(self,
user,
cookie,
seq,
pip,
vip,
port,
tlvs)
(inherited from TOCClient )
| |
IM_IN:<user>:<autoreply T|F>:message (inherited from TOCClient )
| |
NICK:<format of nickname> | |
RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port> [:tlv tag1:tlv value1[:tlv tag2:tlv value2[:...]]] (inherited from TOCClient )
| |
tocSEND_FILE(self,
user,
cookie,
seq,
pip,
vip,
port,
tlvs)
(inherited from TOCClient )
| |
tocSIGN_ON(self,
data)
(inherited from TOCClient )
| |
tocUNKNOWN(self,
command,
data)
(inherited from TOCClient )
| |
UPDATE_BUDDY:<username>:<online T|F>:<warning level>:<signon time>:<idle time (minutes)>:<user class> (inherited from TOCClient )
| |
Tell the chat UI that I have `signed off'. (inherited from AbstractClientMixin )
| |
called when a buddy changes state username := the user whos state changed online := true if the user is online evilness := the users current warning level signontime := the time the user signed on (UNIX epoch) idletime := the time the user has been idle (minutes) away := true if the user is away userclass := the class of the user (generally " O") |
Class Variable Summary | |
---|---|
None |
name
|
Method Details |
---|
chatHearMessage(self, roomid, username, message)a message was sent to the room roomid := the AIM id for the room username := the user who sent the message message := the message
|
chatHearWhisper(self, roomid, username, message)someone whispered to us in a chatroom roomid := the AIM for the room username := the user who whispered to us message := the message
|
chatInvited(self, roomid, roomname, username, message)we were invited to a chat room roomid := the AIM id for the room roomname := the name of the room username := the user who invited us message := the invite message
|
chatJoined(self, roomid, roomname, users)we just joined a chat room roomid := the AIM id for the room roomname := the name for the room users := a list of the users already in the room
|
chatLeft(self, roomid)we left the room roomid := the AIM id for the room
|
gotConfig(self, mode, buddylist, permit, deny)called when we get a configuration from the server mode := permit/deny mode buddylist := current buddylist permit := permit list deny := deny list
|
hearError(self, code, args)called when an error is received code := error code args := misc. arguments (username, etc.)
|
hearMessage(self, username, message, autoreply)called when you receive an IM username := the user who the IM is from message := the message autoreply := true if the message is an autoreply from an away message
|
hearWarning(self, newamount, username)called when we get warned newamount := the current warning level username := the user who warned us, or '' if it's anonymous
|
onLine(self)called when we are first online
|
receiveBytes(self, user, file, chunk, sofar, total)we received part of a file from a file transfer file := the name of the file chunk := the chunk of data sofar := how much data we've gotten so far total := the total amount of data
|
rvousProposal(self, type, cookie, user, vip, port, **kw)we were asked for a rondevouz type := the type of rondevous. currently, one of ["send"] cookie := the cookie. pass this to rvous_accept() user := the user who asked us vip := their verified_ip port := the port they want us to conenct to kw := misc. args
|
tocNICK(self, data)NICK:<format of nickname>
|
updateBuddy(self, username, online, evilness, signontime, idletime, userclass, away)called when a buddy changes state username := the user whos state changed online := true if the user is online evilness := the users current warning level signontime := the time the user signed on (UNIX epoch) idletime := the time the user has been idle (minutes) away := true if the user is away userclass := the class of the user (generally " O")
|
Class Variable Details |
---|
name
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 1.1 on Sat Feb 15 21:17:51 2003 | http://epydoc.sf.net |