Difference between revisions of "ATC/Current/SDK/Method reference"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
|||
| Line 2: | Line 2: | ||
|Standalone=No | |Standalone=No | ||
|DisplayName=Method reference | |DisplayName=Method reference | ||
| − | |||
|TocName=Method reference | |TocName=Method reference | ||
| + | |Context=View a list of all methods in the Journey JavaScript SDK. | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | | | + | |Platform=PureEngage, PureConnect, PureCloud |
| + | |Prereq= | ||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Initialization methods | |sectionHeading=Initialization methods | ||
| − | | | + | |anchor= |
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=For complete information about a method, including signature and arguments, click the method's name. | |structuredtext=For complete information about a method, including signature and arguments, click the method's name. | ||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
| Line 23: | Line 25: | ||
{{!}}{{!}}Stops all {{MINTYDOCSPRODUCT}} SDK activity and removes all tracking information | {{!}}{{!}}Stops all {{MINTYDOCSPRODUCT}} SDK activity and removes all tracking information | ||
{{!}}} | {{!}}} | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Tracking methods | |sectionHeading=Tracking methods | ||
| − | | | + | |anchor= |
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=For complete information about a method, including signature and arguments, click the method's name. | |structuredtext=For complete information about a method, including signature and arguments, click the method's name. | ||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
| Line 48: | Line 52: | ||
{{!}}{{!}} | {{!}}{{!}} | ||
{{!}}} | {{!}}} | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Utility methods | |sectionHeading=Utility methods | ||
| − | | | + | |anchor= |
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=For complete information about a method, click the method's name. | |structuredtext=For complete information about a method, click the method's name. | ||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
| Line 61: | Line 68: | ||
{{!}}- | {{!}}- | ||
{{!}}{{!}} | {{!}}{{!}} | ||
| − | |||
{{Link-SomewhereInThisManual|topic=serialize}}<br /> | {{Link-SomewhereInThisManual|topic=serialize}}<br /> | ||
{{!}}{{!}}Used for passing serialized data from a form. | {{!}}{{!}}Used for passing serialized data from a form. | ||
| Line 71: | Line 77: | ||
{{!}}{{!}}Sends helpful messages to the console. | {{!}}{{!}}Sends helpful messages to the console. | ||
{{!}}} | {{!}}} | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Visit API methods | |sectionHeading=Visit API methods | ||
| − | | | + | |anchor= |
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext={{{!}} class="wikitable" | |structuredtext={{{!}} class="wikitable" | ||
{{!}}- | {{!}}- | ||
| Line 92: | Line 100: | ||
{{!}}{{!}}This provides the same functionality as<tt>'api.visit.cached'</tt>, but only the 'shortId' is returned. The short ID is useful as a legible reference number that can be displayed on the website.<br /> | {{!}}{{!}}This provides the same functionality as<tt>'api.visit.cached'</tt>, but only the 'shortId' is returned. The short ID is useful as a legible reference number that can be displayed on the website.<br /> | ||
{{!}}} | {{!}}} | ||
| − | | | + | |structuredtextwide= |
| − | |Status= | + | |FAQHeading= |
| + | |Status=Yes | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Customer API methods | |sectionHeading=Customer API methods | ||
| − | | | + | |anchor= |
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext={{{!}} class="wikitable" style="font-size: 14px;" | |structuredtext={{{!}} class="wikitable" style="font-size: 14px;" | ||
{{!}}- | {{!}}- | ||
| Line 107: | Line 117: | ||
{{!}}{{!}}This performs an AJAX request to retrieve the visitor data from the {{MINTYDOCSPRODUCT}} server.<br /> | {{!}}{{!}}This performs an AJAX request to retrieve the visitor data from the {{MINTYDOCSPRODUCT}} server.<br /> | ||
{{!}}} | {{!}}} | ||
| − | | | + | |structuredtextwide= |
| − | |Status= | + | |FAQHeading= |
| + | |Status=Yes | ||
}} | }} | ||
}} | }} | ||
Revision as of 09:30, May 19, 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 Genesys Predictive Engagement SDK |
| destroy | Stops all Genesys Predictive Engagement SDK activity and removes all tracking information |
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 |
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!