o.p.i.f.Plugin(chatMod.chatMod) : class documentation

Part of otfbot.plugins.ircClient.feed View Source View In Hierarchy

No class docstring
Method __init__ Undocumented
Method addSource add a feed
Method loadSource Undocumented
Method joined we have joined a channel
Method getWaitTime calculate the new wait time
Method loadNews Undocumented
Method parseNews Undocumented
Method postNews Undocumented
Method postNewsLoop load News if needed and Post them to a channel
Method connectionLost lost connection to server
Method stop called, when the bot is stopped, or the module is reloaded
Method command a command message received

Inherited from chatMod:

Method auth check the authorisation of the user
Method query a private message received
Method msg message received
Method connectionMade made 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 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
def __init__(self, bot): (source)
def addSource(self, url, channel, minWait, maxWait, factor, postMax): (source)
add a feed
Parametersurlthe url of the feed
minWaitminimal time between updates
maxWaitmaximum time between updates
factorthe factor to increase update delay if no new news were found
postMaxmaximum new items to post on update
def loadSource(self, num, channel): (source)
def joined(self, channel): (source)
we have joined a channel
def getWaitTime(self, curWait, minWait, maxWait, factor, hadNew): (source)
calculate the new wait time
ParameterscurWaitcurrent wait time (type: float )
minWaitminimum wait time (type: float )
maxWait (type: float )
curWaitmaximum wait time
maxWait (type: float )
factorfactor (>=1) to increase the delay if no news were found
hadNewset to true, if new news were loaded (type: bool )
def loadNews(self, url): (source)
def parseNews(self, feedcontent, url): (source)
def postNews(self, channel, url, feedPostMax): (source)
def postNewsLoop(self, channel, url, curWait=5.0, minWait=1.0, maxWait=60.0, factor=1.5, feedPostMax=3): (source)
load News if needed and Post them to a channel
def connectionLost(self, reason): (source)
lost connection to server
def stop(self): (source)
called, when the bot is stopped, or the module is reloaded
def command(self, user, channel, command, options): (source)
a command message received
API Documentation for OtfBot, generated by pydoctor at 2011-05-03 16:14:29.