Extends

• ArchBaseActionFindSystemObject

Members

readonly displayTypeName :string

Returns the display type name string 'ArchBaseActionFindSystemObject'.

Overrides:

• ArchBaseActionFindSystemObject#displayTypeName

readonly findId :ArchValueString

The identifier of the object to look up. While it is always a string, inheriting Find action classes will provide the context of the identifier. For example, in the ArchActionFindUserById action this would be the identifier of the user that you wish to look up at runtime.

readonly findResult :ArchBaseValue

The value that holds the returned system object which was found at runtime. Inheriting Find action instances will override this property and assign a type to it appropriate to the type of object they're finding. The output result type will inherit from ArchBaseNetworkValueSingleton. For example, the ArchActionFindUserPrompt#findResult will have a findResult type of ArchValuePrompt.

Overrides:

• ArchBaseActionFindSystemObject#findResult

hasFakeDisconnectOutput :boolean

True when this action models a "Disconnect" output in the UI that is not a real, scriptable branch. See ArchBaseActionWithOutputsFakeDisconnect.

Overrides:

• ArchBaseActionFindSystemObject#hasFakeDisconnectOutput

hasFakeSuccessOutput :boolean

True when this action models a "Success" output in the UI that is not a real, scriptable branch (e.g. some transfer actions). See ArchBaseActionWithOutputsFakeSuccessFailure.

Overrides:

• ArchBaseActionFindSystemObject#hasFakeSuccessOutput

readonly isArchBaseActionFindSystemObject :boolean

Returns true indicating that this is an ArchBaseActionFindSystemObject instance.

Overrides:

• ArchBaseActionFindSystemObject#isArchBaseActionFindSystemObject

readonly isArchBaseActionFindSystemObjectById :boolean

Returns true indicating that this is an ArchBaseActionFindSystemObject instance.

readonly outputCount :number

Returns the number of outputs on this action. For actions that have a fake success output like what you see on the various transfer actions, that will be included in the count to be consistent with the Architect UI. Attempting to get the output count on a menu choice's action such as such as the ArchMenuTransferToAcd#actionTransferToAcd action on an ArchMenuTransferToAcd menu will return 0.

Overrides:

• ArchBaseActionFindSystemObject#outputCount

readonly outputFound :ArchActionOutput

The found output for this action

Overrides:

• ArchBaseActionFindSystemObject#outputFound

readonly outputNotFound :ArchActionOutput

The not found output for this action

Overrides:

• ArchBaseActionFindSystemObject#outputNotFound

readonly outputs :Array.<ArchActionOutput>

Returns an array of action outputs for this action. Remember that it is possible to have an undefined item in the returned ArchActionOutput array. This is true when the output is "fake". Accessing the outputs on a menu choice's action such as ArchMenuTransferToAcd#actionTransferToAcd will return an empty array.

Overrides:

• ArchBaseActionFindSystemObject#outputs

Methods

getOutputById(output) → {ArchActionOutput}

Gets an output by its identifier. If it cannot be found, this method will throw. Normally you won't need to use this method and will use the helper methods available on inheriting classes when accessing pre-defined outputs like success, failure, timeout, etc. etc. Attempting to get an output by id on a menu choice's action such as the ArchMenuTransferToAcd#actionTransferToAcd action on an ArchMenuTransferToAcd menu will return nothing.

Parameters:

Name	Type	Description
output	string | ArchBranch	identifies output you want to obtain. If output is an ArchBranch instance, the ArchBranch#outputId value will be used. Otherwise valid string identifier values can be found in ArchEnums#OUTPUT_IDS or can be a guid. Remember that requesting the 'success' output on an action with a fake success output will return nothing.

Returns:

ArchActionOutput

Overrides:

• ArchBaseActionFindSystemObject#getOutputById

getOutputByIndex(index) → {ArchActionOutput}

Returns the output at the given index. It's important to note that on actions that have a fake success output if you request the output at the index for the fake success, you will get nothing returned because the fake success output isn't something that you should do anything with. Attempting to access an output by index on a menu choice's action such as ArchMenuTransferToAcd#actionTransferToAcd will return nothing.

Parameters:

Name	Type	Description
index	number	the index of the output to retrieve. This value should be a non-negative integer.

Returns:

ArchActionOutput

Overrides:

• ArchBaseActionFindSystemObject#getOutputByIndex

getOutputByName(output, wantDynamicOutputopt) → {ArchActionOutput}

Gets an output by its identifier. If it cannot be found, this method will throw. Normally you won't need to use this method and will use the helper methods available on inheriting classes when accessing pre-defined outputs like success, failure, timeout, etc. etc. Attempting to get an output by id on a menu choice's action such as the ArchMenuTransferToAcd#actionTransferToAcd action on an ArchMenuTransferToAcd menu will return nothing.

Parameters:

Name	Type	Attributes	Default	Description
output	string | ArchBranch			identifies output you want to obtain by name. If output is an ArchBranch instance, the ArchBranch#name value will be used. Remember that requesting the 'Success' output on an action with a fake success output will return nothing. For non-dynamic outputs, the name should be specified in English.
wantDynamicOutput	boolean	<optional>	false	because it is possible for some actions to have both a non-dynamic output and a dynamic output with the same name, this boolean will let you specify which output you want. An example of this would be the built in Failure output on a call bot action but that bot also has an intent named Failure so the action has two outputs with the same name of 'Failure'. Only one of those would be a dynamic output and that's the output for the Failure intent, not the built-in Failure action output.

Returns:

ArchActionOutput

Overrides:

• ArchBaseActionFindSystemObject#getOutputByName