Language Strings

3min
You can update any of the texts displayed to a user in Hosted Experience. You may choose to do this to provide a language specific experience, based on the users browser settings, or simply to customize the text used to fit your brand and user experience.
To do this, the languageStrings property can be defined to update any of the text displayed within the Hosted Experience interface. Language strings object should contain values corresponding to ISO-639-1 languages, e.g. en, es, ja, etc. Within each language code value, provide an object containing the key of the value you want to update. Additionally a specific locale/region may be provided for more precise language targetting, e.g. en-US, en-GB, de-DE, pt-BR.
When a user loads the digital human experience their browser will provide a list of their preferred languages (an array in preference order). Hosted Experience will iteratively search the list of languageStrings you provide to find a match for the key based on the users preferred languages set in their browser. More information on how the browser detects the preferred language can be found here.
If a language code is not provided then the 'default' value will be used. If no 'default' configuration is specified by you, then the Hosted Experience base values will be used.
﻿
Example
The below code block displays the complete list of languageString keys that may be used to replace a UI text within Hosted Experience - along with the base values.
JS
const uneeqOptions = {
    languageStrings: {
        "default": {
            callToActionText: '👋 Hey! It is so good to meet you.',
            errorText: 'An error occurred.',
            textInputPlaceholder: 'Type here...',
            showContentToolTip: 'Show Content',
            sendQuestionButtonToolTip: 'Send Message',
            startRecordingButtonToolTip: 'Start Recording',
            unmuteMicrophoneToolTip: 'Unmute',
            muteMicrophoneToolTip: 'Mute',
            microphonePermissionNotAllowedButtonToolTip: 'Microphone permission not allowed',
            microphoneEnabledHintTitle: 'Microphone Enabled',
            microphoneEnabledHintText: 'You can speak to me, I\'m listening.',
            microphoneEnabledHintTitleOverlay: 'Mic Enabled',
            microphoneNotAllowedMessage: 'Microphone permission was not allowed. Please allow access to your microphone ' +
            'via your browser settings, and try again.',
            recordingTapToStart: 'Tap to record, tap again to send',
            recordingSpeakNowPrompt: 'Speak now',
            recordingTapStopWhenDone: 'Tap stop when done',
            recordingStopButtonToolTip: 'Stop Recording',
            recordingRequestingMicrophonePrompt: 'Requesting Microphone',
            settingsExitButton: 'Exit',
            confirmExitDescription: 'Are you sure you want to exit?',
            confirmExitStayButton: 'STAY',
            confirmExitEndButton: 'EXIT',
            hideContentButton: 'Hide Content',
            hideDigitalHumanButton: 'Hide Digital Human'
        }
    }
}
const uneeqOptions = {
    languageStrings: {
        "default": {
            callToActionText: '👋 Hey! It is so good to meet you.',
            errorText: 'An error occurred.',
            textInputPlaceholder: 'Type here...',
            showContentToolTip: 'Show Content',
            sendQuestionButtonToolTip: 'Send Message',
            startRecordingButtonToolTip: 'Start Recording',
            unmuteMicrophoneToolTip: 'Unmute',
            muteMicrophoneToolTip: 'Mute',
            microphonePermissionNotAllowedButtonToolTip: 'Microphone permission not allowed',
            microphoneEnabledHintTitle: 'Microphone Enabled',
            microphoneEnabledHintText: 'You can speak to me, I\'m listening.',
            microphoneEnabledHintTitleOverlay: 'Mic Enabled',
            microphoneNotAllowedMessage: 'Microphone permission was not allowed. Please allow access to your microphone ' +
            'via your browser settings, and try again.',
            recordingTapToStart: 'Tap to record, tap again to send',
            recordingSpeakNowPrompt: 'Speak now',
            recordingTapStopWhenDone: 'Tap stop when done',
            recordingStopButtonToolTip: 'Stop Recording',
            recordingRequestingMicrophonePrompt: 'Requesting Microphone',
            settingsExitButton: 'Exit',
            confirmExitDescription: 'Are you sure you want to exit?',
            confirmExitStayButton: 'STAY',
            confirmExitEndButton: 'EXIT',
            hideContentButton: 'Hide Content',
            hideDigitalHumanButton: 'Hide Digital Human'
        }
    }
}
﻿
﻿
Language Replacement
You can provide your own strings to be used for each hosted experience language you define.
For example, you can replace the 'es' language callToActionText like this:
JS
languageStrings: {
    "es": {
        "callToActionText": "¡Hola! Haga clic aquí para iniciar una conversación.e"
    }
}
languageStrings: {
    "es": {
        "callToActionText": "¡Hola! Haga clic aquí para iniciar una conversación.e"
    }
}
﻿
﻿
Multiple language replacement:
JS
 const uneeqOptions = {
    languageStrings: {
        "es": {
            "callToActionText": "¡Hola! Haga clic aquí para iniciar una conversación.e",
            "textInputPlaceholder": "Escriba aquí..."
        },
        "ja": {
            "callToActionText": "やあ！会話を始めるにはここをクリックしてください。",
            "textInputPlaceholder": "ここに入力..."
        },
        "de-DE": {
            "callToActionText": "Hi! Klicken Sie hier, um ein Gespräch zu beginnen.",
            "textInputPlaceholder": "Geben Sie hier ein ..."
        },
        "default": {
            callToActionText: '👋 Hey! It is so good to meet you.',
            errorText: 'An error occurred.',
            textInputPlaceholder: 'Type here...',
            showContentToolTip: 'Show Content',
            sendQuestionButtonToolTip: 'Send Message',
            startRecordingButtonToolTip: 'Start Recording',
            unmuteMicrophoneToolTip: 'Unmute',
            muteMicrophoneToolTip: 'Mute',
            microphonePermissionNotAllowedButtonToolTip: 'Microphone permission not allowed',
            microphoneEnabledHintTitle: 'Microphone Enabled',
            microphoneEnabledHintText: 'You can speak to me, I\'m listening.',
            microphoneEnabledHintTitleOverlay: 'Mic Enabled',
            microphoneNotAllowedMessage: 'Microphone permission was not allowed. Please allow access to your microphone ' +
            'via your browser settings, and try again.',
            recordingTapToStart: 'Tap to record, tap again to send',
            recordingSpeakNowPrompt: 'Speak now',
            recordingTapStopWhenDone: 'Tap stop when done',
            recordingStopButtonToolTip: 'Stop Recording',
            recordingRequestingMicrophonePrompt: 'Requesting Microphone',
            settingsExitButton: 'Exit',
            confirmExitDescription: 'Are you sure you want to exit?',
            confirmExitStayButton: 'STAY',
            confirmExitEndButton: 'EXIT',
            hideContentButton: 'Hide Content',
            hideDigitalHumanButton: 'Hide Digital Human'
        }
    }
}
 const uneeqOptions = {
    languageStrings: {
        "es": {
            "callToActionText": "¡Hola! Haga clic aquí para iniciar una conversación.e",
            "textInputPlaceholder": "Escriba aquí..."
        },
        "ja": {
            "callToActionText": "やあ！会話を始めるにはここをクリックしてください。",
            "textInputPlaceholder": "ここに入力..."
        },
        "de-DE": {
            "callToActionText": "Hi! Klicken Sie hier, um ein Gespräch zu beginnen.",
            "textInputPlaceholder": "Geben Sie hier ein ..."
        },
        "default": {
            callToActionText: '👋 Hey! It is so good to meet you.',
            errorText: 'An error occurred.',
            textInputPlaceholder: 'Type here...',
            showContentToolTip: 'Show Content',
            sendQuestionButtonToolTip: 'Send Message',
            startRecordingButtonToolTip: 'Start Recording',
            unmuteMicrophoneToolTip: 'Unmute',
            muteMicrophoneToolTip: 'Mute',
            microphonePermissionNotAllowedButtonToolTip: 'Microphone permission not allowed',
            microphoneEnabledHintTitle: 'Microphone Enabled',
            microphoneEnabledHintText: 'You can speak to me, I\'m listening.',
            microphoneEnabledHintTitleOverlay: 'Mic Enabled',
            microphoneNotAllowedMessage: 'Microphone permission was not allowed. Please allow access to your microphone ' +
            'via your browser settings, and try again.',
            recordingTapToStart: 'Tap to record, tap again to send',
            recordingSpeakNowPrompt: 'Speak now',
            recordingTapStopWhenDone: 'Tap stop when done',
            recordingStopButtonToolTip: 'Stop Recording',
            recordingRequestingMicrophonePrompt: 'Requesting Microphone',
            settingsExitButton: 'Exit',
            confirmExitDescription: 'Are you sure you want to exit?',
            confirmExitStayButton: 'STAY',
            confirmExitEndButton: 'EXIT',
            hideContentButton: 'Hide Content',
            hideDigitalHumanButton: 'Hide Digital Human'
        }
    }
}
﻿
﻿
Custom Styles
Events