Package pw.chew.clickup4j.api.entities.customfields

Interface TextCustomField

All Superinterfaces:

ICustomField

All Known Implementing Classes:

TextCustomFieldImpl

public interface TextCustomField
extends ICustomField

Text Custom Field

The text custom field is used to store text.

Method Summary

Modifier and Type	Method	Description
default CustomFieldType	getType()	Returns the type of this custom field.
String	getValue()	Returns the value of this custom field.

Methods inherited from interface pw.chew.clickup4j.api.entities.customfields.ICustomField

getClickUp4j, getId, getName, getTimeCreated, isRequired

Method Details

getValue

String getValue()

Description copied from interface: ICustomField

Returns the value of this custom field.

It's highly recommended to cast this value to the appropriate type, because it returns more appropriate data. For example, if the custom field is of type CustomFieldType.TEXT, you can cast the value to TextCustomField, this class can be found using CustomFieldType.getAssociatedClass().

This will be null under the following circumstances:

• No value is specified.
• The task response did not contain a value. Notably when an individual task is retrieved.

Specified by:

getValue in interface ICustomField

Returns:

the value of this custom field

getType

default CustomFieldType getType()

Description copied from interface: ICustomField

Returns the type of this custom field. This will be one of CustomFieldType.

Specified by:

getType in interface ICustomField

Returns:

the type of this custom field