ArchActionSendResponse(coreSendResponseAction)

new ArchActionSendResponse(coreSendResponseAction)

The Architect Scripting class for the Send Response action. Instances of this action should be created by calling ArchFactoryActions#addActionSendResponse

Parameters:
Name Type Description
coreSendResponseAction Object

( Internal ) an Architect core send response action.

See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionSendResponse'.

readonly isArchActionSendResponse :boolean

Returns true indicating that this is an ArchActionSendResponse instance.

readonly messageBody :ArchValueString

The message body.

readonly messageBodyStyle :ArchValueString

The message body style of the Send Response action. The string values in ArchEnums#MESSAGE_BODY_STYLES lists valid message body style values.

readonly outputSuccess :ArchActionOutput

The success output for this action

Inherited From:

Methods

setLiteralMessageBodyStyle(newMessageBodyStyle)

A helper method that sets the messageBodyStyle ArchActionSendResponse#messageBodyStyle to a literal string value. The string values in ArchEnums#MESSAGE_BODY_STYLES lists valid message body style values.

Parameters:
Name Type Description
newMessageBodyStyle string

the messageBodyStyle value to set

setMessageBodyVariable(messageBodyVariable)

Helper method to set a variable on the messageBodyVariable property.

Parameters:
Name Type Description
messageBodyVariable string | ArchVariableString

the variable to hold the message data