com.zion.jbuddy.bots
Class BotActionResultType

java.lang.Object
  com.zion.jbuddy.bots.BotActionResultType

public class BotActionResultType
extends Object

Available action result types. The engine sends different result content to the user depending on an action's result type.

See Also:

BotAction

Field Summary

static BotActionResultType	FILE Results are written to a temporary file and sent to the user as a BotFile.
static BotActionResultType	HTML Results are processed as HTML (rich content) and sent to the user as BotContent.
static BotActionResultType	NONE No results are returned.
static BotActionResultType	STRING Results are processed as a literal string (plain content) and sent to the user as BotContent.
static BotActionResultType	XHTML Results are processed as XHTML (rich content) and sent to the user as BotContent.
static BotActionResultType	XML Results are processed as Bot Definition XML.

Method Summary

String

toString()

Methods inherited from class java.lang.Object

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

Field Detail

STRING

public static BotActionResultType STRING

Results are processed as a literal string (plain content) and sent to the user as BotContent. Formatting tags within the string are NOT processed.

HTML

public static BotActionResultType HTML

Results are processed as HTML (rich content) and sent to the user as BotContent.

XHTML

public static BotActionResultType XHTML

Results are processed as XHTML (rich content) and sent to the user as BotContent.

FILE

public static BotActionResultType FILE

Results are written to a temporary file and sent to the user as a BotFile.

XML

public static BotActionResultType XML

Results are processed as Bot Definition XML. The XML is parsed dynamically into a BotCall and presented to the user as if it was part of the original Bot Definition.

For example, an XML action could return the following string to present a menu to the user:

"<menu xmlns='http://www.zionsoftware.com/jbuddy/bot'>" + " <title>A Dynamic Menu</title>" + " <target command='content'>" + " <content>Here is some example content.</content>" + " </target>" + "</menu>"

NONE

public static BotActionResultType NONE

No results are returned. If the action normally returns results, the results are ignored.

Method Detail

toString

public String toString()

Overrides:

toString in class Object