com.inductiveautomation.ignition.common.script.hints

Interface ScriptFunctionHint

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PackageHint

public interface ScriptFunctionHint
extends java.io.Serializable

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutocompleteText()
java.lang.String	getMethodDescription()
java.lang.String	getMethodSignature()
java.util.Map<java.lang.String,java.lang.String>	getParameterDescriptions()
java.lang.String	getReturnValueDescription()

Method Detail

getAutocompleteText

java.lang.String getAutocompleteText()

Returns:

The String to insert if the user chooses to auto-complete this hint.

getMethodSignature

java.lang.String getMethodSignature()

Returns:

The formatted String to use as the method signature.

getMethodDescription

java.lang.String getMethodDescription()

Returns:

A description of what the function does.

getParameterDescriptions

java.util.Map<java.lang.String,java.lang.String> getParameterDescriptions()

Returns:

Map of parameter names matched to their descriptions.

getReturnValueDescription

java.lang.String getReturnValueDescription()

Returns:

A description of the function's return value.