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

Interface AutomaticProgressCustomField

All Superinterfaces:

ICustomField

All Known Implementing Classes:

AutomaticProgressCustomFieldImpl

public interface AutomaticProgressCustomField
extends ICustomField

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AutomaticProgressCustomField.CompleteOn

Method Summary

Modifier and Type	Method	Description
AutomaticProgressCustomField.CompleteOn	getCompleteOn()	Returns the value to return when there is nothing being tracked.
default CustomFieldType	getType()	Returns the type of this custom field.
Float	getValue()	Returns the currently displayed value of the progress bar.
boolean	isArchivedSubTaskTrackingEnabled()
boolean	isAssignedCommentTrackingEnabled()
boolean	isChecklistTrackingEnabled()
boolean	isSubtaskRollupEnabled()
boolean	isSubTaskTrackingEnabled()

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

getClickUp4j, getId, getName, getTimeCreated, isRequired

Method Details

getValue

Float getValue()

Returns the currently displayed value of the progress bar. This is represented as a percentage, so values are between 0 and 1.

Specified by:

getValue in interface ICustomField

Returns:

the current progress

isSubTaskTrackingEnabled

boolean isSubTaskTrackingEnabled()

isChecklistTrackingEnabled

boolean isChecklistTrackingEnabled()

isArchivedSubTaskTrackingEnabled

boolean isArchivedSubTaskTrackingEnabled()

isAssignedCommentTrackingEnabled

boolean isAssignedCommentTrackingEnabled()

getCompleteOn

AutomaticProgressCustomField.CompleteOn getCompleteOn()

Returns the value to return when there is nothing being tracked. This returns a AutomaticProgressCustomField.CompleteOn enum value. You can use AutomaticProgressCustomField.CompleteOn.getAsString() to see what the value is in the UI, or use AutomaticProgressCustomField.CompleteOn.getAsInt() to get the value as an integer.

Returns:

the value to return when there is nothing being tracked

isSubtaskRollupEnabled

boolean isSubtaskRollupEnabled()

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