twisted.words.protocols.oscar.BOSConnection(SNACBased) class documentation

Part of twisted.words.protocols.oscar View Source (View In Hierarchy)
No class docstring
Method __init__ Undocumented
Method parseUser Undocumented
Method oscar_01_05 data for a new service connection d might be a deferred to be called back when the service is ready
Method oscar_01_07 rate parameters
Method oscar_01_10 we've been warned
Method oscar_01_13 MOTD
Method oscar_02_03 location rights response
Method oscar_03_03 buddy list rights response
Method oscar_03_0B buddy update
Method oscar_03_0C buddy offline
Method oscar_04_05 ICBM parms response
Method oscar_04_07 ICBM message (instant message)
Method oscar_09_03 BOS rights response
Method oscar_0B_02 stats reporting interval
Method oscar_13_03 SSI rights response
Method requestSelfInfo ask for the OSCARUser for ourselves
Method initSSI this sends the rate request for family 0x13 (Server Side Information) so we can then use it
Method requestSSI request the server side information if the deferred gets None, it means the SSI is the same
Method activateSSI active the data stored on the server (use buddy list, permit deny settings, etc.)
Method startModifySSI tell the OSCAR server to be on the lookout for SSI modifications
Method addItemSSI 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.
Method modifyItemSSI Undocumented
Method delItemSSI Undocumented
Method endModifySSI Undocumented
Method setProfile set the profile. send None to not set a profile (different from '' for a blank one)
Method setAway set the away message, or return (if away == None)
Method setIdleTime set our idle time. don't call more than once with a non-0 idle time.
Method sendMessage No summary
Method connectService 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.
Method createChat create a chat room
Method joinChat join a chat room
Method warnUser Undocumented
Method getInfo Undocumented
Method getAway Undocumented
Method initDone called when we get the rate information, which means we should do other init. stuff.
Method updateBuddy called when a buddy changes status, with the OSCARUser for that buddy.
Method offlineBuddy called when a buddy goes offline
Method receiveMessage called when someone sends us a message
Method receiveWarning called when someone warns us. user is either None (if it was anonymous) or an OSCARUser
Method receiveChatInvite called when someone invites us to a chat room
Method chatReceiveMessage called when someone in a chatroom sends us a message in the chat
Method chatMemberJoined called when a member joins the chat
Method chatMemberLeft called when a member leaves the chat
Method receiveSendFileRequest called when someone tries to send a file to us
Method _cbGetChatInfoForInvite Undocumented
Method _cbRequestSelfInfo Undocumented
Method _cbInitSSI Undocumented
Method _cbRequestSSI Undocumented
Method _cbSendMessageAck Undocumented
Method _cbConnectService Undocumented
Method _cbJoinChat Undocumented
Method _cbWarnUser Undocumented
Method _cbGetInfo Undocumented
Method _cbGetAway Undocumented

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

Method makeConnection Make a connection to a transport and a server.

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

Method makeConnection Make a connection to a transport and a server.

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

Method makeConnection Make a connection to a transport and a server.

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

Method makeConnection Make a connection to a transport and a server.
def __init__(self, username, cookie): (source)
overrides twisted.words.protocols.oscar.SNACBased.__init__
Undocumented
def parseUser(self, data, count=None): (source)
Undocumented
def oscar_01_05(self, snac, d=None): (source)

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): (source)

rate parameters

def oscar_01_10(self, snac): (source)

we've been warned

def oscar_01_13(self, snac): (source)

MOTD

def oscar_02_03(self, snac): (source)

location rights response

def oscar_03_03(self, snac): (source)

buddy list rights response

def oscar_03_0B(self, snac): (source)

buddy update

def oscar_03_0C(self, snac): (source)

buddy offline

def oscar_04_05(self, snac): (source)

ICBM parms response

def oscar_04_07(self, snac): (source)

ICBM message (instant message)

def _cbGetChatInfoForInvite(self, info, user, message): (source)
Undocumented
def oscar_09_03(self, snac): (source)

BOS rights response

def oscar_0B_02(self, snac): (source)

stats reporting interval

def oscar_13_03(self, snac): (source)

SSI rights response

def requestSelfInfo(self): (source)

ask for the OSCARUser for ourselves

def _cbRequestSelfInfo(self, snac, d): (source)
Undocumented
def initSSI(self): (source)

this sends the rate request for family 0x13 (Server Side Information) so we can then use it

def _cbInitSSI(self, snac, d): (source)
Undocumented
def requestSSI(self, timestamp=0, revision=0): (source)

request the server side information if the deferred gets None, it means the SSI is the same

def _cbRequestSSI(self, snac, args=()): (source)
Undocumented
def activateSSI(self): (source)

active the data stored on the server (use buddy list, permit deny settings, etc.)

def startModifySSI(self): (source)

tell the OSCAR server to be on the lookout for SSI modifications

def addItemSSI(self, item, groupID=None, buddyID=None): (source)

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): (source)
Undocumented
def delItemSSI(self, item, groupID=None, buddyID=None): (source)
Undocumented
def endModifySSI(self): (source)
Undocumented
def setProfile(self, profile): (source)

set the profile. send None to not set a profile (different from '' for a blank one)

def setAway(self, away=None): (source)

set the away message, or return (if away == None)

def setIdleTime(self, idleTime): (source)

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): (source)

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): (source)
Undocumented
def connectService(self, service, wantCallback=0, extraData=''): (source)

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): (source)
Undocumented
def createChat(self, shortName): (source)

create a chat room

def joinChat(self, exchange, fullName, instance): (source)

join a chat room

def _cbJoinChat(self, chat): (source)
Undocumented
def warnUser(self, user, anon=0): (source)
Undocumented
def _cbWarnUser(self, snac): (source)
Undocumented
def getInfo(self, user): (source)
Undocumented
def _cbGetInfo(self, snac): (source)
Undocumented
def getAway(self, user): (source)
Undocumented
def _cbGetAway(self, snac): (source)
Undocumented
def initDone(self): (source)

called when we get the rate information, which means we should do other init. stuff.

def updateBuddy(self, user): (source)

called when a buddy changes status, with the OSCARUser for that buddy.

def offlineBuddy(self, user): (source)

called when a buddy goes offline

def receiveMessage(self, user, multiparts, flags): (source)

called when someone sends us a message

def receiveWarning(self, newLevel, user): (source)

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): (source)

called when someone invites us to a chat room

def chatReceiveMessage(self, chat, user, message): (source)

called when someone in a chatroom sends us a message in the chat

def chatMemberJoined(self, chat, member): (source)

called when a member joins the chat

def chatMemberLeft(self, chat, member): (source)

called when a member leaves the chat

def receiveSendFileRequest(self, user, file, description, cookie): (source)

called when someone tries to send a file to us

API Documentation for Twisted, generated by pydoctor at 2016-04-04 15:02:49.