Package com.inductiveautomation.vision.api.designer.beans

Class ExtensionFunctionDescriptor

java.lang.Object

com.inductiveautomation.vision.api.designer.beans.ExtensionFunctionDescriptor

public class ExtensionFunctionDescriptor
extends Object

Describes an extension function that a component may call during it's lifecycle. To add support for extension functions on your component, do the following:

1. Have your component implement the ExtensibleComponent interface.
2. Add a List of these descriptors to your bean descriptor. In your bean info's initDesc() method, add a list of these descriptors as an additional value under the key EXTENSION_FUNCTIONS

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtensionFunctionDescriptor.Argument	An argument for an extension function.
static class	ExtensionFunctionDescriptor.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_FUNCTIONS	The key for a bean descriptor property that defines a component's list of extension functions that may be implemented.

Method Summary

Modifier and Type	Method	Description
List<ExtensionFunctionDescriptor.Argument>	getArgs()
String	getDescription()
String	getImplementation()
String	getMethodName()
Class<?>	getReturnType()
static ExtensionFunctionDescriptor.Builder	newFunction(String methodName)
com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	toModernDescriptor()

Methods inherited from class java.lang.Object

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

Field Details

EXTENSION_FUNCTIONS

public static final String EXTENSION_FUNCTIONS

The key for a bean descriptor property that defines a component's list of extension functions that may be implemented.

See Also:

• Constant Field Values

Method Details

newFunction

public static ExtensionFunctionDescriptor.Builder newFunction(String methodName)

getMethodName

public String getMethodName()

getReturnType

public Class<?> getReturnType()

getDescription

public String getDescription()

getImplementation

public String getImplementation()

getArgs

public List<ExtensionFunctionDescriptor.Argument> getArgs()

toModernDescriptor

public com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor toModernDescriptor()