Two help panels are available in the aiWARE SDK:
Documentation panel
The Documentation panel displays the documentation for your app.
Display the default URL
- To display the default URL in the Documentation panel, in your element's event handler, call
aiware.helpCenter.openDocsPanel().
It loads the docsURL you provide in aiware.initConfig when you set up the aiWARE SDK.
Display a custom iframe
- To display a custom iframe in the Documentation panel, in your element's event handler, call
aiware.helpCenter.openDocsPanel( iframeUrl ).
Parameters
The parameter of openDocsPanel() is:
| Name | Required | Type | Description |
| iframeUrl | False | String | The URL of the iframe to display. |
Knowledgebase panel
The Knowledgebase panel displays the knowledge base for your app.
Display the default URL
- To display the default URL in the Knowledgebase panel, in your element's event handler, call
aiware.helpCenter.openKnowledgeBasePanel(). It loads the knowledgeBaseUrl you provide in aiware.initConfig when you set up the aiWARE SDK.
Display a custom iframe
- To display a custom iframe in the Knowledgebase panel, in your element's event handler, call
aiware.helpCenter.openKnowledgeBasePanel(iframeUrl).
Parameters
The parameter of openKnowledgeBasePanel() is:
The URL of the iframe to display.
| Name | Required | Type | Description |
| iframeUrl | False | String | The URL of the iframe to display. |
