Package com.inductiveautomation.ignition.gateway.project

Interface LegacyProjectScriptManager

public interface LegacyProjectScriptManager

Method Summary

Modifier and Type	Method	Description
List<ProjectScriptDiagnostic>	getProjectScriptDiagnostics(String projectName, ProjectScriptDiagnostic.DiagnosticType type)	Get the ProjectScriptDiagnostic for a Project.
void	invokeGWMessageHandler(String projectName, String messageHandlerName, org.python.core.PyDictionary messageParams, MessageResultHandler handler, Properties properties)	Invokes the specified Gateway message handler on a project.

Method Details

getProjectScriptDiagnostics

List<ProjectScriptDiagnostic> getProjectScriptDiagnostics(String projectName,
 ProjectScriptDiagnostic.DiagnosticType type)

Get the ProjectScriptDiagnostic for a Project.

Parameters:

projectName - the name of the Project.

type - the diagnostic type.

Returns:

the ProjectScriptDiagnostic for projectName.

invokeGWMessageHandler

void invokeGWMessageHandler(String projectName,
 String messageHandlerName,
 org.python.core.PyDictionary messageParams,
 MessageResultHandler handler,
 Properties properties)
                     throws MessageHandlerException

Invokes the specified Gateway message handler on a project. The messageParams PyDictionary object is passed to the message handler.

Parameters:

projectName - The project name.

messageHandlerName - The name of the Gateway message handler in the Project.

messageParams - a PyDictionary that is passed to the message handler. See MessageDispatchManager for details.

handler - a result handler. May be null.

properties - Contains associated properties, like originating user and zone. May be null.

Throws:

MessageHandlerException - if the message handler cannot be found in the project or some other problem occurred.