IRPCTaskPaneConfigurations.LoadTaskPaneConfiguration
Vault API / standard write session idempotent returns metadata structure version
Gets the calling user's task pane configuration, falling back to the common configuration and then to the program defaults.
| Service | Task pane configurations MFiles.IRPCTaskPaneConfigurations |
|---|---|
| gRPC method | /MFiles.IRPCTaskPaneConfigurations/LoadTaskPaneConfiguration |
| HTTP (mf-http-grpc) | POST /grpc/v1/load-task-pane-configuration |
| Request | LoadTaskPaneConfigurationRequest |
| Response | LoadTaskPaneConfigurationResponse |
| 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.
- Returns the newest stored blob whose data version is at most
max_data_version_interpretable. An emptydatameans the program defaults.
Request: LoadTaskPaneConfigurationRequest
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 |
|---|---|---|
max_data_version_interpretable | int32 | The newest data version that the caller understands. |
Response: LoadTaskPaneConfigurationResponse
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 |
|---|---|---|
data | bytes | The configuration blob. Its first four bytes are its data version (little-endian); empty means the program defaults. |