GetThumbnail Method

Retrieves a thumbnail image of the current resource.

Syntax

box.getThumbnail([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method retrieves a thumbnail image of the resource specified by ResourceId.

The following properties are applicable when calling this method:

• LocalFile
• ResourceId
• ResourceType
• ThumbnailFormat
• ThumbnailSize

If LocalFile is specified the thumbnail image will be saved at the specified path. If unspecified the data will be held in ResourceData.

Note: Not all file formats support thumbnail images. Consult the Box.com documentation for details on supported file types.

GetThumbnail Example:

box.ResourceType = BoxResourceTypes.rtFile;
box.ResourceId = "MyResouceId";
box.LocalFile = thumbnailFile;
box.ThumbnailSize = BoxThumbnailSizes.bts32x32;
box.GetThumbnail();