IRPCTaskPaneConfigurations.PublishCurrentTaskPaneConfigurationAsCommonConfiguration
Vault API / standard write session idempotent returns metadata structure version
Publishes the calling user's current task pane configuration as the common configuration for all users.
| Service | Task pane configurations MFiles.IRPCTaskPaneConfigurations |
|---|---|
| gRPC method | /MFiles.IRPCTaskPaneConfigurations/PublishCurrentTaskPaneConfigurationAsCommonConfiguration |
| HTTP (mf-http-grpc) | POST /grpc/v1/publish-current-task-pane-configuration-as-common-configuration |
| Request | PublishCurrentTaskPaneConfigurationAsCommonConfigurationRequest |
| Response | PublishCurrentTaskPaneConfigurationAsCommonConfigurationResponse |
| 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 the vault rights
license_allows_modificationsandmanage_common_uisettings; otherwise fails with "Access denied.". - Copies what LoadTaskPaneConfiguration would return for the caller into the common configuration.
- With
reset_common_configuration_for_all_userstrue, the server also overwrites every user's own configuration of that data version, adds it for users who have only older versions, and deletes newer versions, so all users get the published configuration.
Request: PublishCurrentTaskPaneConfigurationAsCommonConfigurationRequest
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_common_configuration_for_all_users | bool | True to also replace the configurations of all users with the published one. |
max_data_version_interpretable | int32 | The newest data version that the caller understands. |
Response: PublishCurrentTaskPaneConfigurationAsCommonConfigurationResponse
No fields.
Related methods
- LoadTaskPaneConfiguration -- Gets the calling user's task pane configuration, falling back to the common configuration and then to the program defaults.