File: //usr/local/ssl/local/share/man/man3/Net::AIM.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AIM 3"
.TH AIM 3 "2002-04-23" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Net::AIM \- Perl extension for AOL Instant Messenger TOC protocol
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Net::AIM;
.Ve
.PP
.Vb 4
\& $aim = new Net::AIM;
\& $conn = $aim->newconn(Screenname => 'Perl AIM',
\& Password => 'yaddayadda');
\& $aim->start;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements an \s-1OO\s0 interface to the Aol Instant Messenger \s-1TOC\s0 protocol.
.PP
This version contains not much more than hacked code that merely connects
to the aol \s-1TOC\s0 servers and acts on instant messages.
.SH "METHODS"
.IX Header "METHODS"
.IP "Net::AIM\->\fInew()\fR" 4
.IX Item "Net::AIM->new()"
This is the Net::AIM constructor. No arguments needed.
.IP "$aim\->debug($debug)" 4
.IX Item "$aim->debug($debug)"
Set whether to print \s-1DEBUGGING\s0 information to \s-1STDERRR\s0.
Accepts \f(CW$debug\fR which should be a boolean value.
.ie n .IP "$aim\->set($key, $val)" 4
.el .IP "$aim\->set($key, \f(CW$val\fR)" 4
.IX Item "$aim->set($key, $val)"
This method simply sets \f(CW$key\fR to \f(CW$val\fR in an internal hash for variables
.IP "$aim\->get($key)" 4
.IX Item "$aim->get($key)"
This method simply gets the value of \f(CW$key\fR from the internal hash
.IP "$aim\->\fInewconn()\fR" 4
.IX Item "$aim->newconn()"
This method creates a new AIM::Connection object
.IP "$aim\->\fIgetconn()\fR" 4
.IX Item "$aim->getconn()"
This method returns a pointer to the AIM::Connection object
.IP "$aim\->\fIdo_one_loop()\fR" 4
.IX Item "$aim->do_one_loop()"
This executes one read off the socket.
.IP "$aim\->\fIstart()\fR" 4
.IX Item "$aim->start()"
This just starts an infinte loop of \f(CW$aim\fR\->do_one_loop;
.IP "$aim\->timeout($secs);" 4
.IX Item "$aim->timeout($secs);"
This sets or returns the current timeout in seconds for the select loop.
Takes 1 optional argument. Fractional timeout values are ok.
.ie n .IP "$aim\->add_buddy($send_bool, $group\fR, \f(CW@buddies);" 4
.el .IP "$aim\->add_buddy($send_bool, \f(CW$group\fR, \f(CW@buddies\fR);" 4
.IX Item "$aim->add_buddy($send_bool, $group, @buddies);"
This adds \f(CW@buddies\fR to your buddy list, under the group \f(CW$group\fR.
if \f(CW$send_bool\fR evaluates to \s-1TRUE\s0 then the toc_add_buddy command
is sent to the server. Otherwise it is not sent out.
This function will also save the list internally.
.ie n .IP "$aim\->add_permit($send_bool, $group\fR, \f(CW@buddies);" 4
.el .IP "$aim\->add_permit($send_bool, \f(CW$group\fR, \f(CW@buddies\fR);" 4
.IX Item "$aim->add_permit($send_bool, $group, @buddies);"
This adds \f(CW@buddies\fR to your permit list, under the group \f(CW$group\fR.
if \f(CW$send_bool\fR evaluates to \s-1TRUE\s0 then the toc_add_permit command
is sent to the server. Otherwise it is not sent out.
This function will also save the list internally.
.ie n .IP "$aim\->add_deny($send_bool, $group\fR, \f(CW@buddies);" 4
.el .IP "$aim\->add_deny($send_bool, \f(CW$group\fR, \f(CW@buddies\fR);" 4
.IX Item "$aim->add_deny($send_bool, $group, @buddies);"
This adds \f(CW@buddies\fR to your deny list, under the group \f(CW$group\fR.
if \f(CW$send_bool\fR evaluates to \s-1TRUE\s0 then the toc_add_deny command
is sent to the server. Otherwise it is not sent out.
This function will also save the list internally.
.ie n .IP "$aim\->remove_buddy($send_bool, $group\fR, \f(CW@buddies);" 4
.el .IP "$aim\->remove_buddy($send_bool, \f(CW$group\fR, \f(CW@buddies\fR);" 4
.IX Item "$aim->remove_buddy($send_bool, $group, @buddies);"
This removes \f(CW@buddies\fR from your buddy list. \f(CW$group\fR must be the
group they were orginally set with for them to be deleted from
the internal \f(CW$aim\fR memory and prevent them from getting added again
incase a set_config method is called.
.Sp
if \f(CW$send_bool\fR evaluates to \s-1TRUE\s0 then the toc_add_deny command
is sent to the server. Otherwise it is not sent out.
This function will also save the list internally.
.IP "$aim\->set_idle($idle_time)" 4
.IX Item "$aim->set_idle($idle_time)"
This method sets our idle time to \f(CW$idle_time\fR.
If \f(CW$idle_time\fR is omitted it will be set to 0.
.IP "$aim\->get_info($screen_name)" 4
.IX Item "$aim->get_info($screen_name)"
Sends an info request to the server for \f(CW$screen_name\fR. The server should
reply with a \s-1URL\s0 which will contain the info requested about the user.
.IP "$aim\->set_info($info)" 4
.IX Item "$aim->set_info($info)"
This method sets your info or profile information to \f(CW$info\fR on the server.
.ie n .IP "$aim\->evil($user, $anon)" 4
.el .IP "$aim\->evil($user, \f(CW$anon\fR)" 4
.IX Item "$aim->evil($user, $anon)"
Warn \f(CW$screen_name\fR.
\&\f(CW$anon\fR: boolean value which will determine whether to warn the user anonymously or normally. Anonymous warnings are less severe.
.IP "$aim\->send($message)" 4
.IX Item "$aim->send($message)"
Send \f(CW$message\fR to the server. This is used internally by other functions
to send commands to the server.
.Sp
.Vb 1
\& $aim->send('toc_add_buddy perlaim')
.Ve
.ie n .IP "$aim\->chat_invite($room, $msg\fR, \f(CW@buddies)" 4
.el .IP "$aim\->chat_invite($room, \f(CW$msg\fR, \f(CW@buddies\fR)" 4
.IX Item "$aim->chat_invite($room, $msg, @buddies)"
Invite \f(CW@buddies\fR to \f(CW$room\fR with the message \f(CW$msg\fR
.IP "$aim\->chat_accept($room_id)" 4
.IX Item "$aim->chat_accept($room_id)"
This will accept an invitation that was sent to us for \f(CW$room_id\fR
.IP "$aim\->chat_leave($room_id)" 4
.IX Item "$aim->chat_leave($room_id)"
This method instructs the server to take you out of the room \f(CW$room_id\fR
.IP "$aim\->chat_whisper($room_id,$user,$msg)" 4
.IX Item "$aim->chat_whisper($room_id,$user,$msg)"
Whisper \f(CW$msg\fR to \f(CW$user\fR in the room \f(CW$room_id\fR
.ie n .IP "$aim\->chat_send($room_id, $message)" 4
.el .IP "$aim\->chat_send($room_id, \f(CW$message\fR)" 4
.IX Item "$aim->chat_send($room_id, $message)"
Send \f(CW$message\fR in chat room \f(CW$room_id\fR
.IP "$aim\->chat_join($roomname)" 4
.IX Item "$aim->chat_join($roomname)"
Send a request to enter the room \f(CW$roomname\fR
.ie n .IP "$aim\->send_im($screen_name, $message)" 4
.el .IP "$aim\->send_im($screen_name, \f(CW$message\fR)" 4
.IX Item "$aim->send_im($screen_name, $message)"
This method sends \f(CW$message\fR to \f(CW$screen_name\fR.
.IP "$aim\->\fIlist_rooms()\fR;" 4
.IX Item "$aim->list_rooms();"
This method returns an \f(CW@array\fR of rooms each consisting of \s-1ID:ROOM_NAME\s0. For instance:
'235236:Perl \s-1AIM\s0 Chat12'
'234323:Perl \s-1AIM\s0 Chat13'
'235832:Perl \s-1AIM\s0 Chat14'
'125082:Perl \s-1AIM\s0 Chat15'
.IP "$aim\->get_roomname($id)" 4
.IX Item "$aim->get_roomname($id)"
This method returns the name of the room with id \f(CW$id\fR.
.ie n .IP "$aim\->set_roomname($id, $roomname)" 4
.el .IP "$aim\->set_roomname($id, \f(CW$roomname\fR)" 4
.IX Item "$aim->set_roomname($id, $roomname)"
This saves \f(CW$roomname\fR in the \f(CW$aim\fR object in a \f(CW%hash\fR keyed on \f(CW$id\fR.
.IP "$aim\->del_roomname($id)" 4
.IX Item "$aim->del_roomname($id)"
Deletes \f(CW$id\fR and it's associate value from our roomname hash in \f(CW$aim\fR
.IP "$aim\->encode($str)" 4
.IX Item "$aim->encode($str)"
This method returns \f(CW$str\fR encoded as per the \s-1TOC\s0 specs: escaped special chars ({}[]$) and enclosed in quotes (")
.IP "$aim\->\fIsend_config()\fR" 4
.IX Item "$aim->send_config()"
This method instructs the module to send our configurations which are the mode (permit/deny/all) and our buddy list to the server and to set it as our saved config on the server
.IP "$aim\->\fIsend_buddies()\fR" 4
.IX Item "$aim->send_buddies()"
This method instructs the module to send all our current buddies to the \s-1AOL\s0 server.
.IP "$set_config_str($config_str, add_bool)" 4
.IX Item "$set_config_str($config_str, add_bool)"
This parses a config string of the form:
g Buddies
p permit1
p permit2
d deny1
d deny2
b budd1
b budd2
.Sp
Key:
g \- Buddy Group (All Buddies until the next g or the end of config are in this group.)
b \- A Buddy
p \- Person on permit list
d \- Person on deny list
m \- Permit/Deny Mode. Possible values are
1 \- Permit All
2 \- Deny All
3 \- Permit Some
4 \- Deny Some
.IP "$aim\->normalize($data)" 4
.IX Item "$aim->normalize($data)"
This method normalizes \f(CW$data\fR by killing all but strict alphnumeric
characters. Typically used for screen_names.
.SH "AUTHOR"
.IX Header "AUTHOR"
.RS 4
.IP "*" 4
Written by Aryeh Goldsmith <perlaim@aryeh.net>, AIM:Perl \s-1AIM\s0
.SH "URL"
.IX Header "URL"
The Net::AIM project:
http://www.aryeh.net/Net\-AIM/
.Sp
The Net::AIM bot list:
http://www.nodoubtyo.com/aimbots/
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1)