com.box.sdkgen.managers.tasks

Class TasksManager

Object

TasksManager

public class TasksManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TasksManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	TasksManager()
protected	TasksManager(TasksManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Task	createTask(CreateTaskRequestBody requestBody) Creates a single task on a file.
Task	createTask(CreateTaskRequestBody requestBody, CreateTaskHeaders headers) Creates a single task on a file.
void	deleteTaskById(String taskId) Removes a task from a file.
void	deleteTaskById(String taskId, DeleteTaskByIdHeaders headers) Removes a task from a file.
Authentication	getAuth()
Tasks	getFileTasks(String fileId) Retrieves a list of all the tasks for a file.
Tasks	getFileTasks(String fileId, GetFileTasksHeaders headers) Retrieves a list of all the tasks for a file.
NetworkSession	getNetworkSession()
Task	getTaskById(String taskId) Retrieves information about a specific task.
Task	getTaskById(String taskId, GetTaskByIdHeaders headers) Retrieves information about a specific task.
Task	updateTaskById(String taskId) Updates a task.
Task	updateTaskById(String taskId, UpdateTaskByIdHeaders headers) Updates a task.
Task	updateTaskById(String taskId, UpdateTaskByIdRequestBody requestBody) Updates a task.
Task	updateTaskById(String taskId, UpdateTaskByIdRequestBody requestBody, UpdateTaskByIdHeaders headers) Updates a task.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

TasksManager

public TasksManager()

TasksManager

protected TasksManager(TasksManager.Builder builder)

Method Detail

getFileTasks

public Tasks getFileTasks(String fileId)

Retrieves a list of all the tasks for a file. This endpoint does not support pagination.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

getFileTasks

public Tasks getFileTasks(String fileId,
                          GetFileTasksHeaders headers)

Retrieves a list of all the tasks for a file. This endpoint does not support pagination.

Parameters:

fileId - The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

headers - Headers of getFileTasks method

createTask

public Task createTask(CreateTaskRequestBody requestBody)

Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately.

Parameters:

requestBody - Request body of createTask method

createTask

public Task createTask(CreateTaskRequestBody requestBody,
                       CreateTaskHeaders headers)

Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately.

Parameters:

requestBody - Request body of createTask method

headers - Headers of createTask method

getTaskById

public Task getTaskById(String taskId)

Retrieves information about a specific task.

Parameters:

taskId - The ID of the task. Example: "12345"

getTaskById

public Task getTaskById(String taskId,
                        GetTaskByIdHeaders headers)

Retrieves information about a specific task.

Parameters:

taskId - The ID of the task. Example: "12345"

headers - Headers of getTaskById method

updateTaskById

public Task updateTaskById(String taskId)

Updates a task. This can be used to update a task's configuration, or to update its completion state.

Parameters:

taskId - The ID of the task. Example: "12345"

updateTaskById

public Task updateTaskById(String taskId,
                           UpdateTaskByIdRequestBody requestBody)

Updates a task. This can be used to update a task's configuration, or to update its completion state.

Parameters:

taskId - The ID of the task. Example: "12345"

requestBody - Request body of updateTaskById method

updateTaskById

public Task updateTaskById(String taskId,
                           UpdateTaskByIdHeaders headers)

Updates a task. This can be used to update a task's configuration, or to update its completion state.

Parameters:

taskId - The ID of the task. Example: "12345"

headers - Headers of updateTaskById method

updateTaskById

public Task updateTaskById(String taskId,
                           UpdateTaskByIdRequestBody requestBody,
                           UpdateTaskByIdHeaders headers)

Updates a task. This can be used to update a task's configuration, or to update its completion state.

Parameters:

taskId - The ID of the task. Example: "12345"

requestBody - Request body of updateTaskById method

headers - Headers of updateTaskById method

deleteTaskById

public void deleteTaskById(String taskId)

Removes a task from a file.

Parameters:

taskId - The ID of the task. Example: "12345"

deleteTaskById

public void deleteTaskById(String taskId,
                           DeleteTaskByIdHeaders headers)

Removes a task from a file.

Parameters:

taskId - The ID of the task. Example: "12345"

headers - Headers of deleteTaskById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()