twisted.words.im.interfaces.IGroup : API documentation

interface documentation

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

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.

My str name, as the server knows me.

The Account I am accessed through.

def __init__(name, account): (source)

Initialize me.

Parameters	name	My name, as the server knows me. (type: str)
	account	The account I am accessed through. (type: `Account`)

def setTopic(text): (source)

Set this Groups topic on the server.

Parameters text Undocumented (type: string)

def sendGroupMessage(text, metadata=None): (source)

Send a message to this group.

Parameters	text	Undocumented (type: str)
	metadata	Valid 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 20.12.1 at 2021-02-28 19:53:36.