Language administration (IRPCLanguagesAdmin)
Adds, modifies and removes the languages of a vault, and reads and writes the translations of its metadata structure names.
Use this interface to add, modify and delete languages in a vault.
| gRPC service | MFiles.IRPCLanguagesAdmin |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 5 |
| Proto file | mfiles/IRPCLanguagesAdmin.proto |
Overview
A vault has a default language (ID 0) and can have additional languages. The names of the metadata structure (classes, property definitions, value lists, views, workflows, named ACLs, ...) can be translated to each language; users see the names in their session language. M-Files Admin uses this service to manage the languages and translations of a vault.
- Session and rights. Requires a vault session with the vault rights
change_metadata_structureandlicense_allows_modifications(VaultAccess). Reading and writing translations also needssee_all_objects. - License. Adding and modifying languages and applying translations fail when the server's license does not include the languages feature.
- List the languages with GetLanguages; this service has no read method for them.
- Translate the vault: GetTranslations
with the default language as source and the target language, fill in
target_stringand setstatetoTRANSLATION_STATE_TRANSLATED, then ApplyTranslations.
Methods
| Method | Summary | Facts |
|---|---|---|
| AddLanguage | Adds a language to the vault. | admin session |
| ApplyTranslations | Stores translated names in a target language. | admin session idempotent |
| GetTranslations | Gets the translatable names of the vault's metadata structure, with their texts in a source and a target language. | admin session idempotent |
| ModifyLanguage | Changes the name or language code of a language. | admin session idempotent |
| RemoveLanguage | Removes an additional language from the vault. | admin session |