react-native-c8osdk
Version:
Use Convertigo MBaaS from React native apps
1,514 lines • 85 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<title>DownloadRequest Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/DownloadRequest" class="dashAnchor"></a>
<a title="DownloadRequest Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
Alamofire Docs
</a>
(86% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/Alamofire/Alamofire">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
<img class="header-icon" src="../img/dash.png"/>
Install in Dash
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">Alamofire Reference</a>
<img class="carat" src="../img/carat.png" />
DownloadRequest Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/String.html">String</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content">
<h1>DownloadRequest</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">DownloadRequest</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre>
</div>
</div>
<p>Specific type of <code><a href="../Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDownloadTask</code>.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/Helper%20Types"></a>
<a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
<a href="#/Helper%20Types">
<h3 class="section-name">Helper Types</h3>
</a>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC0B7OptionsV"></a>
<a name="//apple_ref/swift/Struct/DownloadOptions" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV">DownloadOptions</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the
destination URL.</p>
<a href="../Classes/DownloadRequest/DownloadOptions.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadOptions</span><span class="p">:</span> <span class="kt">OptionSet</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC0B15FileDestinationa"></a>
<a name="//apple_ref/swift/Alias/DownloadFileDestination" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A closure executed once a download request has successfully completed in order to determine where to move the
temporary file written to during the download process. The closure takes two arguments: the temporary file URL
and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
the options defining how the file should be moved.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">DownloadFileDestination</span> <span class="o">=</span> <span class="p">(</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties">
<h3 class="section-name">Properties</h3>
</a>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgvp"></a>
<a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgvp">request</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The request sent or to be sent to the server.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
<a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The resume data of the underlying download task if available after a failure.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">resumeData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8progressSo8ProgressCvp"></a>
<a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8progressSo8ProgressCvp">progress</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The progress of downloading the response data from the server for the request.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/State"></a>
<a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
<a href="#/State">
<h3 class="section-name">State</h3>
</a>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC6cancelyyF"></a>
<a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelyyF">cancel()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Cancels the request.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Progress"></a>
<a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
<a href="#/Progress">
<h3 class="section-name">Progress</h3>
</a>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC16downloadProgressACXDSo13DispatchQueueC5queue_ySo0E0Cc7closuretF"></a>
<a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC16downloadProgressACXDSo13DispatchQueueC5queue_ySo0E0Cc7closuretF">downloadProgress(queue:closure:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sets a closure to be called periodically during the lifecycle of the <code><a href="../Classes/Request.html">Request</a></code> as data is read from the server.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">downloadProgress</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="kt">DispatchQueue</span><span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt">ProgressHandler</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>queue</em>
</code>
</td>
<td>
<div>
<p>The dispatch queue to execute the closure on.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>closure</em>
</code>
</td>
<td>
<div>
<p>The code to be executed periodically as data is read from the server.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Destination"></a>
<a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
<a href="#/Destination">
<h3 class="section-name">Destination</h3>
</a>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination10Foundation3URLV011destinationG0_AC0B7OptionsV7optionstAG_So15HTTPURLResponseCtcSo11FileManagerC19SearchPathDirectoryO3for_AO0nO10DomainMaskV2intFZ"></a>
<a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination10Foundation3URLV011destinationG0_AC0B7OptionsV7optionstAG_So15HTTPURLResponseCtcSo11FileManagerC19SearchPathDirectoryO3for_AO0nO10DomainMaskV2intFZ">suggestedDownloadDestination(for:in:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
file URL in the first available directory with the specified search path directory and search path domain mask.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">suggestedDownloadDestination</span><span class="p">(</span>
<span class="k">for</span> <span class="nv">directory</span><span class="p">:</span> <span class="kt">FileManager</span><span class="o">.</span><span class="kt">SearchPathDirectory</span> <span class="o">=</span> <span class="o">.</span><span class="n">documentDirectory</span><span class="p">,</span>
<span class="k">in</span> <span class="nv">domain</span><span class="p">:</span> <span class="kt">FileManager</span><span class="o">.</span><span class="kt">SearchPathDomainMask</span> <span class="o">=</span> <span class="o">.</span><span class="n">userDomainMask</span><span class="p">)</span>
<span class="o">-></span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>directory</em>
</code>
</td>
<td>
<div>
<p>The search path directory. <code>.DocumentDirectory</code> by default.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>domain</em>
</code>
</td>
<td>
<div>
<p>The search path domain mask. <code>.UserDomainMask</code> by default.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A download file destination closure.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_yAA07DefaultB8ResponseVc17completionHandlertF"></a>
<a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_yAA07DefaultB8ResponseVc17completionHandlertF">response(queue:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a handler to be called once the request has finished.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span>
<span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span>
<span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>queue</em>
</code>
</td>
<td>
<div>
<p>The queue on which the completion handler is dispatched.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>The code to be executed once the request has finished.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_x0D10SerializeryAA0B8ResponseVy16SerializedObjectQzGc17completionHandlertAA0biH8ProtocolRzlF"></a>
<a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8responseACXDSo13DispatchQueueCSg5queue_x0D10SerializeryAA0B8ResponseVy16SerializedObjectQzGc17completionHandlertAA0biH8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a handler to be called once the request has finished.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">response</span><span class="o"><</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span><span class="o">></span><span class="p">(</span>
<span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o"><</span><span class="kt">T</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span>
<span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>queue</em>
</code>
</td>
<td>
<div>
<p>The queue on which the completion handler is dispatched.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>responseSerializer</em>
</code>
</td>
<td>
<div>
<p>The response serializer responsible for serializing the request, response,
and data contained in the destination url.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>The code to be executed once the request has finished.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ"></a>
<a name="//apple_ref/swift/Method/dataResponseSerializer()" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ">dataResponseSerializer()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a response serializer that returns the associated data as-is.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">dataResponseSerializer</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o"><</span><span class="kt">Data</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>A data response serializer.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC12responseDataACXDSo13DispatchQueueCSg5queue_yAA0B8ResponseVy10Foundation0E0VGc17completionHandlertF"></a>
<a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC12responseDataACXDSo13DispatchQueueCSg5queue_yAA0B8ResponseVy10Foundation0E0VGc17completionHandlertF">responseData(queue:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a handler to be called once the request has finished.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span>
<span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o"><</span><span class="kt">Data</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span>
<span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>The code to be executed once the request has finished.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC24stringResponseSerializerAA0beF0VySSGSS10FoundationE8EncodingVSg8encoding_tFZ"></a>
<a name="//apple_ref/swift/Method/stringResponseSerializer(encoding:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC24stringResponseSerializerAA0beF0VySSGSS10FoundationE8EncodingVSg8encoding_tFZ">stringResponseSerializer(encoding:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a response serializer that returns a result string type initialized from the response data with
the specified string encoding.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">stringResponseSerializer</span><span class="p">(</span><span class="nv">encoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>encoding</em>
</code>
</td>
<td>
<div>
<p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server
response, falling back to the default HTTP default character set, ISO-8859-1.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A string response serializer.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC14responseStringACXDSo13DispatchQueueCSg5queue_SS10FoundationE8EncodingVSg8encodingyAA0B8ResponseVySSGc17completionHandlertF"></a>
<a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC14responseStringACXDSo13DispatchQueueCSg5queue_SS10FoundationE8EncodingVSg8encodingyAA0B8ResponseVySSGc17completionHandlertF">responseString(queue:encoding:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a handler to be called once the request has finished.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span>
<span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">encoding</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">Encoding</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o"><</span><span class="kt">String</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span>
<span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>encoding</em>
</code>
</td>
<td>
<div>
<p>The string encoding. If <code>nil</code>, the string encoding will be determined from the
server response, falling back to the default HTTP default character set,
ISO-8859-1.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>A closure to be executed once the request has finished.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC22jsonResponseSerializerAA0beF0VyypGSo17JSONSerializationC14ReadingOptionsV7options_tFZ"></a>
<a name="//apple_ref/swift/Method/jsonResponseSerializer(options:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC22jsonResponseSerializerAA0beF0VyypGSo17JSONSerializationC14ReadingOptionsV7options_tFZ">jsonResponseSerializer(options:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a response serializer that returns a JSON object result type constructed from the response data using
<code>JSONSerialization</code> with the specified reading options.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">jsonResponseSerializer</span><span class="p">(</span>
<span class="nv">options</span><span class="p">:</span> <span class="kt">JSONSerialization</span><span class="o">.</span><span class="kt">ReadingOptions</span> <span class="o">=</span> <span class="o">.</span><span class="n">allowFragments</span><span class="p">)</span>
<span class="o">-></span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>options</em>
</code>
</td>
<td>
<div>
<p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A JSON object response serializer.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC12responseJSONACXDSo13DispatchQueueCSg5queue_So17JSONSerializationC14ReadingOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF"></a>
<a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSONACXDSo13DispatchQueueCSg5queue_So17JSONSerializationC14ReadingOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF">responseJSON(queue:options:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a handler to be called once the request has finished.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span>
<span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">options</span><span class="p">:</span> <span class="kt">JSONSerialization</span><span class="o">.</span><span class="kt">ReadingOptions</span> <span class="o">=</span> <span class="o">.</span><span class="n">allowFragments</span><span class="p">,</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o"><</span><span class="kt">Any</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span>
<span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>options</em>
</code>
</td>
<td>
<div>
<p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>A closure to be executed once the request has finished.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC30propertyListResponseSerializerAA0bfG0VyypGSo08PropertyE13SerializationC17MutabilityOptionsV7options_tFZ"></a>
<a name="//apple_ref/swift/Method/propertyListResponseSerializer(options:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC30propertyListResponseSerializerAA0bfG0VyypGSo08PropertyE13SerializationC17MutabilityOptionsV7options_tFZ">propertyListResponseSerializer(options:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a response serializer that returns an object constructed from the response data using
<code>PropertyListSerialization</code> with the specified reading options.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">propertyListResponseSerializer</span><span class="p">(</span>
<span class="nv">options</span><span class="p">:</span> <span class="kt">PropertyListSerialization</span><span class="o">.</span><span class="kt">ReadOptions</span> <span class="o">=</span> <span class="p">[])</span>
<span class="o">-></span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o"><</span><span class="kt">Any</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>options</em>
</code>
</td>
<td>
<div>
<p>The property list reading options. Defaults to <code>[]</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A property list object response serializer.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC20responsePropertyListACXDSo13DispatchQueueCSg5queue_So0eF13SerializationC17MutabilityOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF"></a>
<a name="//apple_ref/swift/Method/responsePropertyList(queue:options:completionHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC20responsePropertyListACXDSo13DispatchQueueCSg5queue_So0eF13SerializationC17MutabilityOptionsV7optionsyAA0B8ResponseVyypGc17completionHandlertF">responsePropertyList(queue:options:completionHandler:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Adds a handler to be called once the request has finished.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responsePropertyList</span><span class="p">(</span>
<span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">options</span><span class="p">:</span> <span class="kt">PropertyListSerialization</span><span class="o">.</span><span class="kt">ReadOptions</span> <span class="o">=</span> <span class="p">[],</span>
<span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Structs/DownloadResponse.html">DownloadResponse</a></span><span class="o"><</span><span class="kt">Any</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span>
<span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>options</em>
</code>
</td>
<td>
<div>
<p>The property list reading options. Defaults to <code>[]</code>.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>completionHandler</em>
</code>
</td>
<td>
<div>
<p>A closure to be executed once the request has finished.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
<a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
destination URL, and returns whether the request was valid.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Validation</span> <span class="o">=</span> <span class="p">(</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8validateACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So15HTTPURLResponseCAI3URLVSgAQtcF"></a>
<a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So15HTTPURLResponseCAI3URLVSgAQtcF">validate(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Validates the request, using the specified closure.</p>
<p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="n">_</span> <span class="nv">validation</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>validation</em>
</code>
</td>
<td>
<div>
<p>A closure to validate the request.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8validateACXDx10statusCode_ts8SequenceRzSi7ElementRtzlF"></a>
<a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDx10statusCode_ts8SequenceRzSi7ElementRtzlF">validate(statusCode:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Validates that the response has a status code in the specified sequence.</p>
<p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o"><</span><span class="kt">S</span><span class="p">:</span> <span class="kt">Sequence</span><span class="o">></span><span class="p">(</span><span class="n">statusCode</span> <span class="nv">acceptableStatusCodes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">Int</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>range</em>
</code>
</td>
<td>
<div>
<p>The range of acceptable status codes.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8validateACXDx11contentType_ts8SequenceRzSS7ElementRtzlF"></a>
<a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDx11contentType_ts8SequenceRzSS7ElementRtzlF">validate(contentType:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Validates that the response has a content type in the specified sequence.</p>
<p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o"><</span><span class="kt">S</span><span class="p">:</span> <span class="kt">Sequence</span><span class="o">></span><span class="p">(</span><span class="n">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>contentType</em>
</code>
</td>
<td>
<div>
<p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
<a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
<a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Validates that the response has a status code in the default acceptable range of 200…299, and that the content
type matches any specified in the Accept HTTP header field.</p>
<p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>The request.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-04-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>