twisted.words.protocols.msn.MSNContactList : API documentation

t.w.p.m.MSNContactList : class documentation

This class represents a basic MSN contact list.

Instance Variable	contacts	All contacts on my various lists (type: dict (mapping user handles to MSNContact objects))
Instance Variable	version	The current contact list version (used for list syncing)
Instance Variable	groups	a mapping of group ids to group names (groups can only exist on the forward list) (type: dict Note: This is used only for storage and doesn't effect the server's contact list. )
Method	__init__	Undocumented
Method	addContact	Add a contact
Method	remContact	Remove a contact
Method	getContact	No summary
Method	getBlockedContacts	Obtain all the contacts on my block list
Method	getAuthorizedContacts	Obtain all the contacts on my auth list. (These are contacts which I have verified can view my state changes).
Method	getReverseContacts	Get all contacts on my reverse list. (These are contacts which have added me to their forward list).
Method	getContacts	Get all contacts on my forward list. (These are the contacts which I have added to my list).
Method	setGroup	Keep a mapping from the given id to the given name.
Method	remGroup	Removed the stored group mapping for the given id.
Method	_getContactsFromList	Obtain all contacts which belong to the given list type.

contacts =

All contacts on my various lists (type: dict (mapping user handles to MSNContact objects))

version =

The current contact list version (used for list syncing)

groups =

a mapping of group ids to group names (groups can only exist on the forward list) (type: dict

Note: This is used only for storage and doesn't effect the server's contact list.

)

def __init__(self): (source)

Undocumented

def _getContactsFromList(self, listType): (source)

Obtain all contacts which belong to the given list type.

def addContact(self, contact): (source)

Add a contact

def remContact(self, userHandle): (source)

Remove a contact

def getContact(self, userHandle): (source)

Obtain the MSNContact object associated with the given userHandle.

Returns the MSNContact object if the user exists, or None.

def getBlockedContacts(self): (source)

Obtain all the contacts on my block list

def getAuthorizedContacts(self): (source)

Obtain all the contacts on my auth list. (These are contacts which I have verified can view my state changes).

def getReverseContacts(self): (source)

Get all contacts on my reverse list. (These are contacts which have added me to their forward list).

def getContacts(self): (source)

Get all contacts on my forward list. (These are the contacts which I have added to my list).

def setGroup(self, id, name): (source)

Keep a mapping from the given id to the given name.

def remGroup(self, id): (source)

Removed the stored group mapping for the given id.