Extends

• ArchBaseActionDataAction

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionCallData'.

readonly dataActionInputs :ArchNamedValueList

The contents of this named value list come from the selected data action's reported input schema. The name value pair items in this list will let you assign values that will be used as inputs to the data action at runtime. Note that this named value list may be undefined even if a valid data action is specified on the action. If no data action is specified on this action, this will return undefined.

Inherited From:

• ArchBaseActionDataAction#dataActionInputs

readonly dataActionOutputsFailure :ArchNamedValueList

The contents of this named value list come from the selected data action's reported output failure schema. The name value pair items in this list will let you assign variables that will be populated with failure information at runtime if execution of the data action fails. Note that this named value list may be undefined even if a valid data action is specified on the action. If no data action is specified on this action, this will return undefined.

Inherited From:

• ArchBaseActionDataAction#dataActionOutputsFailure

readonly dataActionOutputsSuccess :ArchNamedValueList

The contents of this named value list come from the selected data action's reported success output schema. The name value pair items in this list will let you assign variables that will be populated with output values from the data action if execution is successful. Note that this named value list may be undefined even if a valid data action is specified on the action. If no data action is specified on this action, this will return undefined.

Inherited From:

• ArchBaseActionDataAction#dataActionOutputsSuccess

readonly displayTypeName :string

Returns the display type name string 'ArchBaseActionDataAction'.

Overrides:

• ArchBaseActionDataAction#displayTypeName

readonly isArchActionCallData :boolean

Returns true indicating that this is an ArchActionCallData instance.

readonly isArchBaseActionDataAction :boolean

Returns true indicating that this is an ArchBaseActionDataAction instance.

Inherited From:

• ArchBaseActionDataAction#isArchBaseActionDataAction

readonly processingPrompt :ArchValuePrompt

Returns the processing prompt value where you can set the prompt to play on the call when the system is busy processing the data action configured on this action.

Inherited From:

• ArchBaseActionDataAction#processingPrompt

readonly supportsDataActionOutputsFailure :boolean

Returns whether failure outputs are supported on this Data Action instance based on the flow type that the Data Action is being used in.

Inherited From:

• ArchBaseActionDataAction#supportsDataActionOutputsFailure

readonly timeout :ArchValueDuration

Specifies the amount of time to wait for the data action invocation to complete execution at runtime. Note that this value only applies if ArchBaseActionDataAction#useSuggestedTimeout is false.

Inherited From:

• ArchBaseActionDataAction#timeout

useSuggestedTimeout :boolean

Indicates whether or not to use the action provided suggested timeout at runtime.

Inherited From:

• ArchBaseActionDataAction#useSuggestedTimeout

Methods

setDataActionByIdAsync(dataActionId, callbackFunctionopt) → {Promise.<ArchActionCallData>}

This sets the data action to call at runtime by its identifier.

Parameters:

Name	Type	Attributes	Description
dataActionId	string		the identifier of the Data Action Service action.
callbackFunction	callbackArchActionCallData	<optional>	a callback function to call if the Data Action Service action action is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect call data action instance.

Returns:

Promise.<ArchActionCallData>

setDataActionByNameAsync(dataActionName, callbackFunctionopt, categoryNameopt) → {Promise.<ArchActionCallData>}

This sets the data action to call at runtime by its name.

Parameters:

Name	Type	Attributes	Description
dataActionName	string		the name of the Data Action Service action.
callbackFunction	function	<optional>	a callback function to call if the Data Action is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect call data action instance.
categoryName	string	<optional>	if a non-blank string is supplied for the category name, the data action will be set only if it belongs to the specified category. Category name lookups are performed case insensitively. Additionally if you have a scenario where multiple data actions are named the same but reside in different categories, use this parameter to specify the category to disambiguate the data action you want.

Returns:

Promise.<ArchActionCallData>