abstract ArchBaseActionBotWithSessionVariables(coreBaseBotActionViewModel)

new abstract ArchBaseActionBotWithSessionVariables(coreBaseBotActionViewModel)

The Architect Scripting class for the Base Bot Action with Session Variables instance. Instances of this class will be created automatically by Architect Scripting as needed.

Parameters:
Name Type Description
coreBaseBotActionViewModel Object

( Internal ) an Architect core bot action view model.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchBaseActionBot'.

static, readonly isArchBaseActionBotWithSessionVariables :boolean

Returns true indicating that this is an ArchBaseActionBot instance.

readonly failureOutputs :ArchNamedValueList

The failure outputs (errorType, errorMessage) that get populated when the action takes the failure path. Cached on first access. Returns undefined if the action has no errorBindings.

Inherited From:

readonly outputFailure :ArchActionOutput

The failure output for this action

Inherited From:

readonly sessionVariables :ArchBaseNameValuePairs

Returns the input Session Variables configured on the action.

Methods

addSessionVariableNameValuePair(nameLiteralopt, valueExpressionopt) → {ArchBaseNameValuePair}

This adds a session variable name value pair to the Base Bot action that can be used to specify the session variable's name and corresponding value that should be assigned to it. On the returned ArchBaseNameValuePair pair:

  • the name property specifies the name of the session variable whose value you want to set
  • the value property is the value to set on the session variable at runtime.
Parameters:
Name Type Attributes Description
nameLiteral string <optional>

a string that specifies the name of the session variable to set.

valueExpression string <optional>

a string expression that specifies the value to set on the session variable.