Methods
|
|
|
|
__init__
|
__init__ (
self,
username,
password,
authhost="login.oscar.aol.com",
authport=5190,
)
|
|
_debug
|
_debug ( self, data )
|
|
add_buddy
|
add_buddy ( self, buddies )
|
|
add_deny
|
add_deny ( self, users )
|
|
add_permit
|
add_permit ( self, users )
|
|
away
|
away ( self, message='' )
change away state
message := the message, or '' to come back from awayness
|
|
chatHearMessage
|
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
|
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
|
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
|
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
|
chatLeft ( self, roomid )
we left the room
roomid := the AIM id for the room
|
|
chatUpdate
|
chatUpdate (
self,
roomid,
username,
inroom,
)
a user has joined the room
roomid := the AIM id for the room
username := the username
inroom := true if the user is in the room
|
|
chat_accept
|
chat_accept ( self, roomid )
accept an invite to a chat room
roomid := the AIM id for the room
|
|
chat_invite
|
chat_invite (
self,
roomid,
usernames,
message,
)
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
|
|
chat_join
|
chat_join (
self,
exchange,
roomname,
)
join a chat room
exchange := should almost always be 4
roomname := room name
|
|
chat_leave
|
chat_leave ( self, roomid )
leave a chat room.
roomid := the AIM id for the room
|
|
chat_say
|
chat_say (
self,
roomid,
message,
)
send a message to a chatroom
roomid := the AIM id for the room
message := the message to send
|
|
chat_whisper
|
chat_whisper (
self,
roomid,
user,
message,
)
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
|
|
connectionLost
|
connectionLost ( self )
|
|
connectionMade
|
connectionMade ( self )
|
|
dataReceived
|
dataReceived ( self, data )
|
|
del_buddy
|
del_buddy ( self, buddies )
|
|
del_deny
|
del_deny ( self, users )
|
|
del_permit
|
del_permit ( self, users )
|
|
evil
|
evil (
self,
user,
anon=0,
)
warn a user
user := the user to warn
anon := if true, an anonymous warning
|
|
gotConfig
|
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
|
hearError (
self,
code,
args,
)
called when an error is received
code := error code
args := misc. arguments (username, etc.)
|
|
hearMessage
|
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
|
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
|
|
idle
|
idle ( self, idletime=0 )
change idle state
idletime := the seconds that the user has been away, or 0 if they're back
|
|
isFlap
|
isFlap ( self )
tests to see if a flap is actually on the buffer
|
|
isaway
|
isaway ( self )
return our away status
|
|
modeData
|
modeData ( self, flap )
|
|
modeSendNick
|
modeSendNick ( self, flap )
|
|
onLine
|
onLine ( self )
called when we are first online
|
|
readFlap
|
readFlap ( self )
|
|
receiveBytes
|
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
|
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
|
|
rvous_accept
|
rvous_accept ( self, cookie )
|
|
rvous_cancel
|
rvous_cancel ( self, cookie )
|
|
say
|
say (
self,
user,
message,
autoreply=0,
)
send a message
user := the user to send to
message := the message
autoreply := true if the message is an autoreply (good for away messages)
|
|
sendFlap
|
sendFlap (
self,
type,
data,
)
|
|
set_config
|
set_config (
self,
mode,
buddylist,
permit,
deny,
)
set the server configuration
mode := permit mode
buddylist := buddy list
permit := permit list
deny := deny list
|
|
signon
|
signon ( self )
called to finish the setup, and signon to the network
|
|
tocCHAT_IN
|
tocCHAT_IN ( self, data )
CHAT_IN:<room id>:<username>:<whisper T/F>:<message>
whisper isn't used
|
|
tocCHAT_INVITE
|
tocCHAT_INVITE ( self, data )
CHAT_INVITE:<room name>:<room id>:<username>:<message>
|
|
tocCHAT_JOIN
|
tocCHAT_JOIN ( self, data )
CHAT_JOIN:<room id>:<room name>
|
|
tocCHAT_LEFT
|
tocCHAT_LEFT ( self, data )
CHAT_LEFT:<room id>
|
|
tocCHAT_UPDATE_BUDDY
|
tocCHAT_UPDATE_BUDDY ( self, data )
CHAT_UPDATE_BUDDY:<room id>:<in room? T/F>:<user 1>:<user 2>...
|
|
tocCONFIG
|
tocCONFIG ( self, data )
CONFIG:<config>
format of config data:
g: group. all users until next g or end of config are in this group
b: buddy
p: person on the permit list
d: person on the deny list
m: permit/deny mode (1: permit all, 2: deny all, 3: permit some, 4: deny some)
|
|
tocERROR
|
tocERROR ( self, data )
ERROR:<error code>:<misc. data>
|
|
tocEVILED
|
tocEVILED ( self, data )
EVILED:<current warning level>:<user who warned us>
|
|
tocGET_FILE
|
tocGET_FILE (
self,
user,
cookie,
seq,
pip,
vip,
port,
tlvs,
)
|
|
tocIM_IN
|
tocIM_IN ( self, data )
IM_IN:<user>:<autoreply T|F>:message
|
|
tocNICK
|
tocNICK ( self, data )
NICK:<format of nickname>
|
|
tocRVOUS_PROPOSE
|
tocRVOUS_PROPOSE ( self, data )
RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port>
[:tlv tag1:tlv value1[:tlv tag2:tlv value2[:...]]]
|
|
tocSEND_FILE
|
tocSEND_FILE (
self,
user,
cookie,
seq,
pip,
vip,
port,
tlvs,
)
|
|
tocSIGN_ON
|
tocSIGN_ON ( self, data )
|
|
tocUNKNOWN
|
tocUNKNOWN (
self,
command,
data,
)
|
|
tocUPDATE_BUDDY
|
tocUPDATE_BUDDY ( self, data )
UPDATE_BUDDY:<username>:<online T|F>:<warning level>:<signon time>:<idle time (minutes)>:<user class>
|
|
updateBuddy
|
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")
|