IRPCThumbnails.GetThumbnailOptions

View as Markdown

Vault API / standard read session idempotent returns metadata structure version

Gets the vault's thumbnail settings.

Service	Thumbnails `MFiles.IRPCThumbnails`
gRPC method	`/MFiles.IRPCThumbnails/GetThumbnailOptions`
HTTP (mf-http-grpc)	`POST /grpc/v1/get-thumbnail-options`
Request	`GetThumbnailOptionsRequest`
Response	`GetThumbnailOptionsResponse`
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.
is_thumbnail_feature_on false means that the server returns no classic thumbnails (THUMBNAIL_STATUS_DO_NOT_GENERATE) and clients should not create them either.
size is the size of the classic thumbnails that the server generates, 256 x 256 pixels by default.
denied_file_extensions lists the file extensions (without the dot) for which thumbnails must not be generated.

Request: GetThumbnailOptionsRequest

No fields.

Response: GetThumbnailOptionsResponse

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
`pthumbops`	`ThumbnailOptions`	The thumbnail settings of the vault. See ThumbnailOptions.
`pthumbops.is_thumbnail_feature_on`	`bool`	True if the whole Thumbnails feature is on. If off, neiher the server nor the client generates thumbnails.
`pthumbops.is_client_side_generation_on`	`bool`	True if the client-side thumbnail generation is on. If off, the server still generates thumbnails if bThumbnailFeatureOn is true.
`pthumbops.size`	`Size`	The size of thumbnails generated and cached by server.
`pthumbops.size.width`	`int32`
`pthumbops.size.height`	`int32`
`pthumbops.denied_file_extensions[]`	repeated `string`	An array of file extensions (not including dot) for which thumbnail generation is not allowed.