IPWorks Cloud 2020 iOS Edition

Questions / Feedback?

downloadType (property)

The download type to use for file resources.

Syntax

@property (nonatomic,readwrite,assign,getter=downloadType,setter=setDownloadType:) int downloadType;
- (int)downloadType;
- (void)setDownloadType:(int)newDownloadType;

/* Possible Values */
BDT_FILE_CONTENT(0),
BDT_FILE_THUMBNAIL(1)
public var downloadType: BoxDownloadTypes {
  get {...}
set {...} }
public enum BoxDownloadTypes : Int32 { case bdtFileContent = 0 case bdtFileThumbnail = 1 }

Default Value

0

Remarks

This property controls what the class will download when DownloadFile is called for a file resource. Possible values are:

0 (bdtFileContent - default) DownloadFile will download the file's contents.
1 (bdtFileThumbnail) DownloadFile will download a thumbnail of the file.

File thumbnails may be customized using the ThumbnailFormat and ThumbnailSize configuration settings. Box returns placeholder thumbnail graphics for file types it cannot generate real thumbnails for.

If Box is still in the process of generating the requested thumbnail when this method is called, the class will populate the RetryAfter configuration setting and throw an exception. Retry the request after the number of seconds indicated by RetryAfter.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 iOS Edition - Version 20.0 [Build 8265]