Package com.flowable.action.api.bot

Class BaseBotActionResult

java.lang.Object

com.flowable.action.api.bot.BaseBotActionResult

All Implemented Interfaces:

BotActionResult

Direct Known Subclasses:

BpmnTestActionBot.TestBotActionResult

public class BaseBotActionResult
extends Object
implements BotActionResult

A base implementation for BotActionResult.

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected Intent	intent
protected Map<String,Object>	payload
protected com.fasterxml.jackson.databind.JsonNode	payloadNode

Constructor Summary

Constructors

Constructor	Description
BaseBotActionResult()
BaseBotActionResult(com.fasterxml.jackson.databind.JsonNode payloadNode, Intent intent)
BaseBotActionResult(Map<String,Object> payload)	Deprecated. use BaseBotActionResult(JsonNode, Intent) with Intent.NOOP as an intent
BaseBotActionResult(Map<String,Object> payload, Intent intent)	Deprecated. use BaseBotActionResult(JsonNode, Intent)

Method Summary

Modifier and Type	Method	Description
Intent	getIntent()	Action to perform in the user interface right after executing the bot action.
Map<String,Object>	getPayload()	Deprecated.
com.fasterxml.jackson.databind.JsonNode	getPayloadNode()	The information from invoking the action.

Methods inherited from class java.lang.Object

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

Field Details

payload

protected Map<String,Object> payload

payloadNode

protected com.fasterxml.jackson.databind.JsonNode payloadNode

intent

protected Intent intent

Constructor Details

BaseBotActionResult

public BaseBotActionResult()

BaseBotActionResult

@Deprecated
public BaseBotActionResult(Map<String,Object> payload)

Deprecated.

use BaseBotActionResult(JsonNode, Intent) with Intent.NOOP as an intent

BaseBotActionResult

@Deprecated
public BaseBotActionResult(Map<String,Object> payload,
 Intent intent)

Deprecated.

use BaseBotActionResult(JsonNode, Intent)

BaseBotActionResult

public BaseBotActionResult(com.fasterxml.jackson.databind.JsonNode payloadNode,
 Intent intent)

Method Details

getPayload

@Deprecated
public Map<String,Object> getPayload()

Deprecated.

Description copied from interface: BotActionResult

The information from invoking the action.

Specified by:

getPayload in interface BotActionResult

Returns:

the information that should be displayed to the user

getPayloadNode

public com.fasterxml.jackson.databind.JsonNode getPayloadNode()

Description copied from interface: BotActionResult

The information from invoking the action.

Specified by:

getPayloadNode in interface BotActionResult

Returns:

the information that should be displayed to the user

getIntent

public Intent getIntent()

Description copied from interface: BotActionResult

Action to perform in the user interface right after executing the bot action.

Specified by:

getIntent in interface BotActionResult

Returns:

UI action to perform in the frontend