twisted.words.protocols.msn.NotificationClient(MSNEventBase) class documentation

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.

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

hook used for detecting specific notification messages

Called when the client has logged in. The default behaviour of this method is to update the factory with our screenName and to sync the contact list (factory.contacts). When this is complete self.listSynchronized will be called.

Called when the client fails to login.

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.

Lists are now synchronized by default upon logging in, this method is called after the synchronization has finished and the factory now has the up-to-date contacts.

Called when our status changes and it isn't in response to a client command. By default we will update the status attribute of the factory.

Called after loggin in when the server sends status of online contacts. By default we will update the status attribute of the contact stored on the factory.

Called when we're notified that a contact's status has changed. By default we will update the status attribute of the contact stored on the factory.

Called when a contact goes offline. By default this method will update the status attribute of the contact stored on the factory.

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. By default we will update the list version for the factory's contact list and update the phone details for the specific user.

Called when a user adds me to their list. (ie. they have been added to the reverse list. By default this method will update the version of the factory's contact list -- that is, if the contact already exists it will update the associated lists attribute, otherwise it will create a new MSNContact object and store it.

Called when a user removes us from their contact list (they are no longer on our reverseContacts list. By default this method will update the version of the factory's contact list -- that is, the user will be removed from the reverse list and if they are no longer part of any lists they will be removed from the contact list entirely.

Called when we get an invitation to a switchboard server. This happens when a user requests a chat session with us.

Called when the server says there has been another login under our account, the server should disconnect us right away.

Called when the server has notified us that it is going down for maintenance.

Change my current status. This method will add a default callback to the returned Deferred which will update the status attribute of the factory.

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.

Used for keeping an up-to-date contact list. A callback is added to the returned Deferred that updates the contact list on the factory and also sets my state to STATUS_ONLINE.

Note: This is called automatically upon signing in using the version attribute of factory.contacts, so you may want to persist this object accordingly. Because of this there is no real need to ever call this method directly.

Set/change my phone numbers stored on the server.

Used to create a new list group. A default callback is added to the returned Deferred which updates the contacts attribute of the factory.

Used to remove a list group. A default callback is added to the returned Deferred which updates the contacts attribute of the factory.

Used to rename an existing list group. A default callback is added to the returned Deferred which updates the contacts attribute of the factory.

Used to add a contact to the desired list. A default callback is added to the returned Deferred which updates the contacts attribute of the factory with the new contact information. If you are adding a contact to the forward list and you want to associate this contact with multiple groups then you will need to call this method for each group you would like to add them to, changing the groupID parameter. The default callback will take care of updating the group information on the factory's contact list.

Used to remove a contact from the desired list. A default callback is added to the returned deferred which updates the contacts attribute of the factory to reflect the new contact information. If you are removing from the forward list then you will need to supply a groupID, if the contact is in more than one group then they will only be removed from this group and not the entire forward list, but if this is their only group they will be removed from the whole list.

Used to change your current screen name. A default callback is added to the returned Deferred which updates the screenName attribute of the factory and also updates the contact list version.

Used to request a switchboard server to use for conversations.

Used to log out of the notification server. After running the method the server is expected to close the connection.