Package com.inductiveautomation.perspective.common.config

Class SystemEventsConfig

java.lang.Object

com.inductiveautomation.ignition.common.script.ScriptConfig

com.inductiveautomation.perspective.common.config.SystemEventsConfig

public class SystemEventsConfig
extends ScriptConfig

A subclass of the Ignition platform's ScriptConfig class that adds JSON serialization / deserialization. Also provides additional script configurations to support perspective session lifecycle and mobile data submission handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemEventsConfig.GsonAdapter

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<KeyEvent,java.lang.String>	keyEventHandlerScripts
static ResourceType	RESOURCE_TYPE

Fields inherited from class com.inductiveautomation.ignition.common.script.ScriptConfig

messageHandlerManager, messageHandlerScripts, MODULE_ID, scheduledScriptManager, scheduledScripts, shutdownScript, startupScript, tagChangeManager, tagChangeScripts, timerScriptManager, timerScripts, updateScript

Constructor Summary

Constructors

Constructor	Description
SystemEventsConfig()

Method Summary

Modifier and Type	Method	Description
static SystemEventsConfig	fromJson(byte[] bytes)
static SystemEventsConfig	fromJson(com.inductiveautomation.ignition.common.gson.JsonObject json)
java.lang.String	getAuthChallengeCompletedScript()
java.util.Map<KeyEvent,java.lang.String>	getKeyEventHandlerScripts()
java.util.Optional<java.lang.String>	getMobileHandlerScript(java.lang.String type)
java.lang.String	getPageStartupScript()
void	setAuthChallengeCompletedScript(java.lang.String script)
void	setKeyEventHandlerScripts(java.util.Map<KeyEvent,java.lang.String> map)
void	setMobileHandlerScript(java.lang.String type, java.lang.String script)
void	setPageStartupScript(java.lang.String script)
com.inductiveautomation.ignition.common.gson.JsonObject	toJson()

Methods inherited from class com.inductiveautomation.ignition.common.script.ScriptConfig

getMessageHandlerExecutionReports, getMessageHandlerManager, getMessageHandlerScriptDiagnostics, getMessageHandlerScripts, getScheduledScriptDiagnostics, getScheduledScripts, getShutdownScript, getStartupScript, getTagChangeScriptDiagnostics, getTagChangeScriptExecutionReports, getTagChangeScripts, getTimerScriptDiagnostics, getTimerScriptExecutionReports, getTimerScripts, getUpdateScript, invokeGWMessageHandler, invokeGWMessageHandler, invokeGWRequestHandler, invokeGWRequestHandler, setMessageHandlerScripts, setScheduledScripts, setShutdownScript, setStartupScript, setTagChangeScripts, setTagChangeScripts, setTimerScripts, setUpdateScript, shutdown, startup

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

keyEventHandlerScripts

protected java.util.Map<KeyEvent,java.lang.String> keyEventHandlerScripts

Constructor Detail

SystemEventsConfig

public SystemEventsConfig()

Method Detail

toJson

public com.inductiveautomation.ignition.common.gson.JsonObject toJson()

fromJson

public static SystemEventsConfig fromJson(byte[] bytes)
                                   throws com.inductiveautomation.ignition.common.gson.JsonParseException

Throws:

com.inductiveautomation.ignition.common.gson.JsonParseException

fromJson

public static SystemEventsConfig fromJson(com.inductiveautomation.ignition.common.gson.JsonObject json)

setMobileHandlerScript

public void setMobileHandlerScript(@Nonnull
                                   java.lang.String type,
                                   @Nonnull
                                   java.lang.String script)

getMobileHandlerScript

public java.util.Optional<java.lang.String> getMobileHandlerScript(@Nonnull
                                                                   java.lang.String type)

setPageStartupScript

public void setPageStartupScript(@Nonnull
                                 java.lang.String script)

getPageStartupScript

public java.lang.String getPageStartupScript()

setAuthChallengeCompletedScript

public void setAuthChallengeCompletedScript(java.lang.String script)

getAuthChallengeCompletedScript

public java.lang.String getAuthChallengeCompletedScript()

setKeyEventHandlerScripts

public void setKeyEventHandlerScripts(java.util.Map<KeyEvent,java.lang.String> map)

getKeyEventHandlerScripts

public java.util.Map<KeyEvent,java.lang.String> getKeyEventHandlerScripts()