Developer Documentation

StdLocalizationParam

This structure holds a single message parameter and formatting settings for it. The structure has fields for string, long, double, date time and nested messages. Only one will be used depending on the type of data sent. For date, double and long it is possible to set additional formatting details.


Properties

Required Property Name Type Description
optional d number

The double value associated with the parameter. The number of displayed fractional digits is changed via LocalizationParam.precision field. this field will be set when double value is used.

optional dt string

Date and time value associated with the parameter. Use the LocalizationParam.format field to specify date and time display style. this field will be set when date and time value is used.

optional format LocalizationParamDateTimeFormat Enum

Format associated with the date and time value in LocalizationParam.dt field. The enumeration value SHORT_DATETIME will be used as default. this may not be set if enumeration value SHORT_DATETIME default format is appropriate

optional i integer

long value associated with the parameter. this field will be set when long value is used.

optional l StdNestedLocalizableMessage

Nested localizable value associated with the parameter. This is useful construct to convert to human readable localized form enumerated type and boolean values. It can also be used for proper handling of pluralization and gender forms in localization. Recursive NestedLocalizableMessage instances can be used for localizing short lists of items. this field will be set when nested localization message value is used.

optional precision integer

Number of fractional digits to include in formatted double value. this will be set when exact precision is required for rendering double numbers.

optional s string

String value associated with the parameter. this field will be set when string value is used.

Feedback

Was this page helpful?