TaskProgress Interface Reference

The TaskProgress interface defines a process manager. More...

Public Member Functions
void	cancel ()
	Cancel task. More...
number	getCurrentProgress ()
	Get Progress. More...
	onProgress (callback:(this:TaskProgress< T >, data:T)=> void)
	Register a callback that is used to get data when the progress is updated. More...

Detailed Description

The TaskProgress interface defines a process manager.

Since

8.2.0

Member Function Documentation

cancel()

void TaskProgress::cancel

(

)

Cancel task.

Returns

void

Since

8.2.0

getCurrentProgress()

number TaskProgress::getCurrentProgress

(

)

Get Progress.

Returns

number - The percentage of progress

Since

8.2.0

onProgress()

TaskProgress::onProgress	(	callback:(this:TaskProgress< T >, data:T)	,
		void
	)

Register a callback that is used to get data when the progress is updated.

Parameters

{function}

callback (this: TaskProgress<T>, data: T) => void (this, data) => { console.log(data); }

Returns

{function}

Since

8.2.0