Class t.w.p.o.BOSConnection(SNACBased):

Part of twisted.words.protocols.oscar View Source View In Hierarchy

Undocumented
Line # Kind Name Docs
426 Method __init__ Undocumented
436 Method parseUser Undocumented
452 Method oscar_01_05 data for a new service connection
468 Method oscar_01_07 rate paramaters
480 Method oscar_01_10 we've been warned
492 Method oscar_01_13 MOTD
498 Method oscar_02_03 location rights response
505 Method oscar_03_03 buddy list rights response
513 Method oscar_03_0B buddy update
519 Method oscar_03_0C buddy offline
527 Method oscar_04_05 ICBM parms response
533 Method oscar_04_07 ICBM message (instant message)
621 Method _cbGetChatInfoForInvite Undocumented
624 Method oscar_09_03 BOS rights response
632 Method oscar_0B_02 stats reporting interval
638 Method oscar_13_03 SSI rights response
646 Method requestSelfInfo ask for the OSCARUser for ourselves
654 Method _cbRequestSelfInfo Undocumented
657 Method initSSI this sends the rate request for family 0x13 (Server Side Information)
664 Method _cbInitSSI Undocumented
667 Method requestSSI request the server side information
675 Method _cbRequestSSI Undocumented
723 Method activateSSI active the data stored on the server (use buddy list, permit deny settings, etc.)
729 Method startModifySSI tell the OSCAR server to be on the lookout for SSI modifications
735 Method addItemSSI add an item to the SSI server. if buddyID == 0, then this should be a group.
749 Method modifyItemSSI Undocumented
759 Method delItemSSI Undocumented
769 Method endModifySSI Undocumented
772 Method setProfile set the profile.
786 Method setAway set the away message, or return (if away == None)
795 Method setIdleTime set our idle time. don't call more than once with a non-0 idle time.
801 Method sendMessage send a message to user (not an OSCARUseR).
845 Method _cbSendMessageAck Undocumented
848 Method connectService connect to another service
861 Method _cbConnectService Undocumented
864 Method createChat create a chat room
874 Method joinChat join a chat room
883 Method _cbJoinChat Undocumented
887 Method warnUser Undocumented
890 Method _cbWarnUser Undocumented
894 Method getInfo Undocumented
898 Method _cbGetInfo Undocumented
903 Method getAway Undocumented
906 Method _cbGetAway Undocumented
914 Method initDone called when we get the rate information, which means we should do other init. stuff.
921 Method updateBuddy called when a buddy changes status, with the OSCARUser for that buddy.
928 Method offlineBuddy called when a buddy goes offline
935 Method receiveMessage called when someone sends us a message
941 Method receiveWarning called when someone warns us.
948 Method receiveChatInvite called when someone invites us to a chat room
954 Method chatReceiveMessage called when someone in a chatroom sends us a message in the chat
960 Method chatMemberJoined called when a member joins the chat
966 Method chatMemberLeft called when a member leaves the chat
972 Method receiveSendFileRequest called when someone tries to send a file to us

Inherited from SNACBased:

Line # Kind Name Docs
324 Method sendSNAC send a snac and wait for the response by returning a Deferred.
339 Method _ebDeferredError Undocumented
344 Method sendSNACnr send a snac, but don't bother adding a deferred, we don't care.
350 Method oscar_ Undocumented
354 Method oscar_Data Undocumented
371 Method oscar_unknown Undocumented
376 Method oscar_01_03 Undocumented
385 Method oscar_01_0A change of rate information.
392 Method oscar_01_18 host versions, in the same format as we sent
398 Method clientReady called when the client is ready to be online

Inherited from OscarConnection (via SNACBased):

Line # Kind Name Docs
243 Method connectionMade Called when a connection is made.
250 Method connectionLost Called when the connection is shut down.
258 Method sendFLAP Undocumented
268 Method readFlap Undocumented
276 Method dataReceived Called whenever data is received.
290 Method setKeepAlive Undocumented
295 Method sendKeepAlive Undocumented
299 Method stopKeepAlive Undocumented
304 Method disconnect send the disconnect flap, and sever the connection

