t.w.i.i.IGroup(Interface) : interface documentation

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

Known implementations: twisted.words.im.ircsupport.IRCGroup, twisted.words.im.pbsupport.TwistedWordsGroup, twisted.words.im.tocsupport.TOCGroup

A group which you may have a conversation with.

Groups generally have a loosely-defined set of members, who may leave and join at any time.
Attribute name My str name, as the server knows me.
Attribute account The Account I am accessed through.
Method __init__ Initialize me.
Method setTopic Set this Groups topic on the server.
Method sendGroupMessage Send a message to this group.
Method join Join this group.
Method leave Depart this group.
name =
My str name, as the server knows me.
account =
The Account I am accessed through.
def __init__(name, account): (source)
Initialize me.
ParametersnameMy name, as the server knows me. (type: str )
accountThe account I am accessed through. (type: Account )
def setTopic(text): (source)
Set this Groups topic on the server.
Parameterstext (type: string )
def sendGroupMessage(text, metadata=None): (source)
Send a message to this group.
Parameterstext (type: str )
metadataValid keys for this dictionary include:
  • 'style': associated with one of:
    • 'emote': indicates this is an action
(type: dict )
def join(): (source)
Join this group.
def leave(): (source)
Depart this group.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.