org.nukesoft.lineproc
Interface LineProcContextCallback

All Known Implementing Classes:
Dialog

public interface LineProcContextCallback

The LineProcContextCallback class is used by LineProc classes to pass off requests to the proper authority.

Author:
Ryan Michela

Method Summary
 void bindConversation(String dialogID)
          Forces all trafic to and from designated dialog to also be echoed to this LineProc.
 String[] getConversations()
          Fetches a list of all active conversations.
 String getIdentity()
          Returns the identity of the Dialog object.
 String getWarningLevel()
          Fetches the warning level of the account to which this conversation is bound.
 void sendIM(IM message)
          Sends an IM.
 void sendWarning(String screenName, boolean anonymous)
          Sends a warning.
 void unbindConversation(String dialogID)
          Halts all traffic to and from designated dialog.
 

Method Detail

sendIM

public void sendIM(IM message)
Sends an IM.

Parameters:
message - The IM to send.

sendWarning

public void sendWarning(String screenName,
                        boolean anonymous)
Sends a warning. May not work on all networks.

Parameters:
screenName - The screen name to warn.
anonymous - If TRUE, warn anonymously.

getWarningLevel

public String getWarningLevel()
Fetches the warning level of the account to which this conversation is bound.

Returns:
Integer string containing warning level if warning is supported on the supporting network. "N/A" if warning is not.

getIdentity

public String getIdentity()
Returns the identity of the Dialog object.

Returns:
Identity string in the form CommPortBindName:ForeignScreenName.

getConversations

public String[] getConversations()
Fetches a list of all active conversations.

Returns:
String array with fully qualified conversation names in the format CommPortBindName:ForeignScreenName.

bindConversation

public void bindConversation(String dialogID)
Forces all trafic to and from designated dialog to also be echoed to this LineProc.

Parameters:
dialogID - Dialog ID to bind to in the format CommPortBindName:ForeignScreenName.

unbindConversation

public void unbindConversation(String dialogID)
Halts all traffic to and from designated dialog. In other words, stops message echoing. Does nothing if not bound to target dialog.

Parameters:
dialogID - Dialog ID to unbind from in the format CommPortBindName:ForeignScreenName.