autoTrackIdle

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Journey JavaScript SDK for version Current of Altocloud.

Learn how to configure when Altocloud detects inactivity on a webpage, so you have more accurate page tracking information for use in segments and outcomes.

Description

The autoTrackIdle module tracks when and where a user becomes inactive on a webpage. To use autoTrackIdle, use the following options to configure the idle events that you want to track:

Signature

ac('load', 'autotrackIdle', [config], [callback]);

Example

ac('load', 'autotrackIdle'); // This is for all one idle event config with defaults
 
ac('load', 'autotrackIdle', {
  idleEvents: [
    {}, // This is for all defaults
    { eventName: 'stuck_on_page' },
    { idleAfter: 60 },
    { eventName: 'idle_for_2_min', idleAfter: 120 },
  ]
}, function () {
    console.log('"autotrackIdle" has been loaded');
});

Config (required)

Description: identifies an array of idle events that should be tracked.

Type: object

Returns: Nothing

Properties:

Name Description Type Status
idleAfter The number of seconds of inactivity after which an event will fire.

The default is 60 seconds.

Note: The minimum is 30 seconds. If you specify less than 30, then 30 seconds is used.

String required
eventName is a string that will be used as the event name when an element matching the selector is clicked. String required

Example

{
  idleEvents: [
    {}, // This is for all defaults
    { eventName: 'stuck_on_page' },
    { idleAfter: 60 },
    { eventName: 'idle_for_2_min', idleAfter: 120 },
  ]
}

Callback (optional)

When a module fully loads, callback is executed. By default, it returns nothing to you. However, you can override the default callback behavior if, for example, you want to supply your own callback behavior and wait for it to execute before doing some other function on your website.

Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/autoTrackIdle (2020-08-08 06:46:29)"