otfbot.plugins.ircClient.feed.Plugin

class documentation

class Plugin(chatMod.chatMod): (source)

View In Hierarchy

Undocumented

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

Inherited from chatMod:

Method action action (/me) received
Method auth check the authorisation of the user
Method connectionMade made connection to server
Method ctcpQuery called for ctcp queries
Method irc_unknown an IRC-Message, which is not handle by twisted was received
Method kickedFrom someone kicked the bot
Method left we have left a channel
Method lineReceived Undocumented
Method modeChanged mode changed
Method msg message received
Method noticed we got a notice
Method query a private message received
Method reload called to reload the settings of the module
Method sendLine Undocumented
Method signedOn successfully signed on
Method start called to start the work of the module put your initialization stuff in here insteadof __init__
Method topicUpdated a user changed the topic of a channel
Method userJoined a user joined the channel
Method userJoinedMask Undocumented
Method userKicked someone kicked someone else
Method userLeft a user left the channel
Method userQuit a user disconnect from the network
Method userRenamed a user changed the nick
Method yourHost info about your host
def __init__(self, bot): (source)
overrides otfbot.lib.chatMod.chatMod.__init__

Undocumented

def addSource(self, url, channel, minWait, maxWait, factor, postMax): (source)

add a feed

Parameters
urlthe url of the feed
channelUndocumented
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
@callback
def command(self, user, channel, command, options): (source)
overrides otfbot.lib.chatMod.chatMod.command

a command message received

@callback
def connectionLost(self, reason): (source)
overrides otfbot.lib.chatMod.chatMod.connectionLost

lost connection to server

def getWaitTime(self, curWait, minWait, maxWait, factor, hadNew): (source)

calculate the new wait time

Parameters
curWait:floatmaximum wait time
minWait:floatminimum wait time
maxWait:floatUndocumented
factorfactor (>=1) to increase the delay if no news were found
hadNew:boolset to true, if new news were loaded
@callback
def joined(self, channel): (source)
overrides otfbot.lib.chatMod.chatMod.joined

we have joined a channel

def loadNews(self, url): (source)

Undocumented

def loadSource(self, num, channel): (source)

Undocumented

def parseNews(self, feedcontent, url): (source)

Undocumented

def postNews(self, channel, url, feedPostMax): (source)

Undocumented

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 stop(self): (source)
overrides otfbot.lib.chatMod.chatMod.stop

called, when the bot is stopped, or the module is reloaded

bot = (source)
overrides otfbot.lib.chatMod.chatMod.bot

Undocumented

callIDs: dict = (source)

Undocumented

end: int = (source)

Undocumented

feedHeadlines: dict = (source)

Undocumented

feedLastLoaded: dict = (source)

Undocumented

feedparser = (source)

Undocumented

readUrls: dict = (source)

Undocumented