t.w.i.t.TOCProto(basesupport.AbstractClientMixin, toc.TOCClient) : class documentation

Part of twisted.words.im.tocsupport View Source View In Hierarchy

Undocumented
Method __init__ Undocumented
Method getGroupConversation Undocumented
Method addContact Undocumented
Method getPerson Undocumented
Method onLine called when we are first online
Method gotConfig No summary
Method tocNICK Handle a message that looks like:
Method hearError called when an error is received code := error code args := misc. arguments (username, etc.)
Method hearWarning called when we get warned newamount := the current warning level username := the user who warned us, or '' if it's anonymous
Method hearMessage No summary
Method updateBuddy No summary
Method chatJoined No summary
Method chatUpdate No summary
Method chatHearMessage No summary
Method chatHearWhisper No summary
Method chatInvited No summary
Method chatLeft we left the room roomid := the AIM id for the room
Method rvousProposal No summary
Method receiveBytes No summary
Method joinGroup Undocumented
Method _debug Undocumented

Inherited from AbstractClientMixin:

Method connectionMade Undocumented
Method connectionLost Undocumented
Method unregisterAsAccountClient Tell the chat UI that I have `signed off'.

Inherited from TOCClient:

Method sendFlap Undocumented
Method isFlap tests to see if a flap is actually on the buffer
Method readFlap Undocumented
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
Method dataReceived Called whenever data is received.
Method modeSendNick Undocumented
Method modeData Undocumented
Method tocUNKNOWN Undocumented
Method tocSIGN_ON Undocumented
Method tocCONFIG Handle a message that looks like:
Method tocIM_IN Handle a message that looks like:
Method tocUPDATE_BUDDY Handle a message that looks like:
Method tocERROR Handle a message that looks like:
Method tocEVILED Handle a message that looks like:
Method tocCHAT_JOIN Handle a message that looks like:
Method tocCHAT_UPDATE_BUDDY Handle a message that looks like:
Method tocCHAT_IN Handle a message that looks like:
Method tocCHAT_INVITE Handle a message that looks like:
Method tocCHAT_LEFT Handle a message that looks like:
Method tocRVOUS_PROPOSE Handle a message that looks like:
Method tocSEND_FILE Undocumented
Method tocGET_FILE Undocumented
Method isaway return our away status
Method set_config No summary
Method add_buddy Undocumented
Method del_buddy Undocumented
Method add_permit Undocumented
Method del_permit Undocumented
Method add_deny Undocumented
Method del_deny Undocumented
Method signon called to finish the setup, and signon to the network
Method say No summary
Method idle change idle state idletime := the seconds that the user has been away, or 0 if they're back
Method evil warn a user user := the user to warn anon := if true, an anonymous warning
Method away change away state message := the message, or '' to come back from awayness
Method chat_join join a chat room exchange := should almost always be 4 roomname := room name
Method chat_say send a message to a chatroom roomid := the AIM id for the room message := the message to send
Method chat_whisper No summary
Method chat_leave leave a chat room. roomid := the AIM id for the room
Method chat_invite No summary
Method chat_accept accept an invite to a chat room roomid := the AIM id for the room
Method rvous_accept Undocumented
Method rvous_cancel Undocumented

Inherited from BaseProtocol (via TOCClient, Protocol):

Method makeConnection Make a connection to a transport and a server.
def __init__(self, account, chatui, logonDeferred): (source)
overrides twisted.words.im.basesupport.AbstractClientMixin.__init__
Undocumented
def _debug(self, m): (source)
overrides twisted.words.protocols.toc.TOCClient._debug
Undocumented
def getGroupConversation(self, name, hide=0): (source)
Undocumented
def addContact(self, name): (source)
Undocumented
def getPerson(self, name): (source)
Undocumented
def onLine(self): (source)
overrides twisted.words.protocols.toc.TOCClient.onLine
called when we are first online
def gotConfig(self, mode, buddylist, permit, deny): (source)
overrides twisted.words.protocols.toc.TOCClient.gotConfig
called when we get a configuration from the server mode := permit/deny mode buddylist := current buddylist permit := permit list deny := deny list
def tocNICK(self, data): (source)
overrides twisted.words.protocols.toc.TOCClient.tocNICK
Handle a message that looks like: 
   NICK:<format of nickname>
def hearError(self, code, args): (source)
overrides twisted.words.protocols.toc.TOCClient.hearError
called when an error is received code := error code args := misc. arguments (username, etc.)
def hearWarning(self, newamount, username): (source)
overrides twisted.words.protocols.toc.TOCClient.hearWarning
called when we get warned newamount := the current warning level username := the user who warned us, or '' if it's anonymous
def hearMessage(self, username, message, autoreply): (source)
overrides twisted.words.protocols.toc.TOCClient.hearMessage
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
def updateBuddy(self, username, online, evilness, signontime, idletime, userclass, away): (source)
overrides twisted.words.protocols.toc.TOCClient.updateBuddy
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")
def chatJoined(self, roomid, roomname, users): (source)
overrides twisted.words.protocols.toc.TOCClient.chatJoined
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
def chatUpdate(self, roomid, member, inroom): (source)
overrides twisted.words.protocols.toc.TOCClient.chatUpdate
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
def chatHearMessage(self, roomid, username, message): (source)
overrides twisted.words.protocols.toc.TOCClient.chatHearMessage
a message was sent to the room roomid := the AIM id for the room username := the user who sent the message message := the message
def chatHearWhisper(self, roomid, username, message): (source)
overrides twisted.words.protocols.toc.TOCClient.chatHearWhisper
someone whispered to us in a chatroom roomid := the AIM for the room username := the user who whispered to us message := the message
def chatInvited(self, roomid, roomname, username, message): (source)
overrides twisted.words.protocols.toc.TOCClient.chatInvited
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
def chatLeft(self, roomid): (source)
overrides twisted.words.protocols.toc.TOCClient.chatLeft
we left the room roomid := the AIM id for the room
def rvousProposal(self, type, cookie, user, vip, port, **kw): (source)
overrides twisted.words.protocols.toc.TOCClient.rvousProposal
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
def receiveBytes(self, user, file, chunk, sofar, total): (source)
overrides twisted.words.protocols.toc.TOCClient.receiveBytes
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
def joinGroup(self, name): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.