DaimInstantMessenger Class Reference

Inherits er::imadaptor::AbstractInstantMessenger.

Collaboration diagram for DaimInstantMessenger:

Collaboration graph
[legend]

List of all members.

Classes

class  DaimOscarClient
class  Factory

Public Member Functions

void addBuddy (String buddyName) throws InstantMessengerException
long buddyListLastModified ()
void connect () throws IMConnectionException
 DaimInstantMessenger (String screenName, String password)
void disconnect ()
String getAwayMessage (String buddyName)
String[] getBuddiesInGroupNamed (String groupName)
String[] getGroupNames ()
String getStatusMessage (String buddyName)
boolean isBuddyAway (String buddyName)
boolean isBuddyOnline (String buddyName)
boolean isConnected ()
void removeBuddy (String buddyName) throws InstantMessengerException
void sendMessage (String buddyName, String message, boolean ignoreIfOffline) throws MessageException

Private Attributes

boolean _connected
long _lastConnectionAttempt
DaimOscarClient _oscarClient


Constructor & Destructor Documentation

DaimInstantMessenger ( String  screenName,
String  password 
)


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 

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 connect (  )  throws IMConnectionException

Connects to the instant messenger service.

Exceptions:
IMConnectionException if the connect request fails

Implements IInstantMessenger.

void disconnect (  ) 

Disconnects from the instant messenger service.

Implements IInstantMessenger.

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.

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.

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.

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.

boolean isConnected (  ) 

Returns whether or not this messenger is connected.

Implements IInstantMessenger.

void removeBuddy ( String  buddyName  )  throws InstantMessengerException

Removes a buddy from the buddy list.

Parameters:
buddyName the name of the buddy to remove
Exceptions:
InstantMessengerException 

Implements IInstantMessenger.

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

boolean _connected [private]

long _lastConnectionAttempt [private]


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

Generated on Sat May 26 06:43:18 2012 for Project Wonder by  doxygen 1.5.8