Package com.atlassian.confluence.api.service.longtasks

Interface LongTaskService

All Known Implementing Classes:

LongTaskServiceImpl

public interface LongTaskService

Manages LongTaskStatuss.

Method Summary

Modifier and Type	Method	Description
com.atlassian.fugue.Option<LongTaskStatus>	get(LongTaskId id, Expansion... expansions)	Deprecated. since 6.13.0, use {getStatus(LongTaskId, Expansion...)}
PageResponse<LongTaskStatus>	getAll(PageRequest request, Expansion... expansions)	Returns the status of all tracked long-running tasks visible to the user.
default Optional<LongTaskStatus>	getStatus(LongTaskId id, Expansion... expansions)	Returns the status of a long-running task.

Method Detail

get

@Deprecated
com.atlassian.fugue.Option<LongTaskStatus> get(LongTaskId id,
                                               Expansion... expansions)

Deprecated.

since 6.13.0, use {getStatus(LongTaskId, Expansion...)}

Returns the status of a long-running task.

Parameters:

id - the identifier of the task to return

expansions - additional information about the task returned

Returns:

the long running task with the supplied id

getStatus

default Optional<LongTaskStatus> getStatus(LongTaskId id,
                                           Expansion... expansions)

Returns the status of a long-running task.

Parameters:

id - the identifier of the task to return

expansions - additional information about the task returned

Returns:

the long running task with the supplied id

Since:

6.13.0

getAll

PageResponse<LongTaskStatus> getAll(PageRequest request,
                                    Expansion... expansions)

Returns the status of all tracked long-running tasks visible to the user.

Parameters:

request - defines the page of tasks to be returned

expansions - additional information about the tasks returned

Returns:

the currently-tracked long running tasks