Difference between revisions of "ATC/Current/SDK/Method reference"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2") |
||
Line 5: | Line 5: | ||
|Context=View a list of all methods in the Journey JavaScript SDK. | |Context=View a list of all methods in the Journey JavaScript SDK. | ||
|ComingSoon=No | |ComingSoon=No | ||
− | |Platform= | + | |Platform=GenesysEngage-onpremises, PureConnect, PureCloud |
|Prereq= | |Prereq= | ||
|Section={{Section | |Section={{Section |
Revision as of 11:44, July 15, 2020
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.
Contents
View a list of all methods in the Journey JavaScript SDK.
Initialization methods
For complete 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 fully initialized. |
destroy | Stops all Journey JavaScript SDK activity and removes all tracking information |
Session methods
For complete 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 complete information about a method, including signature and arguments, click the method's name.
Method | Description |
pageview | Tracks page views |
record | Records custom website events |
identify | Adds information to a customer |
forms:track |
Events methods
For complete 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 complete information about a method, click the method's name.
Method | Description |
Used for passing serialized data from a form. | |
dom - ready |
Allows you specify a function handler to run when the DOM has fully loaded. |
debug |
Sends helpful messages to the console. |
Comments or questions about this documentation? Contact us for support!