Hinrik Örn Sigurðsson > POE-Component-IRC-Plugin-MultiProxy > POE::Component::IRC::Plugin::MultiProxy::Away

Download:
POE-Component-IRC-Plugin-MultiProxy-0.01.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

POE::Component::IRC::Plugin::MultiProxy::Away - A PoCo-IRC plugin which changes the away status based on the presence of proxy clients

SYNOPSIS ^

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

 $irc->plugin_add('Away', POE::Compoent::IRC::Plugin::MultiProxy::Away->new(Message => "I'm out to lunch"));

DESCRIPTION ^

POE::Compoent::IRC::Plugin::MultiProxy::Away is a POE::Component::IRC plugin. When the last proxy clien detaches, it changes the status to away, with the supplied away message.

This plugin requires the IRC component to be POE::Component::IRC::State or a subclass thereof.

METHODS ^

new

One optional argument:

'Message', the away message you want to use. Defaults to 'No clients attached'.

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

message

One optional argument:

An away message

Changes the away message when called with an argument, returns the current away message otherwise.

AUTHOR ^

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

syntax highlighting: