Skip to content

Input

Get a list of fields and their settings.

  • Permissions to view the App is needed.
  • API Tokens cannot be used with this API.

AttachmentField

Warning

Methods

getThumbnailSize()

Get the thumbnailSize

Parameter

(none)

Return

Integer

Sample code

get Thumbnail Size Source code
Integer thumbnailSize = attachmentField.getThumbnailSize();

CalculatedField

Warning

Methods

getExpression()

Get the expression

Parameter

(none)

Return

String

Sample code

get Expression Source code
String expression = calculatedField.getExpression();

getHideExpression()

Get the hideExpression

Parameter

(none)

Return

Boolean

Sample code

get Hide Expression Source code
Boolean hideExpression = calculatedField.getHideExpression();

getDisplayScale()

Get the displayScale

Parameter

(none)

Return

Integer

Sample code

get Display Scale Source code
Integer displayScale = calculatedField.getDisplayScale();

getUnit()

Get the unit

Parameter

(none)

Return

String

Sample code

get Unit Source code
String unit = calculatedField.getUnit();

getUnitPosition()

Get the unitPosition

Parameter

(none)

Return

UnitPosition

Sample code

get Unit Position Source code
UnitPosition unitPosition = calculatedField.getUnitPosition();

getFormat()

Get the format

Parameter

(none)

Return

NumberFormat

Sample code

get Format Source code
NumberFormat format = calculatedField.getFormat();

LinkField

Warning

Methods

getDefaultValue()

Get the defaultValue

Parameter

(none)

Return

String

Sample code

get Default Value Source code
String defaultValue = linkField.getDefaultValue();

getUnique()

Get the unique

Parameter

(none)

Return

Boolean

Sample code

get Unique Source code
Boolean unique = linkField.getUnique();

getMaxLength()

Get the maxLength

Parameter

(none)

Return

Integer

Sample code

get Max Length Source code
Integer maxLength = linkField.getMaxLength();

getMinLength()

Get the minLength

Parameter

(none)

Return

Integer

Sample code

get Min Length Source code
Integer minLength = linkField.getMinLength();

getProtocol()

Get the protocol

Parameter

(none)

Return

LinkProtocol

Sample code

get Protocol Source code
LinkProtocol protocol = linkField.getProtocol();

MultiLineTextField

Warning

Methods

getDefaultValue()

Get the defaultValue

Parameter

(none)

Return

String

Sample code

get Default Value Source code
String defaultValue = multiLineTextField.getDefaultValue();

NumberField

Warning

Methods

getDisplayScale()

Get the displayScale

Parameter

(none)

Return

Integer

Sample code

get Display Scale Source code
Integer displayScale = numberField.getDisplayScale();

getUnit()

Get the unit

Parameter

(none)

Return

String

Sample code

get Unit Source code
String unit = numberField.getUnit();

getUnitPosition()

Get the unitPosition

Parameter

(none)

Return

UnitPosition

Sample code

get Unit Position Source code
UnitPosition unitPosition = numberField.getUnitPosition();

getDigit()

Get the digit

Parameter

(none)

Return

Boolean

Sample code

get Digit Source code
Boolean digit = numberField.getDigit();

getMaxValue()

Get the maxValue

Parameter

(none)

Return

Integer

Sample code

get Max Value Source code
Integer maxValue = numberField.getMaxValue();

getMinValue()

Get the minValue

Parameter

(none)

Return

Integer

Sample code

get Min Value Source code
Integer minValue = numberField.getMinValue();

getDefaultValue()

Get the defaultValue

Parameter

(none)

Return

String

Sample code

get Default Value Source code
String defaultValue = numberField.getDefaultValue();

getUnique()

Get the unique

Parameter

(none)

Return

Boolean

Sample code

get Unique Source code
Boolean unique = numberField.getUnique();

RichTextField

Warning

Methods

getDefaultValue()

Get the defaultValue

Parameter

(none)

Return

String

Sample code

get Default Value Source code
String defaultValue = richTextField.getDefaultValue();

SingleLineTextField

Warning

Methods

getMinLength()

Get the minLength

Parameter

(none)

Return

Integer

Sample code

get Min Length Source code
Integer minLength = singleLineTextField.getMinLength();

getMaxLength()

Get the maxLength

Parameter

(none)

Return

Integer

Sample code

get Max Length Source code
Integer maxLength = singleLineTextField.getMaxLength();

getExpression()

Get the expression

Parameter

(none)

Return

String

Sample code

get Expression Source code
String expression = singleLineTextField.getExpression();

getHideExpression()

Get the hideExpression

Parameter

(none)

Return

Boolean

Sample code

get Hide Expression Source code
Boolean hideExpression = singleLineTextField.getHideExpression();

getDefaultValue()

Get the defaultValue

Parameter

(none)

Return

String

Sample code

get Default Value Source code
String defaultValue = singleLineTextField.getDefaultValue();

getUnique()

Get the unique

Parameter

(none)

Return

Boolean

Sample code

get Unique Source code
Boolean unique = singleLineTextField.getUnique();

AbstractInputField

Warning

  • extend the abstract class "Field"
  • This class is an abstract class.

Methods

getLabel()

Get the label

Parameter

(none)

Return

String

getNoLabel()

Get the noLabel

Parameter

(none)

Return

Boolean

getRequired()

Get the required

Parameter

(none)

Return

Boolean

Reference