twisted.words.im.interfaces.IChatUI : API documentation

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`	Get a Person for a client.
Method	`getGroup`	Get a Group for a client.
Method	`contactChangedNick`	For the given person, changes the person's name to newnick, and tells the contact list and any conversation windows with that person to change as well.

def registerAccountClient(client): (source)

Notifies user that an account has been signed on to.

Parameters client Undocumented (type: Client)

def unregisterAccountClient(client): (source)

Notifies user that an account has been signed off or disconnected.

Parameters client Undocumented (type: Client)

def getContactsList(): (source)

Returns Undocumented (type: ContactsList)

def getConversation(person, Class, 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	Undocumented (type: `Person`)
	Class	Undocumented (type: `Conversation` class)
	stayHidden	Undocumented (type: boolean)
Returns	Undocumented (type: `Conversation`)

def getGroupConversation(group, Class, 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	Undocumented (type: `Group`)
	Class	Undocumented (type: `Conversation` class)
	stayHidden	Undocumented (type: boolean)
Returns	Undocumented (type: `GroupConversation`)

def getPerson(name, client): (source)

Get a Person for a client.

Duplicates IAccount.getPerson.

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

def getGroup(name, client): (source)

Get a Group for a client.

Duplicates IAccount.getGroup.

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

def contactChangedNick(oldnick, newnick): (source)

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

Parameters	oldnick	Undocumented (type: string)
	newnick	Undocumented (type: string)