Difference between revisions of "ATC/Current/SDK/Load modules"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
|||
| Line 2: | Line 2: | ||
|Standalone=No | |Standalone=No | ||
|DisplayName=load | |DisplayName=load | ||
| − | |||
|TocName=load | |TocName=load | ||
| + | |Context=Learn how to add the functionality of a module to to the Journey JavaScript SDK. | ||
| + | |Dimension=Modules | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | | | + | |Platform=PureEngage, PureConnect, PureCloud |
| + | |Prereq= | ||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
| − | | | + | |anchor= |
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|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. | |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. | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
|anchor=LoadSignature | |anchor=LoadSignature | ||
| − | |||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=<tt>ac('load', moduleName, ,[userOptions], [callback])</tt> | |structuredtext=<tt>ac('load', moduleName, ,[userOptions], [callback])</tt> | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
|anchor=LoadArguments | |anchor=LoadArguments | ||
| − | |||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | | | + | |Media= |
| + | |image= | ||
| + | |structuredtext= | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=moduleName | |sectionHeading=moduleName | ||
|anchor=LoadModuleName | |anchor=LoadModuleName | ||
| − | |||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|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 | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=userOptions | |sectionHeading=userOptions | ||
|anchor=LoaduserOptions | |anchor=LoaduserOptions | ||
| − | |||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|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 | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=callback | |sectionHeading=callback | ||
|anchor=Loadcallback | |anchor=Loadcallback | ||
| − | |||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|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 | ||
| Line 66: | Line 75: | ||
**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 | ||
| − | | | + | |structuredtextwide= |
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Example | |sectionHeading=Example | ||
|anchor=LoadExample | |anchor=LoadExample | ||
| − | |||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | | | + | |Media= |
| + | |image= | ||
| + | |structuredtext= | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 10:07, June 10, 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!