JSDoc: Class: FlowScriptCompiler

Constructor

Source:

Compiles the CFL script using the FlowScriptDoc provided by the Load method.

Source:

Loads a CFL script. This is used when loading an app or for widget builders wanting to accept CFL as a parameter (see violetList as an example).

Source:

Registers a Conversational Element (Widget) to be used in a FlowScript. This method is intended to be called by Widget Implementations when loaded.

Name Type Description

widgetDef

Object

widget definition

Name	Type	Description
`name`	String	name of the widget, i.e. what the element name is going to be in the CFL for this widget.
`init`	String	initiatilizes the widget for every element in the CFL document. This parameter method is used rarely (only by app, decision and dialog widgets) so that the code is called at compile time once for every node and intents/hooks are registered using the registeringIntentHooks method. This callback is called with three parameters: a reference to the CFL Doc, a reference to Violet (the conversation engine), and a reference to the widget node.
`fIntentType`	Boolean	used to flag if the widget type needs to be associated with a intent/hook when the registeringIntentHooks method is called. It is currently used by the choice adn dialog widgets.
`impl`	Object	implementation for the widget. This is called at runtime when the widget gets triggered. Most widgets need to provide an implementation for this. The typical example is the say widget. This callback is called with three parameters: a reference to the runtime response object, a reference to the CFL Doc, and a reference to the widget node
`fNonNestable`	Boolean	used to flag widgets that are not to be processed by the FlowScriptCompiler. These are used when non-CFL elements are nested inside the given widget, for example with the say element which can include SSML tags.

Source:

Calls the implementation (resolve method) of children elements.

Source: