leafchat.core.api
Interface Plugin


public interface Plugin

Interface that must be implemented by all Plugin main classes


Method Summary
 void close()
          Plugin is being closed and should free resources etc if necessary.
 void init(PluginContext pc, PluginLoadReporter status)
          Plugin should store context for future use (if necessary) and register itself with events in which it has interest.
 

Method Detail

init

void init(PluginContext pc,
          PluginLoadReporter status)
          throws GeneralException
Plugin should store context for future use (if necessary) and register itself with events in which it has interest.

Parameters:
pc - Context for plugin
status - Load reporter to optionally display messages in splash
Throws:
GeneralException - Any error

close

void close()
           throws GeneralException
Plugin is being closed and should free resources etc if necessary. (Importantly, if this plugin created any threads, it should ensure that they end within a few hundred milliseconds of this call.)

Throws:
GeneralException - Any error


Copyright © 2011 Samuel Marshall. All rights reserved.