twisted.words.im.interfaces.IChatUI

interface documentation

class IChatUI(Interface): (source)

View In Hierarchy

Undocumented

Method contact​Changed​Nick 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.
Method get​Contacts​List
Method get​Conversation For the given person object, returns the conversation window or creates and returns a new conversation window if one does not exist.
Method get​Group Get a Group for a client.
Method get​Group​Conversation 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 get​Person Get a Person for a client.
Method register​Account​Client Notifies user that an account has been signed on to.
Method unregister​Account​Client Notifies user that an account has been signed off or disconnected.
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:stringUndocumented
newnick:stringUndocumented
def getContactsList(): (source)
Returns
ContactsListUndocumented
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:PersonUndocumented
​Class:Conversation classUndocumented
stay​Hidden:booleanUndocumented
Returns
ConversationUndocumented
def getGroup(name, client): (source)

Get a Group for a client.

Duplicates IAccount.getGroup.

Parameters
name:stringUndocumented
client:ClientUndocumented
Returns
GroupUndocumented
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:GroupUndocumented
​Class:Conversation classUndocumented
stay​Hidden:booleanUndocumented
Returns
GroupConversationUndocumented
def getPerson(name, client): (source)

Get a Person for a client.

Duplicates IAccount.getPerson.

Parameters
name:stringUndocumented
client:ClientUndocumented
Returns
PersonUndocumented
def registerAccountClient(client): (source)
Notifies user that an account has been signed on to.
Parameters
client:ClientUndocumented
def unregisterAccountClient(client): (source)
Notifies user that an account has been signed off or disconnected.
Parameters
client:ClientUndocumented