Package pw.chew.clickup4j.api.entities

Interface TimelineEntry

All Known Implementing Classes:
TimelineEntryImpl
public interface TimelineEntry

Timeline Entry

This is used for the Timeline of a Goal or Target.

  • Method Details

    • getId

      @NotNull @NotNull UUID getId()
      Get the ID of this Timeline Entry.
      Returns:
      never-null ID of this Timeline Entry.

    • getTarget

      @NotNull @NotNull Target getTarget()
      Gets the Target this Timeline Entry is for.
      Returns:
      never-null Target this Timeline Entry is for.

    • getUserId

      @NotNull @NotNull String getUserId()
      Returns the User id who created this Timeline Entry.
      Returns:
      never-null User id who created this Timeline Entry.

    • getNote

      @NotNull @NotNull String getNote()
      The note of this entry as displayed to the user.
      If the user did not leave a note, this will be a blank String.
      Returns:
      never-null note of this entry.

    • getDateModified

      @NotNull @NotNull OffsetDateTime getDateModified()
      The date this entry was created (or last modified).
      Returns:
      never-null date this entry was created.

    • getStepsTaken

      @Nullable @Nullable Integer getStepsTaken()
      Returns the amount of steps taken caused by this entry.
      This will be null if the entry was not a step change.
      Returns:
      amount of steps taken caused by this entry.

    • getStepsBefore

      @Nullable @Nullable Integer getStepsBefore()
      Returns the amount of steps before this entry occurred.
      This will be null if the entry was creating the Target.
      Returns:
      amount of steps before this entry occurred.

    • getClickUp4j

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