Class ReportingClientHook
- java.lang.Object
-
- com.inductiveautomation.vision.api.client.AbstractClientModuleHook
-
- com.inductiveautomation.reporting.client.ReportingClientHook
-
- All Implemented Interfaces:
ClientModuleHook
public class ReportingClientHook extends AbstractClientModuleHook
-
-
Constructor Summary
Constructors Constructor Description ReportingClientHook()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addComponent(ILicenseAwareComponent component)
void
configureDeserializer(XMLDeserializer deserializer)
Called when an XMLDeserializer is created.void
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.void
notifyActivationStateChanged(LicenseState licenseState)
Notifies this client module that its license state has changed.void
removeComponent(ILicenseAwareComponent component)
protected void
setupRM14()
void
shutdown()
Called when the module is shut down.void
startup(ClientContext context, LicenseState activationState)
The main entrypoint for the module hook.-
Methods inherited from class com.inductiveautomation.vision.api.client.AbstractClientModuleHook
configureFunctionFactory, createPermissionKeys
-
-
-
-
Method Detail
-
configureDeserializer
public void configureDeserializer(XMLDeserializer deserializer)
Description copied from interface:ClientModuleHook
Called when an XMLDeserializer is created. Gives the module a chance to add custom deserialization delegates to the deserializer.- Specified by:
configureDeserializer
in interfaceClientModuleHook
- Overrides:
configureDeserializer
in classAbstractClientModuleHook
-
notifyActivationStateChanged
public void notifyActivationStateChanged(LicenseState licenseState)
Description copied from interface:ClientModuleHook
Notifies this client module that its license state has changed. Note that if the trial mode expires, the entire client will automatically time out, so client modules don't typically need to worry about trial mode.- Specified by:
notifyActivationStateChanged
in interfaceClientModuleHook
- Overrides:
notifyActivationStateChanged
in classAbstractClientModuleHook
-
shutdown
public void shutdown()
Description copied from interface:ClientModuleHook
Called when the module is shut down.- Specified by:
shutdown
in interfaceClientModuleHook
- Overrides:
shutdown
in classAbstractClientModuleHook
-
startup
public void startup(ClientContext context, LicenseState activationState) throws java.lang.Exception
Description copied from interface:ClientModuleHook
The main entrypoint for the module hook. This will only be called once for a given project. If another project is ever opened,ClientModuleHook.shutdown()
will be called and a new hook will be instantiated- Specified by:
startup
in interfaceClientModuleHook
- Overrides:
startup
in classAbstractClientModuleHook
- Throws:
java.lang.Exception
- if the module was not able to be initialized for the given project.
-
setupRM14
protected void setupRM14()
-
addComponent
public void addComponent(ILicenseAwareComponent component)
-
removeComponent
public void removeComponent(ILicenseAwareComponent component)
-
initializeScriptManager
public void initializeScriptManager(ScriptManager manager)
Description copied from interface:ClientModuleHook
Initialize a newly-instantiated script manager. This will be called exactly once for any given ScriptManager instance. Usually this will involve callingScriptManager.addScriptModule(String, Object)
, which reflectively loads the public (instance and static) java functions from the given object into the scripting environment, at the provided path.- Specified by:
initializeScriptManager
in interfaceClientModuleHook
- Overrides:
initializeScriptManager
in classAbstractClientModuleHook
-
-