IRPCFolderUISettings.ResetFolderUISettingsToDefaults

Vault API / standard write session idempotent returns metadata structure version

Resets the caller's display settings of a folder to the program defaults or to the common settings, and returns the result as an opaque blob.

Service	Folder UI settings `MFiles.IRPCFolderUISettings`
gRPC method	`/MFiles.IRPCFolderUISettings/ResetFolderUISettingsToDefaults`
HTTP (mf-http-grpc)	`POST /grpc/v1/reset-folder-uisettings-to-defaults`
Request	`ResetFolderUISettingsToDefaultsRequest`
Response	`ResetFolderUISettingsToDefaultsResponse`
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.
Exactly one of reset_to_program_defaults and reset_to_common_defaults must be true; otherwise the call fails with "The parameter is incorrect." and nothing changes.
Resetting to the common settings copies them into the caller's own settings (or stores program defaults if there are no common settings) and deletes the caller's settings of newer data versions.
Only the caller's own settings change.

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.
`reset_to_common_defaults`	`bool`	True to reset to the 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.
`max_data_version_interpretable`	`int32`	The newest data version that the caller understands.

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
`data`	`bytes`	The caller's settings after the reset, as returned by GetFolderUISettings.