ArchActionWaitForInput(coreWaitForInputActionViewModel)

new ArchActionWaitForInput(coreWaitForInputActionViewModel)

The Architect Scripting class that represents the Wait for Input action. Instances of this action should be created by calling ArchFactoryActions#addActionWaitForInput

Parameters:
Name Type Description
coreWaitForInputActionViewModel Object

( Internal ) an Architect core Wait for Input action view model.
See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionWaitForInput'.

customizeNoMatch :ArchValueBoolean

If this property is set to true, the ArchActionWaitForInput#noMatchReprompts communication collection will be used for No Match prompts. Otherwise, the ArchActionWaitForInput#noMatch communication will be used.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseAction'.

Overrides:

readonly displayTypeNameArchitect :string

The Architect action type label

Inherited From:

readonly isArchActionWaitForInput :boolean

Returns true indicating that this is an ArchActionWaitForInput instance.

readonly isArchBaseAction :boolean

A property that can be checked to verify the scripting object is a type of ArchBaseAction

Inherited From:

readonly isMenuChoiceAction :boolean

Returns whether or not this action is the action property for a menu choice. For example, the ArchMenuDisconnect#actionDisconnect property on an ArchMenuDisconnect instance.

Inherited From:

readonly isReachable :boolean

Returns whether or not this action is reachable at runtime.

Inherited From:

readonly isSecure :boolean

Returns whether or not this action is secure which means either the action by its very nature is secure or it consumes secure data.

Inherited From:

readonly isUnreachable :boolean

Returns whether or not this action is unreachable at runtime.

Inherited From:

readonly knowledgeSearchResult :ArchValueKnowledgeBaseDocumentCollection

The variable that holds the collection of KnowledgeBaseDocument objects matched in the search that occurs at this action. If 'Standard' knowledge handling is selected then the search results collection will only ever contain the article shown to the user. If 'Custom' knowledge handling is selected then the results collection may contain multiple articles that strongly match the search.

readonly logStr :string

A string suitable for logging that contains information about this action. This will contain the action tracking id, name and scripting type name.

Inherited From:

name :string

The name of the action

Inherited From:

readonly noMatch :ArchValueCommunication

The communication to use when no matching input is received

noMatchReprompts :ArchValueCommunicationCollection

The No Match Reprompts collection of communications for the action. In order to use this property, ArchActionWaitForInput#customizeNoMatch must be set to true. To have no, No Match re-prompting, set this to an empty collection.

readonly parentFlow :ArchBaseFlow

Returns the parent flow for this action.

Inherited From:

readonly parentMenuChoice :ArchBaseMenuChoice

Returns the parent menu choice if this action is the action for a menu choice. Otherwise, nothing is returned.

Inherited From:

readonly parentState :ArchState

Returns the parent state that contains this action if this action is in a state. Otherwise, nothing is returned.

Inherited From:

readonly parentTask :ArchTask|ArchTaskLoop

Returns the parent task that contains this action if this action is in a task or looping task. Otherwise, nothing is returned.

Inherited From:

readonly question :ArchValueCommunication

Wording the bot will use prior to waiting for input from the external participant.

readonly trackingId :number

The integer tracking identifier for this action. This is the numeric identifier is displayed in the Architect user interface.

Inherited From: