Package pw.chew.clickup4j.api

Interface ClickUp4j

All Known Implementing Classes:
ClickUp4jImpl
public interface ClickUp4j
The core of ClickUp4j. All parts of the API can be accessed starting from this class

  • Method Details

    • getToken

      String getToken()
      Gets the token currently being used for requests.
      Returns:
      the token

    • getHttpClient

      okhttp3.OkHttpClient getHttpClient()
      Returns the OkHttpClient used for requests.
      Returns:
      the OkHttpClient

    • retrieveTasks

      Requester<List<Task>> retrieveTasks(@NotNull @NotNull String listId)
      Returns a list of tasks in a specified list ID.
      Parameters:
      listId - the list ID
      Returns:
      the list of tasks

    • retrieveTask

      Requester<Task> retrieveTask(@NotNull @NotNull String taskId)
      Retrieves a single task by ID. This can be from any workspace the user has access to.
      This will NOT return values for the custom fields.
      Custom IDs are not supported with this method.
      Parameters:
      taskId - the task ID
      Returns:
      the task

    • retrieveSpace

      Requester<Space> retrieveSpace(@NotNull @NotNull String spaceId)
      Retrieves a space by ID. This can be from any workspace the user has access to.
      Parameters:
      spaceId - the space ID
      Returns:
      the space

    • retrieveWorkspaces

      Requester<List<Workspace>> retrieveWorkspaces()
      Retrieves a list of workspaces the currently authenticated user can access.
      Returns:
      the list of workspaces

    • retrieveGoal

      Requester<Goal> retrieveGoal(String goalId)
      Retrieve a specific goal by ID.
      Parameters:
      goalId - the goal ID
      Returns:
      the goal

    • retrieveGoals

      Requester<List<Goal>> retrieveGoals(String workspaceId)
      Retrieves a list of goals for the specified workspace.
      Parameters:
      workspaceId - the workspace ID
      Returns:
      the list of goals

    • retrieveSelfUser

      Requester<User> retrieveSelfUser()
      Retrieves the currently logged-in User.
      The user is workspace agnostic.
      Returns:
      the user

    • retrieveWebhooks

      Requester<List<Webhook>> retrieveWebhooks(String workspaceId)
      Retrieves a list of webhooks for the specified workspace.
      Parameters:
      workspaceId - the workspace ID
      Returns:
      the list of webhooks

    • startWebhookServer

      void startWebhookServer(String workspaceId)
      Starts a webhook server with the settings provided from the ClickUp4jBuilder.
      This method will do the following:
      1. Retrieve existing webhooks
      2. If a webhook with the endpoint exists, do nothing.
      3. Otherwise, create a new webhook with the endpoint.

      Be sure to stop the server when you're done with stopWebhookServer().
      Parameters:
      workspaceId - the workspace ID

    • stopWebhookServer

      void stopWebhookServer()
      Shuts down the webhook server.
      This method will also delete the webhook from ClickUp.