Inherited from BaseProtocol (via SNACBased, OscarConnection, Protocol):

Line # Kind Name Docs
325 Method makeConnection Make a connection to a transport and a server.
def __init__(self, username, cookie):
overrides twisted.words.protocols.oscar.SNACBased.__init__
Undocumented
def parseUser(self, data, count=None):
Undocumented
def 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
def oscar_01_07(self, snac):
rate paramaters
def oscar_01_10(self, snac):
we've been warned
def oscar_01_13(self, snac):
MOTD
def oscar_02_03(self, snac):
location rights response
def oscar_03_03(self, snac):
buddy list rights response
def oscar_03_0B(self, snac):
buddy update
def oscar_03_0C(self, snac):
buddy offline
def oscar_04_05(self, snac):
ICBM parms response
def oscar_04_07(self, snac):
ICBM message (instant message)
def _cbGetChatInfoForInvite(self, info, user, message):
Undocumented
def oscar_09_03(self, snac):
BOS rights response
def oscar_0B_02(self, snac):
stats reporting interval
def oscar_13_03(self, snac):
SSI rights response
def requestSelfInfo(self):
ask for the OSCARUser for ourselves
def _cbRequestSelfInfo(self, snac, d):
Undocumented
def initSSI(self):
this sends the rate request for family 0x13 (Server Side Information) so we can then use it
def _cbInitSSI(self, snac, d):
Undocumented
def requestSSI(self, timestamp=0, revision=0):
request the server side information if the deferred gets None, it means the SSI is the same
def _cbRequestSSI(self, snac, args=()):
Undocumented
def activateSSI(self):
active the data stored on the server (use buddy list, permit deny settings, etc.)
def startModifySSI(self):
tell the OSCAR server to be on the lookout for SSI modifications
def addItemSSI(self, item, groupID=None, buddyID=None):
add an item to the SSI server. if buddyID == 0, then this should be a group. this gets a callback when it's finished, but you can probably ignore it.
def modifyItemSSI(self, item, groupID=None, buddyID=None):
Undocumented
def delItemSSI(self, item, groupID=None, buddyID=None):
Undocumented
def endModifySSI(self):
Undocumented
def setProfile(self, profile):
set the profile. send None to not set a profile (different from '' for a blank one)
def setAway(self, away=None):
set the away message, or return (if away == None)
def setIdleTime(self, idleTime):
set our idle time. don't call more than once with a non-0 idle time.
def 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)
def _cbSendMessageAck(self, snac, user, message):
Undocumented
def 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.
def _cbConnectService(self, snac, d):
Undocumented
def createChat(self, shortName):
create a chat room
def joinChat(self, exchange, fullName, instance):
join a chat room
def _cbJoinChat(self, chat):
Undocumented
def warnUser(self, user, anon=0):
Undocumented
def _cbWarnUser(self, snac):
Undocumented
def getInfo(self, user):
Undocumented
def _cbGetInfo(self, snac):
Undocumented
def getAway(self, user):
Undocumented
def _cbGetAway(self, snac):
Undocumented
def initDone(self):
called when we get the rate information, which means we should do other init. stuff.
def updateBuddy(self, user):
called when a buddy changes status, with the OSCARUser for that buddy.
def offlineBuddy(self, user):
called when a buddy goes offline
def receiveMessage(self, user, multiparts, flags):
called when someone sends us a message
def receiveWarning(self, newLevel, user):
called when someone warns us. user is either None (if it was anonymous) or an OSCARUser
def receiveChatInvite(self, user, message, exchange, fullName, instance, shortName, inviteTime):
called when someone invites us to a chat room
def chatReceiveMessage(self, chat, user, message):
called when someone in a chatroom sends us a message in the chat
def chatMemberJoined(self, chat, member):
called when a member joins the chat
def chatMemberLeft(self, chat, member):
called when a member leaves the chat
def receiveSendFileRequest(self, user, file, description, cookie):
called when someone tries to send a file to us