cp.idle.md

docs » cp.idle

---

This library allows tasks to be queue for execution when the computer has been idle for a specified amount of time. 'Idle' is defined as no keyboard or mouse movement.

API Overview

• Functions - API calls offered directly by the extension
• queue

API Documentation

Functions

queue

Signature	cp.idle.queue(idleSeconds, actionFn[, retryOnError]) -> nothing
Type	Function
Description	Adds an action to the idle queue, which will be run after the the computer has been idle
Parameters	idleSeconds - The number of seconds of idle time must have elapsed run the action actionFn - The function to execute retryOnError - Optional. If set to true, the action will try running again if there is an error.
Returns	Nothing