Difference between revisions of "ATC/Current/SDK/Load modules"
From Genesys Documentation
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2") |
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX") |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
|DisplayName=load | |DisplayName=load | ||
|TocName=load | |TocName=load | ||
| − | |Context=Learn how to add the functionality of a module | + | |Context=Learn how to add the functionality of a module to the Journey JavaScript SDK. |
|Dimension=Modules | |Dimension=Modules | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Platform=GenesysEngage- | + | |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 | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |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 | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 22: | Line 20: | ||
|anchor=LoadSignature | |anchor=LoadSignature | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<tt>ac('load', moduleName, ,[userOptions], [callback])</tt> | |structuredtext=<tt>ac('load', moduleName, ,[userOptions], [callback])</tt> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 42: | Line 26: | ||
|anchor=LoadModuleName | |anchor=LoadModuleName | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*'''Description:''' name of the module to load. The module must be on the list of valid modules. | |
| − | + | *'''Type:''' string | |
| − | |structuredtext=*Description: name of the module to load. The module must be on the list of valid modules. | + | *'''Status:''' required |
| − | *Type: string | ||
| − | *Status: required | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 54: | Line 34: | ||
|anchor=LoaduserOptions | |anchor=LoaduserOptions | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*'''Description:''' configuration for the loaded module | |
| − | + | *'''Type:''' object | |
| − | |structuredtext=*Description: configuration for the loaded module | + | *'''Status:''' module dependent |
| − | *Type: object | + | *'''Properties:''' module dependent |
| − | *Status: module dependent | ||
| − | *Properties: module dependent | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 67: | Line 43: | ||
|anchor=Loadcallback | |anchor=Loadcallback | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*'''Description:''' callback that triggers when the module has finished loading | |
| − | + | *'''Type:''' function | |
| − | |structuredtext=*Description: callback that triggers when the module has finished loading | + | *'''Status:''' optional (default implementation does nothing) |
| − | *Type: function | + | *'''Arguments:''' |
| − | *Status: optional (default implementation does nothing) | ||
| − | *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 | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|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
Comments or questions about this documentation? Contact us for support!