Package pw.chew.clickup4j.api.entities

Interface User

All Known Implementing Classes:
UserImpl
public interface User

ClickUp User

The user entity represents a user in the ClickUp system.
This class is a little weird due to inconsistencies in the ClickUp API. From what I could gather, these are the fields that appear in every reference to a user. Member may have additional fields, but when they show up is infrequent.

  • Method Details

    • getId

      long getId()
      The unique ID of the user.
      Returns:
      the user ID

    • getUsername

      @NotNull @NotNull String getUsername()
      This user's username. This is what is displayed in the ClickUp UI.
      Returns:
      the username

    • getColor

      @NotNull @NotNull Color getColor()
      The color for this user.
      Returns:
      the color

    • getProfilePicture

      @Nullable @Nullable String getProfilePicture()
      Returns a link to this user's profile picture.
      This will be null if the user has no profile picture.
      Returns:
      the possibly-null profile picture link

    • getClickUp4j

      @NotNull @NotNull ClickUp4j getClickUp4j()
      Returns this ClickUp4j instance.
      Returns:
      the ClickUp4j instance