DownloadRequest.html 159 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646
  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 5.4.4 Docs
  21. </a>
  22. (97% 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.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  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/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  310. </li>
  311. </ul>
  312. </li>
  313. <li class="nav-group-name">
  314. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  315. <ul class="nav-group-tasks">
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  387. </li>
  388. </ul>
  389. </li>
  390. <li class="nav-group-name">
  391. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  392. <ul class="nav-group-tasks">
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  467. </li>
  468. </ul>
  469. </li>
  470. <li class="nav-group-name">
  471. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  472. <ul class="nav-group-tasks">
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  490. </li>
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  493. </li>
  494. </ul>
  495. </li>
  496. </ul>
  497. </nav>
  498. <article class="main-content">
  499. <section class="section">
  500. <div class="section-content top-matter">
  501. <h1>DownloadRequest</h1>
  502. <div class="declaration">
  503. <div class="language">
  504. <pre class="highlight swift"><code><span class="kd">public</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>
  505. </div>
  506. </div>
  507. <p><code><a href="../Classes/Request.html">Request</a></code> subclass which downloads <code>Data</code> to a file on disk using <code>URLSessionDownloadTask</code>.</p>
  508. </div>
  509. </section>
  510. <section class="section">
  511. <div class="section-content">
  512. <div class="task-group">
  513. <ul class="item-container">
  514. <li class="item">
  515. <div>
  516. <code>
  517. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  518. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  519. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  520. </code>
  521. </div>
  522. <div class="height-container">
  523. <div class="pointer-container"></div>
  524. <section class="section">
  525. <div class="pointer"></div>
  526. <div class="abstract">
  527. <p>A set of options to be executed prior to moving a downloaded file from the temporary <code>URL</code> to the destination
  528. <code>URL</code>.</p>
  529. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  530. </div>
  531. <div class="declaration">
  532. <h4>Declaration</h4>
  533. <div class="language">
  534. <p class="aside-title">Swift</p>
  535. <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>
  536. </div>
  537. </div>
  538. </section>
  539. </div>
  540. </li>
  541. </ul>
  542. </div>
  543. <div class="task-group">
  544. <div class="task-name-container">
  545. <a name="/Destination"></a>
  546. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  547. <div class="section-name-container">
  548. <a class="section-name-link" href="#/Destination"></a>
  549. <h3 class="section-name"><p>Destination</p>
  550. </h3>
  551. </div>
  552. </div>
  553. <ul class="item-container">
  554. <li class="item">
  555. <div>
  556. <code>
  557. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  558. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  559. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  560. </code>
  561. </div>
  562. <div class="height-container">
  563. <div class="pointer-container"></div>
  564. <section class="section">
  565. <div class="pointer"></div>
  566. <div class="abstract">
  567. <p>A closure executed once a <code>DownloadRequest</code> has successfully completed in order to determine where to move the
  568. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  569. and the <code>HTTPURLResponse</code>, and returns two values: the file URL where the temporary file should be moved and
  570. the options defining how the file should be moved.</p>
  571. <div class="aside aside-note">
  572. <p class="aside-title">Note</p>
  573. Downloads from a local <code>file://</code> <code>URL</code>s do not use the <code>Destination</code> closure, as those downloads do not
  574. return an <code>HTTPURLResponse</code>. Instead the file is merely moved within the temporary directory.
  575. </div>
  576. </div>
  577. <div class="declaration">
  578. <h4>Declaration</h4>
  579. <div class="language">
  580. <p class="aside-title">Swift</p>
  581. <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>
  582. <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>
  583. </div>
  584. </div>
  585. </section>
  586. </div>
  587. </li>
  588. <li class="item">
  589. <div>
  590. <code>
  591. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  592. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  593. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:<wbr>in:<wbr>options:<wbr>)</a>
  594. </code>
  595. </div>
  596. <div class="height-container">
  597. <div class="pointer-container"></div>
  598. <section class="section">
  599. <div class="pointer"></div>
  600. <div class="abstract">
  601. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  602. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  603. </div>
  604. <div class="declaration">
  605. <h4>Declaration</h4>
  606. <div class="language">
  607. <p class="aside-title">Swift</p>
  608. <pre class="highlight swift"><code><span class="kd">public</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>
  609. <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>
  610. <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>
  611. </div>
  612. </div>
  613. <div>
  614. <h4>Parameters</h4>
  615. <table class="graybox">
  616. <tbody>
  617. <tr>
  618. <td>
  619. <code>
  620. <em>directory</em>
  621. </code>
  622. </td>
  623. <td>
  624. <div>
  625. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  626. </div>
  627. </td>
  628. </tr>
  629. <tr>
  630. <td>
  631. <code>
  632. <em>domain</em>
  633. </code>
  634. </td>
  635. <td>
  636. <div>
  637. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  638. </div>
  639. </td>
  640. </tr>
  641. <tr>
  642. <td>
  643. <code>
  644. <em>options</em>
  645. </code>
  646. </td>
  647. <td>
  648. <div>
  649. <p><code><a href="../Classes/DownloadRequest/Options.html">DownloadRequest.Options</a></code> used when moving the downloaded file to its destination. None by
  650. default.</p>
  651. </div>
  652. </td>
  653. </tr>
  654. </tbody>
  655. </table>
  656. </div>
  657. <div>
  658. <h4>Return Value</h4>
  659. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></code> closure.</p>
  660. </div>
  661. </section>
  662. </div>
  663. </li>
  664. </ul>
  665. </div>
  666. <div class="task-group">
  667. <div class="task-name-container">
  668. <a name="/Downloadable"></a>
  669. <a name="//apple_ref/swift/Section/Downloadable" class="dashAnchor"></a>
  670. <div class="section-name-container">
  671. <a class="section-name-link" href="#/Downloadable"></a>
  672. <h3 class="section-name"><p>Downloadable</p>
  673. </h3>
  674. </div>
  675. </div>
  676. <ul class="item-container">
  677. <li class="item">
  678. <div>
  679. <code>
  680. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  681. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  682. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  683. </code>
  684. </div>
  685. <div class="height-container">
  686. <div class="pointer-container"></div>
  687. <section class="section">
  688. <div class="pointer"></div>
  689. <div class="abstract">
  690. <p>Type describing the source used to create the underlying <code>URLSessionDownloadTask</code>.</p>
  691. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  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">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  698. </div>
  699. </div>
  700. </section>
  701. </div>
  702. </li>
  703. </ul>
  704. </div>
  705. <div class="task-group">
  706. <div class="task-name-container">
  707. <a name="/Mutable%20State"></a>
  708. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  709. <div class="section-name-container">
  710. <a class="section-name-link" href="#/Mutable%20State"></a>
  711. <h3 class="section-name"><p>Mutable State</p>
  712. </h3>
  713. </div>
  714. </div>
  715. <ul class="item-container">
  716. <li class="item">
  717. <div>
  718. <code>
  719. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  720. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  721. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  722. </code>
  723. </div>
  724. <div class="height-container">
  725. <div class="pointer-container"></div>
  726. <section class="section">
  727. <div class="pointer"></div>
  728. <div class="abstract">
  729. <p>If the download is resumable and is eventually cancelled or fails, this value may be used to resume the download
  730. using the <code>download(resumingWith data:)</code> API.</p>
  731. <div class="aside aside-note">
  732. <p class="aside-title">Note</p>
  733. For more information about <code>resumeData</code>, see <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>.
  734. </div>
  735. </div>
  736. <div class="declaration">
  737. <h4>Declaration</h4>
  738. <div class="language">
  739. <p class="aside-title">Swift</p>
  740. <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>
  741. </div>
  742. </div>
  743. </section>
  744. </div>
  745. </li>
  746. <li class="item">
  747. <div>
  748. <code>
  749. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  750. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  751. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  752. </code>
  753. </div>
  754. <div class="height-container">
  755. <div class="pointer-container"></div>
  756. <section class="section">
  757. <div class="pointer"></div>
  758. <div class="abstract">
  759. <p>If the download is successful, the <code>URL</code> where the file was downloaded.</p>
  760. </div>
  761. <div class="declaration">
  762. <h4>Declaration</h4>
  763. <div class="language">
  764. <p class="aside-title">Swift</p>
  765. <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>
  766. </div>
  767. </div>
  768. </section>
  769. </div>
  770. </li>
  771. </ul>
  772. </div>
  773. <div class="task-group">
  774. <div class="task-name-container">
  775. <a name="/Initial%20State"></a>
  776. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  777. <div class="section-name-container">
  778. <a class="section-name-link" href="#/Initial%20State"></a>
  779. <h3 class="section-name"><p>Initial State</p>
  780. </h3>
  781. </div>
  782. </div>
  783. <ul class="item-container">
  784. <li class="item">
  785. <div>
  786. <code>
  787. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  788. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  789. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  790. </code>
  791. </div>
  792. <div class="height-container">
  793. <div class="pointer-container"></div>
  794. <section class="section">
  795. <div class="pointer"></div>
  796. <div class="abstract">
  797. <p><code><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></code> value used for this instance.</p>
  798. </div>
  799. <div class="declaration">
  800. <h4>Declaration</h4>
  801. <div class="language">
  802. <p class="aside-title">Swift</p>
  803. <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>
  804. </div>
  805. </div>
  806. </section>
  807. </div>
  808. </li>
  809. <li class="item">
  810. <div>
  811. <code>
  812. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  813. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  814. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:<wbr>using:<wbr>)</a>
  815. </code>
  816. </div>
  817. <div class="height-container">
  818. <div class="pointer-container"></div>
  819. <section class="section">
  820. <div class="pointer"></div>
  821. <div class="abstract">
  822. <p>Creates a <code>URLSessionTask</code> from the provided resume data.</p>
  823. </div>
  824. <div class="declaration">
  825. <h4>Declaration</h4>
  826. <div class="language">
  827. <p class="aside-title">Swift</p>
  828. <pre class="highlight swift"><code><span class="kd">public</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>
  829. </div>
  830. </div>
  831. <div>
  832. <h4>Parameters</h4>
  833. <table class="graybox">
  834. <tbody>
  835. <tr>
  836. <td>
  837. <code>
  838. <em>data</em>
  839. </code>
  840. </td>
  841. <td>
  842. <div>
  843. <p><code>Data</code> used to resume the download.</p>
  844. </div>
  845. </td>
  846. </tr>
  847. <tr>
  848. <td>
  849. <code>
  850. <em>session</em>
  851. </code>
  852. </td>
  853. <td>
  854. <div>
  855. <p><code>URLSession</code> used to create the <code>URLSessionTask</code>.</p>
  856. </div>
  857. </td>
  858. </tr>
  859. </tbody>
  860. </table>
  861. </div>
  862. <div>
  863. <h4>Return Value</h4>
  864. <p>The <code>URLSessionTask</code> created.</p>
  865. </div>
  866. </section>
  867. </div>
  868. </li>
  869. <li class="item">
  870. <div>
  871. <code>
  872. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  873. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  874. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  875. </code>
  876. </div>
  877. <div class="height-container">
  878. <div class="pointer-container"></div>
  879. <section class="section">
  880. <div class="pointer"></div>
  881. <div class="abstract">
  882. <p>Cancels the instance. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed or suspended.</p>
  883. <div class="aside aside-note">
  884. <p class="aside-title">Note</p>
  885. <p>This method will NOT produce resume data. If you wish to cancel and produce resume data, use
  886. <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:)</a></code> or <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:)</a></code>.</p>
  887. </div>
  888. </div>
  889. <div class="declaration">
  890. <h4>Declaration</h4>
  891. <div class="language">
  892. <p class="aside-title">Swift</p>
  893. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  894. <span class="k">override</span> <span class="kd">public</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>
  895. </div>
  896. </div>
  897. <div>
  898. <h4>Return Value</h4>
  899. <p>The instance.</p>
  900. </div>
  901. </section>
  902. </div>
  903. </li>
  904. <li class="item">
  905. <div>
  906. <code>
  907. <a name="/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF"></a>
  908. <a name="//apple_ref/swift/Method/cancel(producingResumeData:)" class="dashAnchor"></a>
  909. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:<wbr>)</a>
  910. </code>
  911. </div>
  912. <div class="height-container">
  913. <div class="pointer-container"></div>
  914. <section class="section">
  915. <div class="pointer"></div>
  916. <div class="abstract">
  917. <p>Cancels the instance, optionally producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be
  918. resumed or suspended.</p>
  919. <div class="aside aside-note">
  920. <p class="aside-title">Note</p>
  921. <p>If <code>producingResumeData</code> is <code>true</code>, the <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a></code> property will be populated with any resume data, if
  922. available.</p>
  923. </div>
  924. </div>
  925. <div class="declaration">
  926. <h4>Declaration</h4>
  927. <div class="language">
  928. <p class="aside-title">Swift</p>
  929. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  930. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="n">producingResumeData</span> <span class="nv">shouldProduceResumeData</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  931. </div>
  932. </div>
  933. <div>
  934. <h4>Return Value</h4>
  935. <p>The instance.</p>
  936. </div>
  937. </section>
  938. </div>
  939. </li>
  940. <li class="item">
  941. <div>
  942. <code>
  943. <a name="/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF"></a>
  944. <a name="//apple_ref/swift/Method/cancel(byProducingResumeData:)" class="dashAnchor"></a>
  945. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:<wbr>)</a>
  946. </code>
  947. </div>
  948. <div class="height-container">
  949. <div class="pointer-container"></div>
  950. <section class="section">
  951. <div class="pointer"></div>
  952. <div class="abstract">
  953. <p>Cancels the instance while producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed
  954. or suspended.</p>
  955. <div class="aside aside-note">
  956. <p class="aside-title">Note</p>
  957. <p>The resume data passed to the completion handler will also be available on the instance&rsquo;s <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a></code>
  958. property.</p>
  959. </div>
  960. </div>
  961. <div class="declaration">
  962. <h4>Declaration</h4>
  963. <div class="language">
  964. <p class="aside-title">Swift</p>
  965. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  966. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">(</span><span class="n">byProducingResumeData</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  967. </div>
  968. </div>
  969. <div>
  970. <h4>Parameters</h4>
  971. <table class="graybox">
  972. <tbody>
  973. <tr>
  974. <td>
  975. <code>
  976. <em>completionHandler</em>
  977. </code>
  978. </td>
  979. <td>
  980. <div>
  981. <p>The completion handler that is called when the download has been successfully
  982. cancelled. It is not guaranteed to be called on a particular queue, so you may
  983. want use an appropriate queue to perform your work.</p>
  984. </div>
  985. </td>
  986. </tr>
  987. </tbody>
  988. </table>
  989. </div>
  990. <div>
  991. <h4>Return Value</h4>
  992. <p>The instance.</p>
  993. </div>
  994. </section>
  995. </div>
  996. </li>
  997. <li class="item">
  998. <div>
  999. <code>
  1000. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF"></a>
  1001. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  1002. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF">validate(_:<wbr>)</a>
  1003. </code>
  1004. </div>
  1005. <div class="height-container">
  1006. <div class="pointer-container"></div>
  1007. <section class="section">
  1008. <div class="pointer"></div>
  1009. <div class="abstract">
  1010. <p>Validates the request, using the specified closure.</p>
  1011. <div class="aside aside-note">
  1012. <p class="aside-title">Note</p>
  1013. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1014. </div>
  1015. </div>
  1016. <div class="declaration">
  1017. <h4>Declaration</h4>
  1018. <div class="language">
  1019. <p class="aside-title">Swift</p>
  1020. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1021. <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>
  1022. </div>
  1023. </div>
  1024. <div>
  1025. <h4>Parameters</h4>
  1026. <table class="graybox">
  1027. <tbody>
  1028. <tr>
  1029. <td>
  1030. <code>
  1031. <em>validation</em>
  1032. </code>
  1033. </td>
  1034. <td>
  1035. <div>
  1036. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></code> closure to validate the response.</p>
  1037. </div>
  1038. </td>
  1039. </tr>
  1040. </tbody>
  1041. </table>
  1042. </div>
  1043. <div>
  1044. <h4>Return Value</h4>
  1045. <p>The instance.</p>
  1046. </div>
  1047. </section>
  1048. </div>
  1049. </li>
  1050. </ul>
  1051. </div>
  1052. <div class="task-group">
  1053. <div class="task-name-container">
  1054. <a name="/DataRequest%20%2F%20UploadRequest"></a>
  1055. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  1056. <div class="section-name-container">
  1057. <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
  1058. <h3 class="section-name"><p>DataRequest / UploadRequest</p>
  1059. </h3>
  1060. </div>
  1061. </div>
  1062. <ul class="item-container">
  1063. <li class="item">
  1064. <div>
  1065. <code>
  1066. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF"></a>
  1067. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1068. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1069. </code>
  1070. </div>
  1071. <div class="height-container">
  1072. <div class="pointer-container"></div>
  1073. <section class="section">
  1074. <div class="pointer"></div>
  1075. <div class="abstract">
  1076. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance using the given <code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> and <code>DispatchQueue</code>.</p>
  1077. </div>
  1078. <div class="declaration">
  1079. <h4>Declaration</h4>
  1080. <div class="language">
  1081. <p class="aside-title">Swift</p>
  1082. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1083. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishResponse</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></span><span class="p">,</span> <span class="kt">T</span><span class="o">&gt;</span><span class="p">(</span><span class="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="n">on</span> <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> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span>
  1084. <span class="k">where</span> <span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span> <span class="o">==</span> <span class="kt">T</span></code></pre>
  1085. </div>
  1086. </div>
  1087. <div>
  1088. <h4>Parameters</h4>
  1089. <table class="graybox">
  1090. <tbody>
  1091. <tr>
  1092. <td>
  1093. <code>
  1094. <em>serializer</em>
  1095. </code>
  1096. </td>
  1097. <td>
  1098. <div>
  1099. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> used to serialize the response <code>Data</code> from disk.</p>
  1100. </div>
  1101. </td>
  1102. </tr>
  1103. <tr>
  1104. <td>
  1105. <code>
  1106. <em>queue</em>
  1107. </code>
  1108. </td>
  1109. <td>
  1110. <div>
  1111. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published.<code>.main</code> by default.</p>
  1112. </div>
  1113. </td>
  1114. </tr>
  1115. </tbody>
  1116. </table>
  1117. </div>
  1118. <div>
  1119. <h4>Return Value</h4>
  1120. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1121. </div>
  1122. </section>
  1123. </div>
  1124. </li>
  1125. <li class="item">
  1126. <div>
  1127. <code>
  1128. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF"></a>
  1129. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1130. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1131. </code>
  1132. </div>
  1133. <div class="height-container">
  1134. <div class="pointer-container"></div>
  1135. <section class="section">
  1136. <div class="pointer"></div>
  1137. <div class="abstract">
  1138. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance using the given <code><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code> and
  1139. <code>DispatchQueue</code>.</p>
  1140. </div>
  1141. <div class="declaration">
  1142. <h4>Declaration</h4>
  1143. <div class="language">
  1144. <p class="aside-title">Swift</p>
  1145. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1146. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishResponse</span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></span><span class="p">,</span> <span class="kt">T</span><span class="o">&gt;</span><span class="p">(</span><span class="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span> <span class="n">on</span> <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> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span>
  1147. <span class="k">where</span> <span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span> <span class="o">==</span> <span class="kt">T</span></code></pre>
  1148. </div>
  1149. </div>
  1150. <div>
  1151. <h4>Parameters</h4>
  1152. <table class="graybox">
  1153. <tbody>
  1154. <tr>
  1155. <td>
  1156. <code>
  1157. <em>serializer</em>
  1158. </code>
  1159. </td>
  1160. <td>
  1161. <div>
  1162. <p><code>DownloadResponseSerializer</code> used to serialize the response <code>Data</code> from disk.</p>
  1163. </div>
  1164. </td>
  1165. </tr>
  1166. <tr>
  1167. <td>
  1168. <code>
  1169. <em>queue</em>
  1170. </code>
  1171. </td>
  1172. <td>
  1173. <div>
  1174. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published.<code>.main</code> by default.</p>
  1175. </div>
  1176. </td>
  1177. </tr>
  1178. </tbody>
  1179. </table>
  1180. </div>
  1181. <div>
  1182. <h4>Return Value</h4>
  1183. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1184. </div>
  1185. </section>
  1186. </div>
  1187. </li>
  1188. <li class="item">
  1189. <div>
  1190. <code>
  1191. <a name="/s:9Alamofire15DownloadRequestC10publishURL5queueAA0B17ResponsePublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_tF"></a>
  1192. <a name="//apple_ref/swift/Method/publishURL(queue:)" class="dashAnchor"></a>
  1193. <a class="token" href="#/s:9Alamofire15DownloadRequestC10publishURL5queueAA0B17ResponsePublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_tF">publishURL(queue:<wbr>)</a>
  1194. </code>
  1195. </div>
  1196. <div class="height-container">
  1197. <div class="pointer-container"></div>
  1198. <section class="section">
  1199. <div class="pointer"></div>
  1200. <div class="abstract">
  1201. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a></code> to serialize the
  1202. response.</p>
  1203. </div>
  1204. <div class="declaration">
  1205. <h4>Declaration</h4>
  1206. <div class="language">
  1207. <p class="aside-title">Swift</p>
  1208. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1209. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishURL</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="o">.</span><span class="n">main</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="o">&gt;</span></code></pre>
  1210. </div>
  1211. </div>
  1212. <div>
  1213. <h4>Parameters</h4>
  1214. <table class="graybox">
  1215. <tbody>
  1216. <tr>
  1217. <td>
  1218. <code>
  1219. <em>queue</em>
  1220. </code>
  1221. </td>
  1222. <td>
  1223. <div>
  1224. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published. <code>.main</code> by default.</p>
  1225. </div>
  1226. </td>
  1227. </tr>
  1228. </tbody>
  1229. </table>
  1230. </div>
  1231. <div>
  1232. <h4>Return Value</h4>
  1233. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1234. </div>
  1235. </section>
  1236. </div>
  1237. </li>
  1238. <li class="item">
  1239. <div>
  1240. <code>
  1241. <a name="/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF"></a>
  1242. <a name="//apple_ref/swift/Method/publishData(queue:preprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1243. <a class="token" href="#/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF">publishData(queue:<wbr>preprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1244. </code>
  1245. </div>
  1246. <div class="height-container">
  1247. <div class="pointer-container"></div>
  1248. <section class="section">
  1249. <div class="pointer"></div>
  1250. <div class="abstract">
  1251. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to serialize the
  1252. response.</p>
  1253. </div>
  1254. <div class="declaration">
  1255. <h4>Declaration</h4>
  1256. <div class="language">
  1257. <p class="aside-title">Swift</p>
  1258. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1259. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishData</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="o">.</span><span class="n">main</span><span class="p">,</span>
  1260. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1261. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1262. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  1263. </div>
  1264. </div>
  1265. <div>
  1266. <h4>Parameters</h4>
  1267. <table class="graybox">
  1268. <tbody>
  1269. <tr>
  1270. <td>
  1271. <code>
  1272. <em>queue</em>
  1273. </code>
  1274. </td>
  1275. <td>
  1276. <div>
  1277. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published. <code>.main</code> by default.</p>
  1278. </div>
  1279. </td>
  1280. </tr>
  1281. <tr>
  1282. <td>
  1283. <code>
  1284. <em>preprocessor</em>
  1285. </code>
  1286. </td>
  1287. <td>
  1288. <div>
  1289. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1290. by default.</p>
  1291. </div>
  1292. </td>
  1293. </tr>
  1294. <tr>
  1295. <td>
  1296. <code>
  1297. <em>emptyResponseCodes</em>
  1298. </code>
  1299. </td>
  1300. <td>
  1301. <div>
  1302. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1303. default.</p>
  1304. </div>
  1305. </td>
  1306. </tr>
  1307. <tr>
  1308. <td>
  1309. <code>
  1310. <em>emptyRequestMethods</em>
  1311. </code>
  1312. </td>
  1313. <td>
  1314. <div>
  1315. <p><code>Set&lt;HTTPMethod&gt;</code> of <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are allowed, regardless of
  1316. status code. <code>[.head]</code> by default.</p>
  1317. </div>
  1318. </td>
  1319. </tr>
  1320. </tbody>
  1321. </table>
  1322. </div>
  1323. <div>
  1324. <h4>Return Value</h4>
  1325. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1326. </div>
  1327. </section>
  1328. </div>
  1329. </li>
  1330. <li class="item">
  1331. <div>
  1332. <code>
  1333. <a name="/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  1334. <a name="//apple_ref/swift/Method/publishString(queue:preprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1335. <a class="token" href="#/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">publishString(queue:<wbr>preprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1336. </code>
  1337. </div>
  1338. <div class="height-container">
  1339. <div class="pointer-container"></div>
  1340. <section class="section">
  1341. <div class="pointer"></div>
  1342. <div class="abstract">
  1343. <p>Creates a <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to serialize the
  1344. response.</p>
  1345. </div>
  1346. <div class="declaration">
  1347. <h4>Declaration</h4>
  1348. <div class="language">
  1349. <p class="aside-title">Swift</p>
  1350. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1351. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishString</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="o">.</span><span class="n">main</span><span class="p">,</span>
  1352. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1353. <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>
  1354. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1355. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  1356. </div>
  1357. </div>
  1358. <div>
  1359. <h4>Parameters</h4>
  1360. <table class="graybox">
  1361. <tbody>
  1362. <tr>
  1363. <td>
  1364. <code>
  1365. <em>queue</em>
  1366. </code>
  1367. </td>
  1368. <td>
  1369. <div>
  1370. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DataResponse.html">DataResponse</a></code> will be published. <code>.main</code> by default.</p>
  1371. </div>
  1372. </td>
  1373. </tr>
  1374. <tr>
  1375. <td>
  1376. <code>
  1377. <em>preprocessor</em>
  1378. </code>
  1379. </td>
  1380. <td>
  1381. <div>
  1382. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1383. by default.</p>
  1384. </div>
  1385. </td>
  1386. </tr>
  1387. <tr>
  1388. <td>
  1389. <code>
  1390. <em>encoding</em>
  1391. </code>
  1392. </td>
  1393. <td>
  1394. <div>
  1395. <p><code>String.Encoding</code> to parse the response. <code>nil</code> by default, in which case the encoding
  1396. will be determined by the server response, falling back to the default HTTP character
  1397. set, <code>ISO-8859-1</code>.</p>
  1398. </div>
  1399. </td>
  1400. </tr>
  1401. <tr>
  1402. <td>
  1403. <code>
  1404. <em>emptyResponseCodes</em>
  1405. </code>
  1406. </td>
  1407. <td>
  1408. <div>
  1409. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1410. default.</p>
  1411. </div>
  1412. </td>
  1413. </tr>
  1414. <tr>
  1415. <td>
  1416. <code>
  1417. <em>emptyRequestMethods</em>
  1418. </code>
  1419. </td>
  1420. <td>
  1421. <div>
  1422. <p><code>Set&lt;HTTPMethod&gt;</code> of <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are allowed, regardless of
  1423. status code. <code>[.head]</code> by default.</p>
  1424. </div>
  1425. </td>
  1426. </tr>
  1427. </tbody>
  1428. </table>
  1429. </div>
  1430. <div>
  1431. <h4>Return Value</h4>
  1432. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1433. </div>
  1434. </section>
  1435. </div>
  1436. </li>
  1437. <li class="item">
  1438. <div>
  1439. <code>
  1440. <a name="/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1441. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyResponseMethods:)" class="dashAnchor"></a>
  1442. <a class="token" href="#/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">publishDecodable(type:<wbr>queue:<wbr>preprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyResponseMethods:<wbr>)</a>
  1443. </code>
  1444. </div>
  1445. <div class="height-container">
  1446. <div class="pointer-container"></div>
  1447. <section class="section">
  1448. <div class="pointer"></div>
  1449. <div class="abstract">
  1450. <p>Creates a <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to serialize the
  1451. response.</p>
  1452. </div>
  1453. <div class="declaration">
  1454. <h4>Declaration</h4>
  1455. <div class="language">
  1456. <p class="aside-title">Swift</p>
  1457. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1458. <span class="kd">public</span> <span class="kd">func</span> <span class="n">publishDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1459. <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>
  1460. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1461. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  1462. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1463. <span class="nv">emptyResponseMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span></code></pre>
  1464. </div>
  1465. </div>
  1466. <div>
  1467. <h4>Parameters</h4>
  1468. <table class="graybox">
  1469. <tbody>
  1470. <tr>
  1471. <td>
  1472. <code>
  1473. <em>type</em>
  1474. </code>
  1475. </td>
  1476. <td>
  1477. <div>
  1478. <p><code>Decodable</code> type to which to decode response <code>Data</code>. Inferred from the context by default.</p>
  1479. </div>
  1480. </td>
  1481. </tr>
  1482. <tr>
  1483. <td>
  1484. <code>
  1485. <em>queue</em>
  1486. </code>
  1487. </td>
  1488. <td>
  1489. <div>
  1490. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DataResponse.html">DataResponse</a></code> will be published. <code>.main</code> by default.</p>
  1491. </div>
  1492. </td>
  1493. </tr>
  1494. <tr>
  1495. <td>
  1496. <code>
  1497. <em>preprocessor</em>
  1498. </code>
  1499. </td>
  1500. <td>
  1501. <div>
  1502. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1503. by default.</p>
  1504. </div>
  1505. </td>
  1506. </tr>
  1507. <tr>
  1508. <td>
  1509. <code>
  1510. <em>decoder</em>
  1511. </code>
  1512. </td>
  1513. <td>
  1514. <div>
  1515. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode response <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  1516. </div>
  1517. </td>
  1518. </tr>
  1519. <tr>
  1520. <td>
  1521. <code>
  1522. <em>emptyResponseCodes</em>
  1523. </code>
  1524. </td>
  1525. <td>
  1526. <div>
  1527. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1528. default.</p>
  1529. </div>
  1530. </td>
  1531. </tr>
  1532. <tr>
  1533. <td>
  1534. <code>
  1535. <em>emptyRequestMethods</em>
  1536. </code>
  1537. </td>
  1538. <td>
  1539. <div>
  1540. <p><code>Set&lt;HTTPMethod&gt;</code> of <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are allowed, regardless of
  1541. status code. <code>[.head]</code> by default.</p>
  1542. </div>
  1543. </td>
  1544. </tr>
  1545. </tbody>
  1546. </table>
  1547. </div>
  1548. <div>
  1549. <h4>Return Value</h4>
  1550. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1551. </div>
  1552. </section>
  1553. </div>
  1554. </li>
  1555. <li class="item">
  1556. <div>
  1557. <code>
  1558. <a name="/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF"></a>
  1559. <a name="//apple_ref/swift/Method/publishUnserialized(on:)" class="dashAnchor"></a>
  1560. <a class="token" href="#/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF">publishUnserialized(on:<wbr>)</a>
  1561. </code>
  1562. </div>
  1563. <div class="height-container">
  1564. <div class="pointer-container"></div>
  1565. <section class="section">
  1566. <div class="pointer"></div>
  1567. <div class="abstract">
  1568. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance which does not serialize the response before publishing.</p>
  1569. </div>
  1570. <div class="declaration">
  1571. <h4>Declaration</h4>
  1572. <div class="language">
  1573. <p class="aside-title">Swift</p>
  1574. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1575. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">publishUnserialized</span><span class="p">(</span><span class="n">on</span> <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> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="p">?</span><span class="o">&gt;</span></code></pre>
  1576. </div>
  1577. </div>
  1578. <div>
  1579. <h4>Parameters</h4>
  1580. <table class="graybox">
  1581. <tbody>
  1582. <tr>
  1583. <td>
  1584. <code>
  1585. <em>queue</em>
  1586. </code>
  1587. </td>
  1588. <td>
  1589. <div>
  1590. <p><code>DispatchQueue</code> on which the <code><a href="../Structs/DownloadResponse.html">DownloadResponse</a></code> will be published. <code>.main</code> by default.</p>
  1591. </div>
  1592. </td>
  1593. </tr>
  1594. </tbody>
  1595. </table>
  1596. </div>
  1597. <div>
  1598. <h4>Return Value</h4>
  1599. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1600. </div>
  1601. </section>
  1602. </div>
  1603. </li>
  1604. </ul>
  1605. </div>
  1606. <div class="task-group">
  1607. <div class="task-name-container">
  1608. <a name="/Default"></a>
  1609. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  1610. <div class="section-name-container">
  1611. <a class="section-name-link" href="#/Default"></a>
  1612. <h3 class="section-name"><p>Default</p>
  1613. </h3>
  1614. </div>
  1615. </div>
  1616. <ul class="item-container">
  1617. <li class="item">
  1618. <div>
  1619. <code>
  1620. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF"></a>
  1621. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  1622. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF">response(queue:<wbr>completionHandler:<wbr>)</a>
  1623. </code>
  1624. </div>
  1625. <div class="height-container">
  1626. <div class="pointer-container"></div>
  1627. <section class="section">
  1628. <div class="pointer"></div>
  1629. <div class="abstract">
  1630. <p>Adds a handler to be called once the request has finished.</p>
  1631. </div>
  1632. <div class="declaration">
  1633. <h4>Declaration</h4>
  1634. <div class="language">
  1635. <p class="aside-title">Swift</p>
  1636. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1637. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1638. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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>
  1639. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1640. </div>
  1641. </div>
  1642. <div>
  1643. <h4>Parameters</h4>
  1644. <table class="graybox">
  1645. <tbody>
  1646. <tr>
  1647. <td>
  1648. <code>
  1649. <em>queue</em>
  1650. </code>
  1651. </td>
  1652. <td>
  1653. <div>
  1654. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1655. </div>
  1656. </td>
  1657. </tr>
  1658. <tr>
  1659. <td>
  1660. <code>
  1661. <em>completionHandler</em>
  1662. </code>
  1663. </td>
  1664. <td>
  1665. <div>
  1666. <p>The code to be executed once the request has finished.</p>
  1667. </div>
  1668. </td>
  1669. </tr>
  1670. </tbody>
  1671. </table>
  1672. </div>
  1673. <div>
  1674. <h4>Return Value</h4>
  1675. <p>The request.</p>
  1676. </div>
  1677. </section>
  1678. </div>
  1679. </li>
  1680. <li class="item">
  1681. <div>
  1682. <code>
  1683. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  1684. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  1685. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  1686. </code>
  1687. </div>
  1688. <div class="height-container">
  1689. <div class="pointer-container"></div>
  1690. <section class="section">
  1691. <div class="pointer"></div>
  1692. <div class="abstract">
  1693. <p>Adds a handler to be called once the request has finished.</p>
  1694. </div>
  1695. <div class="declaration">
  1696. <h4>Declaration</h4>
  1697. <div class="language">
  1698. <p class="aside-title">Swift</p>
  1699. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1700. <span class="kd">public</span> <span class="kd">func</span> <span class="n">response</span><span class="o">&lt;</span><span class="kt">Serializer</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><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>
  1701. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  1702. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">Serializer</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>
  1703. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1704. </div>
  1705. </div>
  1706. <div>
  1707. <h4>Parameters</h4>
  1708. <table class="graybox">
  1709. <tbody>
  1710. <tr>
  1711. <td>
  1712. <code>
  1713. <em>queue</em>
  1714. </code>
  1715. </td>
  1716. <td>
  1717. <div>
  1718. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1719. </div>
  1720. </td>
  1721. </tr>
  1722. <tr>
  1723. <td>
  1724. <code>
  1725. <em>responseSerializer</em>
  1726. </code>
  1727. </td>
  1728. <td>
  1729. <div>
  1730. <p>The response serializer responsible for serializing the request, response, and data
  1731. contained in the destination <code>URL</code>.</p>
  1732. </div>
  1733. </td>
  1734. </tr>
  1735. <tr>
  1736. <td>
  1737. <code>
  1738. <em>completionHandler</em>
  1739. </code>
  1740. </td>
  1741. <td>
  1742. <div>
  1743. <p>The code to be executed once the request has finished.</p>
  1744. </div>
  1745. </td>
  1746. </tr>
  1747. </tbody>
  1748. </table>
  1749. </div>
  1750. <div>
  1751. <h4>Return Value</h4>
  1752. <p>The request.</p>
  1753. </div>
  1754. </section>
  1755. </div>
  1756. </li>
  1757. </ul>
  1758. </div>
  1759. <div class="task-group">
  1760. <div class="task-name-container">
  1761. <a name="/URL"></a>
  1762. <a name="//apple_ref/swift/Section/URL" class="dashAnchor"></a>
  1763. <div class="section-name-container">
  1764. <a class="section-name-link" href="#/URL"></a>
  1765. <h3 class="section-name"><p>URL</p>
  1766. </h3>
  1767. </div>
  1768. </div>
  1769. <ul class="item-container">
  1770. <li class="item">
  1771. <div>
  1772. <code>
  1773. <a name="/s:9Alamofire15DownloadRequestC11responseURL5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF"></a>
  1774. <a name="//apple_ref/swift/Method/responseURL(queue:completionHandler:)" class="dashAnchor"></a>
  1775. <a class="token" href="#/s:9Alamofire15DownloadRequestC11responseURL5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF">responseURL(queue:<wbr>completionHandler:<wbr>)</a>
  1776. </code>
  1777. </div>
  1778. <div class="height-container">
  1779. <div class="pointer-container"></div>
  1780. <section class="section">
  1781. <div class="pointer"></div>
  1782. <div class="abstract">
  1783. <p>Adds a handler using a <code><a href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a></code> to be called once the request is finished.</p>
  1784. </div>
  1785. <div class="declaration">
  1786. <h4>Declaration</h4>
  1787. <div class="language">
  1788. <p class="aside-title">Swift</p>
  1789. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1790. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseURL</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="o">.</span><span class="n">main</span><span class="p">,</span>
  1791. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1792. </div>
  1793. </div>
  1794. <div>
  1795. <h4>Parameters</h4>
  1796. <table class="graybox">
  1797. <tbody>
  1798. <tr>
  1799. <td>
  1800. <code>
  1801. <em>queue</em>
  1802. </code>
  1803. </td>
  1804. <td>
  1805. <div>
  1806. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  1807. </div>
  1808. </td>
  1809. </tr>
  1810. <tr>
  1811. <td>
  1812. <code>
  1813. <em>completionHandler</em>
  1814. </code>
  1815. </td>
  1816. <td>
  1817. <div>
  1818. <p>A closure to be executed once the request has finished.</p>
  1819. </div>
  1820. </td>
  1821. </tr>
  1822. </tbody>
  1823. </table>
  1824. </div>
  1825. <div>
  1826. <h4>Return Value</h4>
  1827. <p>The request.</p>
  1828. </div>
  1829. </section>
  1830. </div>
  1831. </li>
  1832. </ul>
  1833. </div>
  1834. <div class="task-group">
  1835. <div class="task-name-container">
  1836. <a name="/Data"></a>
  1837. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  1838. <div class="section-name-container">
  1839. <a class="section-name-link" href="#/Data"></a>
  1840. <h3 class="section-name"><p>Data</p>
  1841. </h3>
  1842. </div>
  1843. </div>
  1844. <ul class="item-container">
  1845. <li class="item">
  1846. <div>
  1847. <code>
  1848. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF"></a>
  1849. <a name="//apple_ref/swift/Method/responseData(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1850. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF">responseData(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  1851. </code>
  1852. </div>
  1853. <div class="height-container">
  1854. <div class="pointer-container"></div>
  1855. <section class="section">
  1856. <div class="pointer"></div>
  1857. <div class="abstract">
  1858. <p>Adds a handler using a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to be called once the request has finished.</p>
  1859. </div>
  1860. <div class="declaration">
  1861. <h4>Declaration</h4>
  1862. <div class="language">
  1863. <p class="aside-title">Swift</p>
  1864. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1865. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseData</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1866. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1867. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1868. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  1869. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1870. </div>
  1871. </div>
  1872. <div>
  1873. <h4>Parameters</h4>
  1874. <table class="graybox">
  1875. <tbody>
  1876. <tr>
  1877. <td>
  1878. <code>
  1879. <em>queue</em>
  1880. </code>
  1881. </td>
  1882. <td>
  1883. <div>
  1884. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  1885. </div>
  1886. </td>
  1887. </tr>
  1888. <tr>
  1889. <td>
  1890. <code>
  1891. <em>dataPreprocessor</em>
  1892. </code>
  1893. </td>
  1894. <td>
  1895. <div>
  1896. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1897. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1898. </div>
  1899. </td>
  1900. </tr>
  1901. <tr>
  1902. <td>
  1903. <code>
  1904. <em>emptyResponseCodes</em>
  1905. </code>
  1906. </td>
  1907. <td>
  1908. <div>
  1909. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1910. </div>
  1911. </td>
  1912. </tr>
  1913. <tr>
  1914. <td>
  1915. <code>
  1916. <em>emptyRequestMethods</em>
  1917. </code>
  1918. </td>
  1919. <td>
  1920. <div>
  1921. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1922. </div>
  1923. </td>
  1924. </tr>
  1925. <tr>
  1926. <td>
  1927. <code>
  1928. <em>completionHandler</em>
  1929. </code>
  1930. </td>
  1931. <td>
  1932. <div>
  1933. <p>A closure to be executed once the request has finished.</p>
  1934. </div>
  1935. </td>
  1936. </tr>
  1937. </tbody>
  1938. </table>
  1939. </div>
  1940. <div>
  1941. <h4>Return Value</h4>
  1942. <p>The request.</p>
  1943. </div>
  1944. </section>
  1945. </div>
  1946. </li>
  1947. </ul>
  1948. </div>
  1949. <div class="task-group">
  1950. <div class="task-name-container">
  1951. <a name="/String"></a>
  1952. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  1953. <div class="section-name-container">
  1954. <a class="section-name-link" href="#/String"></a>
  1955. <h3 class="section-name"><p>String</p>
  1956. </h3>
  1957. </div>
  1958. </div>
  1959. <ul class="item-container">
  1960. <li class="item">
  1961. <div>
  1962. <code>
  1963. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF"></a>
  1964. <a name="//apple_ref/swift/Method/responseString(queue:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1965. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF">responseString(queue:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  1966. </code>
  1967. </div>
  1968. <div class="height-container">
  1969. <div class="pointer-container"></div>
  1970. <section class="section">
  1971. <div class="pointer"></div>
  1972. <div class="abstract">
  1973. <p>Adds a handler using a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to be called once the request has finished.</p>
  1974. </div>
  1975. <div class="declaration">
  1976. <h4>Declaration</h4>
  1977. <div class="language">
  1978. <p class="aside-title">Swift</p>
  1979. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1980. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseString</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  1981. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1982. <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>
  1983. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1984. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  1985. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1986. </div>
  1987. </div>
  1988. <div>
  1989. <h4>Parameters</h4>
  1990. <table class="graybox">
  1991. <tbody>
  1992. <tr>
  1993. <td>
  1994. <code>
  1995. <em>queue</em>
  1996. </code>
  1997. </td>
  1998. <td>
  1999. <div>
  2000. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2001. </div>
  2002. </td>
  2003. </tr>
  2004. <tr>
  2005. <td>
  2006. <code>
  2007. <em>dataPreprocessor</em>
  2008. </code>
  2009. </td>
  2010. <td>
  2011. <div>
  2012. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2013. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2014. </div>
  2015. </td>
  2016. </tr>
  2017. <tr>
  2018. <td>
  2019. <code>
  2020. <em>encoding</em>
  2021. </code>
  2022. </td>
  2023. <td>
  2024. <div>
  2025. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2026. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2027. </div>
  2028. </td>
  2029. </tr>
  2030. <tr>
  2031. <td>
  2032. <code>
  2033. <em>emptyResponseCodes</em>
  2034. </code>
  2035. </td>
  2036. <td>
  2037. <div>
  2038. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2039. </div>
  2040. </td>
  2041. </tr>
  2042. <tr>
  2043. <td>
  2044. <code>
  2045. <em>emptyRequestMethods</em>
  2046. </code>
  2047. </td>
  2048. <td>
  2049. <div>
  2050. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2051. </div>
  2052. </td>
  2053. </tr>
  2054. <tr>
  2055. <td>
  2056. <code>
  2057. <em>completionHandler</em>
  2058. </code>
  2059. </td>
  2060. <td>
  2061. <div>
  2062. <p>A closure to be executed once the request has finished.</p>
  2063. </div>
  2064. </td>
  2065. </tr>
  2066. </tbody>
  2067. </table>
  2068. </div>
  2069. <div>
  2070. <h4>Return Value</h4>
  2071. <p>The request.</p>
  2072. </div>
  2073. </section>
  2074. </div>
  2075. </li>
  2076. </ul>
  2077. </div>
  2078. <div class="task-group">
  2079. <div class="task-name-container">
  2080. <a name="/JSON"></a>
  2081. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  2082. <div class="section-name-container">
  2083. <a class="section-name-link" href="#/JSON"></a>
  2084. <h3 class="section-name"><p>JSON</p>
  2085. </h3>
  2086. </div>
  2087. </div>
  2088. <ul class="item-container">
  2089. <li class="item">
  2090. <div>
  2091. <code>
  2092. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF"></a>
  2093. <a name="//apple_ref/swift/Method/responseJSON(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:options:completionHandler:)" class="dashAnchor"></a>
  2094. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF">responseJSON(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>options:<wbr>completionHandler:<wbr>)</a>
  2095. </code>
  2096. </div>
  2097. <div class="height-container">
  2098. <div class="pointer-container"></div>
  2099. <section class="section">
  2100. <div class="pointer"></div>
  2101. <div class="abstract">
  2102. <p>Adds a handler using a <code><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></code> to be called once the request has finished.</p>
  2103. </div>
  2104. <div class="declaration">
  2105. <h4>Declaration</h4>
  2106. <div class="language">
  2107. <p class="aside-title">Swift</p>
  2108. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2109. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">responseJSON</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span>
  2110. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  2111. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  2112. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  2113. <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>
  2114. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</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> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2115. </div>
  2116. </div>
  2117. <div>
  2118. <h4>Parameters</h4>
  2119. <table class="graybox">
  2120. <tbody>
  2121. <tr>
  2122. <td>
  2123. <code>
  2124. <em>queue</em>
  2125. </code>
  2126. </td>
  2127. <td>
  2128. <div>
  2129. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2130. </div>
  2131. </td>
  2132. </tr>
  2133. <tr>
  2134. <td>
  2135. <code>
  2136. <em>dataPreprocessor</em>
  2137. </code>
  2138. </td>
  2139. <td>
  2140. <div>
  2141. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2142. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2143. </div>
  2144. </td>
  2145. </tr>
  2146. <tr>
  2147. <td>
  2148. <code>
  2149. <em>encoding</em>
  2150. </code>
  2151. </td>
  2152. <td>
  2153. <div>
  2154. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2155. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2156. </div>
  2157. </td>
  2158. </tr>
  2159. <tr>
  2160. <td>
  2161. <code>
  2162. <em>emptyResponseCodes</em>
  2163. </code>
  2164. </td>
  2165. <td>
  2166. <div>
  2167. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2168. </div>
  2169. </td>
  2170. </tr>
  2171. <tr>
  2172. <td>
  2173. <code>
  2174. <em>emptyRequestMethods</em>
  2175. </code>
  2176. </td>
  2177. <td>
  2178. <div>
  2179. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2180. </div>
  2181. </td>
  2182. </tr>
  2183. <tr>
  2184. <td>
  2185. <code>
  2186. <em>options</em>
  2187. </code>
  2188. </td>
  2189. <td>
  2190. <div>
  2191. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  2192. by default.</p>
  2193. </div>
  2194. </td>
  2195. </tr>
  2196. <tr>
  2197. <td>
  2198. <code>
  2199. <em>completionHandler</em>
  2200. </code>
  2201. </td>
  2202. <td>
  2203. <div>
  2204. <p>A closure to be executed once the request has finished.</p>
  2205. </div>
  2206. </td>
  2207. </tr>
  2208. </tbody>
  2209. </table>
  2210. </div>
  2211. <div>
  2212. <h4>Return Value</h4>
  2213. <p>The request.</p>
  2214. </div>
  2215. </section>
  2216. </div>
  2217. </li>
  2218. </ul>
  2219. </div>
  2220. <div class="task-group">
  2221. <div class="task-name-container">
  2222. <a name="/Decodable"></a>
  2223. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  2224. <div class="section-name-container">
  2225. <a class="section-name-link" href="#/Decodable"></a>
  2226. <h3 class="section-name"><p>Decodable</p>
  2227. </h3>
  2228. </div>
  2229. </div>
  2230. <ul class="item-container">
  2231. <li class="item">
  2232. <div>
  2233. <code>
  2234. <a name="/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA04DataI0_pAA0S7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF"></a>
  2235. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2236. <a class="token" href="#/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA04DataI0_pAA0S7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF">responseDecodable(of:<wbr>queue:<wbr>dataPreprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  2237. </code>
  2238. </div>
  2239. <div class="height-container">
  2240. <div class="pointer-container"></div>
  2241. <section class="section">
  2242. <div class="pointer"></div>
  2243. <div class="abstract">
  2244. <p>Adds a handler using a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to be called once the request has finished.</p>
  2245. </div>
  2246. <div class="declaration">
  2247. <h4>Declaration</h4>
  2248. <div class="language">
  2249. <p class="aside-title">Swift</p>
  2250. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2251. <span class="kd">public</span> <span class="kd">func</span> <span class="n">responseDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">of</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  2252. <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>
  2253. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  2254. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  2255. <span class="nv">emptyResponseCodes</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  2256. <span class="nv">emptyRequestMethods</span><span class="p">:</span> <span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span><span class="o">&gt;</span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultEmptyRequestMethods</span><span class="p">,</span>
  2257. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2258. </div>
  2259. </div>
  2260. <div>
  2261. <h4>Parameters</h4>
  2262. <table class="graybox">
  2263. <tbody>
  2264. <tr>
  2265. <td>
  2266. <code>
  2267. <em>type</em>
  2268. </code>
  2269. </td>
  2270. <td>
  2271. <div>
  2272. <p><code>Decodable</code> type to decode from response data.</p>
  2273. </div>
  2274. </td>
  2275. </tr>
  2276. <tr>
  2277. <td>
  2278. <code>
  2279. <em>queue</em>
  2280. </code>
  2281. </td>
  2282. <td>
  2283. <div>
  2284. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2285. </div>
  2286. </td>
  2287. </tr>
  2288. <tr>
  2289. <td>
  2290. <code>
  2291. <em>dataPreprocessor</em>
  2292. </code>
  2293. </td>
  2294. <td>
  2295. <div>
  2296. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2297. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2298. </div>
  2299. </td>
  2300. </tr>
  2301. <tr>
  2302. <td>
  2303. <code>
  2304. <em>decoder</em>
  2305. </code>
  2306. </td>
  2307. <td>
  2308. <div>
  2309. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  2310. </div>
  2311. </td>
  2312. </tr>
  2313. <tr>
  2314. <td>
  2315. <code>
  2316. <em>encoding</em>
  2317. </code>
  2318. </td>
  2319. <td>
  2320. <div>
  2321. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2322. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2323. </div>
  2324. </td>
  2325. </tr>
  2326. <tr>
  2327. <td>
  2328. <code>
  2329. <em>emptyResponseCodes</em>
  2330. </code>
  2331. </td>
  2332. <td>
  2333. <div>
  2334. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2335. </div>
  2336. </td>
  2337. </tr>
  2338. <tr>
  2339. <td>
  2340. <code>
  2341. <em>emptyRequestMethods</em>
  2342. </code>
  2343. </td>
  2344. <td>
  2345. <div>
  2346. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2347. </div>
  2348. </td>
  2349. </tr>
  2350. <tr>
  2351. <td>
  2352. <code>
  2353. <em>options</em>
  2354. </code>
  2355. </td>
  2356. <td>
  2357. <div>
  2358. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  2359. by default.</p>
  2360. </div>
  2361. </td>
  2362. </tr>
  2363. <tr>
  2364. <td>
  2365. <code>
  2366. <em>completionHandler</em>
  2367. </code>
  2368. </td>
  2369. <td>
  2370. <div>
  2371. <p>A closure to be executed once the request has finished.</p>
  2372. </div>
  2373. </td>
  2374. </tr>
  2375. </tbody>
  2376. </table>
  2377. </div>
  2378. <div>
  2379. <h4>Return Value</h4>
  2380. <p>The request.</p>
  2381. </div>
  2382. </section>
  2383. </div>
  2384. </li>
  2385. </ul>
  2386. </div>
  2387. <div class="task-group">
  2388. <ul class="item-container">
  2389. <li class="item">
  2390. <div>
  2391. <code>
  2392. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  2393. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  2394. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  2395. </code>
  2396. </div>
  2397. <div class="height-container">
  2398. <div class="pointer-container"></div>
  2399. <section class="section">
  2400. <div class="pointer"></div>
  2401. <div class="abstract">
  2402. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  2403. destination URL, and returns whether the request was valid.</p>
  2404. </div>
  2405. <div class="declaration">
  2406. <h4>Declaration</h4>
  2407. <div class="language">
  2408. <p class="aside-title">Swift</p>
  2409. <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>
  2410. <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span>
  2411. <span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span>
  2412. <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  2413. </div>
  2414. </div>
  2415. </section>
  2416. </div>
  2417. </li>
  2418. <li class="item">
  2419. <div>
  2420. <code>
  2421. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  2422. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  2423. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  2424. </code>
  2425. </div>
  2426. <div class="height-container">
  2427. <div class="pointer-container"></div>
  2428. <section class="section">
  2429. <div class="pointer"></div>
  2430. <div class="abstract">
  2431. <p>Validates that the response has a status code in the specified sequence.</p>
  2432. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  2433. </div>
  2434. <div class="declaration">
  2435. <h4>Declaration</h4>
  2436. <div class="language">
  2437. <p class="aside-title">Swift</p>
  2438. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2439. <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>
  2440. </div>
  2441. </div>
  2442. <div>
  2443. <h4>Parameters</h4>
  2444. <table class="graybox">
  2445. <tbody>
  2446. <tr>
  2447. <td>
  2448. <code>
  2449. <em>statusCode</em>
  2450. </code>
  2451. </td>
  2452. <td>
  2453. <div>
  2454. <p><code>Sequence</code> of acceptable response status codes.</p>
  2455. </div>
  2456. </td>
  2457. </tr>
  2458. </tbody>
  2459. </table>
  2460. </div>
  2461. <div>
  2462. <h4>Return Value</h4>
  2463. <p>The instance.</p>
  2464. </div>
  2465. </section>
  2466. </div>
  2467. </li>
  2468. <li class="item">
  2469. <div>
  2470. <code>
  2471. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  2472. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  2473. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  2474. </code>
  2475. </div>
  2476. <div class="height-container">
  2477. <div class="pointer-container"></div>
  2478. <section class="section">
  2479. <div class="pointer"></div>
  2480. <div class="abstract">
  2481. <p>Validates that the response has a content type in the specified sequence.</p>
  2482. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  2483. </div>
  2484. <div class="declaration">
  2485. <h4>Declaration</h4>
  2486. <div class="language">
  2487. <p class="aside-title">Swift</p>
  2488. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2489. <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="kd">@autoclosure</span> <span class="kd">@escaping</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="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>
  2490. </div>
  2491. </div>
  2492. <div>
  2493. <h4>Parameters</h4>
  2494. <table class="graybox">
  2495. <tbody>
  2496. <tr>
  2497. <td>
  2498. <code>
  2499. <em>contentType</em>
  2500. </code>
  2501. </td>
  2502. <td>
  2503. <div>
  2504. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  2505. </div>
  2506. </td>
  2507. </tr>
  2508. </tbody>
  2509. </table>
  2510. </div>
  2511. <div>
  2512. <h4>Return Value</h4>
  2513. <p>The request.</p>
  2514. </div>
  2515. </section>
  2516. </div>
  2517. </li>
  2518. <li class="item">
  2519. <div>
  2520. <code>
  2521. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  2522. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  2523. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  2524. </code>
  2525. </div>
  2526. <div class="height-container">
  2527. <div class="pointer-container"></div>
  2528. <section class="section">
  2529. <div class="pointer"></div>
  2530. <div class="abstract">
  2531. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  2532. type matches any specified in the Accept HTTP header field.</p>
  2533. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  2534. </div>
  2535. <div class="declaration">
  2536. <h4>Declaration</h4>
  2537. <div class="language">
  2538. <p class="aside-title">Swift</p>
  2539. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2540. <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>
  2541. </div>
  2542. </div>
  2543. <div>
  2544. <h4>Return Value</h4>
  2545. <p>The request.</p>
  2546. </div>
  2547. </section>
  2548. </div>
  2549. </li>
  2550. </ul>
  2551. </div>
  2552. </div>
  2553. </section>
  2554. </article>
  2555. </div>
  2556. <section class="footer">
  2557. <p>&copy; 2021 <a class="link" href="http://alamofire.org/" target="_blank" rel="noopener" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2021-09-20)</p>
  2558. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
  2559. </section>
  2560. </body>
  2561. </div>
  2562. </html>