Table of Contents

Class: BOSConnection | Twisted-0.19.0/twisted/protocols/oscar.py
--- | ---
Base Classes |
--- | ---
SNACBased OscarConnection protocol.Protocol
Methods |
--- | ---
__init__ _cbConnectService _cbGetAway _cbGetChatInfoForInvite _cbGetInfo _cbInitSSI _cbJoinChat _cbRequestSSI _cbRequestSelfInfo _cbSendMessageAck _cbWarnUser activateSSI chatMemberJoined chatMemberLeft chatReceiveMessage connectService | createChat getAway getInfo initDone initSSI joinChat offlineBuddy oscar_01_05 oscar_01_07 oscar_01_10 oscar_01_13 oscar_02_03 oscar_03_03 oscar_03_0B oscar_03_0C oscar_04_05 | oscar_04_07 oscar_09_03 oscar_0B_02 oscar_13_03 parseUser receiveChatInvite receiveMessage receiveWarning requestSSI requestSelfInfo sendMessage setAway setIdleTime setProfile updateBuddy warnUser
| __init__
    __init__ (
            self,
            username,
            cookie,
            )
| _cbConnectService
    _cbConnectService (
            self,
            snac,
            d,
            )
| _cbGetAway
    _cbGetAway ( self,  snac )
| _cbGetChatInfoForInvite
    _cbGetChatInfoForInvite (
            self,
            info,
            user,
            message,
            )
| _cbGetInfo
    _cbGetInfo ( self,  snac )
| _cbInitSSI
    _cbInitSSI (
            self,
            snac,
            d,
            )
| _cbJoinChat
    _cbJoinChat ( self,  chat )
| _cbRequestSSI
    _cbRequestSSI (
            self,
            snac,
            d,
            args=(),
            )
| _cbRequestSelfInfo
    _cbRequestSelfInfo (
            self,
            snac,
            d,
            )
| _cbSendMessageAck
    _cbSendMessageAck (
            self,
            snac,
            user,
            )
| _cbWarnUser
    _cbWarnUser ( self,  snac )
| activateSSI
    activateSSI ( self )
active the data stored on the server (use buddy list, permit deny settings, etc.)
| chatMemberJoined
    chatMemberJoined (
            self,
            chat,
            member,
            )
called when a member joins the chat
| chatMemberLeft
    chatMemberLeft (
            self,
            chat,
            member,
            )
called when a member leaves the chat
| chatReceiveMessage
    chatReceiveMessage (
            self,
            chat,
            user,
            message,
            )
called when someone in a chatroom sends us a message in the chat
| connectService
    connectService (
            self,
            service,
            wantCallback=0,
            extraData='',
            )
connect to another service if wantCallback, we return a Deferred that gets called back when the service is online. if extraData, append that to our request.
| createChat
    createChat ( self,  shortName )
create a chat room
| getAway
    getAway ( self,  user )
| getInfo
    getInfo ( self,  user )
| initDone
    initDone ( self )
called when we get the rate information, which means we should do other init. stuff.
| initSSI
    initSSI ( self )
this sends the rate request for family 0x13 (Server Side Information) so we can then use it
| joinChat
    joinChat (
            self,
            exchange,
            fullName,
            instance,
            )
join a chat room
| offlineBuddy
    offlineBuddy ( self,  user )
called when a buddy goes offline
| oscar_01_05
    oscar_01_05 (
            self,
            snac,
            d=None,
            )
data for a new service connection d might be a deferred to be called back when the service is ready
| oscar_01_07
    oscar_01_07 ( self,  snac )
rate paramaters
| oscar_01_10
    oscar_01_10 ( self,  snac )
we've been warned
| oscar_01_13
    oscar_01_13 ( self,  snac )
MOTD
| oscar_02_03
    oscar_02_03 ( self,  snac )
location rights response
| oscar_03_03
    oscar_03_03 ( self,  snac )
buddy list rights response
| oscar_03_0B
    oscar_03_0B ( self,  snac )
buddy update
| oscar_03_0C
    oscar_03_0C ( self,  snac )
buddy offline
| oscar_04_05
    oscar_04_05 ( self,  snac )
ICBM parms response
| oscar_04_07
    oscar_04_07 ( self,  snac )
ICBM message (instant message)
| oscar_09_03
    oscar_09_03 ( self,  snac )
BOS rights response
| oscar_0B_02
    oscar_0B_02 ( self,  snac )
stats reporting interval
| oscar_13_03
    oscar_13_03 ( self,  snac )
SSI rights response
| parseUser
    parseUser (
            self,
            data,
            count=None,
            )
| receiveChatInvite
    receiveChatInvite (
            self,
            user,
            message,
            exchange,
            fullName,
            instance,
            shortName,
            inviteTime,
            )
called when someone invites us to a chat room
| receiveMessage
    receiveMessage (
            self,
            user,
            multiparts,
            flags,
            )
called when someone sends us a message
| receiveWarning
    receiveWarning (
            self,
            newLevel,
            user,
            )
called when someone warns us. user is either None (if it was anonymous) or an OSCARUser
| requestSSI
    requestSSI (
            self,
            timestamp=0,
            revision=0,
            )
request the server side information if the deferred gets None, it means the SSI is the same
| requestSelfInfo
    requestSelfInfo ( self )
ask for the OSCARUser for ourselves
| sendMessage
    sendMessage (
            self,
            user,
            message,
            wantAck=0,
            autoResponse=0,
            offline=0,
            )
send a message to user (not an OSCARUseR). message can be a string, or a multipart tuple. if wantAck, we return a Deferred that gets a callback when the message is sent. if autoResponse, this message is an autoResponse, as if from an away message. if offline, this is an offline message (ICQ only, I think)
| setAway
    setAway ( self,  away=None )
set the away message, or return (if away == None)
| setIdleTime
    setIdleTime ( self,  idleTime )
set our idle time. don't call more than once with a non-0 idle time.
| setProfile
    setProfile ( self,  profile )
set the profile. send None to not set a profile (different from '' for a blank one)
| updateBuddy
    updateBuddy ( self,  user )
called when a buddy changes status, with the OSCARUser for that buddy.
| warnUser
    warnUser (
            self,
            user,
            anon=0,
            )

Table of Contents

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