IRPCFolderUISettings.GetFolderUISettings

Vault API / standard read session idempotent returns metadata structure version

Gets the display settings of a folder as an opaque blob.

Service	Folder UI settings `MFiles.IRPCFolderUISettings`
gRPC method	`/MFiles.IRPCFolderUISettings/GetFolderUISettings`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-folder-uisettings`
Request	`GetFolderUISettingsRequest`
Response	`GetFolderUISettingsResponse`
Book and level	Vault API, standard
Kind	read
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.
With common_settings false, returns the caller's own settings, falling back to the common settings and then to the program defaults (empty data). With true, returns the common settings or empty data.
Returns the newest stored data version that is at most max_data_version_interpretable.

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
`common_settings`	`bool`	True for the common settings; false for the caller's effective 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 settings blob, starting with its data version as a 32-bit little-endian integer; empty means the program defaults.