Skip to main content

InputField Object

Represents an input field for a Component Action. Defines the basic properties that must be satisfied by the input data.

Return fields#

action (Action)#

The Action to which this InputField is associated, if any.

allowRemove (Boolean!)#

Specifies whether the signed-in User can remove the InputField.

allowUpdate (Boolean!)#

Specifies whether the signed-in User can update the InputField.

collection (InputFieldCollection)#

Specifies the type of collection to use for storing input values, if applicable.

comments (String)#

Additional notes about the InputField.

connection (Connection)#

The Connection to which this InputField is associated, if any.

default (String)#

The default value for the InputField.

example (String)#

Example valid input for the InputField.

id (ID!)#

The ID of the object.

key (String!)#

A string which uniquely identifies the InputField in the context of the Action.

keyLabel (String)#

Label used for the Keys of a 'keyvaluelist' collection.

label (String!)#

The name of the InputField.

language (String)#

Language to use for the Code Field.

model (JSONString)#

Dictates how possible choices are provided for this InputField.

placeholder (String)#

Placeholder text that will appear in the InputField UI.

required (Boolean!)#

Specifies whether the InputField is required by the Action.

shown (Boolean!)#

Specifies whether the InputField is shown in the Designer.

type (InputFieldType!)#

Specifies the type of data the InputField handles.