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

Interface DropDownCustomField

All Superinterfaces:

ICustomField

public interface DropDownCustomField
extends ICustomField

Drop Down Custom Field

A drop down custom field can have multiple options, and is not unlike a status. Each option can have a color associated with it.
A custom field will have a value, nullable current value, and a list of possible options.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DropDownCustomField.DropDownOption	A drop-down option.

Method Summary

Modifier and Type	Method	Description
DropDownCustomField.DropDownOption	getDefaultValue()	The default value of the custom field, if it has one.
@NotNull List<DropDownCustomField.DropDownOption>	getOptions()	A list of possible options for the custom field.
@Nullable String	getPlaceholder()	A placeholder.
default CustomFieldType	getType()	Returns the type of this custom field.
@Nullable DropDownCustomField.DropDownOption	getValue()	Possibly null current value of the custom field.

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

getClickUp4j, getId, getName, getTimeCreated, isRequired

Method Details

getValue

@Nullable
@Nullable DropDownCustomField.DropDownOption getValue()

Possibly null current value of the custom field.

Specified by:

getValue in interface ICustomField

Returns:

current value of the custom field

getDefaultValue

DropDownCustomField.DropDownOption getDefaultValue()

The default value of the custom field, if it has one.

Returns:

default value of the custom field

getPlaceholder

@Nullable
@Nullable String getPlaceholder()

A placeholder. This doesn't seem to be used.

Returns:

the placeholder

getOptions

@NotNull
@NotNull List<DropDownCustomField.DropDownOption> getOptions()

A list of possible options for the custom field.

Returns:

list of possible options

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