twisted.words.iwords.IChatClient(Interface) interface documentationtwisted.words.iwords
View Source
(View In Hierarchy)
Known implementations: twisted.words.service.ChatAvatar, twisted.words.service.IRCUser, twisted.words.service.PBMindReference
Interface through which IChatService interacts with clients.
| Attribute | name | A short string, unique among users. This will be set by the IChatService
at login time. |
| 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. |
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.
| 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) | |
Callback notifying this user that the metadata for the given group has changed.
| Returns | (type: twisted.internet.defer.Deferred) | |
Callback notifying this user that the given user has joined the given group.
| Returns | (type: twisted.internet.defer.Deferred) | |
Callback notifying this user that the given user has left the given group for the given reason.
| Returns | (type: twisted.internet.defer.Deferred) | |