twisted.words.im.basechat.ChatUI : API documentation

A GUI chat client.

Instance Variables	conversations	A cache of all the direct windows. (type: `dict` of `Conversation`. )
	groupConversations	A cache of all the group windows. (type: `dict` of `GroupConversation`. )
	persons	A cache of all the users associated with this client. (type: `dict` with keys that are a `tuple` of (`str`, `basesupport.AbstractAccount`) and values that are `Person`. )
	groups	A cache of all the user groups associated with this client. (type: `dict` with keys that are a `tuple` of (`str`, `basesupport.AbstractAccount`) and values that are `Group` )
	onlineClients	A list of message sources currently online. (type: `list` of `Client` )
	contactsList	A contacts list. (type: `ContactsList` )

Method	__init__	Undocumented
Method	registerAccountClient	Notifies user that an account has been signed on to.
Method	unregisterAccountClient	Notifies user that an account has been signed off or disconnected
Method	getContactsList
Method	getConversation	For the given person object, returns the conversation window or creates and returns a new conversation window if one does not exist.
Method	getGroupConversation	For the given group object, returns the group conversation window or creates and returns a new group conversation window if it doesn't exist
Method	getPerson	For the given name and account client, returns the instance of the AbstractPerson subclass, or creates and returns a new AbstractPerson subclass of the type Class
Method	getGroup	For the given name and account client, returns the instance of the AbstractGroup subclass, or creates and returns a new AbstractGroup subclass of the type Class
Method	contactChangedNick	For the given `person`, change the `person`'s `name` to `newnick` and tell the contact list and any conversation windows with that `person` to change as well.

def getConversation(self, person, Class=Conversation, stayHidden=0): (source)

For the given person object, returns the conversation window or creates and returns a new conversation window if one does not exist.

Parameters	person	(type: `Person` )
	Class	(type: `Conversation` class )
	stayHidden	(type: boolean )
Returns	(type: `Conversation` )

def getGroupConversation(self, group, Class=GroupConversation, stayHidden=0): (source)

For the given group object, returns the group conversation window or creates and returns a new group conversation window if it doesn't exist

Parameters	group	(type: `Group` )
	Class	(type: `Conversation` class )
	stayHidden	(type: boolean )
Returns	(type: `GroupConversation` )

def getPerson(self, name, client): (source)

For the given name and account client, returns the instance of the AbstractPerson subclass, or creates and returns a new AbstractPerson subclass of the type Class

Parameters	name	(type: string )
	client	(type: `Client` )
Returns	(type: `Person` )

def getGroup(self, name, client): (source)

For the given name and account client, returns the instance of the AbstractGroup subclass, or creates and returns a new AbstractGroup subclass of the type Class

Parameters	name	(type: string )
	client	(type: `Client` )
Returns	(type: `Group` )

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

For the given person, change the person's name to newnick and tell the contact list and any conversation windows with that person to change as well.

Parameters	person	The person whose nickname will get changed. (type: `Person` )
	newnick	The new `name` `person` will take. (type: `str` )

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