Difference between revisions of "ATC/Current/SDK/Load modules"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
DannaShirley (talk | contribs) (Published) |
||
| Line 4: | Line 4: | ||
|Platform=PureEngage, PureConnect, PureCloud | |Platform=PureEngage, PureConnect, PureCloud | ||
|TocName=load | |TocName=load | ||
| − | |ComingSoon= | + | |ComingSoon=No |
|Context=Learn how to add the functionality of a module to to the Journey JavaScript SDK. | |Context=Learn how to add the functionality of a module to to the Journey JavaScript SDK. | ||
|Section={{Section | |Section={{Section | ||
| Line 29: | Line 29: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
| − | |||
| − | |||
| − | |||
|fullwidth=No | |fullwidth=No | ||
|Status=No | |Status=No | ||
| Line 40: | Line 37: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |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 | |fullwidth=No | ||
|Status=No | |Status=No | ||
| Line 51: | Line 48: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |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 | |fullwidth=No | ||
|Status=No | |Status=No | ||
| Line 63: | Line 60: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |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 | |fullwidth=No | ||
|Status=No | |Status=No | ||
| Line 77: | Line 74: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|fullwidth=No | |fullwidth=No | ||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 19:06, January 14, 2020
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 to the Journey JavaScript SDK.
Description
Use the load function to load modules. When you load a module, its functionality is immediately added to the Journey JavaScript SDK.
Signature
ac('load', moduleName, ,[userOptions], [callback])
Arguments
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
Example
Comments or questions about this documentation? Contact us for support!