twisted.words.im.interfaces.IGroup(Interface) interface documentation

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

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

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):

Initialize me.

ParametersnameMy name, as the server knows me. (type: str)
accountThe account I am accessed through. (type: Account)
def setTopic(text):

Set this Groups topic on the server.

def sendGroupMessage(text, metadata=None):

Send a message to this group.

ParametersmetadataValid keys for this dictionary include:
  • 'style': associated with one of:
    • 'emote': indicates this is an action
(type: dict)
def join():

Join this group.

def leave():

Depart this group.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.