twisted.words.im.basechat.GroupConversation : API documentation

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

Instance Variables	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` )

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.

def __init__(self, group, chatui): (source)

Parameters	chatui	The GUI chat client associated with this conversation. (type: `ChatUI` )
	group	The group of people that are having this conversation. (type: `IGroup` provider )

def sendText(self, text): (source)

Send text to the group.

Parameters	The text to be sent.
	text	(type: `str` )

def showGroupMessage(self, sender, text, metadata=None): (source)

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

Parameters	sender	The person sending the message. (type: `str` )
	text	The sent message. (type: `str` )
	metadata	Metadata associated with this message. (type: `dict` )

def setGroupMembers(self, members): (source)

Set the list of members in the group.

Parameters members The names of the people that will be in this group. (type: list of str )

def setTopic(self, topic, author): (source)

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

Parameters	topic	This group's topic. (type: `str` )
	author	The person changing the topic. (type: `str` )

def memberJoined(self, member): (source)

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

Parameters member The person joining the group conversation. (type: str )

def memberChangedNick(self, oldnick, newnick): (source)

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

Parameters	oldnick	The old nickname. (type: `str` )
	newnick	The new nickname. (type: `str` )

def memberLeft(self, member): (source)

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

Parameters member The person leaving the group conversation. (type: str )

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