Home | Trees | Index | Help |
---|
Package twisted :: Package protocols :: Module msn :: Class MSNNotificationClient |
|
BaseProtocol
--+ |Protocol
--+ |LineReceiver
--+ |MSNEventBase
--+ | MSNNotificationClient
Method Summary | |
---|---|
__init__(self,
currentID)
| |
used to add a contact to the desired list. | |
used to create a new list group. | |
used to change your current screen name. | |
change my current status. | |
hook used for detecting specific notification messages | |
Clear buffered data. (inherited from LineReceiver )
| |
(Deprecated) (inherited from Protocol )
| |
Called when the connection is shut down. (inherited from MSNEventBase )
| |
Called when a connection is made. | |
called when a contact goes offline. | |
called when we're notified that a contact's status has changed. | |
Protocol.dataReceived. (inherited from LineReceiver )
| |
called when a handler notifies me that this line is broken (inherited from MSNEventBase )
| |
called after loggin in when the server sends status of online contacts. | |
called when the server sends an error which is not in response to a sent command (ie. (inherited from MSNEventBase )
| |
called when we receive a message - override in notification and switchboard clients (inherited from MSNEventBase )
| |
called when the server sends us phone details about a specific user (for example after a user is added the server will send their status, phone details etc ... | |
called after logging in when the server sends an initial message with MSN/passport specific profile information such as country, number of kids, etc... | |
called when we get an invitation to a switchboard server. | |
handle_ADD(self,
params)
| |
handle_ADG(self,
params)
| |
handle_BLP(self,
params)
| |
handle_BPR(self,
params)
| |
handle_CHG(self,
params)
| |
handle_CHL(self,
params)
| |
handle_FLN(self,
params)
| |
handle_GTC(self,
params)
| |
handle_ILN(self,
params)
| |
handle_INF(self,
params)
| |
handle_LSG(self,
params)
| |
handle_LST(self,
params)
| |
handle_MSG(self,
params)
(inherited from MSNEventBase )
| |
handle_NLN(self,
params)
| |
handle_OUT(self,
params)
| |
handle_PRP(self,
params)
| |
handle_QRY(self,
params)
| |
handle_REA(self,
params)
| |
handle_REG(self,
params)
| |
handle_REM(self,
params)
| |
handle_RMG(self,
params)
| |
handle_RNG(self,
params)
| |
handle_SYN(self,
params)
| |
implement me in subclasses if you want to handle unknown events (inherited from MSNEventBase )
| |
handle_USR(self,
params)
| |
handle_VER(self,
params)
| |
handle_XFR(self,
params)
| |
Called when the maximum line length has been reached. (inherited from LineReceiver )
| |
Override this for when each line is received. (inherited from MSNEventBase )
| |
called when the client has logged in | |
used to log out of the notification server. | |
called when the server says there has been another login under our account, the server should disconnect us right away. | |
Override this for when raw data is received. (inherited from MSNEventBase )
| |
used to remove a contact from the desired list. | |
used to remove a list group. | |
used to rename an existing list group. | |
request the desired list type | |
Request (forward) list groups. | |
used to request a switchboard server to use for conversations. | |
Sends a line to the other end of the connection. (inherited from LineReceiver )
| |
called when the server has notified us that it is going down for maintenance. | |
Sets the line-mode of this receiver. (inherited from LineReceiver )
| |
Set/change my phone numbers stored on the server. | |
set my privacy mode on the server. | |
Sets the raw mode of this receiver. (inherited from LineReceiver )
| |
called when our status changes and it isn't in response to a client command. | |
used for keeping an up-to-date contact list. | |
called when a user adds me to their list. | |
called when a user removes us from their contact list (they are no longer on our reverseContacts list and changes to the underlying list should be made to reflect this). |
Instance Variable Summary | |
---|---|
password
- MSN password | |
screenName
- your screen name | |
userHandle
- your user handle. |
Method Details |
---|
addContact(self, listType, userHandle, groupID=0)used to add a contact to the desired list.
|
addListGroup(self, name)used to create a new list group.
|
changeScreenName(self, newName)used to change your current screen name.
|
changeStatus(self, status)change my current status.
|
checkMessage(self, message)hook used for detecting specific notification messages |
connectionMade(self)Called when a connection is made. This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
|
contactOffline(self, userHandle)called when a contact goes offline.
|
contactStatusChanged(self, statusCode, userHandle, screenName)called when we're notified that a contact's status has changed.
|
gotContactStatus(self, statusCode, userHandle, screenName)called after loggin in when the server sends status of online contacts.
|
gotPhoneNumber(self, listVersion, userHandle, phoneType, number)called when the server sends us phone details about a specific user (for example after a user is added the server will send their status, phone details etc ...
|
gotProfile(self, message)called after logging in when the server sends an initial message with MSN/passport specific profile information such as country, number of kids, etc... Check the message headers for the specific values.
|
gotSwitchboardInvitation(self, sessionID, host, port, key, userHandle, screenName)called when we get an invitation to a switchboard server. This happens when a user requests a chat session with us.
|
loggedIn(self, userHandle, screenName, verified)called when the client has logged in
|
logOut(self)used to log out of the notification server. After running the method the server is expected to close the connection. |
multipleLogin(self)called when the server says there has been another login under our account, the server should disconnect us right away. |
remContact(self, listType, userHandle, groupID=0)used to remove a contact from the desired list.
|
remListGroup(self, groupID)used to remove a list group.
|
renameListGroup(self, groupID, newName)used to rename an existing list group.
|
requestList(self, listType)request the desired list type
|
requestListGroups(self)Request (forward) list groups.
|
requestSwitchboardServer(self)used to request a switchboard server to use for conversations.
|
serverGoingDown(self)called when the server has notified us that it is going down for maintenance. |
setPhoneDetails(self, phoneType, value)Set/change my phone numbers stored on the server.
|
setPrivacyMode(self, privLevel)set my privacy mode on the server. Note: This only keeps the current privacy setting on the server for later retrieval, it does not effect the way the server works at all.
|
statusChanged(self, statusCode)called when our status changes and it isn't in response to a client command.
|
syncList(self, version)used for keeping an up-to-date contact list.
|
userAddedMe(self, userHandle, screenName, listVersion)called when a user adds me to their list. (ie. they have been added to the reverse list.
|
userRemovedMe(self, userHandle, listVersion)called when a user removes us from their contact list (they are no longer on our reverseContacts list and changes to the underlying list should be made to reflect this).
|
Instance Variable Details |
---|
passwordMSN password |
screenNameyour screen name |
userHandleyour user handle. |
Home | Trees | Index | Help |
---|
Generated by Epydoc 1.1 on Fri Jun 27 03:45:51 2003 | http://epydoc.sf.net |