CoreUiApi
Utilities for interacting with general Genesys Cloud App UI components
since 1.0.0
Hierarchy
↳ CoreUiApi
Index
Methods
Methods
hideHelp
▸ hideHelp(): void
Hide the help UI. Noop if already hidden.
Copied
myClientApp.coreUi.hideHelp();since 1.0.0
Returns: void
openWindow
▸ openWindow(targetUrl: string): void
Open a URL in a new window.
Copied
myClientApp.coreUi.openWindow("https://en.wikipedia.org/wiki/Main_Page");since 2.3.0
Parameters:
Name | Type | Description |
Returns: void
showHelp
▸ showHelp(): void
Show the help UI. Noop if already shown.
Copied
myClientApp.coreUi.showHelp();since 1.0.0
Returns: void
showResourceCenterArtifact
▸ showResourceCenterArtifact(artifactRelPath: string): void
Open the help panel to the specified Resource Center artifact
Copied
// Direct path
myClientApp.coreUi.showResourceCenterArtifact('articles/complete-profile');Copied
// Permalink
myClientApp.coreUi.showResourceCenterArtifact('?p=7711');since 1.0.0
Parameters:
Name | Type | Description |
Returns: void
