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 final record	SystemEventsConfig.AccelerometerScript
static final record	SystemEventsConfig.AuthChallengeScript
static final record	SystemEventsConfig.BarcodeScript
static final record	SystemEventsConfig.BluetoothScript
static class	SystemEventsConfig.GsonAdapter
static final record	SystemEventsConfig.KeyEventScript
static final record	SystemEventsConfig.NfcScanScript
static final record	SystemEventsConfig.PageStartupScript

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.script.ScriptConfig

ScriptConfig.MessageHandlerScript, ScriptConfig.ShutdownScript, ScriptConfig.StartupScript, ScriptConfig.TagChangeScriptEvent, ScriptConfig.TimerScript

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_HANDLERS
protected Map<KeyEvent,String>	keyEventHandlerScripts
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	MESSAGE_HANDLER_DESCRIPTOR
static final String	MESSAGE_HANDLERS
static final ResourceType	MESSAGE_RESOURCE_TYPE
static final String	ON_AUTH_CHALLENGE_COMPLETED
static final String	ON_PAGE_STARTUP
static final String	ON_SHUTDOWN
static final String	ON_STARTUP
static final ResourceType	RESOURCE_TYPE
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	SHUTDOWN_DESCRIPTOR
static final ResourceType	SHUTDOWN_RESOURCE_TYPE
static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	STARTUP_DESCRIPTOR
static final ResourceType	STARTUP_RESOURCE_TYPE

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

ENABLED_KEY, MESSAGE_SCRIPT_VALUE, messageHandlerScripts, PROJECT_UPDATE_VALUE, SCHEDULED_SCRIPT_VALUE, scheduledScripts, SHUTDOWN_LOCATION_VALUE, shutdownScript, STARTUP_LOCATION_VALUE, startupScript, TAG_CHANGE_VALUE, tagChangeScripts, TIMER_SCRIPT_VALUE, timerScripts, updateScript

Constructor Summary

Constructors

Constructor	Description
SystemEventsConfig()

Method Summary

Modifier and Type	Method	Description
Map<ResourcePath,Consumer<ResourceBuilder>>	collectMigrationScriptMappings()	Collects legacy script configurations (startup, shutdown, tag change, etc.) and maps each to its corresponding ResourcePath and ResourceBuilder.
static SystemEventsConfig	fromJson(byte[] bytes)
static SystemEventsConfig	fromJson(com.inductiveautomation.ignition.common.gson.JsonObject json)
String	getAuthChallengeCompletedScript()
Map<KeyEvent,String>	getKeyEventHandlerScripts()
Optional<String>	getMobileHandlerScript(String type)
String	getPageStartupScript()
void	setAuthChallengeCompletedScript(String script)
void	setKeyEventHandlerScripts(Map<KeyEvent,String> map)
void	setMobileHandlerScript(String type, String script)
void	setPageStartupScript(String script)
com.inductiveautomation.ignition.common.gson.JsonObject	toJson()

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

getMessageHandlerScripts, getScheduledScripts, getShutdownScript, getStartupScript, getTagChangeScripts, getTimerScripts, getUpdateScript, setMessageHandlerScripts, setScheduledScripts, setShutdownScript, setStartupScript, setTagChangeScripts, setTagChangeScripts, setTimerScripts, setUpdateScript

Methods inherited from class java.lang.Object

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

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

STARTUP_RESOURCE_TYPE

public static final ResourceType STARTUP_RESOURCE_TYPE

SHUTDOWN_RESOURCE_TYPE

public static final ResourceType SHUTDOWN_RESOURCE_TYPE

MESSAGE_RESOURCE_TYPE

public static final ResourceType MESSAGE_RESOURCE_TYPE

ON_STARTUP

public static final String ON_STARTUP

See Also:

• Constant Field Values

ON_PAGE_STARTUP

public static final String ON_PAGE_STARTUP

See Also:

• Constant Field Values

ON_SHUTDOWN

public static final String ON_SHUTDOWN

See Also:

• Constant Field Values

ON_AUTH_CHALLENGE_COMPLETED

public static final String ON_AUTH_CHALLENGE_COMPLETED

See Also:

• Constant Field Values

MESSAGE_HANDLERS

public static final String MESSAGE_HANDLERS

See Also:

• Constant Field Values

KEY_HANDLERS

public static final String KEY_HANDLERS

See Also:

• Constant Field Values

keyEventHandlerScripts

protected Map<KeyEvent,String> keyEventHandlerScripts

STARTUP_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor STARTUP_DESCRIPTOR

SHUTDOWN_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor SHUTDOWN_DESCRIPTOR

MESSAGE_HANDLER_DESCRIPTOR

public static final com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor MESSAGE_HANDLER_DESCRIPTOR

Constructor Details

SystemEventsConfig

public SystemEventsConfig()

Method Details

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
 String type,
 @Nonnull
 String script)

getMobileHandlerScript

public Optional<String> getMobileHandlerScript(@Nonnull
 String type)

setPageStartupScript

public void setPageStartupScript(@Nonnull
 String script)

getPageStartupScript

public String getPageStartupScript()

setAuthChallengeCompletedScript

public void setAuthChallengeCompletedScript(String script)

getAuthChallengeCompletedScript

public String getAuthChallengeCompletedScript()

setKeyEventHandlerScripts

public void setKeyEventHandlerScripts(Map<KeyEvent,String> map)

getKeyEventHandlerScripts

public Map<KeyEvent,String> getKeyEventHandlerScripts()

collectMigrationScriptMappings

public Map<ResourcePath,Consumer<ResourceBuilder>> collectMigrationScriptMappings()

Description copied from class: ScriptConfig

Collects legacy script configurations (startup, shutdown, tag change, etc.) and maps each to its corresponding ResourcePath and ResourceBuilder. The resulting map contains builders to construct and serialize these scripts into resources on disk

Overrides:

collectMigrationScriptMappings in class ScriptConfig