updateLocale() - IBM watsonx Orchestrate ADK

Changes the display language of the chat widget at runtime. By default, the locale is English (en).

Syntax

await instance.updateLocale(locale, savePreference);

Parameters

locale

string

required

A locale string representing the desired language and region.The following table details the supported locales:

Language	Language Code
Chinese - Simplified	`zh-CN`
Chinese - Traditional	`zh-TW`
Dutch	`nl`
English	`en`
French	`fr`
German	`de`
Italian	`it`
Japanese	`ja`
Korean	`ko`
Portuguese - Brazil	`pt-BR`
Spanish	`es`

savePreference

boolean

default:"false"

Determines whether the locale preference must be saved to the platform database. When set to true, the system persists the user’s locale preference and applies it in future sessions. When set to false or omitted, the locale change is temporary and applies only to the current session.

Returns

Promise<void>

A promise that resolves when the system updates the locale.

Examples

The following examples show different ways to change the locale:

// Change to Japanese
await instance.updateLocale('ja');

// Change to Brazilian Portuguese
await instance.updateLocale('pt-BR');

// Change to French and save the preference to the backend
await instance.updateLocale('fr', true);

// Change based on user selection and persist the preference
const userLanguage = getUserPreferredLanguage();
await instance.updateLocale(userLanguage, true);

Do you need practical examples?

Learn how to apply the features available for embedded chat into your implementation with guidance and examples.

​Syntax

​Parameters

​Returns

​Examples

Do you need practical examples?

Syntax

Parameters

Returns

Examples