# Idle (ref)

(part of package '[Idle Web Service](https://docs.servoy.com/reference/servoyextensions/packages/browser-plugin-packages/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](https://docs.servoy.com/servoy-developer/component_and_service_property_types#function)} onIdle Triggers when user is idle
> * {[Function](https://docs.servoy.com/servoy-developer/component_and_service_property_types#function)} onActive Triggers when user is active
> * {[Function](https://docs.servoy.com/servoy-developer/component_and_service_property_types#function)} onHide Triggers when window is hidden
> * {[Function](https://docs.servoy.com/servoy-developer/component_and_service_property_types#function)} onShow Triggers when window is shown
> * {[String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string)} events String of events that will reset idle time (default : 'mousemove keydown mousedown touchstart')
> * {[Number](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/number)} idle Idle time in ms, default: 60000
> * {[Boolean](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/boolean)} keepTracking Set to false if we only want to track the first time (true by default)
> * {[Boolean](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/boolean)} startAtIdle If you want to start at idle, set to true
> * {[Boolean](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/boolean)} recurIdleCall Use setInterval versus timeout, by default uses setTimeout

***

***