Skip to content

i18n

The API must work with localized interfaces. To achieve this, the data type i18n was introduced. It is a subtype of the string type and always holds a translation key.

When used in method definition, the data type must be qualified with the translation namespace. For example i18n@errors means, that client will use the value of the attribute to search for a localized string in the errors object returned by the messages_get. Any translation key used in API should be translated in the answer to the above mentioned method call.

When used in model definition, it can be qualified. If it is not qualified, it inherits the qualification of the model. Any model that defines an unqualified i18n type must only be used with qualification.