twisted.words.im.interfaces.IPerson

interface documentation

class IPerson(Interface): (source)

View In Hierarchy

Undocumented

Method __init__ Initialize me.
Method isOnline Am I online right now?
Method getStatus What is my on-line status?
Method getIdleTime
Method sendMessage Send a message to this person.
def __init__(name, account): (source)

Initialize me.

ParametersnameMy name, as the server knows me. (type: string)
accountThe account I am accessed through. (type: Account)
def isOnline(): (source)

Am I online right now?

ReturnsUndocumented (type: boolean)
def getStatus(): (source)

What is my on-line status?

Returnslocals.StatusEnum
def getIdleTime(): (source)
ReturnsUndocumented (type: string (XXX: How about a scalar?))
def sendMessage(text, metadata=None): (source)

Send a message to this person.

ParameterstextUndocumented (type: string)
metadataUndocumented (type: dict)
API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.