Richard Clamp > Siesta > Siesta::Plugin

Download:
Siesta-0.66.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Source  

NAME ^

Siesta::Plugin - base class for Siesta Plugins

SYNOPSIS ^

DESCRIPTION ^

Methods ^

->list

->user

->personal

does this plugin also run in the personal queue.

->process( $message );

$message is a Siesta::Message

Return a true value to indicate "process no further plugins". use this for message rejection.

->options

Returns a hashref, the keys of which are the various config options a plugin accepts. These are:

 description - a short description of the option
 type        - string, number, list, hash, boolean (1 or 0)
 default     - the default value
 widget      - what widget should be used in a gui to represent this

This should be overridden by a deriving class.

->descripton

return a scalar which describes your plugin

->pref( $name ) =head2 ->pref( $name, $value );

promote

Return the Siesta::Plugin::* instance that relates to this object

syntax highlighting: