ScriptFunction (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

PrefixedEnum

All Known Implementing Classes:

CustomOperationScriptFunction, CustomWizardScriptFunction, DefaultScriptFunction, ExtensionPointScriptFunction, InboundSmsScriptFunction, LoadValuesScriptFunction, PhoneNumberHandlingScriptFunction, ServiceInterceptorScriptFunction, SessionHandlingScriptFunction
```
public interface ScriptFunction
extends PrefixedEnum
```
Defines a script function. Each ScriptType has one or more functions which are called in different context

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class ScriptFunction.Mapping

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`MessageKey`	`messageKey()`	Returns a message key to use for this function
`String`	`name()`	Returns the function name
`boolean`	`required()`	Returns whether the function is required

Methods inherited from interface org.cyclos.utils.PrefixedEnum
prefix

- Method Detail
  - messageKey
```
MessageKey messageKey()
```
    Returns a message key to use for this function
  - name
```
String name()
```
    Returns the function name
    
    Specified by:
    
    name in interface PrefixedEnum
  - required
```
boolean required()
```
    Returns whether the function is required