.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Plugin::AutoJoin 3pm"
.TH POE::Component::IRC::Plugin::AutoJoin 3pm "2021-09-30" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::IRC::Plugin::AutoJoin \- A PoCo\-IRC plugin which
keeps you on your favorite channels
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use POE qw(Component::IRC::State Component::IRC::Plugin::AutoJoin);
\&
\& my $nickname = \*(AqChatter\*(Aq;
\& my $server = \*(Aqirc.blahblahblah.irc\*(Aq;
\&
\& my %channels = (
\&     \*(Aq#Blah\*(Aq   => \*(Aq\*(Aq,
\&     \*(Aq#Secret\*(Aq => \*(Aqsecret_password\*(Aq,
\&     \*(Aq#Foo\*(Aq    => \*(Aq\*(Aq,
\& );
\&
\& POE::Session\->create(
\&     package_states => [
\&         main => [ qw(_start irc_join) ],
\&     ],
\& );
\&
\& $poe_kernel\->run();
\&
\& sub _start {
\&     my $irc = POE::Component::IRC::State\->spawn(
\&         Nick => $nickname,
\&         Server => $server,
\&     ) or die "Oh noooo! $!";
\&
\&     $irc\->plugin_add(\*(AqAutoJoin\*(Aq, POE::Component::IRC::Plugin::AutoJoin\->new( Channels => \e%channels ));
\&     $irc\->yield(register => qw(join);
\&     $irc\->yield(connect => { } );
\& }
\&
\& sub irc_join {
\&     my $chan = @_[ARG1];
\&     $irc\->yield(privmsg => $chan => "hi $channel!");
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::AutoJoin is a POE::Component::IRC
plugin. If you get disconnected, the plugin will join all the channels you were
on the next time it gets connected to the \s-1IRC\s0 server. It can also rejoin a
channel if the \s-1IRC\s0 component gets kicked from it. It keeps track of channel
keys so it will be able to rejoin keyed channels in case of reconnects/kicks.
.PP
If a POE::Component::IRC::Plugin::NickServID
plugin has been added to the \s-1IRC\s0 component, then AutoJoin will wait for a
reply from NickServ before joining channels on connect.
.PP
This plugin requires the \s-1IRC\s0 component to be
POE::Component::IRC::State or a subclass thereof.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Takes the following optional arguments:
.PP
\&\fB'Channels'\fR, either an array reference of channel names, or a hash reference
keyed on channel name, containing the password for each channel. By default it
uses the channels the component is already on if you are using
POE::Component::IRC::State.
.PP
\&\fB'RejoinOnKick'\fR, set this to 1 if you want the plugin to try to rejoin a
channel (once) if you get kicked from it. Default is 0.
.PP
\&\fB'Rejoin_delay'\fR, the time, in seconds, to wait before rejoining a channel
after being kicked (if \fB'RejoinOnKick'\fR is on). Default is 5.
.PP
\&\fB'Retry_when_banned'\fR, if you can't join a channel due to a ban, set this
to the number of seconds to wait between retries. Default is 0 (disabled).
.PP
\&\fB'NickServ_delay'\fR, how long (in seconds) to wait for a reply from NickServ
before joining channels. Default is 5.
.PP
Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.SH "AUTHOR"
.IX Header "AUTHOR"
Hinrik Örn Sigurðsson, hinrik.sig@gmail.com