com.rivescript.macro

Interface ObjectHandler

All Known Implementing Classes:

GroovyHandler, JavaScriptHandler, Jsr223ScriptingHandler, Perl, RubyHandler

public interface ObjectHandler

Interface for RiveScript object handlers.

Author:

Noah Petherbridge, Marcel Overdijk

Method Summary

Modifier and Type	Method and Description
java.lang.String	call(RiveScript rs, java.lang.String name, java.lang.String[] fields) Handler for when a user invokes the object.
void	load(RiveScript rs, java.lang.String name, java.lang.String[] code) Handler for when object code is read (loaded) by RiveScript.

Method Detail

load

void load(RiveScript rs,
          java.lang.String name,
          java.lang.String[] code)

Handler for when object code is read (loaded) by RiveScript.

Parameters:

rs - the reference to the parent RiveScript instance

name - the name of the object

code - the source code inside the object

call

java.lang.String call(RiveScript rs,
                      java.lang.String name,
                      java.lang.String[] fields)

Handler for when a user invokes the object. Should return the String result from the object.

This code is executed when a <call> tag in a RiveScript reply wants to call your object macro.

Parameters:

rs - the reference to the parent RiveScript instance

name - the name of the object being called

fields - the argument list from the call tag

Returns:

the result