DownloadRequest.html 86 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>DownloadRequest Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/DownloadRequest" class="dashAnchor"></a>
  16. <a title="DownloadRequest Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (86% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. DownloadRequest Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. <li class="nav-group-task">
  274. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  275. </li>
  276. <li class="nav-group-task">
  277. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  278. </li>
  279. </ul>
  280. </li>
  281. <li class="nav-group-name">
  282. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  283. <ul class="nav-group-tasks">
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </nav>
  297. <article class="main-content">
  298. <section class="section">
  299. <div class="section-content">
  300. <h1>DownloadRequest</h1>
  301. <div class="declaration">
  302. <div class="language">
  303. <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>
  304. </div>
  305. </div>
  306. <p>Specific type of <code><a href="../Classes/Request.html">Request</a></code> that manages an underlying <code>URLSessionDownloadTask</code>.</p>
  307. </div>
  308. </section>
  309. <section class="section">
  310. <div class="section-content">
  311. <div class="task-group">
  312. <div class="task-name-container">
  313. <a name="/Helper%20Types"></a>
  314. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  315. <a href="#/Helper%20Types">
  316. <h3 class="section-name">Helper Types</h3>
  317. </a>
  318. </div>
  319. <ul class="item-container">
  320. <li class="item">
  321. <div>
  322. <code>
  323. <a name="/s:9Alamofire15DownloadRequestC0B7OptionsV"></a>
  324. <a name="//apple_ref/swift/Struct/DownloadOptions" class="dashAnchor"></a>
  325. <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV">DownloadOptions</a>
  326. </code>
  327. </div>
  328. <div class="height-container">
  329. <div class="pointer-container"></div>
  330. <section class="section">
  331. <div class="pointer"></div>
  332. <div class="abstract">
  333. <p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the
  334. destination URL.</p>
  335. <a href="../Classes/DownloadRequest/DownloadOptions.html" class="slightly-smaller">See more</a>
  336. </div>
  337. <div class="declaration">
  338. <h4>Declaration</h4>
  339. <div class="language">
  340. <p class="aside-title">Swift</p>
  341. <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>
  342. </div>
  343. </div>
  344. </section>
  345. </div>
  346. </li>
  347. <li class="item">
  348. <div>
  349. <code>
  350. <a name="/s:9Alamofire15DownloadRequestC0B15FileDestinationa"></a>
  351. <a name="//apple_ref/swift/Alias/DownloadFileDestination" class="dashAnchor"></a>
  352. <a class="token" href="#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a>
  353. </code>
  354. </div>
  355. <div class="height-container">
  356. <div class="pointer-container"></div>
  357. <section class="section">
  358. <div class="pointer"></div>
  359. <div class="abstract">
  360. <p>A closure executed once a download request has successfully completed in order to determine where to move the
  361. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  362. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  363. the options defining how the file should be moved.</p>
  364. </div>
  365. <div class="declaration">
  366. <h4>Declaration</h4>
  367. <div class="language">
  368. <p class="aside-title">Swift</p>
  369. <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><span class="n">_</span> <span class="nv">temporaryURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="nv">destinationURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/DownloadOptions.html">DownloadOptions</a></span><span class="p">)</span></code></pre>
  370. </div>
  371. </div>
  372. </section>
  373. </div>
  374. </li>
  375. </ul>
  376. </div>
  377. <div class="task-group">
  378. <div class="task-name-container">
  379. <a name="/Properties"></a>
  380. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  381. <a href="#/Properties">
  382. <h3 class="section-name">Properties</h3>
  383. </a>
  384. </div>
  385. <ul class="item-container">
  386. <li class="item">
  387. <div>
  388. <code>
  389. <a name="/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgvp"></a>
  390. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  391. <a class="token" href="#/s:9Alamofire15DownloadRequestC7request10Foundation10URLRequestVSgvp">request</a>
  392. </code>
  393. </div>
  394. <div class="height-container">
  395. <div class="pointer-container"></div>
  396. <section class="section">
  397. <div class="pointer"></div>
  398. <div class="abstract">
  399. <p>The request sent or to be sent to the server.</p>
  400. </div>
  401. <div class="declaration">
  402. <h4>Declaration</h4>
  403. <div class="language">
  404. <p class="aside-title">Swift</p>
  405. <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> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  406. </div>
  407. </div>
  408. </section>
  409. </div>
  410. </li>
  411. <li class="item">
  412. <div>
  413. <code>
  414. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  415. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  416. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  417. </code>
  418. </div>
  419. <div class="height-container">
  420. <div class="pointer-container"></div>
  421. <section class="section">
  422. <div class="pointer"></div>
  423. <div class="abstract">
  424. <p>The resume data of the underlying download task if available after a failure.</p>
  425. </div>
  426. <div class="declaration">
  427. <h4>Declaration</h4>
  428. <div class="language">
  429. <p class="aside-title">Swift</p>
  430. <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> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  431. </div>
  432. </div>
  433. </section>
  434. </div>
  435. </li>
  436. <li class="item">
  437. <div>
  438. <code>
  439. <a name="/s:9Alamofire15DownloadRequestC8progressSo10NSProgressCvp"></a>
  440. <a name="//apple_ref/swift/Property/progress" class="dashAnchor"></a>
  441. <a class="token" href="#/s:9Alamofire15DownloadRequestC8progressSo10NSProgressCvp">progress</a>
  442. </code>
  443. </div>
  444. <div class="height-container">
  445. <div class="pointer-container"></div>
  446. <section class="section">
  447. <div class="pointer"></div>
  448. <div class="abstract">
  449. <p>The progress of downloading the response data from the server for the request.</p>
  450. </div>
  451. <div class="declaration">
  452. <h4>Declaration</h4>
  453. <div class="language">
  454. <p class="aside-title">Swift</p>
  455. <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> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  456. </div>
  457. </div>
  458. </section>
  459. </div>
  460. </li>
  461. </ul>
  462. </div>
  463. <div class="task-group">
  464. <div class="task-name-container">
  465. <a name="/State"></a>
  466. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  467. <a href="#/State">
  468. <h3 class="section-name">State</h3>
  469. </a>
  470. </div>
  471. <ul class="item-container">
  472. <li class="item">
  473. <div>
  474. <code>
  475. <a name="/s:9Alamofire15DownloadRequestC6cancelyyF"></a>
  476. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  477. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelyyF">cancel()</a>
  478. </code>
  479. </div>
  480. <div class="height-container">
  481. <div class="pointer-container"></div>
  482. <section class="section">
  483. <div class="pointer"></div>
  484. <div class="abstract">
  485. <p>Cancels the request.</p>
  486. </div>
  487. <div class="declaration">
  488. <h4>Declaration</h4>
  489. <div class="language">
  490. <p class="aside-title">Swift</p>
  491. <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>
  492. </div>
  493. </div>
  494. </section>
  495. </div>
  496. </li>
  497. </ul>
  498. </div>
  499. <div class="task-group">
  500. <div class="task-name-container">
  501. <a name="/Progress"></a>
  502. <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
  503. <a href="#/Progress">
  504. <h3 class="section-name">Progress</h3>
  505. </a>
  506. </div>
  507. <ul class="item-container">
  508. <li class="item">
  509. <div>
  510. <code>
  511. <a name="/s:9Alamofire15DownloadRequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_F0C_ySo10NSProgressCctF"></a>
  512. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  513. <a class="token" href="#/s:9Alamofire15DownloadRequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_F0C_ySo10NSProgressCctF">downloadProgress(queue:closure:)</a>
  514. </code>
  515. </div>
  516. <div class="height-container">
  517. <div class="pointer-container"></div>
  518. <section class="section">
  519. <div class="pointer"></div>
  520. <div class="abstract">
  521. <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>
  522. </div>
  523. <div class="declaration">
  524. <h4>Declaration</h4>
  525. <div class="language">
  526. <p class="aside-title">Swift</p>
  527. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  528. <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">-&gt;</span> <span class="k">Self</span></code></pre>
  529. </div>
  530. </div>
  531. <div>
  532. <h4>Parameters</h4>
  533. <table class="graybox">
  534. <tbody>
  535. <tr>
  536. <td>
  537. <code>
  538. <em>queue</em>
  539. </code>
  540. </td>
  541. <td>
  542. <div>
  543. <p>The dispatch queue to execute the closure on.</p>
  544. </div>
  545. </td>
  546. </tr>
  547. <tr>
  548. <td>
  549. <code>
  550. <em>closure</em>
  551. </code>
  552. </td>
  553. <td>
  554. <div>
  555. <p>The code to be executed periodically as data is read from the server.</p>
  556. </div>
  557. </td>
  558. </tr>
  559. </tbody>
  560. </table>
  561. </div>
  562. <div>
  563. <h4>Return Value</h4>
  564. <p>The request.</p>
  565. </div>
  566. </section>
  567. </div>
  568. </li>
  569. </ul>
  570. </div>
  571. <div class="task-group">
  572. <div class="task-name-container">
  573. <a name="/Destination"></a>
  574. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  575. <a href="#/Destination">
  576. <h3 class="section-name">Destination</h3>
  577. </a>
  578. </div>
  579. <ul class="item-container">
  580. <li class="item">
  581. <div>
  582. <code>
  583. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in10Foundation3URLV011destinationI0_AC0B7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVtFZ"></a>
  584. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:)" class="dashAnchor"></a>
  585. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in10Foundation3URLV011destinationI0_AC0B7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVtFZ">suggestedDownloadDestination(for:in:)</a>
  586. </code>
  587. </div>
  588. <div class="height-container">
  589. <div class="pointer-container"></div>
  590. <section class="section">
  591. <div class="pointer"></div>
  592. <div class="abstract">
  593. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  594. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  595. </div>
  596. <div class="declaration">
  597. <h4>Declaration</h4>
  598. <div class="language">
  599. <p class="aside-title">Swift</p>
  600. <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>
  601. <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>
  602. <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>
  603. <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC0B15FileDestinationa">DownloadFileDestination</a></span></code></pre>
  604. </div>
  605. </div>
  606. <div>
  607. <h4>Parameters</h4>
  608. <table class="graybox">
  609. <tbody>
  610. <tr>
  611. <td>
  612. <code>
  613. <em>directory</em>
  614. </code>
  615. </td>
  616. <td>
  617. <div>
  618. <p>The search path directory. <code>.DocumentDirectory</code> by default.</p>
  619. </div>
  620. </td>
  621. </tr>
  622. <tr>
  623. <td>
  624. <code>
  625. <em>domain</em>
  626. </code>
  627. </td>
  628. <td>
  629. <div>
  630. <p>The search path domain mask. <code>.UserDomainMask</code> by default.</p>
  631. </div>
  632. </td>
  633. </tr>
  634. </tbody>
  635. </table>
  636. </div>
  637. <div>
  638. <h4>Return Value</h4>
  639. <p>A download file destination closure.</p>
  640. </div>
  641. </section>
  642. </div>
  643. </li>
  644. </ul>
  645. </div>
  646. <div class="task-group">
  647. <div class="task-name-container">
  648. <a name="/Default"></a>
  649. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  650. <a href="#/Default">
  651. <h3 class="section-name">Default</h3>
  652. </a>
  653. </div>
  654. <ul class="item-container">
  655. <li class="item">
  656. <div>
  657. <code>
  658. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0CSg_yAA07DefaultB8ResponseVctF"></a>
  659. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  660. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0CSg_yAA07DefaultB8ResponseVctF">response(queue:completionHandler:)</a>
  661. </code>
  662. </div>
  663. <div class="height-container">
  664. <div class="pointer-container"></div>
  665. <section class="section">
  666. <div class="pointer"></div>
  667. <div class="abstract">
  668. <p>Adds a handler to be called once the request has finished.</p>
  669. </div>
  670. <div class="declaration">
  671. <h4>Declaration</h4>
  672. <div class="language">
  673. <p class="aside-title">Swift</p>
  674. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  675. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span>
  676. <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>
  677. <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">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  678. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  679. </div>
  680. </div>
  681. <div>
  682. <h4>Parameters</h4>
  683. <table class="graybox">
  684. <tbody>
  685. <tr>
  686. <td>
  687. <code>
  688. <em>queue</em>
  689. </code>
  690. </td>
  691. <td>
  692. <div>
  693. <p>The queue on which the completion handler is dispatched.</p>
  694. </div>
  695. </td>
  696. </tr>
  697. <tr>
  698. <td>
  699. <code>
  700. <em>completionHandler</em>
  701. </code>
  702. </td>
  703. <td>
  704. <div>
  705. <p>The code to be executed once the request has finished.</p>
  706. </div>
  707. </td>
  708. </tr>
  709. </tbody>
  710. </table>
  711. </div>
  712. <div>
  713. <h4>Return Value</h4>
  714. <p>The request.</p>
  715. </div>
  716. </section>
  717. </div>
  718. </li>
  719. <li class="item">
  720. <div>
  721. <code>
  722. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0CSg_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF"></a>
  723. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  724. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0CSg_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  725. </code>
  726. </div>
  727. <div class="height-container">
  728. <div class="pointer-container"></div>
  729. <section class="section">
  730. <div class="pointer"></div>
  731. <div class="abstract">
  732. <p>Adds a handler to be called once the request has finished.</p>
  733. </div>
  734. <div class="declaration">
  735. <h4>Declaration</h4>
  736. <div class="language">
  737. <p class="aside-title">Swift</p>
  738. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  739. <span class="kd">public</span> <span class="kd">func</span> <span class="n">response</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span><span class="o">&gt;</span><span class="p">(</span>
  740. <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>
  741. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
  742. <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">&lt;</span><span class="kt">T</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  743. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  744. </div>
  745. </div>
  746. <div>
  747. <h4>Parameters</h4>
  748. <table class="graybox">
  749. <tbody>
  750. <tr>
  751. <td>
  752. <code>
  753. <em>queue</em>
  754. </code>
  755. </td>
  756. <td>
  757. <div>
  758. <p>The queue on which the completion handler is dispatched.</p>
  759. </div>
  760. </td>
  761. </tr>
  762. <tr>
  763. <td>
  764. <code>
  765. <em>responseSerializer</em>
  766. </code>
  767. </td>
  768. <td>
  769. <div>
  770. <p>The response serializer responsible for serializing the request, response,
  771. and data contained in the destination url.</p>
  772. </div>
  773. </td>
  774. </tr>
  775. <tr>
  776. <td>
  777. <code>
  778. <em>completionHandler</em>
  779. </code>
  780. </td>
  781. <td>
  782. <div>
  783. <p>The code to be executed once the request has finished.</p>
  784. </div>
  785. </td>
  786. </tr>
  787. </tbody>
  788. </table>
  789. </div>
  790. <div>
  791. <h4>Return Value</h4>
  792. <p>The request.</p>
  793. </div>
  794. </section>
  795. </div>
  796. </li>
  797. </ul>
  798. </div>
  799. <div class="task-group">
  800. <div class="task-name-container">
  801. <a name="/Data"></a>
  802. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  803. <a href="#/Data">
  804. <h3 class="section-name">Data</h3>
  805. </a>
  806. </div>
  807. <ul class="item-container">
  808. <li class="item">
  809. <div>
  810. <code>
  811. <a name="/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ"></a>
  812. <a name="//apple_ref/swift/Method/dataResponseSerializer()" class="dashAnchor"></a>
  813. <a class="token" href="#/s:9Alamofire15DownloadRequestC22dataResponseSerializerAA0beF0Vy10Foundation4DataVGyFZ">dataResponseSerializer()</a>
  814. </code>
  815. </div>
  816. <div class="height-container">
  817. <div class="pointer-container"></div>
  818. <section class="section">
  819. <div class="pointer"></div>
  820. <div class="abstract">
  821. <p>Creates a response serializer that returns the associated data as-is.</p>
  822. </div>
  823. <div class="declaration">
  824. <h4>Declaration</h4>
  825. <div class="language">
  826. <p class="aside-title">Swift</p>
  827. <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">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  828. </div>
  829. </div>
  830. <div>
  831. <h4>Return Value</h4>
  832. <p>A data response serializer.</p>
  833. </div>
  834. </section>
  835. </div>
  836. </li>
  837. <li class="item">
  838. <div>
  839. <code>
  840. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0CSg_yAA0B8ResponseVy10Foundation0E0VGctF"></a>
  841. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  842. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0CSg_yAA0B8ResponseVy10Foundation0E0VGctF">responseData(queue:completionHandler:)</a>
  843. </code>
  844. </div>
  845. <div class="height-container">
  846. <div class="pointer-container"></div>
  847. <section class="section">
  848. <div class="pointer"></div>
  849. <div class="abstract">
  850. <p>Adds a handler to be called once the request has finished.</p>
  851. </div>
  852. <div class="declaration">
  853. <h4>Declaration</h4>
  854. <div class="language">
  855. <p class="aside-title">Swift</p>
  856. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  857. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span>
  858. <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>
  859. <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">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  860. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  861. </div>
  862. </div>
  863. <div>
  864. <h4>Parameters</h4>
  865. <table class="graybox">
  866. <tbody>
  867. <tr>
  868. <td>
  869. <code>
  870. <em>completionHandler</em>
  871. </code>
  872. </td>
  873. <td>
  874. <div>
  875. <p>The code to be executed once the request has finished.</p>
  876. </div>
  877. </td>
  878. </tr>
  879. </tbody>
  880. </table>
  881. </div>
  882. <div>
  883. <h4>Return Value</h4>
  884. <p>The request.</p>
  885. </div>
  886. </section>
  887. </div>
  888. </li>
  889. </ul>
  890. </div>
  891. <div class="task-group">
  892. <div class="task-name-container">
  893. <a name="/String"></a>
  894. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  895. <a href="#/String">
  896. <h3 class="section-name">String</h3>
  897. </a>
  898. </div>
  899. <ul class="item-container">
  900. <li class="item">
  901. <div>
  902. <code>
  903. <a name="/s:9Alamofire15DownloadRequestC24stringResponseSerializer8encodingAA0beF0VySSGSS10FoundationE8EncodingVSg_tFZ"></a>
  904. <a name="//apple_ref/swift/Method/stringResponseSerializer(encoding:)" class="dashAnchor"></a>
  905. <a class="token" href="#/s:9Alamofire15DownloadRequestC24stringResponseSerializer8encodingAA0beF0VySSGSS10FoundationE8EncodingVSg_tFZ">stringResponseSerializer(encoding:)</a>
  906. </code>
  907. </div>
  908. <div class="height-container">
  909. <div class="pointer-container"></div>
  910. <section class="section">
  911. <div class="pointer"></div>
  912. <div class="abstract">
  913. <p>Creates a response serializer that returns a result string type initialized from the response data with
  914. the specified string encoding.</p>
  915. </div>
  916. <div class="declaration">
  917. <h4>Declaration</h4>
  918. <div class="language">
  919. <p class="aside-title">Swift</p>
  920. <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">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  921. </div>
  922. </div>
  923. <div>
  924. <h4>Parameters</h4>
  925. <table class="graybox">
  926. <tbody>
  927. <tr>
  928. <td>
  929. <code>
  930. <em>encoding</em>
  931. </code>
  932. </td>
  933. <td>
  934. <div>
  935. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the server
  936. response, falling back to the default HTTP default character set, ISO-8859-1.</p>
  937. </div>
  938. </td>
  939. </tr>
  940. </tbody>
  941. </table>
  942. </div>
  943. <div>
  944. <h4>Return Value</h4>
  945. <p>A string response serializer.</p>
  946. </div>
  947. </section>
  948. </div>
  949. </li>
  950. <li class="item">
  951. <div>
  952. <code>
  953. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0CSg_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF"></a>
  954. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  955. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0CSg_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF">responseString(queue:encoding:completionHandler:)</a>
  956. </code>
  957. </div>
  958. <div class="height-container">
  959. <div class="pointer-container"></div>
  960. <section class="section">
  961. <div class="pointer"></div>
  962. <div class="abstract">
  963. <p>Adds a handler to be called once the request has finished.</p>
  964. </div>
  965. <div class="declaration">
  966. <h4>Declaration</h4>
  967. <div class="language">
  968. <p class="aside-title">Swift</p>
  969. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  970. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span>
  971. <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>
  972. <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>
  973. <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">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  974. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  975. </div>
  976. </div>
  977. <div>
  978. <h4>Parameters</h4>
  979. <table class="graybox">
  980. <tbody>
  981. <tr>
  982. <td>
  983. <code>
  984. <em>encoding</em>
  985. </code>
  986. </td>
  987. <td>
  988. <div>
  989. <p>The string encoding. If <code>nil</code>, the string encoding will be determined from the
  990. server response, falling back to the default HTTP default character set,
  991. ISO-8859-1.</p>
  992. </div>
  993. </td>
  994. </tr>
  995. <tr>
  996. <td>
  997. <code>
  998. <em>completionHandler</em>
  999. </code>
  1000. </td>
  1001. <td>
  1002. <div>
  1003. <p>A closure to be executed once the request has finished.</p>
  1004. </div>
  1005. </td>
  1006. </tr>
  1007. </tbody>
  1008. </table>
  1009. </div>
  1010. <div>
  1011. <h4>Return Value</h4>
  1012. <p>The request.</p>
  1013. </div>
  1014. </section>
  1015. </div>
  1016. </li>
  1017. </ul>
  1018. </div>
  1019. <div class="task-group">
  1020. <div class="task-name-container">
  1021. <a name="/JSON"></a>
  1022. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1023. <a href="#/JSON">
  1024. <h3 class="section-name">JSON</h3>
  1025. </a>
  1026. </div>
  1027. <ul class="item-container">
  1028. <li class="item">
  1029. <div>
  1030. <code>
  1031. <a name="/s:9Alamofire15DownloadRequestC22jsonResponseSerializer7optionsAA0beF0VyypGSo20NSJSONReadingOptionsV_tFZ"></a>
  1032. <a name="//apple_ref/swift/Method/jsonResponseSerializer(options:)" class="dashAnchor"></a>
  1033. <a class="token" href="#/s:9Alamofire15DownloadRequestC22jsonResponseSerializer7optionsAA0beF0VyypGSo20NSJSONReadingOptionsV_tFZ">jsonResponseSerializer(options:)</a>
  1034. </code>
  1035. </div>
  1036. <div class="height-container">
  1037. <div class="pointer-container"></div>
  1038. <section class="section">
  1039. <div class="pointer"></div>
  1040. <div class="abstract">
  1041. <p>Creates a response serializer that returns a JSON object result type constructed from the response data using
  1042. <code>JSONSerialization</code> with the specified reading options.</p>
  1043. </div>
  1044. <div class="declaration">
  1045. <h4>Declaration</h4>
  1046. <div class="language">
  1047. <p class="aside-title">Swift</p>
  1048. <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>
  1049. <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>
  1050. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span></code></pre>
  1051. </div>
  1052. </div>
  1053. <div>
  1054. <h4>Parameters</h4>
  1055. <table class="graybox">
  1056. <tbody>
  1057. <tr>
  1058. <td>
  1059. <code>
  1060. <em>options</em>
  1061. </code>
  1062. </td>
  1063. <td>
  1064. <div>
  1065. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1066. </div>
  1067. </td>
  1068. </tr>
  1069. </tbody>
  1070. </table>
  1071. </div>
  1072. <div>
  1073. <h4>Return Value</h4>
  1074. <p>A JSON object response serializer.</p>
  1075. </div>
  1076. </section>
  1077. </div>
  1078. </li>
  1079. <li class="item">
  1080. <div>
  1081. <code>
  1082. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0CSg_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF"></a>
  1083. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  1084. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0CSg_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF">responseJSON(queue:options:completionHandler:)</a>
  1085. </code>
  1086. </div>
  1087. <div class="height-container">
  1088. <div class="pointer-container"></div>
  1089. <section class="section">
  1090. <div class="pointer"></div>
  1091. <div class="abstract">
  1092. <p>Adds a handler to be called once the request has finished.</p>
  1093. </div>
  1094. <div class="declaration">
  1095. <h4>Declaration</h4>
  1096. <div class="language">
  1097. <p class="aside-title">Swift</p>
  1098. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1099. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span>
  1100. <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>
  1101. <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>
  1102. <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">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  1103. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1104. </div>
  1105. </div>
  1106. <div>
  1107. <h4>Parameters</h4>
  1108. <table class="graybox">
  1109. <tbody>
  1110. <tr>
  1111. <td>
  1112. <code>
  1113. <em>options</em>
  1114. </code>
  1115. </td>
  1116. <td>
  1117. <div>
  1118. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1119. </div>
  1120. </td>
  1121. </tr>
  1122. <tr>
  1123. <td>
  1124. <code>
  1125. <em>completionHandler</em>
  1126. </code>
  1127. </td>
  1128. <td>
  1129. <div>
  1130. <p>A closure to be executed once the request has finished.</p>
  1131. </div>
  1132. </td>
  1133. </tr>
  1134. </tbody>
  1135. </table>
  1136. </div>
  1137. <div>
  1138. <h4>Return Value</h4>
  1139. <p>The request.</p>
  1140. </div>
  1141. </section>
  1142. </div>
  1143. </li>
  1144. </ul>
  1145. </div>
  1146. <div class="task-group">
  1147. <div class="task-name-container">
  1148. <a name="/Property%20List"></a>
  1149. <a name="//apple_ref/swift/Section/Property List" class="dashAnchor"></a>
  1150. <a href="#/Property%20List">
  1151. <h3 class="section-name">Property List</h3>
  1152. </a>
  1153. </div>
  1154. <ul class="item-container">
  1155. <li class="item">
  1156. <div>
  1157. <code>
  1158. <a name="/s:9Alamofire15DownloadRequestC30propertyListResponseSerializer7optionsAA0bfG0VyypGSo010NSPropertyE17MutabilityOptionsV_tFZ"></a>
  1159. <a name="//apple_ref/swift/Method/propertyListResponseSerializer(options:)" class="dashAnchor"></a>
  1160. <a class="token" href="#/s:9Alamofire15DownloadRequestC30propertyListResponseSerializer7optionsAA0bfG0VyypGSo010NSPropertyE17MutabilityOptionsV_tFZ">propertyListResponseSerializer(options:)</a>
  1161. </code>
  1162. </div>
  1163. <div class="height-container">
  1164. <div class="pointer-container"></div>
  1165. <section class="section">
  1166. <div class="pointer"></div>
  1167. <div class="abstract">
  1168. <p>Creates a response serializer that returns an object constructed from the response data using
  1169. <code>PropertyListSerialization</code> with the specified reading options.</p>
  1170. </div>
  1171. <div class="declaration">
  1172. <h4>Declaration</h4>
  1173. <div class="language">
  1174. <p class="aside-title">Swift</p>
  1175. <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>
  1176. <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>
  1177. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span></code></pre>
  1178. </div>
  1179. </div>
  1180. <div>
  1181. <h4>Parameters</h4>
  1182. <table class="graybox">
  1183. <tbody>
  1184. <tr>
  1185. <td>
  1186. <code>
  1187. <em>options</em>
  1188. </code>
  1189. </td>
  1190. <td>
  1191. <div>
  1192. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1193. </div>
  1194. </td>
  1195. </tr>
  1196. </tbody>
  1197. </table>
  1198. </div>
  1199. <div>
  1200. <h4>Return Value</h4>
  1201. <p>A property list object response serializer.</p>
  1202. </div>
  1203. </section>
  1204. </div>
  1205. </li>
  1206. <li class="item">
  1207. <div>
  1208. <code>
  1209. <a name="/s:9Alamofire15DownloadRequestC20responsePropertyList5queue7options17completionHandlerACXDSo012OS_dispatch_G0CSg_So010NSPropertyF17MutabilityOptionsVyAA0B8ResponseVyypGctF"></a>
  1210. <a name="//apple_ref/swift/Method/responsePropertyList(queue:options:completionHandler:)" class="dashAnchor"></a>
  1211. <a class="token" href="#/s:9Alamofire15DownloadRequestC20responsePropertyList5queue7options17completionHandlerACXDSo012OS_dispatch_G0CSg_So010NSPropertyF17MutabilityOptionsVyAA0B8ResponseVyypGctF">responsePropertyList(queue:options:completionHandler:)</a>
  1212. </code>
  1213. </div>
  1214. <div class="height-container">
  1215. <div class="pointer-container"></div>
  1216. <section class="section">
  1217. <div class="pointer"></div>
  1218. <div class="abstract">
  1219. <p>Adds a handler to be called once the request has finished.</p>
  1220. </div>
  1221. <div class="declaration">
  1222. <h4>Declaration</h4>
  1223. <div class="language">
  1224. <p class="aside-title">Swift</p>
  1225. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1226. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responsePropertyList</span><span class="p">(</span>
  1227. <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>
  1228. <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>
  1229. <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">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  1230. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1231. </div>
  1232. </div>
  1233. <div>
  1234. <h4>Parameters</h4>
  1235. <table class="graybox">
  1236. <tbody>
  1237. <tr>
  1238. <td>
  1239. <code>
  1240. <em>options</em>
  1241. </code>
  1242. </td>
  1243. <td>
  1244. <div>
  1245. <p>The property list reading options. Defaults to <code>[]</code>.</p>
  1246. </div>
  1247. </td>
  1248. </tr>
  1249. <tr>
  1250. <td>
  1251. <code>
  1252. <em>completionHandler</em>
  1253. </code>
  1254. </td>
  1255. <td>
  1256. <div>
  1257. <p>A closure to be executed once the request has finished.</p>
  1258. </div>
  1259. </td>
  1260. </tr>
  1261. </tbody>
  1262. </table>
  1263. </div>
  1264. <div>
  1265. <h4>Return Value</h4>
  1266. <p>The request.</p>
  1267. </div>
  1268. </section>
  1269. </div>
  1270. </li>
  1271. </ul>
  1272. </div>
  1273. <div class="task-group">
  1274. <ul class="item-container">
  1275. <li class="item">
  1276. <div>
  1277. <code>
  1278. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  1279. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1280. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  1281. </code>
  1282. </div>
  1283. <div class="height-container">
  1284. <div class="pointer-container"></div>
  1285. <section class="section">
  1286. <div class="pointer"></div>
  1287. <div class="abstract">
  1288. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  1289. destination URL, and returns whether the request was valid.</p>
  1290. </div>
  1291. <div class="declaration">
  1292. <h4>Declaration</h4>
  1293. <div class="language">
  1294. <p class="aside-title">Swift</p>
  1295. <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><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?,</span> <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span> <span class="n">_</span> <span class="nv">temporaryURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?,</span> <span class="n">_</span> <span class="nv">destinationURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  1296. </div>
  1297. </div>
  1298. </section>
  1299. </div>
  1300. </li>
  1301. <li class="item">
  1302. <div>
  1303. <code>
  1304. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgAQtcF"></a>
  1305. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  1306. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDAA0C0C16ValidationResultO10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgAQtcF">validate(_:)</a>
  1307. </code>
  1308. </div>
  1309. <div class="height-container">
  1310. <div class="pointer-container"></div>
  1311. <section class="section">
  1312. <div class="pointer"></div>
  1313. <div class="abstract">
  1314. <p>Validates the request, using the specified closure.</p>
  1315. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1316. </div>
  1317. <div class="declaration">
  1318. <h4>Declaration</h4>
  1319. <div class="language">
  1320. <p class="aside-title">Swift</p>
  1321. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1322. <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">-&gt;</span> <span class="k">Self</span></code></pre>
  1323. </div>
  1324. </div>
  1325. <div>
  1326. <h4>Parameters</h4>
  1327. <table class="graybox">
  1328. <tbody>
  1329. <tr>
  1330. <td>
  1331. <code>
  1332. <em>validation</em>
  1333. </code>
  1334. </td>
  1335. <td>
  1336. <div>
  1337. <p>A closure to validate the request.</p>
  1338. </div>
  1339. </td>
  1340. </tr>
  1341. </tbody>
  1342. </table>
  1343. </div>
  1344. <div>
  1345. <h4>Return Value</h4>
  1346. <p>The request.</p>
  1347. </div>
  1348. </section>
  1349. </div>
  1350. </li>
  1351. <li class="item">
  1352. <div>
  1353. <code>
  1354. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1355. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1356. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:)</a>
  1357. </code>
  1358. </div>
  1359. <div class="height-container">
  1360. <div class="pointer-container"></div>
  1361. <section class="section">
  1362. <div class="pointer"></div>
  1363. <div class="abstract">
  1364. <p>Validates that the response has a status code in the specified sequence.</p>
  1365. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1366. </div>
  1367. <div class="declaration">
  1368. <h4>Declaration</h4>
  1369. <div class="language">
  1370. <p class="aside-title">Swift</p>
  1371. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1372. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</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">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">Int</span></code></pre>
  1373. </div>
  1374. </div>
  1375. <div>
  1376. <h4>Parameters</h4>
  1377. <table class="graybox">
  1378. <tbody>
  1379. <tr>
  1380. <td>
  1381. <code>
  1382. <em>range</em>
  1383. </code>
  1384. </td>
  1385. <td>
  1386. <div>
  1387. <p>The range of acceptable status codes.</p>
  1388. </div>
  1389. </td>
  1390. </tr>
  1391. </tbody>
  1392. </table>
  1393. </div>
  1394. <div>
  1395. <h4>Return Value</h4>
  1396. <p>The request.</p>
  1397. </div>
  1398. </section>
  1399. </div>
  1400. </li>
  1401. <li class="item">
  1402. <div>
  1403. <code>
  1404. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDx_tSTRzSS7ElementRtzlF"></a>
  1405. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1406. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDx_tSTRzSS7ElementRtzlF">validate(contentType:)</a>
  1407. </code>
  1408. </div>
  1409. <div class="height-container">
  1410. <div class="pointer-container"></div>
  1411. <section class="section">
  1412. <div class="pointer"></div>
  1413. <div class="abstract">
  1414. <p>Validates that the response has a content type in the specified sequence.</p>
  1415. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1416. </div>
  1417. <div class="declaration">
  1418. <h4>Declaration</h4>
  1419. <div class="language">
  1420. <p class="aside-title">Swift</p>
  1421. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1422. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</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">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
  1423. </div>
  1424. </div>
  1425. <div>
  1426. <h4>Parameters</h4>
  1427. <table class="graybox">
  1428. <tbody>
  1429. <tr>
  1430. <td>
  1431. <code>
  1432. <em>contentType</em>
  1433. </code>
  1434. </td>
  1435. <td>
  1436. <div>
  1437. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1438. </div>
  1439. </td>
  1440. </tr>
  1441. </tbody>
  1442. </table>
  1443. </div>
  1444. <div>
  1445. <h4>Return Value</h4>
  1446. <p>The request.</p>
  1447. </div>
  1448. </section>
  1449. </div>
  1450. </li>
  1451. <li class="item">
  1452. <div>
  1453. <code>
  1454. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  1455. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1456. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  1457. </code>
  1458. </div>
  1459. <div class="height-container">
  1460. <div class="pointer-container"></div>
  1461. <section class="section">
  1462. <div class="pointer"></div>
  1463. <div class="abstract">
  1464. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1465. type matches any specified in the Accept HTTP header field.</p>
  1466. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1467. </div>
  1468. <div class="declaration">
  1469. <h4>Declaration</h4>
  1470. <div class="language">
  1471. <p class="aside-title">Swift</p>
  1472. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1473. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1474. </div>
  1475. </div>
  1476. <div>
  1477. <h4>Return Value</h4>
  1478. <p>The request.</p>
  1479. </div>
  1480. </section>
  1481. </div>
  1482. </li>
  1483. </ul>
  1484. </div>
  1485. </div>
  1486. </section>
  1487. </article>
  1488. </div>
  1489. <section class="footer">
  1490. <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-11-24)</p>
  1491. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1492. </section>
  1493. </body>
  1494. </div>
  1495. </html>