IRPCTaskPaneConfigurations.ResetTaskPaneConfiguration
Vault API / standard write session idempotent returns metadata structure version
Resets the calling user's task pane configuration to the program defaults or to the common configuration.
| Service | Task pane configurations MFiles.IRPCTaskPaneConfigurations |
|---|---|
| gRPC method | /MFiles.IRPCTaskPaneConfigurations/ResetTaskPaneConfiguration |
| HTTP (mf-http-grpc) | POST /grpc/v1/reset-task-pane-configuration |
| Request | ResetTaskPaneConfigurationRequest |
| Response | ResetTaskPaneConfigurationResponse |
| 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.
- With
reset_to_program_defaultstrue, the user's configuration becomes empty (program defaults). With false, the server copies the common configuration (or the program defaults if there is none) into the user's configuration. - Like a save, the reset deletes the user's stored configurations of newer data versions than the one written.
Request: ResetTaskPaneConfigurationRequest
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 |
|---|---|---|
reset_to_program_defaults | bool | True to reset to the program defaults; false to reset to the common configuration. |
max_data_version_interpretable | int32 | The newest data version that the caller understands. |
Response: ResetTaskPaneConfigurationResponse
No fields.