twisted.words.im.basechat.ChatUI
class documentationtwisted.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. |
Notify the user that an account has been signed off or disconnected.
Parameters | client | The client account for the person who has just signed off. (type: IClient
provider) |
Get the contacts list associated with this chat window.
Returns | The contacts list associated with this chat window. (type: ContactsList ) |
For the given person object, return the conversation window or create and return a new conversation window if one does not exist.
Parameters | person | The 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. | ||
stayHidden | Whether or not the conversation window should stay hidden. (type: bool ) | |
Returns | The conversation window. (type: IConversation
provider) |
For the given group object, return the group conversation window or create and return a new group conversation window if it doesn't exist.
Parameters | group | The 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. | ||
stayHidden | Whether or not the conversation window should stay hidden. (type: bool ) | |
Returns | The group conversation window. (type: IGroupConversation
provider) |
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.
Parameters | name | The name of the person of interest. (type: str ) |
client | The client account of interest. (type: IClient
provider) | |
Returns | The person with that name . (type: IPerson
provider) |
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.
Parameters | name | The name of the group of interest. (type: str ) |
client | The client account of interest. (type: IClient
provider) | |
Returns | The group with that name . (type: IGroup
provider) |
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.
Parameters | person | The person whose nickname will get changed. (type: IPerson
provider) |
newnick | The new name person will take. (type: str ) |