Package pw.chew.clickup4j.api.entities

Interface Checklist

All Known Implementing Classes:
ChecklistImpl
public interface Checklist

Checklist

A checklist is a list of items that can be completed. Every checklist can have items, and items can be completed.

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      The checklist's ID.
      Returns:
      The checklist's ID.

    • getTaskId

      @NotNull @NotNull String getTaskId()
      The ID of the task this checklist belongs to.
      Returns:
      The ID of the task this checklist belongs to.

    • getName

      @NotNull @NotNull String getName()
      The checklist's name.
      Returns:
      The checklist's name.

    • getCreatedAt

      @NotNull @NotNull OffsetDateTime getCreatedAt()
      Return when this checklist was created.
      Returns:
      When this checklist was created.

    • getOrderIndex

      int getOrderIndex()
      The ordering of this checklist, if there are multiple. This can be used as a sorting key.
      Returns:
      The order index of this checklist.

    • getCreatorId

      long getCreatorId()
      Gets the ID of the user who created this checklist.
      Returns:
      the user ID of the user who created this checklist.

    • getResolvedCount

      int getResolvedCount()
      The amount of items that are marked as complete.
      Returns:
      The amount of items that are marked as complete.

    • getUnresolvedCount

      int getUnresolvedCount()
      The amount of items that are marked as incomplete.
      Returns:
      The amount of items that are marked as incomplete.

    • getItems

      List<Checklist.Item> getItems()
      Returns the items in this checklist.
      Returns:
      The items in this checklist.

    • getClickUp4j

      ClickUp4j getClickUp4j()
      Returns this ClickUp4j instance.
      Returns:
      This ClickUp4j instance.