JOscarInstantMessenger Class Reference

Inherits er::imadaptor::AbstractInstantMessenger.

Collaboration diagram for JOscarInstantMessenger:

[legend]

List of all members.

Classes
class	AimStateHandler
class	BuddyChangeListener
class	ConversationHandler
class	Factory
class	IcbmHandler
Public Member Functions
BuddyInfo	_addBuddyIfNecessary (String buddyName)
void	addBuddy (String buddyName)
long	buddyListLastModified ()
synchronized void	connect () throws IMConnectionException
synchronized void	disconnect ()
synchronized String	getAwayMessage (String buddyName)
String[]	getBuddiesInGroupNamed (String groupName)
String[]	getGroupNames ()
synchronized String	getStatusMessage (String buddyName)
synchronized boolean	isBuddyAway (String buddyName)
synchronized boolean	isBuddyOnline (String buddyName)
synchronized boolean	isConnected ()
	JOscarInstantMessenger (String screenName, String password)
void	removeBuddy (String buddyName)
synchronized void	sendMessage (String buddyName, String message, boolean ignoreIfOffline) throws MessageException
Protected Member Functions
void	buddyListModified ()
Private Attributes
AimSession	_aimSession
AimConnection	_conn
boolean	_connected
ConversationHandler	_conversationHandler
IcbmHandler	_icbmHandler
long	_lastBuddyListChange
long	_lastConnectionAttempt

---

Constructor & Destructor Documentation

JOscarInstantMessenger	(	String	screenName,
		String	password
	)

---

Member Function Documentation

BuddyInfo _addBuddyIfNecessary

(

String

buddyName

)

void addBuddy

(

String

buddyName

)

Adds a buddy to the buddy list.

Parameters:

buddyName

the name of the buddy to add

Exceptions:

InstantMessengerException

Implements IInstantMessenger.

long buddyListLastModified

(

)

Returns the timestamp of the last buddy list modification.

Returns:

the timestamp of the last buddy list modification

Implements IInstantMessenger.

void buddyListModified

(

)

[protected]

synchronized void connect

(

)

throws IMConnectionException

Connects to the instant messenger service.

Exceptions:

IMConnectionException

if the connect request fails

Implements IInstantMessenger.

synchronized void disconnect

(

)

Disconnects from the instant messenger service.

Implements IInstantMessenger.

synchronized String getAwayMessage

(

String

buddyName

)

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

Implements IInstantMessenger.

String [] getBuddiesInGroupNamed

(

String

groupName

)

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

Implements IInstantMessenger.

String [] getGroupNames

(

)

Returns the names of the buddy list groups.

Returns:

the names of the buddy list groups

Exceptions:

InstantMessengerException

Implements IInstantMessenger.

synchronized String getStatusMessage

(

String

buddyName

)

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

Implements IInstantMessenger.

synchronized boolean isBuddyAway

(

String

buddyName

)

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

Implements IInstantMessenger.

synchronized boolean isBuddyOnline

(

String

buddyName

)

Returns whether or not the specified buddy name is online.

Parameters:

buddyName

the name of the buddy to check for

Exceptions:

InstantMessengerException

Implements IInstantMessenger.

synchronized boolean isConnected

(

)

Returns whether or not this messenger is connected.

Implements IInstantMessenger.

void removeBuddy

(

String

buddyName

)

Removes a buddy from the buddy list.

Parameters:

buddyName

the name of the buddy to remove

Exceptions:

InstantMessengerException

Implements IInstantMessenger.

synchronized 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

Implements IInstantMessenger.

---

Member Data Documentation

AimSession _aimSession [private]

AimConnection _conn [private]

boolean _connected [private]

ConversationHandler _conversationHandler [private]

IcbmHandler _icbmHandler [private]

long _lastBuddyListChange [private]

long _lastConnectionAttempt [private]

---

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

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