Package pw.chew.clickup4j.api.entities

Interface Member

All Known Implementing Classes:
MemberImpl
public interface Member
A member is a simple wrapper for a User. It may contain additional information. Most of the time, you might just want getUser().

  • Method Details

    • getUser

      @NotNull @NotNull User getUser()
      Returns the User sub-interface of this member.
      Returns:
      never-null User sub-interface

    • getEmail

      @NotNull @NotNull String getEmail()
      The email of the user.
      Returns:
      never-null email

    • getInitials

      @NotNull @NotNull String getInitials()
      The "initials" for this user.
      This seems to be used internally in the API for users without a profile picture.
      Returns:
      never-null initials

    • getRole

      @NotNull @NotNull Member.Role getRole()
      The role for this user. This is an enum constant Member.Role to store the possible values.
      Returns:
      never-null Member.Role

    • getCustomRole

      @Nullable @Nullable String getCustomRole()
      Returns the custom role of this user, if any.
      Custom Roles require Business Plus Plan or above.
      Returns:
      nullable custom role

    • getLastActive

      @Nullable @Nullable OffsetDateTime getLastActive()
      Returns when this user was last active.
      If the user has been invited, but has not accepted yet, this will be null.
      Returns:
      nullable last active date

    • getDateJoined

      @Nullable @Nullable OffsetDateTime getDateJoined()
      Returns when this user joined the workspace.
      If the user has been invited, but has not accepted yet, this will be null.
      Returns:
      nullable join date

    • getDateInvited

      @NotNull @NotNull OffsetDateTime getDateInvited()
      Returns when this user was invited.
      All members have an invitation date, even if they have not accepted yet, and even if they're owner.
      Returns:
      never-null invitation date

    • getInvitedBy

      @Nullable @Nullable User getInvitedBy()
      Returns the inviting user for this member.
      Owners were never invited, so this may be null.
      Returns:
      nullable inviting user

    • getClickUp4j

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