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

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

A GUI chat client
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, changes the person's name to newnick, and tells the contact list and any conversation windows with that person to change as well.
def __init__(self): (source)
Undocumented
def registerAccountClient(self, client): (source)
Notifies user that an account has been signed on to.
Parametersclient (type: Client )
Returnsclient, so that I may be used in a callback chain
def unregisterAccountClient(self, client): (source)
Notifies user that an account has been signed off or disconnected
Parametersclient (type: Client )
def getContactsList(self): (source)
Returns (type: ContactsList )
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.
Parametersperson (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
Parametersgroup (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
Parametersname (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
Parametersname (type: string )
client (type: Client )
Returns (type: Group )
def contactChangedNick(self, 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.
Parametersoldnick (type: string )
newnick (type: string )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:07:41.