chromex.app.idle — binaryage/chromex 0.8.6

clj

Use the chrome.idle API to detect when the machine's idle state changes.

• available since Chrome 34
• https://developer.chrome.com/apps/idle

api-table clj

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-auto-lock-delay clj/s macro

(get-auto-lock-delay)

Gets the time, in seconds, it takes until the screen is locked automatically while idle. Returns a zero duration if the screen is never locked automatically. Currently supported on Chrome OS only.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [delay] where:

|delay| - Time, in seconds, until the screen is locked automatically while idle. This is zero if the screen never locks automatically.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/idle#method-getAutoLockDelay.

get-auto-lock-delay* cljs

(get-auto-lock-delay* config)

on-state-changed* cljs

(on-state-changed* config channel & args)

query-state clj/s macro

(query-state detection-interval-in-seconds)

Returns 'locked' if the system is locked, 'idle' if the user has not generated any input for a specified number of seconds, or 'active' otherwise.

|detection-interval-in-seconds| - The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [new-state] where:

|new-state| - https://developer.chrome.com/apps/idle#property-callback-newState.

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/apps/idle#method-queryState.

query-state* cljs

(query-state* config detection-interval-in-seconds)

set-detection-interval clj/s macro

(set-detection-interval interval-in-seconds)

Sets the interval, in seconds, used to determine when the system is in an idle state for onStateChanged events. The default interval is 60 seconds.

|interval-in-seconds| - Threshold, in seconds, used to determine when the system is in an idle state.

https://developer.chrome.com/apps/idle#method-setDetectionInterval.

set-detection-interval* cljs

(set-detection-interval* config interval-in-seconds)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.app.idle namespace.

tap-on-state-changed-events clj/s macro

(tap-on-state-changed-events channel & args)

Fired when the system changes to an active, idle or locked state. The event fires with 'locked' if the screen is locked or the screensaver activates, 'idle' if the system is unlocked and the user has not generated any input for a specified number of seconds, and 'active' when the user generates input on an idle system.

Events will be put on the |channel| with signature [::on-state-changed [new-state]] where:

|new-state| - https://developer.chrome.com/apps/idle#property-onStateChanged-newState.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/apps/idle#event-onStateChanged.