MBXDownloadOptions

 

@interface MBXDownloadOptions : NSObject

Structure to configure download session.

  • Structure which contains parameters to use for sending HTTP request. Http method will be ignored from this request.

    Declaration

    Objective-C

    @property (nonatomic, nonnull) MBXHttpRequest *request;

  • Absolute path where to store downloaded file. If a file with the specified name already exists and resume is set to false, the existing file is overwritten.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSString *localPath;

  • If localPath points to an existing file on disk, resume the download starting from an offset equal to file size.

    Declaration

    Objective-C

    @property (nonatomic) BOOL resume;

  • If the size of the response, in bytes, is at most this threshold, the data will be returned in memory via the httpResult field of DownloadStatus instead of being written to disk.

    Note: since responses smaller than the threshold are not written to disk, it is not possible to resume them. Conversely, if localPath points to an existing file and resume is true, the threshold is ignored and the response is written to disk.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint32_t memoryThreshold;