Documentation - CSK_Module_MultiWebSocketClient 1.0.0

CSK_MultiWebSocketClient.addEventToForward(event)

CSK_MultiWebSocketClient.addEventToForwardViaUI()

CSK_MultiWebSocketClient.addInstance()

CSK_MultiWebSocketClient.clearFlowConfigRelevantConfiguration()

CSK_MultiWebSocketClient.deleteEventToForward(event)

CSK_MultiWebSocketClient.deleteEventToForwardViaUI()

amount = CSK_MultiWebSocketClient.getInstancesAmount()

jsonParameters = CSK_MultiWebSocketClient.getParameters(instanceNo)

status = CSK_MultiWebSocketClient.getStatusModuleActive()

success = CSK_MultiWebSocketClient.loadParameters()

empty = CSK_MultiWebSocketClient.pageCalled()

CSK_MultiWebSocketClient.resetInstances()

CSK_MultiWebSocketClient.resetModule()

CSK_MultiWebSocketClient.selectEventToForwardViaUI(selection)

CSK_MultiWebSocketClient.sendParameters(noDataSave)

CSK_MultiWebSocketClient.setConnectionStatus(status)

CSK_MultiWebSocketClient.setConnectionTimeout(timeout)

CSK_MultiWebSocketClient.setDataToTransmit(data)

CSK_MultiWebSocketClient.setEventToForward(value)

CSK_MultiWebSocketClient.setFlowConfigPriority(status)

CSK_MultiWebSocketClient.setLoadOnReboot(status)

CSK_MultiWebSocketClient.setMessageFormat(format)

CSK_MultiWebSocketClient.setParameterName(name)

CSK_MultiWebSocketClient.setSelectedInstance(instance)

CSK_MultiWebSocketClient.setServerURL(url)

CSK_MultiWebSocketClient.setShowLog(status)

CSK_MultiWebSocketClient.stopFlowConfigRelevantProvider()

success = CSK_MultiWebSocketClient.transmitDataNUM(data)

CSK_MultiWebSocketClient.transmitDataViaUI()

function handleOnDataLoadedOnReboot()
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")

function handleOnNewDataNUM(data, format)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewDataNUM", "handleOnNewDataNUM")

function handleOnNewEventToForward(eventName)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewEventToForward", "handleOnNewEventToForward")

function handleOnNewEventToForwardList(list)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewEventToForwardList", "handleOnNewEventToForwardList")

function handleOnNewInstanceList(list)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewInstanceList", "handleOnNewInstanceList")

function handleOnNewLog(log)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewLog", "handleOnNewLog")

function handleOnNewParameterName(name)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewParameterName", "handleOnNewParameterName")

function handleOnNewProcessingParameter(objectNo, parameter, value)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewProcessingParameter", "handleOnNewProcessingParameter")

function handleOnNewSelectedInstance(selectedObject)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewSelectedInstance", "handleOnNewSelectedInstance")

function handleOnNewStatusConnectionStatus(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusConnectionStatus", "handleOnNewStatusConnectionStatus")

function handleOnNewStatusConnectionTimeout(timeout)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusConnectionTimeout", "handleOnNewStatusConnectionTimeout")

function handleOnNewStatusCSKStyle(theme)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")

function handleOnNewStatusCurrentlyConnected(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusCurrentlyConnected", "handleOnNewStatusCurrentlyConnected")

function handleOnNewStatusFlowConfigPriority(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")

function handleOnNewStatusLoadParameterOnReboot(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")

function handleOnNewStatusMessageFormat(format)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusMessageFormat", "handleOnNewStatusMessageFormat")

function handleOnNewStatusModuleIsActive(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")

function handleOnNewStatusModuleVersion(version)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")

function handleOnNewStatusShowLog(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusShowLog", "handleOnNewStatusShowLog")

function handleOnNewStatusTempDataToTransmit(data)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusTempDataToTransmit", "handleOnNewStatusTempDataToTransmit")

function handleOnNewStatusURL(url)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewStatusURL", "handleOnNewStatusURL")

function handleOnNewValueToForwardNUM(eventname, value)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")

function handleOnNewValueUpdateNUM(instance, parameter, value, selectedObject)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")

function handleOnPersistentDataModuleAvailable(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")

function handleOnUserLevelAdminActive(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")

function handleOnUserLevelMaintenanceActive(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")

function handleOnUserLevelOperatorActive(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")

function handleOnUserLevelServiceActive(status)
  -- Do something
end

Script.register("CSK_MultiWebSocketClient.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

handle = MultiWebSocketClient_FC.OnReceive.create(Instance)

success = MultiWebSocketClient_FC.OnReceive.register(handle, eventname, callback)

function handleOnNewData(handle, OnNewData)
  -- Do something
end

Script.register("MultiWebSocketClient_FC.OnReceive.OnNewData", "handleOnNewData")

handle = MultiWebSocketClient_FC.Transmit.create(Instance)

MultiWebSocketClient_FC.Transmit.transmit(handle, source1, source2, source3, source4)