IRPCTaskPaneConfigurations.LoadTaskPaneConfiguration

View as Markdown

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.

ServiceTask pane configurations MFiles.IRPCTaskPaneConfigurations
gRPC method/MFiles.IRPCTaskPaneConfigurations/LoadTaskPaneConfiguration
HTTP (mf-http-grpc)POST /grpc/v1/load-task-pane-configuration
RequestLoadTaskPaneConfigurationRequest
ResponseLoadTaskPaneConfigurationResponse
Book and levelVault API, standard
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionyes (in the mfiles-metadata-version-bin trailer)
Streamingnone (unary)

Remarks

Request: LoadTaskPaneConfigurationRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
max_data_version_interpretableint32The 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.

FieldTypeDescription
databytesThe configuration blob. Its first four bytes are its data version (little-endian); empty means the program defaults.