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

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

A GUI chat client.
Instance Variable conversations A cache of all the direct windows. (type: dict of Conversation)
Instance Variable groupConversations A cache of all the group windows. (type: dict of GroupConversation)
Instance Variable persons A cache of all the users associated with this client. (type: dict with keys that are a tuple of (str, IAccount provider) and values that are IPerson provider)
Instance Variable groups A cache of all the groups associated with this client. (type: dict with keys that are a tuple of (str, IAccount provider) and values that are IGroup provider)
Instance Variable onlineClients A list of message sources currently online. (type: list of IClient providers)
Instance Variable contactsList A contacts list. (type: ContactsList)
Method __init__ Undocumented
Method registerAccountClient Notify the user that an account has been signed on to.
Method unregisterAccountClient Notify the user that an account has been signed off or disconnected.
Method getContactsList Get the contacts list associated with this chat window.
Method getConversation For the given person object, return the conversation window or create and return a new conversation window if one does not exist.
Method getGroupConversation For the given group object, return the group conversation window or create and return a new group conversation window if it doesn't exist.
Method getPerson For the given name and account client, return an instance of a IGroup provider or create and return a new instance of a IGroup provider.
Method getGroup For the given name and account client, return an instance of a IGroup provider or create and return a new instance of a IGroup provider.
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.
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, IAccount provider) and values that are IPerson provider)
groups =
A cache of all the groups associated with this client. (type: dict with keys that are a tuple of (str, IAccount provider) and values that are IGroup provider)
onlineClients =
A list of message sources currently online. (type: list of IClient providers)
contactsList =
A contacts list. (type: ContactsList)
def __init__(self): (source)
Undocumented
def registerAccountClient(self, client): (source)
Notify the user that an account has been signed on to.
ParametersclientThe client account for the person who has just signed on. (type: IClient provider)
ReturnsThe client, so that it may be used in a callback chain. (type: IClient provider)
def unregisterAccountClient(self, client): (source)
Notify the user that an account has been signed off or disconnected.
ParametersclientThe client account for the person who has just signed off. (type: IClient provider)
def getContactsList(self): (source)
Get the contacts list associated with this chat window.
ReturnsThe contacts list associated with this chat window. (type: ContactsList)
def getConversation(self, person, Class=Conversation, stayHidden=False): (source)
For the given person object, return the conversation window or create and return a new conversation window if one does not exist.
ParameterspersonThe person whose conversation window we want to get. (type: IPerson provider)
The kind of conversation window we want. If the conversation window for this person didn't already exist, create one of this type.
stayHiddenWhether or not the conversation window should stay hidden. (type: bool)
ReturnsThe conversation window. (type: IConversation provider)
def getGroupConversation(self, group, Class=GroupConversation, stayHidden=False): (source)
For the given group object, return the group conversation window or create and return a new group conversation window if it doesn't exist.
ParametersgroupThe group whose conversation window we want to get. (type: IGroup provider)
The kind of conversation window we want. If the conversation window for this person didn't already exist, create one of this type.
stayHiddenWhether or not the conversation window should stay hidden. (type: bool)
ReturnsThe group conversation window. (type: IGroupConversation provider)
def getPerson(self, name, client): (source)
For the given name and account client, return an instance of a IGroup provider or create and return a new instance of a IGroup provider.
ParametersnameThe name of the person of interest. (type: str)
clientThe client account of interest. (type: IClient provider)
ReturnsThe person with that name. (type: IPerson provider)
def getGroup(self, name, client): (source)
For the given name and account client, return an instance of a IGroup provider or create and return a new instance of a IGroup provider.
ParametersnameThe name of the group of interest. (type: str)
clientThe client account of interest. (type: IClient provider)
ReturnsThe group with that name. (type: IGroup provider)
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.
ParameterspersonThe person whose nickname will get changed. (type: IPerson provider)
newnickThe new name person will take. (type: str)
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.