t.w.i.i.IChatUI(Interface) : interface documentation

Part of twisted.words.im.interfaces View Source View In Hierarchy

No interface docstring

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
Method	getGroupConversation	For the given group object, returns the group conversation window or
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

def registerAccountClient(client): (source)

Notifies user that an account has been signed on to.

Parameters client (type: Client )

def unregisterAccountClient(client): (source)

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

Parameters client (type: Client )

def getContactsList(): (source)

Returns (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	(type: `Person` )
	Class	(type: `Conversation` class )
	stayHidden	(type: boolean )
Returns	(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	(type: `Group` )
	Class	(type: `Conversation` class )
	stayHidden	(type: boolean )
Returns	(type: `GroupConversation` )

def getPerson(name, client): (source)

Get a Person for a client.

Duplicates IAccount.getPerson.

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

def getGroup(name, client): (source)

Get a Group for a client.

Duplicates IAccount.getGroup.

Parameters	name	(type: string )
	client	(type: `Client` )
Returns	(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	(type: string )
	newnick	(type: string )

API Documentation for Twisted, generated by pydoctor at 2011-04-03 00:32:03.