IdlePolicy | Firebolt

IdlePolicy Schema


Version 0.1.0-alpha.4

JSON-Schema

This document was generated from a JSON-Schema, and is intended to provide a human readable overview and examples of the methods contained in the module.

For the full schema, see the link below.

Table of Contents

Schemas

IdlePolicy

type IdlePolicy = {
  interactionIdleTimer: number         // The duration, starting from last user interaction, after which the user will be considered idle, if no action is taken first.
  decoderIdleTimer: number             // The duration, starting from last known decoder activity, after which the decoder will be considered idle, if no activity is recorded first.
  interactionIdleWarningTime: number   // How much time, in ms, before the interaction idle timer takes effect, that a warning event be fired, e.g. to enable a UI to present a prompt to cancel.
  decoderIdleWarningTime: number       // How much time, in ms, before the decoder idle timer takes effect, that a warning event be fired, e.g. to enable a UI to present a prompt to cancel.
  enabledInteractivitySources: {
    developerTools: boolean
    appDetectedInteractivity: boolean
  }
}
Examples
{
  "interactionIdleTimer": 10800000,
  "decoderIdleTimer": 600000,
  "interactionIdleWarningTime": 1000,
  "decoderIdleWarningTime": 1000,
  "enabledInteractivitySources": {
    "developerTools": false
  }
}

Details

A configuration describing when the user/device is considered to be idle.


Go To Top