ArchActionSetLanguage(coreSetLocaleActionViewModel)

new ArchActionSetLanguage(coreSetLocaleActionViewModel)

The Architect Scripting class that represents the Set Language action. Instances of this action should be created by calling ArchFactoryActions#addActionSetLanguage

Parameters:
Name Type Description
coreSetLocaleActionViewModel Object

( Internal ) an Architect core set locale action view model.
See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchActionSetLanguage'.

readonly displayTypeName :string

Returns the display type name string 'ArchBaseAction'.

Overrides:

readonly displayTypeNameArchitect :string

The Architect action type label

Inherited From:

readonly isArchActionSetLanguage :boolean

Returns true indicating that this is an ArchActionSetLanguage 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:

language :ArchLanguage

The runtime language to set on the flow. Note that valid languages to use for this action must be a language with a region sub-tag. This is a legacy helper property for setting via an ArchLanguage and ArchActionSetLanguage.languageValue should be used instead. If the language was set via ArchActionSetLanguage.languageValue, the ArchLanguage will only be returned if the value is a string literal and is a valid language code. Otherwise, this will return null.

readonly languageValue :ArchValueString

The runtime language to set on the flow. Any language string used when setting this value must be a valid language with a region sub-tag. If setting a literal string value, be sure to use a lowercase string.

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 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 trackingId :number

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

Inherited From: