new ArchActionCallDataSecure(coreSecureActionViewModel)
The Architect Scripting class that represents the Call Secure Data Action action.
Instances of this action should be created by calling ArchFactoryActions#addActionCallDataSecure
Parameters:
| Name | Type | Description |
|---|---|---|
coreSecureActionViewModel |
Object | ( Internal ) an Architect core call secure action view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionCallDataSecure'.
-
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:
-
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:
-
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:
-
readonly displayTypeName :string
-
Returns the display type name string 'ArchBaseActionDataAction'.
- Overrides:
-
readonly isArchActionCallDataSecure :boolean
-
Returns true indicating that this is an ArchActionCallDataSecure instance.
-
readonly isArchBaseActionDataAction :boolean
-
Returns true indicating that this is an ArchBaseActionDataAction instance.
- Inherited From:
-
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:
-
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:
-
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#useSuggestedTimeoutis false.- Inherited From:
-
useSuggestedTimeout :boolean
-
Indicates whether or not to use the action provided suggested timeout at runtime.
- Inherited From:
Methods
-
setDataSecureActionByIdAsync(secureActionId, callbackFunctionopt) → {Promise.<ArchActionCallDataSecure>}
-
This sets the secure action to call at runtime by its identifier.
Parameters:
Name Type Attributes Description secureActionIdstring the identifier of the Secure Action Service action.
callbackFunctioncallbackArchActionCallDataSecure <optional>
a callback function to call if the Secure 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 secure action instance.
Returns:
Promise.<ArchActionCallDataSecure> -
setDataSecureActionByNameAsync(dataSecureActionName, callbackFunctionopt, categoryNameopt) → {Promise.<ArchActionCallDataSecure>}
-
This sets the secure data action to call at runtime by its name.
Parameters:
Name Type Attributes Description dataSecureActionNamestring the name of the Secure Data Action Service action. The name is not case sensitive on the lookup.
callbackFunctionfunction <optional>
a callback function to call if the Secure Data Action is successfully looked up and configured on this action. The first parameter passed to the callback function will be this Architect call secure action instance.
categoryNamestring <optional>
if a non-blank string is supplied for the category name, the secure 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 secure data actions are named the same but reside in different categories, use this parameter to specify the category to disambiguate the secure data action you want.
Returns:
Promise.<ArchActionCallDataSecure>