Package pw.chew.clickup4j.api.entities

Interface Space

All Known Implementing Classes:
SpaceImpl
public interface Space
Represents a space in ClickUp.
A space is the 2nd level of organization in ClickUp. It can contain lists, folders, and docs.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ClickUp4j
    getClickUp4j()
    Returns the ClickUp4j instance of this Space.
    @NotNull String
    getId()
    Returns the ID of this space.
    @NotNull String
    getName()
    The human-readable name of the Space.
    @NotNull List<Task.Status>
    getStatuses()
    Returns a list of space-level Task statuses.
    boolean
    isArchived()
    Returns if this Space is archived, meaning it is no longer visible to users.
    boolean
    isMultipleAssignees()
    Returns if the Multiple Assignees feature is enabled for this space.
    boolean
    isPrivate()
    Checks if this space is private, meaning members must be invited to see it.

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      Returns the ID of this space.
      Returns:
      Never-null String containing the Id.

    • getName

      @NotNull @NotNull String getName()
      The human-readable name of the Space.
      Returns:
      Never-null String containing the space's name.

    • getStatuses

      @NotNull @NotNull List<Task.Status> getStatuses()
      Returns a list of space-level Task statuses.
      Lists and folders may have their own statuses.
      Returns:
      Never-null List of Task.Status objects.

    • isPrivate

      boolean isPrivate()
      Checks if this space is private, meaning members must be invited to see it.
      Returns:
      True if this space is private, false otherwise.

    • isMultipleAssignees

      boolean isMultipleAssignees()
      Returns if the Multiple Assignees feature is enabled for this space.
      Returns:
      true if enabled, false otherwise

    • isArchived

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

    • getClickUp4j

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