scheduler.md

scheduler

Manages scheduling and execution of tasks

Table of Contents

• Constants
• Methods
  • init
  • removePeriodicTask
  • restartPeriodicTask
  • schedulePeriodicTask
  • tick
  • updatePeriodicTask
  • _fireTask
  • _handleTick

Constants

Name	Type	Value	Description
QUERY_INTERVAL	Integer	1000	Time (ms) interval for ticks
SLEEP_THRESHOLD	Integer	60000	Time (ms) threshold to execute tasks after app has been asleep/inactive for
_jQueryCleanupTaskId	String	specific to local	ID of the task that manages cleanup of jQuery fragments
_lastTickTime	Integer	specific to local	Time (ms) value of the last passed tick
_tasks	Object	-	Object containing all tasks that are run periodically

Methods

init

Description:
Sets the _lastTickTime to current unix time, adds the jQuery cleanup task and sets _jQueryCleanupTaskId

removePeriodicTask

Parameters:

• taskID String

Description:
Removes the task with ID taskID

restartPeriodicTask

Parameters:

• taskID String

Description:
Restarts the task with ID taskID

schedulePeriodicTask

Parameters:

• interval Integer
• func Function
• ??? (optional)

Description:
Creates a task that is executes func with the set interval

tick

Description:
This function initializes the interval for the scheduler

updatePeriodicTask

Parameters:

• taskID String
• interval Integer
• func Function

Description:
Update task with the ID taskID to have a new interval and/or func

_fireTask

Parameters:

• task Object

Description:
Executes the callback function of specified task

_handleTick

Description:
Handles ticks and executes callback functions if required