Configs

Exporter
Configs
Summary
Configs
Variables
@EXPORT
Configuration Variables
Functions
getBotConfig
getAdminJID of admin
getBotNameName of the bot
getLogfileName of the logfile
getLogging1 if logging is enabled
addForumAdds a Forum to the list of forums
removeForumRemoves a Forum from the list of forums
isInForumDetermines if Bot ins active in a given Forum
isOwnConferenceOnlyTests if bot is only allowed to enter rooms in own conference server
getConferenceServerURL of confernece server

Variables

@EXPORT

our @EXPORT

Configuration Variables

$adminJID of admin
$botnameName of the Bot
$logfileName of file to log conversations
$enableLogging1 to enable logging in $logfile
$ownConferenceOnly1 to restrict access to own confernece server.  0 to allow bot to join rooms on other conference servers.
$conferenceServerURL of own conference server
@keywordsList of Strings to react to in MUC (empty string means: react to everything)
%forumsHash of MUCs to connect to with a reference to a list of Strings to react to.
%botConfigConfiguration hash for Net::Jabber::Bot

Functions

getBotConfig

sub getBotConfig

Parameters

$newMessageFuncReference to function that should be called when a new Message (for the bot) arrives
$backgroundChecksReference to function that is called in intervals of $botConfig{loop_sleep_time} seconds

Returns

The configuration hash of the bot

getAdmin

sub getAdmin

Returns

JID of admin

getBotName

sub getBotName

Returns

Name of the bot

getLogfile

sub getLogfile

Returns

Name of the logfile

getLogging

sub getLogging

Returns

1 if logging is enabled

addForum

sub addForum

Adds a Forum to the list of forums

Parameters

$forumForum to be added

removeForum

sub removeForum

Removes a Forum from the list of forums

Parameters

$forumForum to be removed

isInForum

sub isInForum

Determines if Bot ins active in a given Forum

Parameters

$forumForum to be tested for activity

Returns

1 if bot is activce in the Forum, else 0

isOwnConferenceOnly

sub isOwnConferenceOnly

Tests if bot is only allowed to enter rooms in own conference server

Returns

1 if bot is restricted to own conference server

See Also

$ownConferenceOnly

getConferenceServer

sub getConferenceServer

Returns

URL of confernece server

our @EXPORT
sub getBotConfig
sub getAdmin
JID of admin
sub getBotName
Name of the bot
sub getLogfile
Name of the logfile
sub getLogging
1 if logging is enabled
sub addForum
Adds a Forum to the list of forums
sub removeForum
Removes a Forum from the list of forums
sub isInForum
Determines if Bot ins active in a given Forum
sub isOwnConferenceOnly
Tests if bot is only allowed to enter rooms in own conference server
sub getConferenceServer
URL of confernece server
1 to restrict access to own confernece server.
Close