Activity API

Owned by Lynn Neir (Deactivated)
Last updated: May 16, 2017
1 min read

Purpose

The application needs to be informed if activity (keyboard or mouse input) has occurred.

SSF Activity API


ssf.registerActivityDetection(throttle, callback);

throttle (number): minimum report period in milliseconds.

callback: the callback is invoked when the activity occurs.

Whenever activity occurs the callback will be invoked. If additional activity occurs within the period given by the 'throttle', then the callback will be invoked at time: X + throttle (where X is the time of last activity report send).  This prevents flooding the API with activity reports.  Activity is defined as keyboard or mouse interaction anywhere in the OS.

Implementation

Could be implemented using node module: https://github.com/paulcbetts/node-system-idle-time

Need help? Email help@finos.org we'll get back to you.

Content on this page is licensed under the CC BY 4.0 license.
Code on this page is licensed under the Apache 2.0 license.