load

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