ATC/Current/SDK/autotrackIdle - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

2021-11-09T21:28:37Z

Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

2021-08-10T10:35:15Z

Published

Barbara.martin@genesys.com: Published

2021-04-28T18:29:45Z

Published

Barbara.martin@genesys.com: Published

2020-12-17T16:42:27Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T17:59:38Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T17:48:04Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:29:32Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

2020-07-15T11:59:33Z

Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:44:28Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

DannaShirley: Published

2020-07-08T10:03:29Z

Published

New page

{{Article
|Standalone=No
|DisplayName=autotrackIdle
|TocName=autotrackIdle
|Context=Learn how to configure when {{MINTYDOCSPRODUCT}} detects inactivity on a webpage, so you have more accurate page tracking information for use in segments and outcomes.
|Dimension=Modules
|ComingSoon=No
|Platform=PureEngage, PureConnect, PureCloud
|Prereq=
|Section={{Section
|sectionHeading=Description
|anchor=Description
|alignment=Vertical
|Media=
|image=
|structuredtext=The <code>autotrackIdle</code> module tracks when and where a user becomes inactive on a webpage. To use <code>autotrackIdle</code>, use the following options to configure the idle events that you want to track:

*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Config|display text=Config}}
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Callback|display text=Callback}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Signature
|anchor=Signature
|alignment=Vertical
|Media=
|image=
|structuredtext=<syntaxhighlight lang="javascript">

ac('load', 'autotrackIdle', [config], [callback]);
</syntaxhighlight>
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Example
|anchor=Example
|alignment=Vertical
|Media=
|image=
|structuredtext=<syntaxhighlight lang="javascript">
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');
});
</syntaxhighlight>
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Config (optional)
|anchor=Config
|alignment=Vertical
|Media=
|image=
|structuredtext=Description: identifies an array of idle events that should be tracked.

Type: object

Properties:
{{{!}} class="wikitable"
{{!}}+
!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.
{{!}}Number
{{!}}optional
{{!}}-
{{!}}eventName
{{!}}A string that will be used as the event name when an element matching the selector is clicked.
{{!}}String
{{!}}optional
{{!}}}
====Example====
<syntaxhighlight lang="javascript">
{
idleEvents: [
{}, // This is for all defaults
{ eventName: 'stuck_on_page' },
{ idleAfter: 60 },
{ eventName: 'idle_for_2_min', idleAfter: 120 },
]
}
</syntaxhighlight>
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Callback (optional)
|anchor=Callback
|alignment=Vertical
|Media=
|image=
|structuredtext=When a module fully loads, callback is executed. No arguments are passed to the callback.
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}

@@ Line 48: / Line 48: @@
 |anchor=Config
 |alignment=Vertical
-|structuredtext='''Description:''' identifies an array of idle events to track.
+|structuredtext='''Description:''' Identifies an array of idle events to track.
-'''Type:''' object
+'''Type:''' Object
 '''Properties:''' See the following table.

@@ Line 9: / Line 9: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
+|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 |Status=No
 }}{{Section

@@ Line 3: / Line 3: @@
 |DisplayName=autotrackIdle
 |TocName=autotrackIdle
-|Context=Learn how to configure when {{MINTYDOCSPRODUCT}} detects inactivity on a webpage. This configuration provides more accurate page tracking information for use in segments and outcomes.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.
+|Context=Learn how to configure when {{MINTYDOCSPRODUCT}} detects inactivity on a webpage. This configuration provides more accurate page tracking information for use in segments and outcomes.
 |Dimension=Modules
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Description
 |anchor=Description

@@ Line 11: / Line 11: @@
 |anchor=Description
 |alignment=Vertical
-|structuredtext=The <code>autotrackIdle</code> module tracks when and where a user becomes inactive on a webpage. To use <code>autotrackIdle</code>, configure the idle events to track using the following options:
+|structuredtext=The <code>autotrackIdle</code> module tracks when and where a visitor becomes inactive on a webpage. To use <code>autotrackIdle</code>, configure the idle events to track using the following options:
 *{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Config|display text=Config}}

@@ Line 6: / Line 6: @@
 |Dimension=Modules
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises, PureConnect, GenesysCloud
+|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
 |Prereq=
 |Section={{Section

ATC/Current/SDK/autotrackIdle - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

DannaShirley: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"