com.box.sdk

Class BoxTask

Object

BoxResource

BoxTask

@BoxResourceType(value="task")
public class BoxTask
extends BoxResource

Represents a task on Box. Tasks can have a due date and can be assigned to a specific user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxTask.Action Enumerates the possible actions that a task can have.
static class	BoxTask.CompletionRule Enumerates the possible completion rules for a task.
class	BoxTask.Info Contains information about a BoxTask.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ADD_TASK_ASSIGNMENT_URL_TEMPLATE Add Task Assignment URL Template.
static URLTemplate	GET_ASSIGNMENTS_URL_TEMPLATE Get Assignments URL Template.
static URLTemplate	TASK_URL_TEMPLATE Task URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxTask(BoxAPIConnection api, String id) Constructs a BoxTask for a task with a given ID.

Method Summary

Modifier and Type	Method and Description
BoxTaskAssignment.Info	addAssignment(BoxUser assignTo) Adds a new assignment to this task.
BoxTaskAssignment.Info	addAssignmentByLogin(String assignToLogin) Adds a new assignment to this task using user's login as identifier.
void	delete() Deletes this task.
Iterable<BoxTaskAssignment.Info>	getAllAssignments(String... fields) Gets an iterable of all the assignments of this task.
List<BoxTaskAssignment.Info>	getAssignments() Gets any assignments for this task.
BoxTask.Info	getInfo(String... fields) Gets information about this task.
void	updateInfo(BoxTask.Info info) Updates the information about this task with any info fields that have been modified locally.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

TASK_URL_TEMPLATE

public static final URLTemplate TASK_URL_TEMPLATE

Task URL Template.

GET_ASSIGNMENTS_URL_TEMPLATE

public static final URLTemplate GET_ASSIGNMENTS_URL_TEMPLATE

Get Assignments URL Template.

ADD_TASK_ASSIGNMENT_URL_TEMPLATE

public static final URLTemplate ADD_TASK_ASSIGNMENT_URL_TEMPLATE

Add Task Assignment URL Template.

Constructor Detail

BoxTask

public BoxTask(BoxAPIConnection api,
               String id)

Constructs a BoxTask for a task with a given ID.

Parameters:

api - the API connection to be used by the task.

id - the ID of the task.

Method Detail

delete

public void delete()

Deletes this task.

addAssignment

public BoxTaskAssignment.Info addAssignment(BoxUser assignTo)

Adds a new assignment to this task.

Parameters:

assignTo - the user to assign the assignment to.

Returns:

information about the newly added task assignment.

addAssignmentByLogin

public BoxTaskAssignment.Info addAssignmentByLogin(String assignToLogin)

Adds a new assignment to this task using user's login as identifier.

Parameters:

assignToLogin - the login of user to assign the task to.

Returns:

information about the newly added task assignment.

getAssignments

public List<BoxTaskAssignment.Info> getAssignments()

Gets any assignments for this task.

Returns:

a list of assignments for this task.

getAllAssignments

public Iterable<BoxTaskAssignment.Info> getAllAssignments(String... fields)

Gets an iterable of all the assignments of this task.

Parameters:

fields - the fields to retrieve.

Returns:

an iterable containing info about all the assignments.

getInfo

public BoxTask.Info getInfo(String... fields)

Gets information about this task.

Parameters:

fields - the fields to retrieve.

Returns:

info about this task.

updateInfo

public void updateInfo(BoxTask.Info info)

Updates the information about this task with any info fields that have been modified locally.

The only fields that will be updated are the ones that have been modified locally. For example, the following code won't update any information (or even send a network request) since none of the info's fields were changed:

BoxTask task = new BoxTask(api, id);
 BoxTask.Info info = task.getInfo();
 task.updateInfo(info);

Parameters:

info - the updated info.