Class p.i.f.Plugin(chatMod.chatMod):
Part of 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 |
Inherited from Plugin (via chatMod):
| Method | register_ctl_command | register commands in control service |
| Method | setLogger | set the logger |
| Class | Meta | Undocumented |
def
addSource(self, url, channel, minWait, maxWait, factor, postMax):
(source)
add a feed
| Parameters | url | the url of the feed |
| minWait | minimal time between updates | |
| maxWait | maximum time between updates | |
| factor | the factor to increase update delay if no new news were found | |
| postMax | maximum new items to post on update |
def
getWaitTime(self, curWait, minWait, maxWait, factor, hadNew):
(source)
calculate the new wait time
| Parameters | curWait | current wait time (type: float ) |
| minWait | minimum wait time (type: float ) | |
| maxWait | (type: float ) | |
| curWait | maximum wait time | |
| maxWait | (type: float ) | |
| factor | factor (>=1) to increase the delay if no news were found | |
| hadNew | set to true, if new news were loaded (type: bool ) |
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)
overrides lib.chatMod.chatMod.connectionLost
lost connection to server
def
stop(self):
(source)
overrides lib.chatMod.chatMod.stop
called, when the bot is stopped, or the module is reloaded
def
command(self, user, channel, command, options):
(source)
overrides lib.chatMod.chatMod.command
a command message received
