API docs for “plugins.ircClient.example.Plugin”

Class p.i.e.Plugin(chatMod.chatMod):

Part of plugins.ircClient.example View Source View In Hierarchy

Undocumented
Method __init__ Undocumented
Method joined we have joined a channel
Method command a command message received
Method query a private message received
Method msg message received
Method connectionMade made connection to server
Method connectionLost lost connection to server
Method signedOn successfully signed on
Method left we have left a channel
Method noticed we got a notice
Method action action (/me) received
Method modeChanged mode changed
Method kickedFrom someone kicked the bot
Method userKicked someone kicked someone else
Method userJoined a user joined the channel
Method userJoinedMask Undocumented
Method userLeft a user left the channel
Method userQuit a user disconnect from the network
Method yourHost info about your host
Method userRenamed a user changed the nick
Method topicUpdated a user changed the topic of a channel
Method irc_unknown an IRC-Message, which is not handle by twisted was received
Method stop called, when the bot is stopped, or the module is reloaded
Method reload called to reload the settings of the module
Method start called to start the work of the module
Method sendLine Undocumented
Method lineReceived Undocumented
Method ctcpQuery called for ctcp queries

Inherited from chatMod:

Method auth check the authorisation of the user

Inherited from Plugin (via chatMod):

Method register_ctl_command register commands in control service
Method setLogger set the logger
Class Meta Undocumented
def __init__(self, bot): (source)
overrides lib.chatMod.chatMod.__init__
Undocumented
def joined(self, channel): (source)
overrides lib.chatMod.chatMod.joined
we have joined a channel
def command(self, user, channel, command, options): (source)
overrides lib.chatMod.chatMod.command
a command message received
def query(self, user, channel, msg): (source)
overrides lib.chatMod.chatMod.query
a private message received
def msg(self, user, channel, msg): (source)
overrides lib.chatMod.chatMod.msg
message received
def connectionMade(self): (source)
overrides lib.chatMod.chatMod.connectionMade
made connection to server
def connectionLost(self, reason): (source)
overrides lib.chatMod.chatMod.connectionLost
lost connection to server
def signedOn(self): (source)
overrides lib.chatMod.chatMod.signedOn
successfully signed on
def left(self, channel): (source)
overrides lib.chatMod.chatMod.left
we have left a channel
def noticed(self, user, channel, msg): (source)
overrides lib.chatMod.chatMod.noticed
we got a notice
def action(self, user, channel, msg): (source)
overrides lib.chatMod.chatMod.action
action (/me) received
def modeChanged(self, user, channel, set, modes, args): (source)
overrides lib.chatMod.chatMod.modeChanged
mode changed
def kickedFrom(self, channel, kicker, message): (source)
overrides lib.chatMod.chatMod.kickedFrom
someone kicked the bot
def userKicked(self, kickee, channel, kicker, message): (source)
overrides lib.chatMod.chatMod.userKicked
someone kicked someone else
def userJoined(self, user, channel): (source)
overrides lib.chatMod.chatMod.userJoined
a user joined the channel
def userJoinedMask(self, user, channel): (source)
overrides lib.chatMod.chatMod.userJoinedMask
Undocumented
def userLeft(self, user, channel): (source)
overrides lib.chatMod.chatMod.userLeft
a user left the channel
def userQuit(self, user, quitMessage): (source)
overrides lib.chatMod.chatMod.userQuit
a user disconnect from the network
def yourHost(self, info): (source)
overrides lib.chatMod.chatMod.yourHost
info about your host
def userRenamed(self, oldname, newname): (source)
overrides lib.chatMod.chatMod.userRenamed
a user changed the nick
def topicUpdated(self, user, channel, newTopic): (source)
overrides lib.chatMod.chatMod.topicUpdated
a user changed the topic of a channel
def irc_unknown(self, prefix, command, params): (source)
overrides lib.chatMod.chatMod.irc_unknown
an IRC-Message, which is not handle by twisted was received
def stop(self): (source)
overrides lib.chatMod.chatMod.stop
called, when the bot is stopped, or the module is reloaded
def reload(self): (source)
overrides lib.chatMod.chatMod.reload
called to reload the settings of the module
def start(self): (source)
overrides lib.chatMod.chatMod.start
called to start the work of the module put your initialization stuff in here insteadof __init__
def sendLine(self, line): (source)
overrides lib.chatMod.chatMod.sendLine
Undocumented
def lineReceived(self, line): (source)
overrides lib.chatMod.chatMod.lineReceived
Undocumented
def ctcpQuery(self, user, channel, messages): (source)
overrides lib.chatMod.chatMod.ctcpQuery
called for ctcp queries
API Documentation for OtfBot - the friendly Bot, generated by pydoctor at 2010-01-04 01:40:56.