Task< Type > Class Template Reference

Inheritance diagram for Task< Type >:

Public Member Functions
ApiError	cancel ()
boolean	equals (Object o)
native String	getLastErrorDescription ()
native double	getProgress ()
Type	getResult ()
native ApiError	getReturnValue ()
ApiError	join ()

Detailed Description

A specific version of the BaseTask class that provides a result of template type In case that a task has no result, the type is Task<Void>

Member Function Documentation

cancel()

ApiError cancel ( )

inherited

Aborts the task. If the task is aborted the return value of the task result callback is ApiError.OPERATION_CANCELLED.

Returns

Errorcode

• ApiError.OK if the task has been canceled

equals()

boolean equals ( Object  o )

inherited

getLastErrorDescription()

native String getLastErrorDescription ( )

inherited

Returns

textual description of the last occurred error for the given task

getProgress()

native double getProgress ( )

inherited

Returns

the task progress in percent in the range 0 to 100.0

getResult()

Type getResult

(

)

The result of the task which is of the templated type. The result is valid as soon as the task is finished without error.

getReturnValue()

native ApiError getReturnValue ( )

inherited

Returns

tasks return code. Its value depends on the task itself and is documented with the function that created the task Errorcode

• ApiError.OK if successful
• ApiError.ASYNC_OPERATION_STILL_RUNNING if the async operation is not finished
• Task specific error, please look into the documentation of the method that initiates the task.

join()

ApiError join ( )

inherited

Waits for the task to be finished.

Returns

Errorcode

• ApiError.OK if the task has been finished
• ApiError.ASYNC_OPERATION_STILL_RUNNING if task is still running

---

The documentation for this class was generated from the following file:

• Task.java