GRPC API

thumbnails.proto

CS3Source

Field Type Label Description
path string
authorization string

GetThumbnailRequest

A request to retrieve a thumbnail

Field Type Label Description
filepath string The path to the source image
thumbnail_type GetThumbnailRequest.ThumbnailType The type to which the thumbnail should get encoded to.
width int32 The width of the thumbnail
height int32 The height of the thumbnail
webdav_source WebdavSource
cs3_source CS3Source

GetThumbnailResponse

The service response

Field Type Label Description
thumbnail bytes The thumbnail as a binary
mimetype string The mimetype of the thumbnail

WebdavSource

Field Type Label Description
url string REQUIRED.
is_public_link bool REQUIRED.
webdav_authorization string OPTIONAL.
reva_authorization string OPTIONAL.
public_link_token string OPTIONAL.

GetThumbnailRequest.ThumbnailType

The file types to which the thumbnail can get encoded to.

Name Number Description
PNG 0 Represents PNG type
JPG 1 Represents JPG type

ThumbnailService

A Service for handling thumbnail generation

Method Name Request Type Response Type Description
GetThumbnail GetThumbnailRequest GetThumbnailResponse Generates the thumbnail and returns it.

Scalar Value Types

.proto Type Notes C++ Java
double
double double
float
float float
int32
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int
int64
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long
uint32
Uses variable-length encoding. uint32 int
uint64
Uses variable-length encoding. uint64 long
sint32
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int
sint64
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long
fixed32
Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int
fixed64
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long
sfixed32
Always four bytes. int32 int
sfixed64
Always eight bytes. int64 long
bool
bool boolean
string
A string must always contain UTF-8 encoded or 7-bit ASCII text. string String
bytes
May contain any arbitrary sequence of bytes. string ByteString