Aryeh Goldsmith > Net-AIM > Net::AIM::Event

Download:
Net-AIM-1.22.tgz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Source  

NAME ^

Net::AIM::Event - Object to hold event data

SYNOPSIS ^

DESCRIPTION ^

This module holds data about an event which is any instruction we get from the server.

METHODS ^

Net::AIM::Event->new($type, $from, $to, @args)

Net::AIM::Event constructor. Takes 4 args * The type of event * The originator (screenname or server) * To/Destination (us - remnants from IRC module days...) * @ARGS

$aim_event->dump()

Print the event to STDERR good for debugging

$aim_event->args(@args)

Sets the event's argument list to @args if it is provided. Otherwise it returns the event's argument list.

$aim_event->from($from)

Sets the originator of this event if $from is provided. Otherwise it returns the event's originator. Usually either a ScreenName|Server

$aim_event->to(@to)

Sets the recipients of this event if @to is provided. Otherwise it returns the event's recipient list.

$aim_event->trans($error_code)

This method takes a numeric $error_code and returns a string representing the definition of the error code, or undef if the $error_code is unknown.

$aim_event->type($type)

Sets the type of this event if $type is provided. Otherwise it returns the event's type.

AUTHOR ^

Aryeh Goldsmith <perlaim@aryeh.net>.

URL ^

The Net::AIM project: http://www.aryeh.net/Net-AIM/

The Net::AIM bot list: http://www.nodoubtyo.com/aimbots/

SEE ALSO ^

perl(1)

syntax highlighting: