getThumbnail (method)

Retrieves a thumbnail image of the current resource.

- (void)getThumbnail

Discussion

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();