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 Triggers when user is idle

  • {Function} onActive Triggers when user is active

  • {Function} onHide Triggers when window is hidden

  • {Function} onShow Triggers when window is shown

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

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

  • {Boolean} keepTracking Set to false if we only want to track the first time (true by default)

  • {Boolean} startAtIdle If you want to start at idle, set to true

  • {Boolean} recurIdleCall Use setInterval versus timeout, by default uses setTimeout



Last updated

Was this helpful?