t.w.i.b.ContactsList : class documentation

A GUI object that displays a contacts list.

Instance Variable	chatui	The GUI chat client associated with this contacts list. (type: `ChatUI`)
Instance Variable	contacts	The contacts. (type: `dict` mapping `str` to a `IPerson` provider)
Instance Variable	onlineContacts	The contacts who are currently online (have a status that is not `OFFLINE`). (type: `dict` mapping `str` to a `IPerson` provider)
Instance Variable	clients	The signed-on clients. (type: `list` of `IClient` providers)
Method	__init__
Method	setContactStatus	Inform the user that a person's status has changed.
Method	registerAccountClient	Notify the user that an account client has been signed on to.
Method	unregisterAccountClient	Notify the user that an account client has been signed off or disconnected from.
Method	contactChangedNick	Update your contact information to reflect a change to a contact's nickname.

chatui =

The GUI chat client associated with this contacts list. (type: ChatUI)

contacts =

The contacts. (type: dict mapping str to a IPerson provider)

onlineContacts =

The contacts who are currently online (have a status that is not OFFLINE). (type: dict mapping str to a IPerson provider)

clients =

The signed-on clients. (type: list of IClient providers)

def __init__(self, chatui): (source)

Parameters chatui The GUI chat client associated with this contacts list. (type: ChatUI)

def setContactStatus(self, person): (source)

Inform the user that a person's status has changed.

Parameters person The person whose status has changed. (type: IPerson provider)

def registerAccountClient(self, client): (source)

Notify the user that an account client has been signed on to.

Parameters client The client being added to your list of account clients. (type: IClient provider)

def unregisterAccountClient(self, client): (source)

Notify the user that an account client has been signed off or disconnected from.

Parameters client The client being removed from the list of account clients. (type: IClient provider)

def contactChangedNick(self, person, newnick): (source)

Update your contact information to reflect a change to a contact's nickname.

Parameters	person	The person in your contacts list whose nickname is changing. (type: `IPerson` provider)
	newnick	The new nickname for this person. (type: `str`)

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.