twisted.words.service.PBMindReference : API documentation

Method	receive	Callback notifying this user of the given message sent by the given user.
Method	groupMetaUpdate	Callback notifying this user that the metadata for the given group has changed.
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 RemoteReference:

Method	__init__	(internal) Initialize me with a broker and a locally-unique ID.
Method	notifyOnDisconnect	Register a callback to be called if our broker gets disconnected.
Method	dontNotifyOnDisconnect	Remove a callback that was registered with notifyOnDisconnect.
Method	jellyFor	If I am being sent back to where I came from, serialize as a local backreference.
Method	unjellyFor	Unjelly myself for the jellier.
Method	callRemote	Asynchronously invoke a remote method.
Method	remoteMethod	Get a `RemoteMethod` for this key.
Method	__cmp__	Compare me [to another `RemoteReference`].
Method	__hash__	Hash me.
Method	__del__	Do distributed reference counting on finalization.
Method	_disconnected	Called if we are disconnected and have callbacks registered.

Inherited from Serializable (via RemoteReference):

Method

processUniqueID

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

Inherited from Jellyable (via RemoteReference, Serializable):

Method

getStateFor

Undocumented

Inherited from Ephemeral (via RemoteReference):

Method	__getstate__	Undocumented
Method	__setstate__	Undocumented

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	(type: `IUser` )
	recipient	(type: `IUser` or `IGroup` )
	message	(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 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	(type: `IGroup` )
	meta	(type: `dict` )
Returns	(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	(type: `IGroup` )
	user	(type: `IUser` )
Returns	(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	(type: `IGroup` )
	user	(type: `IUser` )
	reason	(type: `unicode` )
Returns	(type: `twisted.internet.defer.Deferred` )

t.w.s.PBMindReference(pb.RemoteReference) : class documentation