ATC/Current/SDK/Method reference - Revision history

WikiSysop at 09:43, February 2, 2023

2023-02-02T09:43:49Z

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

2021-11-09T21:28:21Z

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

Barbara.martin@genesys.com: Published

2021-08-10T10:37:21Z

Published

Barbara.martin@genesys.com: Published

2021-04-28T18:29:45Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T19:51:07Z

Published

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

2020-07-25T02:30:21Z

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

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

2020-07-15T12:00:20Z

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

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

2020-07-15T11:44:01Z

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

DannaShirley: Published

2020-06-10T10:08:56Z

Published

DannaShirley: Published

2020-06-02T10:46:35Z

Published

@@ Line 64: / Line 64: @@
 {{!}}{{!}}{{#mintydocs_link:topic=Record|link text=record}}
 {{!}}{{!}}Records custom website events.
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Forms:track|link text=forms:track}}
-{{!}}{{!}}
+{{!}}{{!}} Captures when visitors complete web-based forms.
 {{!}}}
 |Status=No

@@ Line 8: / Line 8: @@
 |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=Method reference
 |TocName=Method reference
-|Context=View a list of methods available in the Journey JavaScript SDK.{{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=View a list of methods available in the Journey JavaScript SDK.
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Initialization methods
 |alignment=Vertical

@@ Line 3: / Line 3: @@
 |DisplayName=Method reference
 |TocName=Method reference
-|Context=View a list of methods available in the Journey JavaScript SDK.
+|Context=View a list of methods available in the Journey JavaScript SDK.{{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.
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud

@@ Line 3: / Line 3: @@
 |DisplayName=Method reference
 |TocName=Method reference
-|Context=View a list of all methods in the Journey JavaScript SDK.
+|Context=View a list of methods available in the Journey JavaScript SDK.
 |ComingSoon=No
-|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Initialization methods
 |alignment=Vertical
-|Media=
+|structuredtext=For more information about a method, including signature and arguments, click the method's name.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 20: / Line 16: @@
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Init|link text=init}}
-{{!}}{{!}}Initializes the Journey JavaScript SDK
+{{!}}{{!}}Initializes the Journey JavaScript SDK.
 {{!}}-
 {{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=initialized}}
-{{!}}Notifies when the Journey JavaScript SDK is fully initialized.
+{{!}}Notifies when the Journey JavaScript SDK is initialized fully.
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Destroy|link text=destroy}}
-{{!}}{{!}}Stops all Journey JavaScript SDK activity and removes all tracking information
+{{!}}{{!}}Stops all Journey JavaScript SDK activity and removes all tracking information.
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 35: / Line 29: @@
 |anchor=SessionMethods
 |alignment=Vertical
-|Media=
+|structuredtext=For more information about a method, including signature and arguments, click the method's name.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 44: / Line 36: @@
 {{!}}-
 {{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=api.session.getData}}
-{{!}}{{!}}Returns an object that contains session information
+{{!}}{{!}}Returns an object that contains session information.
 {{!}}-
 {{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=api.session.getCustomerCookieId}}
-{{!}}{{!}}Returns a string that contains the customer cookie Id
+{{!}}{{!}}Returns a string that contains the customer cookie ID.
 {{!}}-
 {{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=api.session.getId}}
-{{!}}Returns a string containing session Id
+{{!}}Returns a string containing session ID.
 {{!}}}<br />
 |Status=No
 }}{{Section
@@ Line 59: / Line 49: @@
 |anchor=TrackingMethods
 |alignment=Vertical
-|Media=
+|structuredtext=For more information about a method, including signature and arguments, click the method's name.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 68: / Line 56: @@
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Pageview|link text=pageview}}
-{{!}}{{!}}Tracks page views
+{{!}}{{!}}Tracks page views.
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Record|link text=record}}
-{{!}}{{!}}Records custom website events
+{{!}}{{!}}Records custom website events.
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Identify|link text=identify}}
-{{!}}{{!}}Adds information to a customer
+{{!}}{{!}}Adds information to a customer.
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Forms:track|link text=forms:track}}
 {{!}}{{!}}
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 86: / Line 72: @@
 |anchor=EventsMethods
 |alignment=Vertical
-|Media=
+|structuredtext=For more information about a method, including signature and arguments, click the method's name.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 101: / Line 85: @@
 {{!}}-
 {{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=off}}
-{{!}}Unsubscribes from notifications about a particular type of Journey JavaScript SDK activity
+{{!}}Unsubscribes from notifications about a particular type of Journey JavaScript SDK activity.
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 110: / Line 92: @@
 |anchor=UtilityMethods
 |alignment=Vertical
-|Media=
+|structuredtext=For more information about a method, click the method's name.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 120: / Line 100: @@
 {{!}}{{!}}
 {{Link-SomewhereInThisManual|topic=serialize}}<br />
-{{!}}{{!}}Used for passing serialized data from a form.
+{{!}}{{!}}Passes serialized data from a form.
 {{!}}-
 {{!}}{{!}}{{Link-SomewhereInThisManual|topic=dom_-_ready}}<br />
-{{!}}{{!}}Allows you specify a function handler to run when the DOM has fully loaded.
+{{!}}{{!}}Allows you to specify a function handler to run when the DOM has loaded fully.
 {{!}}-
 {{!}}{{!}}{{Link-SomewhereInThisManual|topic=debug}}<br />
 {{!}}{{!}}Sends helpful messages to the console.
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=View a list of all methods in the Journey JavaScript SDK.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises, PureConnect, PureCloud
+|Platform=GenesysEngage-onpremises, PureConnect, GenesysCloud
 |Prereq=
 |Section={{Section

@@ Line 20: / Line 20: @@
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Init|link text=init}}
-{{!}}{{!}}Initializes the {{MINTYDOCSPRODUCT}} SDK
+{{!}}{{!}}Initializes the Journey JavaScript SDK
 {{!}}-
 {{!}}{{!}}{{#mintydocs_link:topic=Destroy|link text=destroy}}
-{{!}}{{!}}Stops all {{MINTYDOCSPRODUCT}} SDK activity and removes all tracking information
+{{!}}{{!}}Stops all Journey JavaScript SDK activity and removes all tracking information
 {{!}}}
 |structuredtextwide=
 |FAQHeading=
@@ Line 56: / Line 83: @@
 |Status=No
 }}{{Section
-|sectionHeading=Session methods
+|sectionHeading=Events methods
-|anchor=SessionMethods
+|anchor=EventsMethods
 |alignment=Vertical
 |Media=
@@ Line 67: / Line 94: @@
 {{!}}{{!}}'''Description'''
 {{!}}-
-{{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=api.session.getData}}
+{{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=on}}
-{{!}}{{!}}Returns an object that contains session information
+{{!}}{{!}}Subscribes to notifications about a particular type of Journey JavaScript SDK activity.
 {{!}}-
-{{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=api.sessiongetCustomerCookieId}}
+{{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=once}}
-{{!}}{{!}}Returns a string that contains the customer cookie Id
+{{!}}{{!}}Subscribes to notifications for first event for a particular type of Journey JavaScript SDK activity.
 {{!}}-
-{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=api.session.getId}}
+{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=off}}
-{{!}}Returns a string containing session Id
+{{!}}Unsubscribes from notifications about a particular type of Journey JavaScript SDK activity
-{{!}}}<br />
+{{!}}}
 |structuredtextwide=
 |FAQHeading=
@@ Line 104: / Line 131: @@
 |FAQHeading=
 |Status=No
 }}
 }}

ATC/Current/SDK/Method reference - Revision history

WikiSysop at 09:43, February 2, 2023

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

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

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"