API docs for “lib.chatMod.chatMod”

Class l.c.chatMod(Plugin):

Part of lib.chatMod View Source View In Hierarchy

Known subclasses: plugins.ircClient.answers.Plugin, plugins.ircClient.auth.Plugin, plugins.ircClient.autorejoin.Plugin, plugins.ircClient.badwords.Plugin, plugins.ircClient.chapterbot.Plugin, plugins.ircClient.commands.Plugin, plugins.ircClient.controlIRC.Plugin, plugins.ircClient.controlServer.Plugin, plugins.ircClient.count.Plugin, plugins.ircClient.eightBall.Plugin, plugins.ircClient.example.Plugin, plugins.ircClient.feed.Plugin, plugins.ircClient.flyspray.Plugin, plugins.ircClient.google.Plugin, plugins.ircClient.human.Plugin, plugins.ircClient.identica.Plugin, plugins.ircClient.identify.Plugin, plugins.ircClient.jc.Plugin, plugins.ircClient.karma.Plugin, plugins.ircClient.ki.Plugin, plugins.ircClient.kurs.Plugin, plugins.ircClient.log.Plugin, plugins.ircClient.marvin.Plugin, plugins.ircClient.math.Plugin, plugins.ircClient.mirror.Plugin, plugins.ircClient.mode.Plugin, plugins.ircClient.moon.Plugin, plugins.ircClient.reminder.Plugin, plugins.ircClient.seen.Plugin, plugins.ircClient.sprichwort.Plugin, plugins.ircClient.svn.Plugin, plugins.ircClient.tictactoe.Plugin, plugins.ircClient.tv.Plugin, plugins.ircClient.url.Plugin, plugins.ircClient.version.Plugin, plugins.ircClient.vote.Plugin, plugins.ircClient.weather.Plugin, plugins.ircClient.weather_old.Plugin, plugins.ircClient.youtube.Plugin, plugins.ircClient.zitat.Plugin, plugins.ircServer.basic.Plugin, plugins.ircServer.controlServer.Plugin, plugins.ircServer.human.Plugin, plugins.webServer.count.Plugin, plugins.webServer.hello.Plugin

this class is mainly for documentation of the callbacks. some functions are helper functions for common tasks, i.e. kicked calls userLeft, so a plugin only implementing userLeft will notice that a kicked user left the channel. a plugin implementing kicked too, can handle it independent from userLeft, because kicked will be overwritten
Method __init__ Undocumented
Method auth check the authorisation of the user
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 Plugin:

Method register_ctl_command register commands in control service
Method setLogger set the logger
Class Meta Undocumented
def __init__(self, bot): (source)
overridden in plugins.ircClient.answers.Plugin, plugins.ircClient.auth.Plugin, plugins.ircClient.autorejoin.Plugin, plugins.ircClient.badwords.Plugin, plugins.ircClient.chapterbot.Plugin, plugins.ircClient.commands.Plugin, plugins.ircClient.controlIRC.Plugin, plugins.ircClient.controlServer.Plugin, plugins.ircClient.count.Plugin, plugins.ircClient.eightBall.Plugin, plugins.ircClient.example.Plugin, plugins.ircClient.feed.Plugin, plugins.ircClient.flyspray.Plugin, plugins.ircClient.google.Plugin, plugins.ircClient.human.Plugin, plugins.ircClient.identica.Plugin, plugins.ircClient.identify.Plugin, plugins.ircClient.jc.Plugin, plugins.ircClient.karma.Plugin, plugins.ircClient.ki.Plugin, plugins.ircClient.kurs.Plugin, plugins.ircClient.log.Plugin, plugins.ircClient.marvin.Plugin, plugins.ircClient.math.Plugin, plugins.ircClient.mirror.Plugin, plugins.ircClient.mode.Plugin, plugins.ircClient.moon.Plugin, plugins.ircClient.reminder.Plugin, plugins.ircClient.seen.Plugin, plugins.ircClient.sprichwort.Plugin, plugins.ircClient.svn.Plugin, plugins.ircClient.tictactoe.Plugin, plugins.ircClient.tv.Plugin, plugins.ircClient.url.Plugin, plugins.ircClient.version.Plugin, plugins.ircClient.vote.Plugin, plugins.ircClient.weather.Plugin, plugins.ircClient.weather_old.Plugin, plugins.ircClient.youtube.Plugin, plugins.ircClient.zitat.Plugin, plugins.ircServer.basic.Plugin, plugins.ircServer.controlServer.Plugin, plugins.ircServer.human.Plugin, plugins.webServer.count.Plugin, plugins.webServer.hello.Plugin
Undocumented
def auth(self, user): (source)
check the authorisation of the user
def joined(self, channel): (source)
def command(self, user, channel, command, options): (source)
def query(self, user, channel, msg): (source)
def msg(self, user, channel, msg): (source)
def connectionMade(self): (source)
def connectionLost(self, reason): (source)
def signedOn(self): (source)
def left(self, channel): (source)
def noticed(self, user, channel, msg): (source)
def action(self, user, channel, msg): (source)
def modeChanged(self, user, channel, set, modes, args): (source)
def kickedFrom(self, channel, kicker, message): (source)
def userKicked(self, kickee, channel, kicker, message): (source)
def userJoined(self, user, channel): (source)
def userJoinedMask(self, user, channel): (source)
Undocumented
def userLeft(self, user, channel): (source)
def userQuit(self, user, quitMessage): (source)
def yourHost(self, info): (source)
info about your host
def userRenamed(self, oldname, newname): (source)
def topicUpdated(self, user, channel, newTopic): (source)
a user changed the topic of a channel
def irc_unknown(self, prefix, command, params): (source)
an IRC-Message, which is not handle by twisted was received
def stop(self): (source)
def reload(self): (source)
def start(self): (source)
def sendLine(self, line): (source)
Undocumented
def lineReceived(self, line): (source)
Undocumented
def ctcpQuery(self, user, channel, messages): (source)
called for ctcp queries
API Documentation for OtfBot - the friendly Bot, generated by pydoctor at 2010-01-04 01:40:56.