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

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 3: Line 3:
 
|DisplayName=load
 
|DisplayName=load
 
|TocName=load
 
|TocName=load
|Context=Learn how to add the functionality of a module to 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=Learn how to add the functionality of a module to the Journey JavaScript SDK.
 
|Dimension=Modules
 
|Dimension=Modules
 
|ComingSoon=No
 
|ComingSoon=No
 
|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 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
 
|alignment=Vertical
 
|alignment=Vertical

Revision as of 10:35, August 10, 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 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:33:08)"
Comments or questions about this documentation? Contact us for support!