Table of Contents

Class: TendrilClient | Twisted-0.19.0/twisted/words/tendril.py
--- | ---
I connect to the IRC server and broker traffic.
Base Classes |
--- | ---
irc.IRCClient wordsService.WordsClientInterface
Methods |
--- | ---
__getstate__ __init__ _getClient _getParticipant _newParticipant action attach attachToWords botUnknown bot_DCC bot_help bot_msg changeParticipantNick connectionLost | ctcpQuery_DCC detach directMessage evacuateGroup groupMessage irc_ERR_BANNEDFROMCHAN irc_ERR_NOTREGISTERED irc_INVITE irc_JOIN irc_KICK irc_NICK irc_PART irc_QUIT irc_TOPIC | isThisMine joinGroup leaveGroup lineReceived log logoutParticipant memberJoined memberLeft msgFromWords noticed privmsg receiveGroupMessage sendLine signedOn
| __getstate__
    __getstate__ ( self )
| __init__
    __init__ (
            self,
            service,
            groupList=None,
            nickname=None,
            networkSuffix=None,
            perspectiveName=None,
            )
### Create a new Tendril client. service a twisted.words.service.Service, or at least something with a `serviceName` attribute and `createParticipant` and `getPerspectiveNamed` methods which work like a words..Service. groupList a list of strings naming groups on the Words service to join and bridge to their counterparts on the IRC server. nickname a string to use as my nickname on the IRC network. networkSuffix a string to append to the nickname of the Participants I bring in through IRC, e.g. "@opn". perspectiveName the name of my perspective with this service. Defaults to nickname + networkSuffix.
| _getClient
    _getClient ( self,  nick )
| _getParticipant
    _getParticipant ( self,  nick )
### Get a Perspective (words.service.Participant) for a IRC user. And if I don't have one around, I'll make one.
| _newParticipant
    _newParticipant ( self,  nick )
Exceptions |
--- | ---
wordsService.wordsError("Eeek! Couldn't get OR " "make a perspective for " "'%s%s'." %( nick, self.networkSuffix ) )
| action
    action (
            self,
            user,
            channel,
            message,
            )
Speak about a participant in third-person.
| attach
    attach ( self )
| attachToWords
    attachToWords ( self )
Get my perspective on the Words service; attach as a client.
Exceptions |
--- | ---
RuntimeError, ("service %s won't give me my " "perspective named %s" %( self.service, self.perspectiveName ) )
| botUnknown
    botUnknown (
            self,
            user,
            channel,
            message,
            )
| bot_DCC
    bot_DCC (
            self,
            user,
            params,
            )
### Commands for brokering DCC handshakes. DCC I'll tell you if I'm holding a DCC request from you. DCC PASSTO nick give the DCC request you gave me to this nick. DCC FORGET forget any DCC requests you offered to me.
| bot_help
    bot_help (
            self,
            user,
            params,
            )
| bot_msg
    bot_msg (
            self,
            sender,
            params,
            )
Pass along a message as a directMessage to a words Participant
| changeParticipantNick
    changeParticipantNick (
            self,
            old_nick,
            new_nick,
            )
| connectionLost
    connectionLost ( self )
When I lose a connection, log out all my IRC participants.
| ctcpQuery_DCC
    ctcpQuery_DCC (
            self,
            user,
            channel,
            data,
            )
Accept DCC handshakes, for passing on to others.
| detach
    detach ( self )
Pull everyone off Words, sign off, cut the IRC connection.
| directMessage
    directMessage (
            self,
            recipientName,
            message,
            )
| evacuateGroup
    evacuateGroup ( self,  groupName )
Pull all of my Participants out of this group.
| groupMessage
    groupMessage (
            self,
            groupName,
            message,
            )
| irc_ERR_BANNEDFROMCHAN
    irc_ERR_BANNEDFROMCHAN (
            self,
            prefix,
            params,
            )
When I can't get on a channel, report it.
| irc_ERR_NOTREGISTERED
    irc_ERR_NOTREGISTERED (
            self,
            prefix,
            params,
            )
| irc_INVITE
    irc_INVITE (
            self,
            prefix,
            params,
            )
Accept an invitation, if it's in my groupList.
| irc_JOIN
    irc_JOIN (
            self,
            prefix,
            params,
            )
Join IRC user to the corresponding group.
| irc_KICK
    irc_KICK (
            self,
            prefix,
            params,
            )
Kicked? Who? Not me, I hope.
| irc_NICK
    irc_NICK (
            self,
            prefix,
            params,
            )
### When an IRC user changes their nickname this does not change the name of their perspectivee, just my nickname->perspective and client->nickname mappings.
| irc_PART
    irc_PART (
            self,
            prefix,
            params,
            )
Parting IRC members leave the correspoding group.
| irc_QUIT
    irc_QUIT (
            self,
            prefix,
            params,
            )
When a user quits IRC, log out their participant.
| irc_TOPIC
    irc_TOPIC (
            self,
            prefix,
            params,
            )
Announce the new topic.
| isThisMine
    isThisMine ( self,  sender )
Returns true if `sender` is the name of a perspective I'm providing.
| joinGroup
    joinGroup ( self,  groupName )
| leaveGroup
    leaveGroup ( self,  groupName )
| lineReceived
    lineReceived ( self,  line )
| log
    log (
            self,
            message,
            priority=None,
            )
I need to give Twisted a prioritized logging facility one of these days.
| logoutParticipant
    logoutParticipant ( self,  nick )
| memberJoined
    memberJoined (
            self,
            member,
            group,
            )
Tell the IRC Channel when someone joins the Words group.
| memberLeft
    memberLeft (
            self,
            member,
            group,
            )
Tell the IRC Channel when someone leaves the Words group.
| msgFromWords
    msgFromWords (
            self,
            toNick,
            sender,
            message,
            metadata=None,
            )
Deliver a directMessage as a privmsg over IRC.
| noticed
    noticed (
            self,
            user,
            channel,
            message,
            )
Pass channel notices on to the group.
| privmsg
    privmsg (
            self,
            user,
            channel,
            message,
            )
Dispatch privmsg as a groupMessage or a command, as appropriate.
| receiveGroupMessage
    receiveGroupMessage (
            self,
            sender,
            group,
            message,
            metadata=None,
            )
### Pass a message from the Words group on to IRC. Or, if it's in our errorGroup, recognize some debugging commands.
| sendLine
    sendLine ( self,  line )
Send a line through my transport, unless my transport isn't up.
| signedOn
    signedOn ( self )
Join my groupList once I've signed on.

Table of Contents

This document was automatically generated on Sun Jul 14 19:53:46 2002 by HappyDoc version 2.0