agentland.software
Interface AOLIM

All Known Implementing Classes:
AOLIMAgent, AOLIMEHA

public interface AOLIM
extends Agent

An interface for talking over AOL's InstantMessage system. This is basically a neat toy so that an Intelligent Room agent could send messages to AOL IM users, if it thought it had a good reason to do so.


Fields inherited from interface metaglue.Agent
ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING
 
Method Summary
 Vector getUsers()
          Show all the users that we care about who are currently logged in.
 void login(String screenname, String password)
          Login to the AOL IM system.
 void logout()
          Exits the system.
 void sendMessage(String username, String message)
          Sends a message to a given AOL user.
 
Methods inherited from interface metaglue.Agent
addMonitor, alive, getAgentID, getMetaglueAgentID, shutdown, startup, whereAreYou
 

Method Detail

login

public void login(String screenname,
                  String password)
           throws RemoteException
Login to the AOL IM system. The screen name and password are given here. In the current incarnation, this starts up the socket to the backend cmdline program.

getUsers

public Vector getUsers()
                throws RemoteException
Show all the users that we care about who are currently logged in. This sends back a vector of strings, which the calling agent can pop up in a dialog box.

sendMessage

public void sendMessage(String username,
                        String message)
                 throws RemoteException
Sends a message to a given AOL user. Messages from other users are sent as notifications to the notification agent. To get messages from AOLIM, call the Notifier with an addSpy() asking to be told of "InstantMessage" notifications.

logout

public void logout()
            throws RemoteException
Exits the system.