Skip to content

tasks.md

Latest commit

 

History

History
161 lines (104 loc) · 3.67 KB

tasks.md

File metadata and controls

161 lines (104 loc) · 3.67 KB

TasksManager

List tasks on file

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

This operation is performed by calling function getFileTasks.

See the endpoint docs at API Reference.

await client.tasks.getFileTasks(file.id);

Arguments

  • fileId string
    • 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"
  • optionalsInput GetFileTasksOptionalsInput

Returns

This function returns a value of type Tasks.

Returns a list of tasks on a file.

If there are no tasks on this file an empty collection is returned instead.

Create task

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

This operation is performed by calling function createTask.

See the endpoint docs at API Reference.

await client.tasks.createTask({
  item: {
    type: 'file' as CreateTaskRequestBodyItemTypeField,
    id: file.id,
  } satisfies CreateTaskRequestBodyItemField,
  message: 'test message',
  dueAt: dateTime,
  action: 'review' as CreateTaskRequestBodyActionField,
  completionRule: 'all_assignees' as CreateTaskRequestBodyCompletionRuleField,
} satisfies CreateTaskRequestBody);

Arguments

  • requestBody CreateTaskRequestBody
    • Request body of createTask method
  • optionalsInput CreateTaskOptionalsInput

Returns

This function returns a value of type Task.

Returns the newly created task.

Get task

Retrieves information about a specific task.

This operation is performed by calling function getTaskById.

See the endpoint docs at API Reference.

await client.tasks.getTaskById(task.id!);

Arguments

  • taskId string
    • The ID of the task. Example: "12345"
  • optionalsInput GetTaskByIdOptionalsInput

Returns

This function returns a value of type Task.

Returns a task object.

Update task

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

This operation is performed by calling function updateTaskById.

See the endpoint docs at API Reference.

await client.tasks.updateTaskById(task.id!, {
  requestBody: {
    message: 'updated message',
  } satisfies UpdateTaskByIdRequestBody,
} satisfies UpdateTaskByIdOptionalsInput);

Arguments

  • taskId string
    • The ID of the task. Example: "12345"
  • optionalsInput UpdateTaskByIdOptionalsInput

Returns

This function returns a value of type Task.

Returns the updated task object.

Remove task

Removes a task from a file.

This operation is performed by calling function deleteTaskById.

See the endpoint docs at API Reference.

await client.tasks.deleteTaskById(task.id!);

Arguments

  • taskId string
    • The ID of the task. Example: "12345"
  • optionalsInput DeleteTaskByIdOptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the task was successfully deleted.