Task pane configurations (IRPCTaskPaneConfigurations)
Stores the task pane configuration of M-Files Desktop per user and for all users.
| gRPC service | MFiles.IRPCTaskPaneConfigurations |
|---|---|
| Book and level | Vault API, standard |
| Methods | 4 |
| Proto file | mfiles/IRPCTaskPaneConfigurations.proto |
Overview
Stores the task pane configuration of M-Files Desktop for each user, and a common configuration that administrators publish for all users. Used by M-Files clients; applications rarely call it.
The configuration is an opaque blob that the client defines. The server stores it per user and per data version and checks only its first four bytes:
- Every non-empty blob starts with its data version as a 32-bit little-endian integer, and that
value must equal the
data_versionit is saved with; otherwise saving fails with "The parameter is incorrect.". - An empty blob means the program defaults.
- Readers pass
max_data_version_interpretable, the newest data version they understand. The server returns the newest stored blob whose version is not greater; saving a version deletes the caller's stored blobs of newer versions.
Lookup order when reading: the user's own configuration, then the common configuration, then the program defaults (an empty blob).
Methods
| Method | Summary | Facts |
|---|---|---|
| LoadTaskPaneConfiguration | Gets the calling user's task pane configuration, falling back to the common configuration and then to the program defaults. | write session idempotent returns metadata structure version |
| PublishCurrentTaskPaneConfigurationAsCommonConfiguration | Publishes the calling user's current task pane configuration as the common configuration for all users. | write session idempotent returns metadata structure version |
| ResetTaskPaneConfiguration | Resets the calling user's task pane configuration to the program defaults or to the common configuration. | write session idempotent returns metadata structure version |
| SaveTaskPaneConfiguration | Saves the calling user's task pane configuration. | write session idempotent returns metadata structure version |