/ 
POE-Component-IRC-Plugin-MultiProxy-0.01
River stage one • 1 direct dependent • 1 total dependent
/ POE::Component::IRC::Plugin::MultiProxy::Recall

NAME

POE::Compoent::IRC::Plugin::MultiProxy::Recall - A PoCo-IRC plugin which can greet proxy clients with the messages they missed while they were away

SYNOPSIS

use POE::Compoent::IRC::Plugin::MultiProxy::Recall;

$irc->plugin_add('Recall', POE::Compoent::IRC::Plugin::MultiProxy::Recall->new( Mode => 'missed' ));

DESCRIPTION

This plugin requires the IRC component to be POE::Component::IRC::State or a subclass thereof. It also requires a POE::Component::IRC::Plugin::BotTraffic to be in the plugin pipeline. It will be added automatically if it is not present.

METHODS

new

One optional argument:

'Mode', which public messages you want it to recall. 'missed', the default, makes it only recall public messages that were received while no proxy client was attached. 'all' will recall public messages from all channels since they were joined. 'none' will recall none. The plugin will always recall missed private messages, regardless of this option.

Returns a plugin object suitable for feeding to POE::Component::IRC's plugin_add() method.

AUTHOR

Hinrik Örn Sigurðsson, hinrik.sig@gmail.com