BA_createInput

Looking for the documentation on the newest versions of Power Actions for Jira 8? Click here and leave these dusty old pages behind!

Syntax

BA_createInput(label, defaultValue, isDisabled)

For Power Actions starting with versions 2.0.8 for Jira 5 and 2.6.1 for Jira 6, the routine has the following syntax:

BA_createInput(label, defaultValue, isDisabled[, isRequired, fieldDescription])

Description

Creates a simple text input suitable for short values. For longer text values like comments, see BA_createTextArea.

Parameters:

Parameter name

Type

Required

Description

label

string

Yes

Field label

defaultValue

string

Yes

A default value or an empty string

isDisabledbooleanYesSpecifies whether the field is read-only or not
isRequiredbooleanNoSpecifies whether the field should be marked as required with a dark red asterisk. Note that marking the field as required does not add any validation.
fieldDescriptionstringNoA description of the field to be displayed immediately under the input box.

Return type

string []

Example

BA_createInput("input 1", "", false, false, "description of field 1");
BA_createInput("input 2", "default value for field 2", false, false, "description of field 2");
BA_createInput("input 3", "read-only default value for field 3", true, false, "description of field 3");