ArchFlowBot(coreBotViewModel)

new ArchFlowBot(coreBotViewModel)

The Architect Scripting class for the Bot flow class. Instances of this Architect Scripting object should be created by calling ArchFactoryFlows#createFlowBotAsync

Parameters:
Name Type Description
coreBotViewModel Object

( Internal ) an Architect core Bot view model.

See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchFlowBot'.

readonly botFlowSettings :ArchSettingsBotFlow

Bot-specific settings for the flow.

Inherited From:

readonly isArchBaseFlowBot :boolean

Returns true indicating that this is an ArchBaseFlowBot instance.

Inherited From:

readonly isArchBaseFlowBotWithKnowledge :boolean

Returns true indicating that this is an isArchBaseFlowBotWithKnowledge instance.

Inherited From:

readonly isArchFlowBot :boolean

Returns true indicating that this is an ArchFlowBot instance.

readonly knowledgeSettings :ArchSettingsNluKnowledge|null

The natural language understanding knowledge settings for the bot flow. Note that if your organization does not have knowledge base support or the flow's supported language does not support knowledge, accessing this property will return null.

Inherited From:

readonly settingsErrorHandling :ArchSettingsEventErrorFlowBot

Returns the error handling settings for the flow.

Inherited From:

readonly settingsPrompts :ArchSettingsPromptsFlow

The prompt settings for the flow.

readonly settingsVirtualAgent :ArchSettingsNluVirtualAgent

The virtual agent settings for the flow.

readonly startUpObject :ArchState

Returns the starting state for this flow. If there is no startup object configured, accessing this property returns null.

Inherited From:

readonly states :Array.<ArchState>

The states in the flow.

Inherited From:

readonly userInputSettings :ArchSettingsUserInput

The user input settings for the flow.

Inherited From:

Methods

deleteState(stateToDelete)

This function deletes the specified state from this flow.

Parameters:
Name Type Description
stateToDelete ArchState

the state to delete.

Inherited From:

setStartingState(archState)

Sets the specified state to be the starting state on the flow.

Parameters:
Name Type Description
archState ArchState

An Architect Scripting state object.

Inherited From: