IAsyncTaskState

public interface IAsyncTaskState

Provides access to the state of the asynchronous task.

Methods

MethodDescription
isCanceled()Gets a value indicating whether the asynchronous task is canceled.
getProgress()Gets the progress of the asynchronous task.
indicateProgress(EventType eventType)Sets the progress of the asynchronous task.
incrementProgressMaxValue(int value)Increments the progress maximum value.

isCanceled()

public abstract boolean isCanceled()

Gets a value indicating whether the asynchronous task is canceled.

Value: true if the asynchronous task is canceled; otherwise, false.

Returns: boolean - a value indicating whether the asynchronous task is canceled.

getProgress()

public abstract EventType getProgress()

Gets the progress of the asynchronous task.

Value: The progress of the asynchronous task.

Returns: EventType - the progress of the asynchronous task.

indicateProgress(EventType eventType)

public abstract void indicateProgress(EventType eventType)

Sets the progress of the asynchronous task.

Parameters:

ParameterTypeDescription
eventTypeEventTypeThe progress state.

incrementProgressMaxValue(int value)

public abstract void incrementProgressMaxValue(int value)

Increments the progress maximum value.

Parameters:

ParameterTypeDescription
valueintThe increase value.