Difference between revisions of "ATC/Current/SDK/Method reference"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
(3 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Section={{Section
 
|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 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
 
|sectionHeading=Initialization methods
 
|sectionHeading=Initialization methods
 
|alignment=Vertical
 
|alignment=Vertical
Line 60: Line 64:
 
{{!}}{{!}}{{#mintydocs_link:topic=Record|link text=record}}
 
{{!}}{{!}}{{#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.
 
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}{{#mintydocs_link:topic=Forms:track|link text=forms:track}}
 
{{!}}{{!}}{{#mintydocs_link:topic=Forms:track|link text=forms:track}}
{{!}}{{!}} 
+
{{!}}{{!}} Captures when visitors complete web-based forms.
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No

Latest revision as of 09:43, February 2, 2023

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

View a list of methods available in the Journey JavaScript SDK.

Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

Initialization methods

For more information about a method, including signature and arguments, click the method's name.

Method Description
init Initializes the Journey JavaScript SDK.
initialized Notifies when the Journey JavaScript SDK is initialized fully.
destroy Stops all Journey JavaScript SDK activity and removes all tracking information.

Session methods

For more information about a method, including signature and arguments, click the method's name.

Method Description
api.session.getData Returns an object that contains session information.
api.session.getCustomerCookieId Returns a string that contains the customer cookie ID.
api.session.getId Returns a string containing session ID.

Tracking methods

For more information about a method, including signature and arguments, click the method's name.

Method Description
pageview Tracks page views.
record Records custom website events.
forms:track  Captures when visitors complete web-based forms.

Events methods

For more information about a method, including signature and arguments, click the method's name.

Method Description
on Subscribes to notifications about a particular type of Journey JavaScript SDK activity.
once Subscribes to notifications for first event for a particular type of Journey JavaScript SDK activity.
off Unsubscribes from notifications about a particular type of Journey JavaScript SDK activity.

Utility methods

For more information about a method, click the method's name.

Method Description

serialize

Passes serialized data from a form.
dom - ready
Allows you to specify a function handler to run when the DOM has loaded fully.
debug
Sends helpful messages to the console.
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Method_reference (2025-06-23 21:25:29)"
Comments or questions about this documentation? Contact us for support!