Package twisted :: Package im :: Module tocsupport :: Class TOCProto

[frames | no frames]

## Class TOCProto

     AbstractClientMixin --+
                           |
    BaseProtocol --+       |
                   |       |
            Protocol --+   |
                       |   |
               TOCClient --+
                           |
                          TOCProto

Method Summary
| `__init__(self, account, chatui, logonDeferred)`
| `_debug(self, m)`
| `addContact(self, name)`
| ``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`(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`(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`(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`(self, roomid)` we left the room roomid := the AIM id for the room
| `chatUpdate(self, roomid, member, inroom)`
| `getGroupConversation(self, name, hide)`
| `getPerson(self, name)`
| ``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`(self, code, args)` called when an error is received code := error code args := misc.
| ``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`(self, newamount, username)` called when we get warned newamount := the current warning level username := the user who warned us, or '' if it's anonymous
| `joinGroup(self, name)`
| ``onLine`(self)` called when we are first online
| ``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`(self, type, cookie, user, vip, port, **kw)` we were asked for a rondevouz type := the type of rondevous.
| ``tocNICK`(self, data)` NICK:<format of nickname>

``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")

Inherited from AbstractClientMixin
| ``connectionLost`(self, reason)`
| ``connectionMade`(self)`
| ``unregisterAsAccountClient`(self)` Tell the chat UI that I have `signed off'.
Inherited from TOCClient
| ``add_buddy`(self, buddies)`
| ``add_deny`(self, users)`
| ``add_permit`(self, users)`
| ``away`(self, message)` change away state message := the message, or '' to come back from awayness
| ``chat_accept`(self, roomid)` accept an invite to a chat room roomid := the AIM id for the room
| ``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`(self, exchange, roomname)` join a chat room exchange := should almost always be 4 roomname := room name
| ``chat_leave`(self, roomid)` leave a chat room.
| ``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`(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
| ``dataReceived`(self, data)` Called whenever data is received.
| ``del_buddy`(self, buddies)`
| ``del_deny`(self, users)`
| ``del_permit`(self, users)`
| ``evil`(self, user, anon)` warn a user user := the user to warn anon := if true, an anonymous warning
| ``idle`(self, idletime)` change idle state idletime := the seconds that the user has been away, or 0 if they're back
| ``isaway`(self)` return our away status
| ``isFlap`(self)` tests to see if a flap is actually on the buffer
| ``modeData`(self, flap)`
| ``modeSendNick`(self, flap)`
| ``readFlap`(self)`
| ``rvous_accept`(self, cookie)`
| ``rvous_cancel`(self, cookie)`
| ``say`(self, user, message, autoreply)` 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`(self, type, data)`
| ``set_config`(self, mode, buddylist, permit, deny)` set the server configuration mode := permit mode buddylist := buddy list permit := permit list deny := deny list
| ``signon`(self)` called to finish the setup, and signon to the network
| ``tocCHAT_IN`(self, data)` CHAT_IN:<room id>:<username>:<whisper T/F>:<message> whisper isn't used
| ``tocCHAT_INVITE`(self, data)` CHAT_INVITE:<room name>:<room id>:<username>:<message>
| ``tocCHAT_JOIN`(self, data)` CHAT_JOIN:<room id>:<room name>
| ``tocCHAT_LEFT`(self, data)` CHAT_LEFT:<room id>
| ``tocCHAT_UPDATE_BUDDY`(self, data)` CHAT_UPDATE_BUDDY:<room id>:<in room? T/F>:<user 1>:<user 2>...
| ``tocCONFIG`(self, data)` CONFIG:<config> format of config data:
| ``tocERROR`(self, data)` ERROR:<error code>:<misc.
| ``tocEVILED`(self, data)` EVILED:<current warning level>:<user who warned us>
| ``tocGET_FILE`(self, user, cookie, seq, pip, vip, port, tlvs)`
| ``tocIM_IN`(self, data)` IM_IN:<user>:<autoreply T|F>:message
| ``tocRVOUS_PROPOSE`(self, data)` RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port>...
| ``tocSEND_FILE`(self, user, cookie, seq, pip, vip, port, tlvs)`
| ``tocSIGN_ON`(self, data)`
| ``tocUNKNOWN`(self, command, data)`
| ``tocUPDATE_BUDDY`(self, data)` UPDATE_BUDDY:<username>:<online T|F>:<warning level>:<signon time>:<idle time (minutes)>:<user class>
Inherited from Protocol
| ``connectionFailed`(self)` (Deprecated)
Inherited from BaseProtocol
| ``makeConnection`(self, transport)` Make a connection to a transport and a server.

Instance Variable Summary
Inherited from AbstractClientMixin
| `_logonDeferred`: Fired when I am done logging in.

Class Variable Summary
`NoneType` | `name` = None
Inherited from Protocol
`tuple` | `__implements__` = `(<class twisted.internet.interfaces.IPr...`
Inherited from BaseProtocol
`int` | `connected` = 0
`NoneType` | `transport` = None

Method Details

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.chatHearMessage` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.chatHearWhisper` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.chatInvited` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.chatJoined` (inherited documentation)

### chatLeft(self, roomid)

we left the room roomid := the AIM id for the room

  Overrides:
    `twisted.protocols.toc.TOCClient.chatLeft` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.gotConfig` (inherited documentation)

### hearError(self, code, args)

called when an error is received code := error code args := misc. arguments (username, etc.)

  Overrides:
    `twisted.protocols.toc.TOCClient.hearError` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.hearMessage` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.hearWarning` (inherited documentation)

### onLine(self)

called when we are first online

  Overrides:
    `twisted.protocols.toc.TOCClient.onLine` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.receiveBytes` (inherited documentation)

### 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

  Overrides:
    `twisted.protocols.toc.TOCClient.rvousProposal` (inherited documentation)

### tocNICK(self, data)

NICK:<format of nickname>

  Overrides:
    `twisted.protocols.toc.TOCClient.tocNICK` (inherited documentation)

### 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")

  Overrides:
    `twisted.protocols.toc.TOCClient.updateBuddy` (inherited documentation)

Class Variable Details

### name

  Type:
    `NoneType`
  Value:

        None

Generated by Epydoc 2.0 on Sat May 15 20:07:40 2004 | http://epydoc.sf.net