|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.walluck.oscar.tools.Tool
org.walluck.oscar.tools.LocateTool
public class LocateTool
Locate tool.
Field Summary |
---|
Fields inherited from class org.walluck.oscar.tools.Tool |
---|
listeners |
Constructor Summary | |
---|---|
LocateTool()
Creates a new Locate tool. |
Method Summary | |
---|---|
void |
bosConnectionAvailable()
Method called by the LoginTool once the BOS connection is available. |
void |
getAway(String sn)
Get a user's away message. |
void |
getInfo(String sn)
Get a user's information. |
void |
locateRights(AIMSession sess,
AIMFrame frame,
int maxsiglen)
Describe locateRights method here. |
void |
setAwayAIM(String awaymsg)
Set an away message on an AIM connection. |
void |
setAwayAIM(String encoding,
byte[] awaymb)
Set an away message on an AIM connection. |
void |
setAwayICQ(String awaymsg)
Set the away message for an ICQ connection. |
void |
setInfo(String encoding,
String text)
Describe setInfo method here. |
void |
shutdown(AIMSession sess)
Called when the tool is shutting down. |
void |
userInfo(AIMSession sess,
AIMFrame frame,
UserInfo info,
int infoType,
String textEncoding,
String text)
Describe userInfo method here. |
Methods inherited from class org.walluck.oscar.tools.Tool |
---|
getFamily, getId, getSession, getToolData, getVersion, setFamily, setId, setSession, setToolData, setVersion |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocateTool()
Method Detail |
---|
public void setInfo(String encoding, String text) throws IOException
setInfo
method here.
encoding
- a String
valuetext
- a String
value
IOException
- if an error occurspublic void getInfo(String sn) throws IOException
sn
- a String
value
IOException
- if an error occurspublic void getAway(String sn) throws IOException
sn
- ScreenName to get the away message for.
IOException
- if an error occurspublic void setAwayAIM(String encoding, byte[] awaymb) throws IOException
encoding
- Encoding of the away message (e.g. "us-ascii")awaymb
- byte[] of away message
IOException
- if an error occurspublic void setAwayAIM(String awaymsg) throws IOException
awaymsg
- Custom away message
IOException
- if an error occurspublic void setAwayICQ(String awaymsg) throws IOException
awaymsg
- The away message
IOException
- if an error occurspublic void shutdown(AIMSession sess)
shutdown
in class Tool
sess
- the oscar sessionpublic void bosConnectionAvailable()
bosConnectionAvailable
in class Tool
public void locateRights(AIMSession sess, AIMFrame frame, int maxsiglen)
locateRights
method here.
locateRights
in interface LocateListener
sess
- an AIMSession
valueframe
- an AIMFrame
valuemaxsiglen
- an int
valuepublic void userInfo(AIMSession sess, AIMFrame frame, UserInfo info, int infoType, String textEncoding, String text)
userInfo
method here.
userInfo
in interface LocateListener
sess
- an AIMSession
valueframe
- an AIMFrame
valueinfo
- an UserInfo
valueinfoType
- an int
valuetextEncoding
- a String
valuetext
- a String
value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |