com.objexcel.chataddin
Interface IChatAddIn


public abstract interface IChatAddIn

An IChatAddIn is an interface for all chat addins to implement. It provides a means to get the initial app context for the addin and a mechanism to be notified when the addin is unloaded.


Method Summary
 java.lang.String getAuthorInfo()
          Returns info on the add-ins author.
 java.lang.String getHelp()
          Return any information needed to use or set up the addin.
 java.lang.String getName()
          Returns the addin name.
 java.lang.String getPurpose()
          Return what the addin does.
 void init(IAddInApp context)
          called after the addin is created, allows the addin to grab hold of the app context.
 void unload()
          unload is called just prior to the addin being dumped.
 

Method Detail

init

public void init(IAddInApp context)
called after the addin is created, allows the addin to grab hold of the app context.

unload

public void unload()
unload is called just prior to the addin being dumped. Lets your addin perform cleanup before it is shutdown.

getName

public java.lang.String getName()
Returns the addin name.

getAuthorInfo

public java.lang.String getAuthorInfo()
Returns info on the add-ins author. May include name, email address and/or download URL.

getPurpose

public java.lang.String getPurpose()
Return what the addin does.

getHelp

public java.lang.String getHelp()
Return any information needed to use or set up the addin.