interface documentation

class twisted.words.im.interfaces.IChatUI(Interface): (source)

View In Hierarchy

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 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 tells the contact list and any conversation windows with that person to change as well.
def registerAccountClient(client): (source)

Notifies user that an account has been signed on to.

ParametersclientUndocumented (type: Client)
def unregisterAccountClient(client): (source)

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

ParametersclientUndocumented (type: Client)
def getContactsList(): (source)
ReturnsUndocumented (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.

ParameterspersonUndocumented (type: Person)
ClassUndocumented (type: Conversation class)
stayHiddenUndocumented (type: boolean)
ReturnsUndocumented (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.

ParametersgroupUndocumented (type: Group)
ClassUndocumented (type: Conversation class)
stayHiddenUndocumented (type: boolean)
ReturnsUndocumented (type: GroupConversation)
def getPerson(name, client): (source)

Get a Person for a client.

Duplicates IAccount.getPerson.

ParametersnameUndocumented (type: string)
clientUndocumented (type: Client)
ReturnsUndocumented (type: Person)
def getGroup(name, client): (source)

Get a Group for a client.

Duplicates IAccount.getGroup.

ParametersnameUndocumented (type: string)
clientUndocumented (type: Client)
ReturnsUndocumented (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.

ParametersoldnickUndocumented (type: string)
newnickUndocumented (type: string)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.