ArchActionGetSIPHeaders(coreGetSIPHeadersActionViewModel)

new ArchActionGetSIPHeaders(coreGetSIPHeadersActionViewModel)

The Architect Scripting class that represents the GetSIPHeaders action. Instances of this action should be created by calling ArchFactoryActions#addActionGetSIPHeaders

Parameters:
Name Type Description
coreGetSIPHeadersActionViewModel Object

( Internal ) an Architect core get sip headers action view model.
See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionGetSIPHeader'.

readonly _actionTypeId :string

Returns the action type identifier string from actionTypes.js

readonly getSipHeadersFailureOutputs :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 isArchActionGetSIPHeaders :boolean

Returns true indicating that this is an ArchActionGetSIPHeaders instance.

readonly outputSuccess :ArchActionOutput

The success output for this action

Inherited From:

readonly sipHeaderNames :ArchValueStringCollection

A string collection of SIP Header names.

readonly sipHeadersResult :ArchValueJson

A JSON object of SIP Header values.

Methods

inputDataVariable(inputDataVariable)

Helper method to set a variable on the sipHeaderResult property.

Parameters:
Name Type Description
inputDataVariable JSON | ArchVariableJson

the variable to hold the caller entered data