Default UI API
The methods and properties related to UI management can be accessed using the Co-browse.API.DefaultUI.
| N | Method Name | Parameters | Description |
|---|---|---|---|
|
1 |
Cobrowse.API.DefaultUI.setLanguage(lang) |
lang: string with a language tag The API supports two-letter language tags as defined in ISO 639-1, three-letter language tags as described in ISO 639-2, culture names composed from language and region identifiers as described in Microsoft API ( https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid) or its decimal LCID equivalents. If the API is given a language tag which doesn't match any supported standard, the API will attempt to parse it according to the RFC 4647, section 3.4 (https://tools.ietf.org/html/rfc4647#section-3.4) until it matches any of the known standards. If no match is obtained, the API will fallback to use the default language for the current deployment. |
Causes default UI to reload in the specified language (from the list of supported languages). return value: true if lang is found in the list of supported languages or false otherwise. Note: Result true does not guarantee UI is actually loaded in the specified language. Loading is a separate asynchronous process. |
| 2 | Cobrowse.API.DefaultUI.getLanguage() | Returns string with LCID corresponding to the currently selected UI language | |
| 3 | Cobrowse.API.DefaultUI.expand() | Causes launch pad to expand to imitate click on launch panel | |
| 4 | Cobrowse.API.DefaultUI.collapse() | Causes launch panel to minimize back to a button | |
| 5 | Cobrowse.API.DefaultUI.hide() | Hides the cobrowse launcher in web pages where this method is referenced |