Difference between revisions of "ATC/Current/SDK/Load modules"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(9 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=load
 
|DisplayName=load
−
|Platform=PureEngage, PureConnect, PureCloud
 
 
|TocName=load
 
|TocName=load
−
|ComingSoon=Yes
+
|Context=Learn how to add the functionality of a module to the Journey JavaScript SDK.
−
|Context=Learn how to add the functionality of a module to to the Journey JavaScript SDK.
+
|Dimension=Modules
 +
|ComingSoon=No
 +
|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=Description
 
|sectionHeading=Description
−
|Type=Structured
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=Use the <tt>load</tt> function to load modules. When you load a module, its functionality is added to the Journey JavaScript SDK.
−
|structuredtext=Use the <tt>load</tt> function to load modules. When you load a module, its functionality is immediately added to the Journey JavaScript SDK.
 
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
−
|Type=Structured
 
 
|anchor=LoadSignature
 
|anchor=LoadSignature
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
 
 
|structuredtext=<tt>ac('load', moduleName, ,[userOptions], [callback])</tt>
 
|structuredtext=<tt>ac('load', moduleName, ,[userOptions], [callback])</tt>
−
|fullwidth=No
 
−
|Status=No
 
−
}}{{Section
 
−
|sectionHeading=Arguments
 
−
|Type=Structured
 
−
|anchor=LoadArguments
 
−
|alignment=Vertical
 
−
|gif=No
 
−
|structuredtext=* {{Link-SomewhereInThisVersion|manual=SDK|topic=Load_modules#LoadModuleName|display text=moduleName}}
 
−
* {{Link-SomewhereInThisVersion|manual=SDK|topic=Load_modules#LoaduserOptions|display text=userOptions}}
 
−
* {{Link-SomewhereInThisVersion|manual=SDK|topic=Load_modules#Loadcallback|display text=callback}}
 
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=moduleName
 
|sectionHeading=moduleName
−
|Type=Structured
 
 
|anchor=LoadModuleName
 
|anchor=LoadModuleName
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*'''Description:''' name of the module to load. The module must be on the list of valid modules.
−
|structuredtext=* Description: name of the module to load. The module must be on the list of valid modules.
+
*'''Type:''' string
−
* Type: string
+
*'''Status:''' required
−
* Status: required
 
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=userOptions
 
|sectionHeading=userOptions
−
|Type=Structured
 
 
|anchor=LoaduserOptions
 
|anchor=LoaduserOptions
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*'''Description:''' configuration for the loaded module
−
|structuredtext=* Description: configuration for the loaded module
+
*'''Type:''' object
−
* Type: object
+
*'''Status:''' module dependent
−
* Status: module dependent
+
*'''Properties:''' module dependent
−
* Properties: module dependent
 
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=callback
 
|sectionHeading=callback
−
|Type=Structured
 
 
|anchor=Loadcallback
 
|anchor=Loadcallback
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*'''Description:''' callback that triggers when the module has finished loading
−
|structuredtext=* Description: callback that triggers when the module has finished loading
+
*'''Type:''' function
−
* Type: function
+
*'''Status:''' optional (default implementation does nothing)
−
* Status: optional (default implementation does nothing)
+
*'''Arguments:'''
−
* Arguments  
+
**On failure, <tt>load</tt> passes an error (like <tt>InvalidModuleError</tt>)
−
** On failure, <tt>load</tt> passes an error (like <tt>InvalidModuleError</tt>)
+
**In other cases, <tt>load</tt> passes module-dependent values to the callback
−
** In other cases, <tt>load</tt> passes module-dependent values to the callback
 
−
|fullwidth=No
 
−
|Status=No
 
−
}}{{Section
 
−
|sectionHeading=Example
 
−
|Type=Structured
 
−
|anchor=LoadExample
 
−
|alignment=Vertical
 
−
|gif=No
 
−
|structuredtext=<source lang="javascript">
 
−
ac(‘load’, ‘autotrackUrlChange’, {}, function(callbackObj) {
 
−
  // check of the obj is an error
 
−
  if (callbackObj instanced Error) {
 
−
    console.error(callbackObj)
 
−
  }
 
−
});
 
−
</source>
 
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 21:27, November 9, 2021

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

Learn how to add the functionality of a module to 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.

Description

Use the load function to load modules. When you load a module, its functionality is added to the Journey JavaScript SDK.

Signature

ac('load', moduleName, ,[userOptions], [callback])

moduleName

  • Description: name of the module to load. The module must be on the list of valid modules.
  • Type: string
  • Status: required

userOptions

  • Description: configuration for the loaded module
  • Type: object
  • Status: module dependent
  • Properties: module dependent

callback

  • Description: callback that triggers when the module has finished loading
  • Type: function
  • Status: optional (default implementation does nothing)
  • Arguments:
    • On failure, load passes an error (like InvalidModuleError)
    • In other cases, load passes module-dependent values to the callback
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Load_modules (2025-06-24 04:30:48)"
Comments or questions about this documentation? Contact us for support!