view release on metacpan or  search on metacpan

lib/App/RoboBot/Plugin/Bot.pm  view on Meta::CPAN

package App::RoboBot::Plugin::Bot;
$App::RoboBot::Plugin::Bot::VERSION = '4.004';
use v5.20;

use namespace::autoclean;

use Moose;
use MooseX::SetOnce;

extends 'App::RoboBot::Plugin';

=head1 bot

Exports functions returning information about the bot and its environment.

=cut

has '+name' => (
    default => 'Bot',
);

has '+description' => (
    default => 'Exports functions returning information about the bot and its environment.',
);

=head2 version

=head3 Description

Returns a string with the bot's version number.

=head2 channel-list

=head3 Description

Returns a list of the channels on the current network which the bot has joined.
If provided a network name, will return the list of channels on that network
instead. The network name must be one from the list provided by
``(network-list)``.

=head3 Usage

[<network name>]

=head3 Examples

    (channel-list freenode)

=head2 network-list

=head3 Description

Returns a list of the networks to which the current instance of the bot is
connected.

=cut

has '+commands' => (
    default => sub {{
        'version' => { method      => 'version',
                       description => 'Returns a string with the bot\'s version number.',
                       usage       => '' },

        'channel-list' => { method      => 'channels',
                            description => 'By default, returns a list of the channels on this network which the bot has joined. If provided a network name, will return the list of channels joined by the bot on that network. Refer to (network-list) f...