com.atlassian.bitbucket.task

Interface TaskService

Deprecated.

in 7.0 for removal in 8.0. Tasks are now managed using comments with BLOCKER severity. App developers should use CommentService to create, retrieve and update BLOCKER comments; this service is now just a facade for that one.

@Deprecated
public interface TaskService

Service to manage Tasks.

As of 7.0, tasks have been deprecated and replaced with CommentSeverity.BLOCKER Comments. As part of that replacement, this service has been reimplemented as a facade for CommentService. App developers who use tasks are strongly encouraged to update their code to use CommentService directly as soon as possible.

Note: CommentSeverity.BLOCKER comments have existed since 6.7, however, prior to 7.0 they are not treated as tasks. Apps that wish to retain semantic compatibility with 6.x must continue using the TaskService until support for pre-7.0 releases can be dropped.

Implementing tasks as BLOCKER comments imposes two semantics-breaking changes despite remaining API-compatible with previous releases:

• Tasks can only be deleted by their authors, and repository administrators; pull request authors can no longer delete tasks they did not create (unless they're a repository administrator)
• Task text can only be updated by its author; pull request authors and repository administrators can no longer update the text for tasks they did not create

In addition to those semantics-breaking changes, there are other implications that may be worth noting:

• BLOCKER comments created using the CommentService directly are included in task results, unless they are root comments (i.e. they have no parent). It was not, and still is not, possible to create a task without an anchoring comment, so root BLOCKER comments cannot be treated as tasks because they would violate the nullability contract for Task.getAnchor()
• BLOCKER comments created and/or updated using the task API still have their whitespace normalized
• Creating, deleting and updating tasks now raises comment events, which means those task operations can be canceled using the cancelable comment events
• Creating a new task creates a BLOCKER reply on the anchoring comment
• Deleting a task deletes the BLOCKER reply
• Updating a task updates the state and/or text of the BLOCKER reply

Method Summary

Modifier and Type	Method and Description
Task	create(TaskCreateRequest request) Deprecated. Create a task.
void	delete(long taskId) Deprecated. Delete a task.
Task	getById(long taskId) Deprecated. Get a task by its ID.
Task	update(TaskUpdateRequest request) Deprecated. Update a task.

Method Detail

create

@Nonnull
Task create(@Nonnull
                     TaskCreateRequest request)

Deprecated.

Create a task.

Since 7.0, this method creates a BLOCKER comment as a reply to the specified anchor comment.

Parameters:

request - request detailing the task's properties

Returns:

an instance of the created task

delete

void delete(long taskId)

Deprecated.

Delete a task.

Since 7.0, this method deletes the BLOCKER comment with the specified ID.

Warning: Since 7.0, the semantics of this method have changed: Pull request authors may no longer delete tasks created by other users. As with comments, tasks can only be deleted by their authors and repository administrators.

Parameters:

taskId - the ID of the task to delete

getById

@Nullable
Task getById(long taskId)

Deprecated.

Get a task by its ID.

Since 7.0, this method retrieves the BLOCKER comment with the specified ID. Due to the nullability contract of Task.getAnchor(), if the BLOCKER comment is a root comment (i.e. has no parent), it cannot be retrieved using this API.

Parameters:

taskId - the ID of the task to retrieve

Returns:

the task matching the ID or null if none matches or the task is not visible to the current user

update

@Nonnull
Task update(@Nonnull
                     TaskUpdateRequest request)

Deprecated.

Update a task.

Since 7.0, this method updates the state and/or text of the BLOCKER comment.

Warning: Since 7.0, the semantics of this method have changed: Pull request authors and repository administrators may no longer change the text of tasks created by other users. As with comments, task text can only be changed by the task's author.

Parameters:

request - the properties to update

Returns:

an instance of the updated task