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

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

This class represents a contact (user).

Instance Variable	userHandle	The contact's user handle (passport).
Instance Variable	screenName	The contact's screen name.
Instance Variable	groups	A list of all the group IDs which this contact belongs to.
Instance Variable	lists	An integer representing the sum of all lists that this contact belongs to.
Instance Variable	status	The contact's status code. (type: str if contact's status is known, None otherwise.)
Instance Variable	homePhone	The contact's home phone number. (type: str if known, otherwise None.)
Instance Variable	workPhone	The contact's work phone number. (type: str if known, otherwise None.)
Instance Variable	mobilePhone	The contact's mobile phone number. (type: str if known, otherwise None.)
Instance Variable	hasPager	Whether or not this user has a mobile pager (true=yes, false=no)
Method	__init__	Undocumented
Method	setPhone	set phone numbers/values for this specific user. for phoneType check the *_PHONE constants and HAS_PAGER
Method	addToList	Update the lists attribute to reflect being part of the given list.
Method	removeFromList	Update the lists attribute to reflect being removed from the given list.

userHandle =

The contact's user handle (passport).

screenName =

The contact's screen name.

groups =

A list of all the group IDs which this contact belongs to.

lists =

An integer representing the sum of all lists that this contact belongs to.

status =

The contact's status code. (type: str if contact's status is known, None otherwise.)

homePhone =

The contact's home phone number. (type: str if known, otherwise None.)

workPhone =

The contact's work phone number. (type: str if known, otherwise None.)

mobilePhone =

The contact's mobile phone number. (type: str if known, otherwise None.)

hasPager =

Whether or not this user has a mobile pager (true=yes, false=no)

def __init__(self, userHandle='', screenName='', lists=0, groups=, status=None): (source)

Undocumented

def setPhone(self, phoneType, value): (source)

set phone numbers/values for this specific user. for phoneType check the *_PHONE constants and HAS_PAGER

def addToList(self, listType): (source)

Update the lists attribute to reflect being part of the given list.

def removeFromList(self, listType): (source)

Update the lists attribute to reflect being removed from the given list.