Class TaskHandler

A simple class for handling potentially repeated executions either deferred or immediate.

Hierarchy (View Summary)

TaskHandlerBase
- TaskHandler

Index

Constructors

Accessors

isScheduled status

Methods

_onDispose _onExecute cancel getStatus runSynchronously start

Constructors

constructor

new TaskHandler(_action: Closure): TaskHandler
Parameters
- _action: Closure
Returns TaskHandler
Overrides TaskHandlerBase.constructor
- Defined in TaskHandler.ts:14

Accessors

isScheduled

get isScheduled(): boolean
Returns boolean
Inherited from TaskHandlerBase.isScheduled
- Defined in TaskHandlerBase.ts:33

status

get status(): TaskStatus
Returns TaskStatus
Inherited from TaskHandlerBase.status
- Defined in TaskHandlerBase.ts:28

Methods

`Protected`_onDispose

_onDispose(): void
Returns void
Overrides TaskHandlerBase._onDispose
- Defined in TaskHandler.ts:25

`Protected`_onExecute

_onExecute(): void
Returns void
Overrides TaskHandlerBase._onExecute
- Defined in TaskHandler.ts:20

cancel

cancel(): boolean
Returns true if cancelled. Returns false if already run or already cancelled or unable to cancel.

Returns boolean
Inherited from TaskHandlerBase.cancel
- Defined in TaskHandlerBase.ts:75

`Protected`getStatus

getStatus(): TaskStatus
Returns TaskStatus
Inherited from TaskHandlerBase.getStatus
- Defined in TaskHandlerBase.ts:88

runSynchronously

runSynchronously(): void
Returns void
Inherited from TaskHandlerBase.runSynchronously
- Defined in TaskHandlerBase.ts:69

start

start(defer?: number): void
Schedules/Reschedules triggering the task.
Parameters
- defer: number = 0
  Optional time to wait until triggering.
Returns void
Inherited from TaskHandlerBase.start
- Defined in TaskHandlerBase.ts:58