DownloadRequest.html 76 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413
  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. (75% 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/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/MultipartUpload.html">MultipartUpload</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  181. </li>
  182. </ul>
  183. </li>
  184. <li class="nav-group-name">
  185. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  186. <ul class="nav-group-tasks">
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  216. </li>
  217. </ul>
  218. </li>
  219. <li class="nav-group-name">
  220. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  221. <ul class="nav-group-tasks">
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  259. </li>
  260. </ul>
  261. </li>
  262. <li class="nav-group-name">
  263. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  264. <ul class="nav-group-tasks">
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/SessionStateProvider.html">SessionStateProvider</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  327. </li>
  328. </ul>
  329. </li>
  330. <li class="nav-group-name">
  331. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  332. <ul class="nav-group-tasks">
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  377. </li>
  378. </ul>
  379. </li>
  380. <li class="nav-group-name">
  381. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  382. <ul class="nav-group-tasks">
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  388. </li>
  389. <li class="nav-group-task">
  390. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  391. </li>
  392. <li class="nav-group-task">
  393. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. </nav>
  399. <article class="main-content">
  400. <section class="section">
  401. <div class="section-content">
  402. <h1>DownloadRequest</h1>
  403. <div class="declaration">
  404. <div class="language">
  405. <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>
  406. </div>
  407. </div>
  408. <p>Undocumented</p>
  409. </div>
  410. </section>
  411. <section class="section">
  412. <div class="section-content">
  413. <div class="task-group">
  414. <ul class="item-container">
  415. <li class="item">
  416. <div>
  417. <code>
  418. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  419. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  420. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  421. </code>
  422. </div>
  423. <div class="height-container">
  424. <div class="pointer-container"></div>
  425. <section class="section">
  426. <div class="pointer"></div>
  427. <div class="abstract">
  428. <p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the
  429. destination URL.</p>
  430. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  431. </div>
  432. <div class="declaration">
  433. <h4>Declaration</h4>
  434. <div class="language">
  435. <p class="aside-title">Swift</p>
  436. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Options</span> <span class="p">:</span> <span class="kt">OptionSet</span></code></pre>
  437. </div>
  438. </div>
  439. </section>
  440. </div>
  441. </li>
  442. <li class="item">
  443. <div>
  444. <code>
  445. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  446. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  447. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  448. </code>
  449. </div>
  450. <div class="height-container">
  451. <div class="pointer-container"></div>
  452. <section class="section">
  453. <div class="pointer"></div>
  454. <div class="abstract">
  455. <p>A closure executed once a download request has successfully completed in order to determine where to move the
  456. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  457. and the URL response, and returns a two arguments: the file URL where the temporary file should be moved and
  458. the options defining how the file should be moved.</p>
  459. </div>
  460. <div class="declaration">
  461. <h4>Declaration</h4>
  462. <div class="language">
  463. <p class="aside-title">Swift</p>
  464. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Destination</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/Options.html">Options</a></span><span class="p">)</span></code></pre>
  465. </div>
  466. </div>
  467. </section>
  468. </div>
  469. </li>
  470. </ul>
  471. </div>
  472. <div class="task-group">
  473. <div class="task-name-container">
  474. <a name="/Destination"></a>
  475. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  476. <a href="#/Destination">
  477. <h3 class="section-name">Destination</h3>
  478. </a>
  479. </div>
  480. <ul class="item-container">
  481. <li class="item">
  482. <div>
  483. <code>
  484. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  485. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  486. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:in:options:)</a>
  487. </code>
  488. </div>
  489. <div class="height-container">
  490. <div class="pointer-container"></div>
  491. <section class="section">
  492. <div class="pointer"></div>
  493. <div class="abstract">
  494. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  495. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  496. </div>
  497. <div class="declaration">
  498. <h4>Declaration</h4>
  499. <div class="language">
  500. <p class="aside-title">Swift</p>
  501. <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>
  502. <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>
  503. <span class="nv">options</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Options.html">Options</a></span> <span class="o">=</span> <span class="p">[])</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></span></code></pre>
  504. </div>
  505. </div>
  506. <div>
  507. <h4>Parameters</h4>
  508. <table class="graybox">
  509. <tbody>
  510. <tr>
  511. <td>
  512. <code>
  513. <em>directory</em>
  514. </code>
  515. </td>
  516. <td>
  517. <div>
  518. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  519. </div>
  520. </td>
  521. </tr>
  522. <tr>
  523. <td>
  524. <code>
  525. <em>domain</em>
  526. </code>
  527. </td>
  528. <td>
  529. <div>
  530. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  531. </div>
  532. </td>
  533. </tr>
  534. </tbody>
  535. </table>
  536. </div>
  537. <div>
  538. <h4>Return Value</h4>
  539. <p>A download file destination closure.</p>
  540. </div>
  541. </section>
  542. </div>
  543. </li>
  544. <li class="item">
  545. <div>
  546. <code>
  547. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  548. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  549. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  550. </code>
  551. </div>
  552. <div class="height-container">
  553. <div class="pointer-container"></div>
  554. <section class="section">
  555. <div class="pointer"></div>
  556. <div class="abstract">
  557. <p>Undocumented</p>
  558. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  559. </div>
  560. <div class="declaration">
  561. <h4>Declaration</h4>
  562. <div class="language">
  563. <p class="aside-title">Swift</p>
  564. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  565. </div>
  566. </div>
  567. </section>
  568. </div>
  569. </li>
  570. </ul>
  571. </div>
  572. <div class="task-group">
  573. <div class="task-name-container">
  574. <a name="/Initial%20State"></a>
  575. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  576. <a href="#/Initial%20State">
  577. <h3 class="section-name">Initial State</h3>
  578. </a>
  579. </div>
  580. <ul class="item-container">
  581. <li class="item">
  582. <div>
  583. <code>
  584. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  585. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  586. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  587. </code>
  588. </div>
  589. <div class="height-container">
  590. <div class="pointer-container"></div>
  591. <section class="section">
  592. <div class="pointer"></div>
  593. <div class="abstract">
  594. <p>Undocumented</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">public</span> <span class="k">let</span> <span class="nv">downloadable</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></span></code></pre>
  601. </div>
  602. </div>
  603. </section>
  604. </div>
  605. </li>
  606. </ul>
  607. </div>
  608. <div class="task-group">
  609. <div class="task-name-container">
  610. <a name="/Updated%20State"></a>
  611. <a name="//apple_ref/swift/Section/Updated State" class="dashAnchor"></a>
  612. <a href="#/Updated%20State">
  613. <h3 class="section-name">Updated State</h3>
  614. </a>
  615. </div>
  616. <ul class="item-container">
  617. <li class="item">
  618. <div>
  619. <code>
  620. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  621. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  622. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  623. </code>
  624. </div>
  625. <div class="height-container">
  626. <div class="pointer-container"></div>
  627. <section class="section">
  628. <div class="pointer"></div>
  629. <div class="abstract">
  630. <p>Undocumented</p>
  631. </div>
  632. <div class="declaration">
  633. <h4>Declaration</h4>
  634. <div class="language">
  635. <p class="aside-title">Swift</p>
  636. <pre class="highlight swift"><code><span class="kd">public</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>
  637. </div>
  638. </div>
  639. </section>
  640. </div>
  641. </li>
  642. <li class="item">
  643. <div>
  644. <code>
  645. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  646. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  647. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  648. </code>
  649. </div>
  650. <div class="height-container">
  651. <div class="pointer-container"></div>
  652. <section class="section">
  653. <div class="pointer"></div>
  654. <div class="abstract">
  655. <p>Undocumented</p>
  656. </div>
  657. <div class="declaration">
  658. <h4>Declaration</h4>
  659. <div class="language">
  660. <p class="aside-title">Swift</p>
  661. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  662. </div>
  663. </div>
  664. </section>
  665. </div>
  666. </li>
  667. </ul>
  668. </div>
  669. <div class="task-group">
  670. <div class="task-name-container">
  671. <a name="/Init"></a>
  672. <a name="//apple_ref/swift/Section/Init" class="dashAnchor"></a>
  673. <a href="#/Init">
  674. <h3 class="section-name">Init</h3>
  675. </a>
  676. </div>
  677. <ul class="item-container">
  678. <li class="item">
  679. <div>
  680. <code>
  681. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  682. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  683. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:using:)</a>
  684. </code>
  685. </div>
  686. <div class="height-container">
  687. <div class="pointer-container"></div>
  688. <section class="section">
  689. <div class="pointer"></div>
  690. <div class="abstract">
  691. <p>Undocumented</p>
  692. </div>
  693. <div class="declaration">
  694. <h4>Declaration</h4>
  695. <div class="language">
  696. <p class="aside-title">Swift</p>
  697. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">task</span><span class="p">(</span><span class="n">forResumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">using</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">URLSessionTask</span></code></pre>
  698. </div>
  699. </div>
  700. </section>
  701. </div>
  702. </li>
  703. <li class="item">
  704. <div>
  705. <code>
  706. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  707. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  708. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  709. </code>
  710. </div>
  711. <div class="height-container">
  712. <div class="pointer-container"></div>
  713. <section class="section">
  714. <div class="pointer"></div>
  715. <div class="abstract">
  716. </div>
  717. <div class="declaration">
  718. <h4>Declaration</h4>
  719. <div class="language">
  720. <p class="aside-title">Swift</p>
  721. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  722. <span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  723. </div>
  724. </div>
  725. </section>
  726. </div>
  727. </li>
  728. <li class="item">
  729. <div>
  730. <code>
  731. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF"></a>
  732. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  733. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF">validate(_:)</a>
  734. </code>
  735. </div>
  736. <div class="height-container">
  737. <div class="pointer-container"></div>
  738. <section class="section">
  739. <div class="pointer"></div>
  740. <div class="abstract">
  741. <p>Validates the request, using the specified closure.</p>
  742. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  743. </div>
  744. <div class="declaration">
  745. <h4>Declaration</h4>
  746. <div class="language">
  747. <p class="aside-title">Swift</p>
  748. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  749. <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>
  750. </div>
  751. </div>
  752. <div>
  753. <h4>Parameters</h4>
  754. <table class="graybox">
  755. <tbody>
  756. <tr>
  757. <td>
  758. <code>
  759. <em>validation</em>
  760. </code>
  761. </td>
  762. <td>
  763. <div>
  764. <p>A closure to validate the request.</p>
  765. </div>
  766. </td>
  767. </tr>
  768. </tbody>
  769. </table>
  770. </div>
  771. <div>
  772. <h4>Return Value</h4>
  773. <p>The request.</p>
  774. </div>
  775. </section>
  776. </div>
  777. </li>
  778. </ul>
  779. </div>
  780. <div class="task-group">
  781. <div class="task-name-container">
  782. <a name="/Default"></a>
  783. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  784. <a href="#/Default">
  785. <h3 class="section-name">Default</h3>
  786. </a>
  787. </div>
  788. <ul class="item-container">
  789. <li class="item">
  790. <div>
  791. <code>
  792. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgGctF"></a>
  793. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  794. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgGctF">response(queue:completionHandler:)</a>
  795. </code>
  796. </div>
  797. <div class="height-container">
  798. <div class="pointer-container"></div>
  799. <section class="section">
  800. <div class="pointer"></div>
  801. <div class="abstract">
  802. <p>Adds a handler to be called once the request has finished.</p>
  803. </div>
  804. <div class="declaration">
  805. <h4>Declaration</h4>
  806. <div class="language">
  807. <p class="aside-title">Swift</p>
  808. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  809. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span>
  810. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  811. <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">URL</span><span class="p">?</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  812. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  813. </div>
  814. </div>
  815. <div>
  816. <h4>Parameters</h4>
  817. <table class="graybox">
  818. <tbody>
  819. <tr>
  820. <td>
  821. <code>
  822. <em>queue</em>
  823. </code>
  824. </td>
  825. <td>
  826. <div>
  827. <p>The queue on which the completion handler is dispatched. Defaults to <code>.main</code>.</p>
  828. </div>
  829. </td>
  830. </tr>
  831. <tr>
  832. <td>
  833. <code>
  834. <em>completionHandler</em>
  835. </code>
  836. </td>
  837. <td>
  838. <div>
  839. <p>The code to be executed once the request has finished.</p>
  840. </div>
  841. </td>
  842. </tr>
  843. </tbody>
  844. </table>
  845. </div>
  846. <div>
  847. <h4>Return Value</h4>
  848. <p>The request.</p>
  849. </div>
  850. </section>
  851. </div>
  852. </li>
  853. <li class="item">
  854. <div>
  855. <code>
  856. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF"></a>
  857. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  858. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzGctAA0bkF8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  859. </code>
  860. </div>
  861. <div class="height-container">
  862. <div class="pointer-container"></div>
  863. <section class="section">
  864. <div class="pointer"></div>
  865. <div class="abstract">
  866. <p>Adds a handler to be called once the request has finished.</p>
  867. </div>
  868. <div class="declaration">
  869. <h4>Declaration</h4>
  870. <div class="language">
  871. <p class="aside-title">Swift</p>
  872. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  873. <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>
  874. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  875. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span>
  876. <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>
  877. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  878. </div>
  879. </div>
  880. <div>
  881. <h4>Parameters</h4>
  882. <table class="graybox">
  883. <tbody>
  884. <tr>
  885. <td>
  886. <code>
  887. <em>queue</em>
  888. </code>
  889. </td>
  890. <td>
  891. <div>
  892. <p>The queue on which the completion handler is dispatched. Defaults to <code>.main</code>.</p>
  893. </div>
  894. </td>
  895. </tr>
  896. <tr>
  897. <td>
  898. <code>
  899. <em>responseSerializer</em>
  900. </code>
  901. </td>
  902. <td>
  903. <div>
  904. <p>The response serializer responsible for serializing the request, response, and data
  905. contained in the destination url.</p>
  906. </div>
  907. </td>
  908. </tr>
  909. <tr>
  910. <td>
  911. <code>
  912. <em>completionHandler</em>
  913. </code>
  914. </td>
  915. <td>
  916. <div>
  917. <p>The code to be executed once the request has finished.</p>
  918. </div>
  919. </td>
  920. </tr>
  921. </tbody>
  922. </table>
  923. </div>
  924. <div>
  925. <h4>Return Value</h4>
  926. <p>The request.</p>
  927. </div>
  928. </section>
  929. </div>
  930. </li>
  931. </ul>
  932. </div>
  933. <div class="task-group">
  934. <div class="task-name-container">
  935. <a name="/Data"></a>
  936. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  937. <a href="#/Data">
  938. <h3 class="section-name">Data</h3>
  939. </a>
  940. </div>
  941. <ul class="item-container">
  942. <li class="item">
  943. <div>
  944. <code>
  945. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VGctF"></a>
  946. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  947. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VGctF">responseData(queue:completionHandler:)</a>
  948. </code>
  949. </div>
  950. <div class="height-container">
  951. <div class="pointer-container"></div>
  952. <section class="section">
  953. <div class="pointer"></div>
  954. <div class="abstract">
  955. <p>Adds a handler to be called once the request has finished.</p>
  956. </div>
  957. <div class="declaration">
  958. <h4>Declaration</h4>
  959. <div class="language">
  960. <p class="aside-title">Swift</p>
  961. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  962. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span>
  963. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  964. <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>
  965. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  966. </div>
  967. </div>
  968. <div>
  969. <h4>Parameters</h4>
  970. <table class="graybox">
  971. <tbody>
  972. <tr>
  973. <td>
  974. <code>
  975. <em>queue</em>
  976. </code>
  977. </td>
  978. <td>
  979. <div>
  980. <p>The queue on which the completion handler is dispatched. Defaults to <code>.main</code>.</p>
  981. </div>
  982. </td>
  983. </tr>
  984. <tr>
  985. <td>
  986. <code>
  987. <em>completionHandler</em>
  988. </code>
  989. </td>
  990. <td>
  991. <div>
  992. <p>The code to be executed once the request has finished.</p>
  993. </div>
  994. </td>
  995. </tr>
  996. </tbody>
  997. </table>
  998. </div>
  999. <div>
  1000. <h4>Return Value</h4>
  1001. <p>The request.</p>
  1002. </div>
  1003. </section>
  1004. </div>
  1005. </li>
  1006. </ul>
  1007. </div>
  1008. <div class="task-group">
  1009. <div class="task-name-container">
  1010. <a name="/String"></a>
  1011. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  1012. <a href="#/String">
  1013. <h3 class="section-name">String</h3>
  1014. </a>
  1015. </div>
  1016. <ul class="item-container">
  1017. <li class="item">
  1018. <div>
  1019. <code>
  1020. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0C_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF"></a>
  1021. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  1022. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0C_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSGctF">responseString(queue:encoding:completionHandler:)</a>
  1023. </code>
  1024. </div>
  1025. <div class="height-container">
  1026. <div class="pointer-container"></div>
  1027. <section class="section">
  1028. <div class="pointer"></div>
  1029. <div class="abstract">
  1030. <p>Adds a handler to be called once the request has finished.</p>
  1031. </div>
  1032. <div class="declaration">
  1033. <h4>Declaration</h4>
  1034. <div class="language">
  1035. <p class="aside-title">Swift</p>
  1036. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1037. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span>
  1038. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1039. <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>
  1040. <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>
  1041. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1042. </div>
  1043. </div>
  1044. <div>
  1045. <h4>Parameters</h4>
  1046. <table class="graybox">
  1047. <tbody>
  1048. <tr>
  1049. <td>
  1050. <code>
  1051. <em>queue</em>
  1052. </code>
  1053. </td>
  1054. <td>
  1055. <div>
  1056. <p>The queue on which the completion handler is dispatched. Defaults to <code>.main</code>.</p>
  1057. </div>
  1058. </td>
  1059. </tr>
  1060. <tr>
  1061. <td>
  1062. <code>
  1063. <em>encoding</em>
  1064. </code>
  1065. </td>
  1066. <td>
  1067. <div>
  1068. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined from
  1069. the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1070. </div>
  1071. </td>
  1072. </tr>
  1073. <tr>
  1074. <td>
  1075. <code>
  1076. <em>completionHandler</em>
  1077. </code>
  1078. </td>
  1079. <td>
  1080. <div>
  1081. <p>A closure to be executed once the request has finished.</p>
  1082. </div>
  1083. </td>
  1084. </tr>
  1085. </tbody>
  1086. </table>
  1087. </div>
  1088. <div>
  1089. <h4>Return Value</h4>
  1090. <p>The request.</p>
  1091. </div>
  1092. </section>
  1093. </div>
  1094. </li>
  1095. </ul>
  1096. </div>
  1097. <div class="task-group">
  1098. <div class="task-name-container">
  1099. <a name="/JSON"></a>
  1100. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1101. <a href="#/JSON">
  1102. <h3 class="section-name">JSON</h3>
  1103. </a>
  1104. </div>
  1105. <ul class="item-container">
  1106. <li class="item">
  1107. <div>
  1108. <code>
  1109. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0C_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF"></a>
  1110. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  1111. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0C_So20NSJSONReadingOptionsVyAA0B8ResponseVyypGctF">responseJSON(queue:options:completionHandler:)</a>
  1112. </code>
  1113. </div>
  1114. <div class="height-container">
  1115. <div class="pointer-container"></div>
  1116. <section class="section">
  1117. <div class="pointer"></div>
  1118. <div class="abstract">
  1119. <p>Adds a handler to be called once the request has finished.</p>
  1120. </div>
  1121. <div class="declaration">
  1122. <h4>Declaration</h4>
  1123. <div class="language">
  1124. <p class="aside-title">Swift</p>
  1125. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1126. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span>
  1127. <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1128. <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>
  1129. <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>
  1130. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1131. </div>
  1132. </div>
  1133. <div>
  1134. <h4>Parameters</h4>
  1135. <table class="graybox">
  1136. <tbody>
  1137. <tr>
  1138. <td>
  1139. <code>
  1140. <em>queue</em>
  1141. </code>
  1142. </td>
  1143. <td>
  1144. <div>
  1145. <p>The queue on which the completion handler is dispatched. Defaults to <code>.main</code>.</p>
  1146. </div>
  1147. </td>
  1148. </tr>
  1149. <tr>
  1150. <td>
  1151. <code>
  1152. <em>options</em>
  1153. </code>
  1154. </td>
  1155. <td>
  1156. <div>
  1157. <p>The JSON serialization reading options. Defaults to <code>.allowFragments</code>.</p>
  1158. </div>
  1159. </td>
  1160. </tr>
  1161. <tr>
  1162. <td>
  1163. <code>
  1164. <em>completionHandler</em>
  1165. </code>
  1166. </td>
  1167. <td>
  1168. <div>
  1169. <p>A closure to be executed once the request has finished.</p>
  1170. </div>
  1171. </td>
  1172. </tr>
  1173. </tbody>
  1174. </table>
  1175. </div>
  1176. <div>
  1177. <h4>Return Value</h4>
  1178. <p>The request.</p>
  1179. </div>
  1180. </section>
  1181. </div>
  1182. </li>
  1183. </ul>
  1184. </div>
  1185. <div class="task-group">
  1186. <ul class="item-container">
  1187. <li class="item">
  1188. <div>
  1189. <code>
  1190. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  1191. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1192. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  1193. </code>
  1194. </div>
  1195. <div class="height-container">
  1196. <div class="pointer-container"></div>
  1197. <section class="section">
  1198. <div class="pointer"></div>
  1199. <div class="abstract">
  1200. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  1201. destination URL, and returns whether the request was valid.</p>
  1202. </div>
  1203. <div class="declaration">
  1204. <h4>Declaration</h4>
  1205. <div class="language">
  1206. <p class="aside-title">Swift</p>
  1207. <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">fileURL</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>
  1208. </div>
  1209. </div>
  1210. </section>
  1211. </div>
  1212. </li>
  1213. <li class="item">
  1214. <div>
  1215. <code>
  1216. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1217. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1218. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:)</a>
  1219. </code>
  1220. </div>
  1221. <div class="height-container">
  1222. <div class="pointer-container"></div>
  1223. <section class="section">
  1224. <div class="pointer"></div>
  1225. <div class="abstract">
  1226. <p>Validates that the response has a status code in the specified sequence.</p>
  1227. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1228. </div>
  1229. <div class="declaration">
  1230. <h4>Declaration</h4>
  1231. <div class="language">
  1232. <p class="aside-title">Swift</p>
  1233. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1234. <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>
  1235. </div>
  1236. </div>
  1237. <div>
  1238. <h4>Parameters</h4>
  1239. <table class="graybox">
  1240. <tbody>
  1241. <tr>
  1242. <td>
  1243. <code>
  1244. <em>range</em>
  1245. </code>
  1246. </td>
  1247. <td>
  1248. <div>
  1249. <p>The range of acceptable status codes.</p>
  1250. </div>
  1251. </td>
  1252. </tr>
  1253. </tbody>
  1254. </table>
  1255. </div>
  1256. <div>
  1257. <h4>Return Value</h4>
  1258. <p>The request.</p>
  1259. </div>
  1260. </section>
  1261. </div>
  1262. </li>
  1263. <li class="item">
  1264. <div>
  1265. <code>
  1266. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1267. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1268. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:)</a>
  1269. </code>
  1270. </div>
  1271. <div class="height-container">
  1272. <div class="pointer-container"></div>
  1273. <section class="section">
  1274. <div class="pointer"></div>
  1275. <div class="abstract">
  1276. <p>Validates that the response has a content type in the specified sequence.</p>
  1277. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1278. </div>
  1279. <div class="declaration">
  1280. <h4>Declaration</h4>
  1281. <div class="language">
  1282. <p class="aside-title">Swift</p>
  1283. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1284. <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="p">:</span> <span class="kt">Sequence</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="kd">@escaping</span> <span class="kd">@autoclosure</span> <span class="p">()</span> <span class="o">-&gt;</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="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>
  1285. </div>
  1286. </div>
  1287. <div>
  1288. <h4>Parameters</h4>
  1289. <table class="graybox">
  1290. <tbody>
  1291. <tr>
  1292. <td>
  1293. <code>
  1294. <em>contentType</em>
  1295. </code>
  1296. </td>
  1297. <td>
  1298. <div>
  1299. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1300. </div>
  1301. </td>
  1302. </tr>
  1303. </tbody>
  1304. </table>
  1305. </div>
  1306. <div>
  1307. <h4>Return Value</h4>
  1308. <p>The request.</p>
  1309. </div>
  1310. </section>
  1311. </div>
  1312. </li>
  1313. <li class="item">
  1314. <div>
  1315. <code>
  1316. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  1317. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1318. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  1319. </code>
  1320. </div>
  1321. <div class="height-container">
  1322. <div class="pointer-container"></div>
  1323. <section class="section">
  1324. <div class="pointer"></div>
  1325. <div class="abstract">
  1326. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1327. type matches any specified in the Accept HTTP header field.</p>
  1328. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1329. </div>
  1330. <div class="declaration">
  1331. <h4>Declaration</h4>
  1332. <div class="language">
  1333. <p class="aside-title">Swift</p>
  1334. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1335. <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>
  1336. </div>
  1337. </div>
  1338. <div>
  1339. <h4>Return Value</h4>
  1340. <p>The request.</p>
  1341. </div>
  1342. </section>
  1343. </div>
  1344. </li>
  1345. </ul>
  1346. </div>
  1347. </div>
  1348. </section>
  1349. </article>
  1350. </div>
  1351. <section class="footer">
  1352. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-03-29)</p>
  1353. <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>
  1354. </section>
  1355. </body>
  1356. </div>
  1357. </html>