UserFacingMessage

  • The JSON representation is used to provide user-facing messages with locale information, with a maximum length of 4096 characters.

  • It includes localizedMessages, a map of locale codes and corresponding messages, and defaultMessage for fallback display.

  • A well-formed BCP 47 language code is used for locale specification, and a default message is required if localized messages are provided.

Provides a user-facing message with locale info. The maximum message length is 4096 characters.

JSON representation 
{
  "localizedMessages": {
    string: string,
    ...
  },
  "defaultMessage": string
}
Fields
localizedMessages

map (key: string, value: string)

A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language code, such as en-US, es-ES, or fr.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultMessage

string

The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.