TOC Task

Description

A task to send an AIM message. Requires the use of jaimlib 0.5 or higher to connect to the TOC server.

Parameters (note items in red indicate functionality not currently available but will be shortly)

Attribute	Description	Required
tochost	Host of the TOC server to connect.	No. default is "toc.oscar.aol.com"
tocport	Port number of the TOC server to connect.	No. default is 9898.
timeout	Time in milleseconds to wait for a connection to be made.	No. default is 5000 (5 seconds).
watch	Buddy to "watch" (master). TOC requires you watch at least one buddy in order to successfully sign on.	No (but recommended please :). default is "tfftbuddy".
from	Buddy name of the sender. This is a buddy name to be used to connect to the TOC server. The buddy must exist (as we will see below)	attribute
password	password of buddy to log onto the TOC server.	attribute
to	Buddy to send message.	At least one of these, or the equivalent elements.
tolist	Comma-separated list of buddies to send messages.	At least one of these, or the equivalent elements.
message	Message to send to buddy/buddies.	This or a `<message>` element.

Parameters specified as nested elements

to

Adds a buddy name element. It takes no attributes.

message

Specifies the message to include in the AIM. cannot be longer that xxxx characters. it takes the following attributes

Attribute	Description	Required
linenum	Line number of the message.	No

Examples

Example 1

  .
  .
  .
  <taskdef name="aim" classname="com.tfftech.ant.taskdefs.im.toc.TocTask" /> 
  <target name="main">
  <aim tochost="toc.oscar.aol.com" tocport="9898" from="buildbuddy" to="otherimname" password="pass">
  	<message>The nightly build has completed</message> 
  </aim>
  .
  .
  .

Sends an IM from buildbuddy to otherimname, authenticating on AIM with the password pass. The IM sent is "The nightly build has completed".

Example 2

  .
  .
  .
  <taskdef name="aim" classname="com.tfftech.ant.taskdefs.im.toc.TocTask" />
  <target name="main">
  <aim tochost="toc.oscar.aol.com" tocport="9898" from="tfftbuddy" password="passwd" watch="watchbuddy" tolist="buddy1,buddy2,buddy3">
        <message>The nightly build has completed</message>
  </aim>
  .
  .
  .

Sends an IM from buildbuddy to multiple users buddy1,buddy2 and buddy3, authenticating on AIM with the password pass. The IM sent is "The nightly build has completed". The watch attribute is specified because the sender is the same as the default watchbuddy.

The following is equivalent to the above (Example 2):

Example 3

  .
  .
  .
  <taskdef name="aim" classname="com.tfftech.ant.taskdefs.im.toc.TocTask" />
  <target name="main">
  <aim tochost="toc.oscar.aol.com" tocport="9898" watch="watchbuddy" from="tfftbuddy" password="pass">
        <to>buddy1</to>
        <to>buddy2</to>
        <to>buddy3</to>
        <message>The nightly build has completed</message>
  </aim>
  .
  .
  .