Class ApplicationFlexibleFieldValue

Represents an application-level custom field value.

See also

Container.getFlexibleFields() - this returns Application-level custom fields.

These fields can be constructed via Container.createCustomFields() in particular when passing the flexibleFields argument for Api.createDocumentContainer and Api.updateDocumentContainer.

While this class represents a specific custom field value, it does not represent general properties of the field, such as its display name or help text. See Class ApplicationFlexibleField for more information about the custom field itself. Also see this class’s ApplicationFlexibleFieldValue.Field property.

class ApplicationFlexibleFieldValue()

Represents an application-level custom field value alongside helper methods to access the internal value and other information related to the custom field, such as display name or help text.

Arguments

• flexibleField (object()) – An instance of ApplicationFlexibleField() that represents meta information about the field in general, but not its value in this particular case.

• flexibleFieldValue (object()) – An underlying raw JSON object that represents the actual value of the application-level custom field.

Properties

ApplicationFlexibleFieldValue.Field

An instance of ApplicationFlexibleField() that represents meta information about the custom field in general, for example, its data type, the display name and help text.

Methods

ApplicationFlexibleFieldValue.getDisplayName()

Return the name of the custom field for display purposes.

ApplicationFlexibleFieldValue.getValue()

Return the value of this custom field. The value returned depends on the internal data type this custom field is configured for.

ApplicationFlexibleFieldValue.getDisplayValue()

Return the value of this custom field for display purposes as a string.