com.box.sdk

Class BoxTaskAssignment

Object

BoxResource

BoxTaskAssignment

@BoxResourceType(value="task_assignment")
public class BoxTaskAssignment
extends BoxResource

Represents a task assignment on Box, which can be used to assign a task to a single user. There can be multiple assignments on a single task.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxTaskAssignment.Info Contains information about a task assignment.
static class	BoxTaskAssignment.ResolutionState Enumerates the possible resolution states that a task assignment can have.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	TASK_ASSIGNMENT_URL_TEMPLATE Task Assignment URL Template.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this task assignment.
BoxTaskAssignment.Info	getInfo() Gets information about this task assignment.
BoxTaskAssignment.Info	getInfo(String... fields) Gets information about this task assignment.
void	updateInfo(BoxTaskAssignment.Info info) Updates the information about this task assignment 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_ASSIGNMENT_URL_TEMPLATE

public static final URLTemplate TASK_ASSIGNMENT_URL_TEMPLATE

Task Assignment URL Template.

Constructor Detail

BoxTaskAssignment

public BoxTaskAssignment(BoxAPIConnection api,
                         String id)

Constructs a BoxTaskAssignment for a task assignment with a given ID.

Parameters:

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

id - the ID of the task assignment.

Method Detail

delete

public void delete()

Deletes this task assignment.

getInfo

public BoxTaskAssignment.Info getInfo()

Gets information about this task assignment.

Returns:

info about this task assignment.

getInfo

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

Gets information about this task assignment.

Parameters:

fields - the fields to retrieve.

Returns:

info about this task assignment.

updateInfo

public void updateInfo(BoxTaskAssignment.Info info)

Updates the information about this task assignment 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:

BoxTaskAssignment taskAssignment = new BoxTaskAssignment(api, id);
 BoxTaskAssignment.Info info = taskAssignment.getInfo();
 taskAssignment.updateInfo(info);

Parameters:

info - the updated info.