IInstantMessenger Interface Reference

Inherited by AbstractInstantMessenger.

List of all members.

Public Member Functions
void	addBuddy (String buddyName) throws InstantMessengerException
void	addMessageListener (IMessageListener messageListener)
long	buddyListLastModified ()
void	connect () throws IMConnectionException
void	disconnect ()
String	getAwayMessage (String buddyName) throws InstantMessengerException
String[]	getBuddiesInGroupNamed (String groupName) throws InstantMessengerException
String[]	getGroupNames () throws InstantMessengerException
String	getScreenName ()
String	getStatusMessage (String buddyName) throws InstantMessengerException
boolean	isBuddyAway (String buddyName) throws InstantMessengerException
boolean	isBuddyOnline (String buddyName) throws InstantMessengerException
boolean	isConnected ()
void	removeBuddy (String buddyName) throws InstantMessengerException
void	removeMessageListener (IMessageListener messageListener)
void	sendMessage (String buddyName, String message, boolean ignoreIfOffline) throws MessageException

---

Detailed Description

IInstantMessenger defines the interface for an instant messenger implementation to hook into the ERIMAdaptor framework.

Author:

mschrag

---

Member Function Documentation

void addBuddy

(

String

buddyName

)

throws InstantMessengerException

Adds a buddy to the buddy list.

Parameters:

buddyName

the name of the buddy to add

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

void addMessageListener

(

IMessageListener

messageListener

)

Adds a listener to this InstantMessenger.

Parameters:

messageListener

the message listener to add

Implemented in AbstractInstantMessenger.

long buddyListLastModified

(

)

Returns the timestamp of the last buddy list modification.

Returns:

the timestamp of the last buddy list modification

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

void connect

(

)

throws IMConnectionException

Connects to the instant messenger service.

Exceptions:

IMConnectionException

if the connect request fails

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

void disconnect

(

)

Disconnects from the instant messenger service.

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

String getAwayMessage

(

String

buddyName

)

throws InstantMessengerException

Returns the away message for the given buddy

Parameters:

buddyName

the name of the buddy to return the away message for

Returns:

the away message of the given buddy

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

String [] getBuddiesInGroupNamed

(

String

groupName

)

throws InstantMessengerException

Returns the names of the buddies in the given group.

Parameters:

groupName

the name of the group to list

Returns:

the names of the buddies in the given group

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

String [] getGroupNames

(

)

throws InstantMessengerException

Returns the names of the buddy list groups.

Returns:

the names of the buddy list groups

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

String getScreenName

(

)

Returns the screen name of the current user.

Implemented in AbstractInstantMessenger.

String getStatusMessage

(

String

buddyName

)

throws InstantMessengerException

Returns the status message for the given buddy

Parameters:

buddyName

the name of the buddy to return status for

Returns:

the status of the given buddy

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

boolean isBuddyAway

(

String

buddyName

)

throws InstantMessengerException

Returns whether or not the given buddy is away.

Parameters:

buddyName

the name of the buddy to check

Returns:

whether or not the given buddy is away

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

boolean isBuddyOnline

(

String

buddyName

)

throws InstantMessengerException

Returns whether or not the specified buddy name is online.

Parameters:

buddyName

the name of the buddy to check for

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

boolean isConnected

(

)

Returns whether or not this messenger is connected.

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

void removeBuddy

(

String

buddyName

)

throws InstantMessengerException

Removes a buddy from the buddy list.

Parameters:

buddyName

the name of the buddy to remove

Exceptions:

InstantMessengerException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

void removeMessageListener

(

IMessageListener

messageListener

)

Removes a listener from this InstantMessenger.

Parameters:

messageListener

the message listener to remove

Implemented in AbstractInstantMessenger.

void sendMessage	(	String	buddyName,
		String	message,
		boolean	ignoreIfOffline
	)			throws MessageException

Sends a message to the specified buddy.

Parameters:

	buddyName	the name of the buddy to message
	message	the message to send
	ignoreIfOffline	should the message be ignored if the user is offline (false = throw an exception)

Exceptions:

MessageException

Implemented in AimBotInstantMessenger, DaimInstantMessenger, and JOscarInstantMessenger.

---

The documentation for this interface was generated from the following file:

• /opt/source/Wonder/Frameworks/WOAdaptors/ERIMAdaptor/Sources/er/imadaptor/IInstantMessenger.java