Package pw.chew.clickup4j.api.entities

Interface Goal

All Known Implementing Classes:
GoalImpl
public interface Goal

Goals

Goals on ClickUp are a way to track your progress towards a goal. From the docs:
Plan, manage, and track - anything you can imagine! Link tasks and Lists into one central source of truth.

Learn more on their site.

  • Method Details

    • getId

      @NotNull @NotNull UUID getId()
      The unique identifier for this goal.
      Returns:
      never-null UUID of this goal.

    • getPrettyId

      @NotNull @NotNull String getPrettyId()
      Returns the "pretty" ID of this goal.
      This is the ID displayed in the client, and appears to be incremental.
      Returns:
      never-null String of the "pretty" ID of this goal.

    • getName

      @NotNull @NotNull String getName()
      The name of this goal.
      Returns:
      never-null String of the name of this goal.

    • getWorkspaceId

      @NotNull @NotNull String getWorkspaceId()
      The ID of the workspace this goal is in.
      Returns:
      never-null ID of the workspace this goal is in.

    • getCreatorId

      @NotNull @NotNull String getCreatorId()
      The ID of the creator of this goal.
      Returns:
      never-null ID of the creator of this goal.

    • getColor

      @NotNull @NotNull Color getColor()
      Returns the color of this Goal, as used in the client as a background color.
      Returns:
      never-null Color of this goal.

    • getDateCreated

      @NotNull @NotNull OffsetDateTime getDateCreated()
      Returns the date this goal was created.
      Returns:
      never-null OffsetDateTime of the date this goal was created.

    • getStartDate

      @Nullable @Nullable OffsetDateTime getStartDate()
      Returns the start date of this goal. It may be null if a goal does not have a start date.
      Returns:
      nullable OffsetDateTime of the start date of this goal.

    • getDueDate

      @Nullable @Nullable OffsetDateTime getDueDate()
      Returns the due date of this goal. It may be null if a goal does not have a due date.
      Returns:
      nullable OffsetDateTime of the due date of this goal.

    • getDescription

      @NotNull @NotNull String getDescription()
      Returns the description of this goal.
      Returns:
      never-null String of the description of this goal.

    • isPrivate

      boolean isPrivate()
      Whether this goal is private, meaning users must be invited to view it.
      Returns:
      true if this goal is private, false otherwise.

    • isArchived

      boolean isArchived()
      Whether this goal is archived, meaning it is no longer visible to users.
      Returns:
      true if this goal is archived, false otherwise.

    • isMultipleOwners

      boolean isMultipleOwners()
      Whether this goal can have multiple owners.
      Returns:
      true if this goal can have multiple owners, false otherwise.

    • getEditorToken

      @NotNull @NotNull String getEditorToken()
      Returns the token used to edit this goal.
      Returns:
      never-null String of the token used to edit this goal.

    • getDateUpdated

      @NotNull @NotNull OffsetDateTime getDateUpdated()
      Returns when this goal was last updated.
      Returns:
      never-null OffsetDateTime of when this goal was last updated.

    • getOwners

      @NotNull @NotNull List<User> getOwners()
      Returns a potentially empty-list of "owners" of this goal.
      If isMultipleOwners() is false, this will be a list of at most one element.
      Returns:
      never-null List of the owners of this goal.

    • getTargets

      @NotNull @NotNull List<Target> getTargets()
      Returns all the targets in this goal.
      This might be an empty list.
      Returns:
      never-null List of the targets in this goal.

    • getTargetCount

      int getTargetCount()
      Returns the target count.
      In theory, this is equal to targets.size(), but it is not guaranteed to be.
      Returns:
      int of the target count.

    • getPercentCompleted

      float getPercentCompleted()
      Returns the current progress of this goal.
      Returns:
      never-null Progress of this goal.

    • getHistory

      @NotNull @NotNull List<TimelineEntry> getHistory()
      Returns the history for this goal.
      This contains created or changed targets.
      Returns:
      never-null List of the history for this goal.

    • getPrettyUrl

      @NotNull @NotNull String getPrettyUrl()
      Returns the pretty URL of this goal.
      This is equal to "https://app.clickup.com/workspaceId/goals/prettyId.
      Returns:
      never-null String of the pretty URL of this goal.

    • getClickUp4j

      @NotNull @NotNull ClickUp4j getClickUp4j()
      Returns this ClickUp4j instance.
      Returns:
      never-null ClickUp4j instance.