Idle (ref)

(part of package 'Idle Web Service')

You can access it in code via: plugins.svyIdle

A simple web service for checking if a user is idle or if the browser window is no longer active.

Properties

API

onIdle(onIdle,onActive,onHide,onShow,events,idle,keepTracking,startAtIdle,recurIdleCall)

Setup Idle options and callbacks

Parameters:

• {function} onIdle OnIdle triggers when user is idle

• {function} onActive OnActive triggers when user is active

• {function} onHide OnHide triggers when window is hidden

• {function} onShow OnShow triggers when window is shown

• {string} events String of events that will reset idle time (default : 'mousemove keydown mousedown touchstart')

• {int} idle Idle time in ms, default: 60000

• {boolean} keepTracking KeepTracking set to false if we only want to track the first time (true by default)

• {boolean} startAtIdle StartAtIdle if you want to start at idle, set to true

• {boolean} recurIdleCall RecurIdleCall use setInterval versus timeout, by default uses setTimeout

---

---