Vapi.Std.LocalizationParam
This schema holds a single message parameter and formatting settings for it. The schema 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.
This schema was added in vSphere API 7.0.0.0.
{
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi.Std.NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
String value associated with the parameter.
This property was added in vSphere API 7.0.0.0.
this property will be set when string value is used.
Date and time value associated with the parameter. Use the format property to specify date and time display style.
This property was added in vSphere API 7.0.0.0.
this property will be set when date and time value is used.
long value associated with the parameter.
This property was added in vSphere API 7.0.0.0.
this property will be set when long value is used.
The double value associated with the parameter. The number of displayed fractional digits is changed via precision property.
This property was added in vSphere API 7.0.0.0.
this property will be set when double value is used.
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 Vapi.Std.NestedLocalizableMessage instances can be used for localizing short lists of items.
This property was added in vSphere API 7.0.0.0.
this property will be set when nested localization message value is used.
Format associated with the date and time value in dt property. The enumeration value SHORT_DATETIME
will be used as default.
Possible values:
SHORT_DATE
: The date and time value will be formatted as short date, for example 2019-01-28MED_DATE
: The date and time value will be formatted as medium date, for example 2019 Jan 28LONG_DATE
: The date and time value will be formatted as long date, for example 2019 Jan 28FULL_DATE
: The date and time value will be formatted as full date, for example 2019 Jan 28, MonSHORT_TIME
: The date and time value will be formatted as short time, for example 12:59MED_TIME
: The date and time value will be formatted as medium time, for example 12:59:01LONG_TIME
: The date and time value will be formatted as long time, for example 12:59:01 ZFULL_TIME
: The date and time value will be formatted as full time, for example 12:59:01 ZSHORT_DATE_TIME
: The date and time value will be formatted as short date and time, for example 2019-01-28 12:59MED_DATE_TIME
: The date and time value will be formatted as medium date and time, for example 2019 Jan 28 12:59:01LONG_DATE_TIME
: The date and time value will be formatted as long date and time, for example 2019 Jan 28 12:59:01 ZFULL_DATE_TIME
: The date and time value will be formatted as full date and time, for example 2019 Jan 28, Mon 12:59:01 Z
For more information see: Vapi.Std.LocalizationParam.DateTimeFormat.
This property was added in vSphere API 7.0.0.0.
this may not be set if enumeration value SHORT_DATETIME
default format is appropriate
Number of fractional digits to include in formatted double value.
This property was added in vSphere API 7.0.0.0.
this will be set when exact precision is required for rendering double numbers.