twisted.words.im.basechat.GroupConversation class documentation

Part of twisted.words.im.basechat (View In Hierarchy)

Known subclasses: twisted.words.test.test_ircsupport.StubGroupConversation

A GUI window of a conversation with a group of people.

Instance Variable chatui The GUI chat client associated with this conversation. (type: ChatUI)
Instance Variable group The group of people that are having this conversation. (type: IGroup provider)
Instance Variable members The names of the people in this conversation. (type: list of str)
Method __init__
Method show Display the GroupConversationWindow.
Method hide Hide the GroupConversationWindow.
Method sendText Send text to the group.
Method showGroupMessage Display to the user a message sent to this group from the given sender.
Method setGroupMembers Set the list of members in the group.
Method setTopic Change the topic for the group conversation window and display this change to the user.
Method memberJoined Add the given member to the list of members in the group conversation and displays this to the user.
Method memberChangedNick Change the nickname for a member of the group conversation and displays this change to the user.
Method memberLeft Delete the given member from the list of members in the group conversation and displays the change to the user.
chatui =
The GUI chat client associated with this conversation. (type: ChatUI)
group =
The group of people that are having this conversation. (type: IGroup provider)
members =
The names of the people in this conversation. (type: list of str)
def __init__(self, group, chatui):
ParameterschatuiThe GUI chat client associated with this conversation. (type: ChatUI)
groupThe group of people that are having this conversation. (type: IGroup provider)
def show(self):
overridden in twisted.words.test.test_ircsupport.StubGroupConversation

Display the GroupConversationWindow.

def hide(self):

Hide the GroupConversationWindow.

def sendText(self, text):

Send text to the group.

ParametersThe text to be sent.
def showGroupMessage(self, sender, text, metadata=None):
overridden in twisted.words.test.test_ircsupport.StubGroupConversation

Display to the user a message sent to this group from the given sender.

ParameterssenderThe person sending the message. (type: str)
textThe sent message. (type: str)
metadataMetadata associated with this message. (type: dict)
def setGroupMembers(self, members):

Set the list of members in the group.

ParametersmembersThe names of the people that will be in this group. (type: list of str)
def setTopic(self, topic, author):
overridden in twisted.words.test.test_ircsupport.StubGroupConversation

Change the topic for the group conversation window and display this change to the user.

ParameterstopicThis group's topic. (type: str)
authorThe person changing the topic. (type: str)
def memberJoined(self, member):

Add the given member to the list of members in the group conversation and displays this to the user.

ParametersmemberThe person joining the group conversation. (type: str)
def memberChangedNick(self, oldnick, newnick):

Change the nickname for a member of the group conversation and displays this change to the user.

ParametersoldnickThe old nickname. (type: str)
newnickThe new nickname. (type: str)
def memberLeft(self, member):

Delete the given member from the list of members in the group conversation and displays the change to the user.

ParametersmemberThe person leaving the group conversation. (type: str)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.