Locale data in Userplane is handled in two ways. First you need to select your base locale ( or language ) to use. This property is provided as the “lang” property in your embed code. Adjusting this property to the language you wish to use will set the baseline for your locale data across all applications and widgets. From there you will be able to override individual locale properties which are detailed in each widget or component within our documentation by using an override.
Adjust your settings object to include the locale
Overriding the indiviaul locale properties in the Userplane features is a very easy process. Simply follow the example below and include any of the properties provided in the below table that you wish to overwrite.
In order to override a locale element you will need to add a locale property to your settings object in your embed code:
up.init({
...
settings: { locale :{} }
...
});
* Note this does not represent a valid embed merely a demonstration of where to put your locale property
Once you have created a locale property in your settings you will now be able to add as many overrides to this object as you desire.
You can also find a detailed list of locale properties on a per application basis on each application page: Presence Bar, Webmessenger, Webchat Lite, WebchatList of Properties
The component is the primary container and the property is the element that you add as a child of the previously mentioned container. So if you were looking at the settings object you might say you were defining settings.locale.component.property which when you filled in could look like settings.locale.presenceBar.welcomeTitle. Below is a complete list of all locale properties we support overriding in the Userplane features.| Component | Property |
|---|---|
| presenceBar | welcomeTitle |
| presenceBar | welcomeDetail |
| presenceBar | connect |
| presenceBar | connecting |
| presenceBar | reconnecting |
| presenceBar | buddyListTab |
| reportAbuse | description |
| reportAbuse | reason |
| reportAbuse | required |
| reportAbuse | comment |
| reportAbuse | submit |
| reportAbuse | cancel |
| reportAbuse | reasons |
| reportAbuse | label |
| notifications | connectErrorLabel |
| notifications | connectionErrorAuthorizationFailed |
| notifications | reconnectingErrorLabel |
| notifications | reconnectingErrorMessage |
| notifications | reconnectingErrorAttemptLabel |
| notifications | disconnectLabel |
| notifications | disconnectMessage |
| notifications | discoveryFailedLabel |
| notifications | discoveryFailed |
| notifications | discoveryErrorLabel |
| notifications | discoveryError |
| notifications | incomfingConversation |
| notifications | incomginConversationTitle |
| notifications | offlineMessage |
| notifications | onlineMessage |
| notifications | userUnavailable |
| notifications | acceptInvitation |
| notifications | denyInviation |
| notifications | invitationMessage |
| notifications | instantMessageButtonLabel |
| av | acceptSession |
| av | requestSession |
| av | ignoreSession |
| av | closeSession |
| av | buttonIgnore |
| av | buttonAccept |
| av | buttonStart |
| av | buttonStop |