com.inductiveautomation.sfc.client

Class SFCClientHook

java.lang.Object

com.inductiveautomation.vision.api.client.AbstractClientModuleHook

com.inductiveautomation.sfc.client.SFCClientHook

All Implemented Interfaces:

ClientStepRegistryProvider, ClientModuleHook

public class SFCClientHook
extends AbstractClientModuleHook
implements ClientStepRegistryProvider

Constructor Summary

Constructors

Constructor and Description
SFCClientHook()

Method Summary

Modifier and Type	Method and Description
ClientStepRegistry	getStepRegistry()
void	initializeScriptManager(ScriptManager manager) Initialize a newly-instantiated script manager.
void	startup(ClientContext context, LicenseState activationState) The main entrypoint for the module hook.

Methods inherited from class com.inductiveautomation.vision.api.client.AbstractClientModuleHook

configureDeserializer, configureFunctionFactory, createPermissionKeys, notifyActivationStateChanged, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFCClientHook

public SFCClientHook()

Method Detail

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 interface ClientModuleHook

Overrides:

startup in class AbstractClientModuleHook

Throws:

java.lang.Exception - if the module was not able to be initialized for the given project.

getStepRegistry

public ClientStepRegistry getStepRegistry()

Specified by:

getStepRegistry in interface ClientStepRegistryProvider

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 calling ScriptManager.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 interface ClientModuleHook

Overrides:

initializeScriptManager in class AbstractClientModuleHook