IRPCFolderUISettings.SaveFolderUISettings

Vault API / standard write session idempotent returns metadata structure version

Saves the display settings of a folder as an opaque blob, for the caller and optionally as the common settings.

Service	Folder UI settings `MFiles.IRPCFolderUISettings`
gRPC method	`/MFiles.IRPCFolderUISettings/SaveFolderUISettings`
HTTP (mf-http-grpc)	`POST /grpc/v1/save-folder-uisettings`
Request	`SaveFolderUISettingsRequest`
Response	`SaveFolderUISettingsResponse`
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. With save_as_common_settings it also needs the vault right manage_common_uisettings; otherwise the call fails with "Access denied.".
The first four bytes of data must be data_version (32-bit little-endian), or the call fails with "The parameter is incorrect.".
The settings are always saved for the caller. With save_as_common_settings they are also saved as the common settings. With reset_common_settings_to_all_users as well, every user's own settings of this folder are overwritten, and their settings of newer data versions are deleted.

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
`save_as_common_settings`	`bool`	True to also save the settings as the common settings of the folder.
`reset_common_settings_to_all_users`	`bool`	True to also overwrite every user's settings of the folder. Used only with `save_as_common_settings`.
`uisfid`	`UISettingsFolderID`	The folder.
`uisfid.type`	`UISettingsFolderType`	The type that describes the folder whose UI settings are being retrieved.
`uisfid.view`	`int32`	If not zero, specifies the view where the folder is located.
`data_version`	`int32`	The data version of `data`.
`data`	`bytes`	The settings blob, starting with `data_version` as a 32-bit little-endian integer.

No fields.