twisted.words.service.ChatAvatar : API documentation

Method	__init__	Undocumented
Instance Variable	avatar	Undocumented
Method	jellyFor	(internal)
Method	remote_join	Undocumented
Property	name	A short string, unique among users. This will be set by the `IChatService` at login time.
Method	name.setter	Undocumented
Method	groupMetaUpdate	Callback notifying this user that the metadata for the given group has changed.
Method	receive	Callback notifying this user of the given message sent by the given user.
Method	userJoined	Callback notifying this user that the given user has joined the given group.
Method	userLeft	Callback notifying this user that the given user has left the given group for the given reason.

Inherited from Referenceable:

Class Variable	perspective	I am an object sent remotely as a direct reference.
Method	remoteMessageReceived	A remote message has been received. Dispatch it appropriately.

Inherited from Serializable (via Referenceable):

Method

processUniqueID

Return an ID which uniquely represents this object for this process.

Inherited from Jellyable (via Referenceable, Serializable):

Method

getStateFor

Undocumented

def __init__(self, avatar): (source)

Undocumented

avatar = (source)

Undocumented

def jellyFor(self, jellier): (source)

from twisted.spread.interfaces.IJellyable

overrides twisted.spread.pb.Referenceable.jellyFor

(internal)

Return a tuple which will be used as the s-expression to serialize this to a peer.

def remote_join(self, groupName): (source)

Undocumented

@property
name = (source)

from twisted.words.iwords.IChatClient

A short string, unique among users. This will be set by the IChatService at login time.

@name.setter
def name(self, value): (source)

Undocumented

def groupMetaUpdate(self, group, meta): (source)

from twisted.words.iwords.IChatClient

Callback notifying this user that the metadata for the given group has changed.

Parameters	group	Undocumented (type: `IGroup`)
	meta	Undocumented (type: `dict`)
Returns	Undocumented (type: `twisted.internet.defer.Deferred`)

def receive(self, sender, recipient, message): (source)

from twisted.words.iwords.IChatClient

Callback notifying this user of the given message sent by the given user.

This will be invoked whenever another user sends a message to a group this user is participating in, or whenever another user sends a message directly to this user. In the former case, recipient will be the group to which the message was sent; in the latter, it will be the same object as the user who is receiving the message.

Parameters	sender	Undocumented (type: `IUser`)
	recipient	Undocumented (type: `IUser` or `IGroup`)
	message	Undocumented (type: `dict`)
Returns	A Deferred which fires when the message has been delivered, or which fails in some way. If the Deferred fails and the message was directed at a group, this user will be removed from that group. (type: `twisted.internet.defer.Deferred`)

def userJoined(self, group, user): (source)

from twisted.words.iwords.IChatClient

Callback notifying this user that the given user has joined the given group.

Parameters	group	Undocumented (type: `IGroup`)
	user	Undocumented (type: `IUser`)
Returns	Undocumented (type: `twisted.internet.defer.Deferred`)

def userLeft(self, group, user, reason=None): (source)

from twisted.words.iwords.IChatClient

Callback notifying this user that the given user has left the given group for the given reason.

Parameters	group	Undocumented (type: `IGroup`)
	user	Undocumented (type: `IUser`)
	reason	Undocumented (type: `unicode`)
Returns	Undocumented (type: `twisted.internet.defer.Deferred`)