demiguise/F1DataTelegramBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adding first pieces of POD.

Browse Source
This commit is contained in:
Stefan Härter 2023-05-22 18:42:56 +02:00
parent 48cee0a640
commit 4884e81d5e
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
F1DataBot.pm
View File

@ -27,6 +27,7 @@ sub new {
my $Self = {}; my $Self = {};
bless( $Self, $Type ); bless( $Self, $Type );
# TODO Use LogLevel Param for Logger Initialisation.
$Self->{LogLevel} = $Param{LogLevel} || 'info'; $Self->{LogLevel} = $Param{LogLevel} || 'info';
$Self->{LogObject} = Log::Log4perl->get_logger('F1DataBot'); $Self->{LogObject} = Log::Log4perl->get_logger('F1DataBot');
$Self->{Token} = 'bot5868933096:AAE8Oe-AxU6m_yCWfpqTqwwjERqnRpBGJtE'; $Self->{Token} = 'bot5868933096:AAE8Oe-AxU6m_yCWfpqTqwwjERqnRpBGJtE';
@ -38,6 +39,12 @@ sub new {
return $Self; return $Self;
} }
=head1 Greet
Merely a dummy routine to test the bot's functionallity. Maybe using it for easter eggs or some kind of fun later.
=cut
sub greet { sub greet {
my ( $Self, %Param ) = @_; my ( $Self, %Param ) = @_;
@ -64,6 +71,12 @@ sub greet {
} }
=head1 build
Sub which is used to offer custom query building to the user by offering a decision tree of options via inline keyboard.
=cut
sub build { sub build {
my ( $Self, %Param ) = @_; my ( $Self, %Param ) = @_;
@ -106,6 +119,12 @@ sub build {
} }
=head1 statistics
Starting point for executing F1 statistic queries.
=cut
sub statistics { sub statistics {
my ( $Self, %Param ) = @_; my ( $Self, %Param ) = @_;
@ -242,6 +261,12 @@ sub statistics {
} }
=head1 processMessage
Function which receives a single message and decides what to to based on message content and attributes.
=cut
sub processMessage { sub processMessage {
my ( $Self, %Param ) = @_; my ( $Self, %Param ) = @_;
@ -308,6 +333,12 @@ sub processMessage {
} }
=head1 fetchMessages
Requesting messages from Telegram API and passing them one by one to processMessage.
=cut
sub fetchMessages { sub fetchMessages {
my ( $Self, %Param ) = @_; my ( $Self, %Param ) = @_;