IRPCLanguages.ChangeLanguage
Vault API / standard write session idempotent returns metadata structure version
Changes the vault language of the calling user, for this session and later sessions.
| Service | Languages MFiles.IRPCLanguages |
|---|---|
| gRPC method | /MFiles.IRPCLanguages/ChangeLanguage |
| HTTP (mf-http-grpc) | POST /grpc/v1/change-language |
| Request | ChangeLanguageRequest |
| Response | ChangeLanguageResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires a vault session. No special vault rights are needed. Anonymous sessions cannot change the language ("Access denied.").
- The language is stored in the user's account, so the user's later sessions start in it. The current session switches immediately: later calls return names in the new language.
- A language ID that does not exist fails with "Not found.".
- Setting the language that the user already has succeeds and changes nothing.
Request: ChangeLanguageRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
language | int32 | The ID of the new language, from GetLanguages. 0 is the vault's default language. |
Response: ChangeLanguageResponse
No fields.