ArchActionAskForAuthentication(coreAskForAuthenticationAction)

new ArchActionAskForAuthentication(coreAskForAuthenticationAction)

The Architect Scripting class for Ask For Authentication action. Instances of this action should be created by calling ArchFactoryActions#addActionAskForAuthentication. Ask to Authenticate is currently only available for Apple Messages for Business.

Parameters:
Name Type Description
coreAskForAuthenticationAction Object

( Internal ) an Architect core Ask For Authentication action.

See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionAskForAuthentication'.

readonly askForAuthenticationOutputsFailure :ArchNamedValueList

The contents of this named value list come from the Failure Outputs schema. It will contain two values: errorType and errorMessage. These values will be returned by the server if the action takes the Failure path.

readonly authenticationCompletionTimeout :ArchValueDuration

The authentication completion timeout in seconds

readonly isArchActionAskForAuthentication :boolean

Returns true indicating that this is an ArchActionAskForAuthentication instance.

readonly isArchBaseActionWithOutputsSuccessFailureNoInputNoMatch :boolean

Returns true indicating that this is an ArchBaseActionWithOutputsSuccessFailureNoInputNoMatch instance.

Inherited From:

readonly signInMessage :ArchValueString

Wording the bot will ask the user to authenticate with

readonly successMessage :ArchValueString

Wording the bot will provide the user when authentication is successful