tasks.md

Tasks

Instantiate the required library class

$http = new \Romby\Box\Http\Adapters\GuzzleHttpAdapter(new \GuzzleHttp\Client())
$tasks = new \Romby\Box\Services\Tasks($http);

Create a Task

/* @param string      $token   the OAuth token.
 * @param int         $fileId  the file this task is for.
 * @param string|null $message an optional message to include with the task.
 * @param string|null $dueAt   the day at which this task is due.
 * @return array the new task.
 */
$tasks->create($token, $fileId, $message = null, $dueAt = null);

Get a Task

/* @param string $token the OAuth token.
 * @param int    $id    the ID of the task.
 * @return array the task.
 */
$tasks->get($token, $id);

Update a Task

/* @param string      $token   the OAuth token.
 * @param int         $id      the id of the task.
 * @param string|null $message an optional message to include with the task.
 * @param string|null $dueAt   the day at which this task is due.
 * @return array the updated task.
 */
$tasks->update($token, $id, $message = null, $dueAt = null);

Delete a Task

/* @param string $token the OAuth token.
 * @param int    $id    the id of the task.
 * @return void
 */
$tasks->delete($token, $id);

Get the Assignments for a Task

/* @param string $token the OAuth token.
 * @param int    $id    the id of the task assignment.
 * @return array the task assignment.
 */
$tasks->getTaskAssignments($token, $id);

Create a Task Assignment

/* @param string $token    the OAuth token.
 * @param int    $taskId   the id of the task.
 * @param array  $assignTo the user to assign the task to.
 * @return array the new task assignment.
 */
$tasks->createTaskAssignment($token, $taskId, array $assignTo);

Get a Task Assignment

/* @param string $token the OAuth token.
 * @param int    $id    the id of the task assignment.
 * @return array the task assignment.
 */
$tasks->getTaskAssignment($token, $id);

Delete a Task Assignment

/* @param string $token the OAuth token.
 * @param int    $id    the id of the task assignment.
 * @return void
 */
$tasks->deleteTaskAssignment($token, $id);

Update a Task Assignment

/* @param string $token           the OAuth token.
 * @param int    $id              the id of the task assignment.
 * @param string $message         a message from the assignee about this task
 * @param string $resolutionState can be completed, incomplete, approved, or rejected.
 * @return array the updated task assignment.
 */
$tasks->updateTaskAssignment($token, $id, $message, $resolutionState);