DownloadRequest.html 203 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262
  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.5.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  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" alt="Dash"/>
  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" alt=""/>
  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/DataStreamTask.html">DataStreamTask</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  485. </li>
  486. </ul>
  487. </li>
  488. <li class="nav-group-name">
  489. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  490. <ul class="nav-group-tasks">
  491. <li class="nav-group-task">
  492. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  493. </li>
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  511. </li>
  512. </ul>
  513. </li>
  514. </ul>
  515. </nav>
  516. <article class="main-content">
  517. <section class="section">
  518. <div class="section-content top-matter">
  519. <h1>DownloadRequest</h1>
  520. <div class="declaration">
  521. <div class="language">
  522. <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>
  523. </div>
  524. </div>
  525. <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>
  526. </div>
  527. </section>
  528. <section class="section">
  529. <div class="section-content">
  530. <div class="task-group">
  531. <ul class="item-container">
  532. <li class="item">
  533. <div>
  534. <code>
  535. <a name="/s:9Alamofire15DownloadRequestC7OptionsV"></a>
  536. <a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>
  537. <a class="token" href="#/s:9Alamofire15DownloadRequestC7OptionsV">Options</a>
  538. </code>
  539. </div>
  540. <div class="height-container">
  541. <div class="pointer-container"></div>
  542. <section class="section">
  543. <div class="pointer"></div>
  544. <div class="abstract">
  545. <p>A set of options to be executed prior to moving a downloaded file from the temporary <code>URL</code> to the destination
  546. <code>URL</code>.</p>
  547. <a href="../Classes/DownloadRequest/Options.html" class="slightly-smaller">See more</a>
  548. </div>
  549. <div class="declaration">
  550. <h4>Declaration</h4>
  551. <div class="language">
  552. <p class="aside-title">Swift</p>
  553. <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>
  554. </div>
  555. </div>
  556. </section>
  557. </div>
  558. </li>
  559. </ul>
  560. </div>
  561. <div class="task-group">
  562. <div class="task-name-container">
  563. <a name="/Destination"></a>
  564. <a name="//apple_ref/swift/Section/Destination" class="dashAnchor"></a>
  565. <div class="section-name-container">
  566. <a class="section-name-link" href="#/Destination"></a>
  567. <h3 class="section-name"><span>Destination</span>
  568. </h3>
  569. </div>
  570. </div>
  571. <ul class="item-container">
  572. <li class="item">
  573. <div>
  574. <code>
  575. <a name="/s:9Alamofire15DownloadRequestC11Destinationa"></a>
  576. <a name="//apple_ref/swift/Alias/Destination" class="dashAnchor"></a>
  577. <a class="token" href="#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a>
  578. </code>
  579. </div>
  580. <div class="height-container">
  581. <div class="pointer-container"></div>
  582. <section class="section">
  583. <div class="pointer"></div>
  584. <div class="abstract">
  585. <p>A closure executed once a <code>DownloadRequest</code> has successfully completed in order to determine where to move the
  586. temporary file written to during the download process. The closure takes two arguments: the temporary file URL
  587. and the <code>HTTPURLResponse</code>, and returns two values: the file URL where the temporary file should be moved and
  588. the options defining how the file should be moved.</p>
  589. <div class="aside aside-note">
  590. <p class="aside-title">Note</p>
  591. Downloads from a local <code>file://</code> <code>URL</code>s do not use the <code>Destination</code> closure, as those downloads do not
  592. return an <code>HTTPURLResponse</code>. Instead the file is merely moved within the temporary directory.
  593. </div>
  594. </div>
  595. <div class="declaration">
  596. <h4>Declaration</h4>
  597. <div class="language">
  598. <p class="aside-title">Swift</p>
  599. <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>
  600. <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>
  601. </div>
  602. </div>
  603. </section>
  604. </div>
  605. </li>
  606. <li class="item">
  607. <div>
  608. <code>
  609. <a name="/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ"></a>
  610. <a name="//apple_ref/swift/Method/suggestedDownloadDestination(for:in:options:)" class="dashAnchor"></a>
  611. <a class="token" href="#/s:9Alamofire15DownloadRequestC09suggestedB11Destination3for2in7options10Foundation3URLV011destinationJ0_AC7OptionsVAGtAJ_So17NSHTTPURLResponseCtcSo21NSSearchPathDirectoryV_So0nO10DomainMaskVAMtFZ">suggestedDownloadDestination(for:<wbr>in:<wbr>options:<wbr>)</a>
  612. </code>
  613. </div>
  614. <div class="height-container">
  615. <div class="pointer-container"></div>
  616. <section class="section">
  617. <div class="pointer"></div>
  618. <div class="abstract">
  619. <p>Creates a download file destination closure which uses the default file manager to move the temporary file to a
  620. file URL in the first available directory with the specified search path directory and search path domain mask.</p>
  621. </div>
  622. <div class="declaration">
  623. <h4>Declaration</h4>
  624. <div class="language">
  625. <p class="aside-title">Swift</p>
  626. <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>
  627. <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>
  628. <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>
  629. </div>
  630. </div>
  631. <div>
  632. <h4>Parameters</h4>
  633. <table class="graybox">
  634. <tbody>
  635. <tr>
  636. <td>
  637. <code>
  638. <em>directory</em>
  639. </code>
  640. </td>
  641. <td>
  642. <div>
  643. <p>The search path directory. <code>.documentDirectory</code> by default.</p>
  644. </div>
  645. </td>
  646. </tr>
  647. <tr>
  648. <td>
  649. <code>
  650. <em>domain</em>
  651. </code>
  652. </td>
  653. <td>
  654. <div>
  655. <p>The search path domain mask. <code>.userDomainMask</code> by default.</p>
  656. </div>
  657. </td>
  658. </tr>
  659. <tr>
  660. <td>
  661. <code>
  662. <em>options</em>
  663. </code>
  664. </td>
  665. <td>
  666. <div>
  667. <p><code><a href="../Classes/DownloadRequest/Options.html">DownloadRequest.Options</a></code> used when moving the downloaded file to its destination. None by
  668. default.</p>
  669. </div>
  670. </td>
  671. </tr>
  672. </tbody>
  673. </table>
  674. </div>
  675. <div>
  676. <h4>Return Value</h4>
  677. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">Destination</a></code> closure.</p>
  678. </div>
  679. </section>
  680. </div>
  681. </li>
  682. </ul>
  683. </div>
  684. <div class="task-group">
  685. <div class="task-name-container">
  686. <a name="/Downloadable"></a>
  687. <a name="//apple_ref/swift/Section/Downloadable" class="dashAnchor"></a>
  688. <div class="section-name-container">
  689. <a class="section-name-link" href="#/Downloadable"></a>
  690. <h3 class="section-name"><span>Downloadable</span>
  691. </h3>
  692. </div>
  693. </div>
  694. <ul class="item-container">
  695. <li class="item">
  696. <div>
  697. <code>
  698. <a name="/s:9Alamofire15DownloadRequestC12DownloadableO"></a>
  699. <a name="//apple_ref/swift/Enum/Downloadable" class="dashAnchor"></a>
  700. <a class="token" href="#/s:9Alamofire15DownloadRequestC12DownloadableO">Downloadable</a>
  701. </code>
  702. </div>
  703. <div class="height-container">
  704. <div class="pointer-container"></div>
  705. <section class="section">
  706. <div class="pointer"></div>
  707. <div class="abstract">
  708. <p>Type describing the source used to create the underlying <code>URLSessionDownloadTask</code>.</p>
  709. <a href="../Classes/DownloadRequest/Downloadable.html" class="slightly-smaller">See more</a>
  710. </div>
  711. <div class="declaration">
  712. <h4>Declaration</h4>
  713. <div class="language">
  714. <p class="aside-title">Swift</p>
  715. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Downloadable</span></code></pre>
  716. </div>
  717. </div>
  718. </section>
  719. </div>
  720. </li>
  721. </ul>
  722. </div>
  723. <div class="task-group">
  724. <div class="task-name-container">
  725. <a name="/Mutable%20State"></a>
  726. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  727. <div class="section-name-container">
  728. <a class="section-name-link" href="#/Mutable%20State"></a>
  729. <h3 class="section-name"><span>Mutable State</span>
  730. </h3>
  731. </div>
  732. </div>
  733. <ul class="item-container">
  734. <li class="item">
  735. <div>
  736. <code>
  737. <a name="/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp"></a>
  738. <a name="//apple_ref/swift/Property/resumeData" class="dashAnchor"></a>
  739. <a class="token" href="#/s:9Alamofire15DownloadRequestC10resumeData10Foundation0E0VSgvp">resumeData</a>
  740. </code>
  741. </div>
  742. <div class="height-container">
  743. <div class="pointer-container"></div>
  744. <section class="section">
  745. <div class="pointer"></div>
  746. <div class="abstract">
  747. <p>If the download is resumable and is eventually cancelled or fails, this value may be used to resume the download
  748. using the <code>download(resumingWith data:)</code> API.</p>
  749. <div class="aside aside-note">
  750. <p class="aside-title">Note</p>
  751. For more information about <code>resumeData</code>, see <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>.
  752. </div>
  753. </div>
  754. <div class="declaration">
  755. <h4>Declaration</h4>
  756. <div class="language">
  757. <p class="aside-title">Swift</p>
  758. <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>
  759. </div>
  760. </div>
  761. </section>
  762. </div>
  763. </li>
  764. <li class="item">
  765. <div>
  766. <code>
  767. <a name="/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp"></a>
  768. <a name="//apple_ref/swift/Property/fileURL" class="dashAnchor"></a>
  769. <a class="token" href="#/s:9Alamofire15DownloadRequestC7fileURL10Foundation0E0VSgvp">fileURL</a>
  770. </code>
  771. </div>
  772. <div class="height-container">
  773. <div class="pointer-container"></div>
  774. <section class="section">
  775. <div class="pointer"></div>
  776. <div class="abstract">
  777. <p>If the download is successful, the <code>URL</code> where the file was downloaded.</p>
  778. </div>
  779. <div class="declaration">
  780. <h4>Declaration</h4>
  781. <div class="language">
  782. <p class="aside-title">Swift</p>
  783. <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>
  784. </div>
  785. </div>
  786. </section>
  787. </div>
  788. </li>
  789. </ul>
  790. </div>
  791. <div class="task-group">
  792. <div class="task-name-container">
  793. <a name="/Initial%20State"></a>
  794. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  795. <div class="section-name-container">
  796. <a class="section-name-link" href="#/Initial%20State"></a>
  797. <h3 class="section-name"><span>Initial State</span>
  798. </h3>
  799. </div>
  800. </div>
  801. <ul class="item-container">
  802. <li class="item">
  803. <div>
  804. <code>
  805. <a name="/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp"></a>
  806. <a name="//apple_ref/swift/Property/downloadable" class="dashAnchor"></a>
  807. <a class="token" href="#/s:9Alamofire15DownloadRequestC12downloadableAC12DownloadableOvp">downloadable</a>
  808. </code>
  809. </div>
  810. <div class="height-container">
  811. <div class="pointer-container"></div>
  812. <section class="section">
  813. <div class="pointer"></div>
  814. <div class="abstract">
  815. <p><code><a href="../Classes/DownloadRequest/Downloadable.html">Downloadable</a></code> value used for this instance.</p>
  816. </div>
  817. <div class="declaration">
  818. <h4>Declaration</h4>
  819. <div class="language">
  820. <p class="aside-title">Swift</p>
  821. <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>
  822. </div>
  823. </div>
  824. </section>
  825. </div>
  826. </li>
  827. <li class="item">
  828. <div>
  829. <code>
  830. <a name="/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF"></a>
  831. <a name="//apple_ref/swift/Method/task(forResumeData:using:)" class="dashAnchor"></a>
  832. <a class="token" href="#/s:9Alamofire15DownloadRequestC4task13forResumeData5usingSo16NSURLSessionTaskC10Foundation0G0V_So0I0CtF">task(forResumeData:<wbr>using:<wbr>)</a>
  833. </code>
  834. </div>
  835. <div class="height-container">
  836. <div class="pointer-container"></div>
  837. <section class="section">
  838. <div class="pointer"></div>
  839. <div class="abstract">
  840. <p>Creates a <code>URLSessionTask</code> from the provided resume data.</p>
  841. </div>
  842. <div class="declaration">
  843. <h4>Declaration</h4>
  844. <div class="language">
  845. <p class="aside-title">Swift</p>
  846. <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>
  847. </div>
  848. </div>
  849. <div>
  850. <h4>Parameters</h4>
  851. <table class="graybox">
  852. <tbody>
  853. <tr>
  854. <td>
  855. <code>
  856. <em>data</em>
  857. </code>
  858. </td>
  859. <td>
  860. <div>
  861. <p><code>Data</code> used to resume the download.</p>
  862. </div>
  863. </td>
  864. </tr>
  865. <tr>
  866. <td>
  867. <code>
  868. <em>session</em>
  869. </code>
  870. </td>
  871. <td>
  872. <div>
  873. <p><code>URLSession</code> used to create the <code>URLSessionTask</code>.</p>
  874. </div>
  875. </td>
  876. </tr>
  877. </tbody>
  878. </table>
  879. </div>
  880. <div>
  881. <h4>Return Value</h4>
  882. <p>The <code>URLSessionTask</code> created.</p>
  883. </div>
  884. </section>
  885. </div>
  886. </li>
  887. <li class="item">
  888. <div>
  889. <code>
  890. <a name="/s:9Alamofire15DownloadRequestC6cancelACXDyF"></a>
  891. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  892. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancelACXDyF">cancel()</a>
  893. </code>
  894. </div>
  895. <div class="height-container">
  896. <div class="pointer-container"></div>
  897. <section class="section">
  898. <div class="pointer"></div>
  899. <div class="abstract">
  900. <p>Cancels the instance. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed or suspended.</p>
  901. <div class="aside aside-note">
  902. <p class="aside-title">Note</p>
  903. <p>This method will NOT produce resume data. If you wish to cancel and produce resume data, use
  904. <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>
  905. </div>
  906. </div>
  907. <div class="declaration">
  908. <h4>Declaration</h4>
  909. <div class="language">
  910. <p class="aside-title">Swift</p>
  911. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  912. <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>
  913. </div>
  914. </div>
  915. <div>
  916. <h4>Return Value</h4>
  917. <p>The instance.</p>
  918. </div>
  919. </section>
  920. </div>
  921. </li>
  922. <li class="item">
  923. <div>
  924. <code>
  925. <a name="/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF"></a>
  926. <a name="//apple_ref/swift/Method/cancel(producingResumeData:)" class="dashAnchor"></a>
  927. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel19producingResumeDataACXDSb_tF">cancel(producingResumeData:<wbr>)</a>
  928. </code>
  929. </div>
  930. <div class="height-container">
  931. <div class="pointer-container"></div>
  932. <section class="section">
  933. <div class="pointer"></div>
  934. <div class="abstract">
  935. <p>Cancels the instance, optionally producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be
  936. resumed or suspended.</p>
  937. <div class="aside aside-note">
  938. <p class="aside-title">Note</p>
  939. <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
  940. available.</p>
  941. </div>
  942. </div>
  943. <div class="declaration">
  944. <h4>Declaration</h4>
  945. <div class="language">
  946. <p class="aside-title">Swift</p>
  947. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  948. <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>
  949. </div>
  950. </div>
  951. <div>
  952. <h4>Return Value</h4>
  953. <p>The instance.</p>
  954. </div>
  955. </section>
  956. </div>
  957. </li>
  958. <li class="item">
  959. <div>
  960. <code>
  961. <a name="/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF"></a>
  962. <a name="//apple_ref/swift/Method/cancel(byProducingResumeData:)" class="dashAnchor"></a>
  963. <a class="token" href="#/s:9Alamofire15DownloadRequestC6cancel21byProducingResumeDataACXDy10Foundation0H0VSgc_tF">cancel(byProducingResumeData:<wbr>)</a>
  964. </code>
  965. </div>
  966. <div class="height-container">
  967. <div class="pointer-container"></div>
  968. <section class="section">
  969. <div class="pointer"></div>
  970. <div class="abstract">
  971. <p>Cancels the instance while producing resume data. Once cancelled, a <code>DownloadRequest</code> can no longer be resumed
  972. or suspended.</p>
  973. <div class="aside aside-note">
  974. <p class="aside-title">Note</p>
  975. <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>
  976. property.</p>
  977. </div>
  978. </div>
  979. <div class="declaration">
  980. <h4>Declaration</h4>
  981. <div class="language">
  982. <p class="aside-title">Swift</p>
  983. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  984. <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>
  985. </div>
  986. </div>
  987. <div>
  988. <h4>Parameters</h4>
  989. <table class="graybox">
  990. <tbody>
  991. <tr>
  992. <td>
  993. <code>
  994. <em>completionHandler</em>
  995. </code>
  996. </td>
  997. <td>
  998. <div>
  999. <p>The completion handler that is called when the download has been successfully
  1000. cancelled. It is not guaranteed to be called on a particular queue, so you may
  1001. want use an appropriate queue to perform your work.</p>
  1002. </div>
  1003. </td>
  1004. </tr>
  1005. </tbody>
  1006. </table>
  1007. </div>
  1008. <div>
  1009. <h4>Return Value</h4>
  1010. <p>The instance.</p>
  1011. </div>
  1012. </section>
  1013. </div>
  1014. </li>
  1015. <li class="item">
  1016. <div>
  1017. <code>
  1018. <a name="/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF"></a>
  1019. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  1020. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI3URLVSgtcF">validate(_:<wbr>)</a>
  1021. </code>
  1022. </div>
  1023. <div class="height-container">
  1024. <div class="pointer-container"></div>
  1025. <section class="section">
  1026. <div class="pointer"></div>
  1027. <div class="abstract">
  1028. <p>Validates the request, using the specified closure.</p>
  1029. <div class="aside aside-note">
  1030. <p class="aside-title">Note</p>
  1031. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1032. </div>
  1033. </div>
  1034. <div class="declaration">
  1035. <h4>Declaration</h4>
  1036. <div class="language">
  1037. <p class="aside-title">Swift</p>
  1038. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1039. <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>
  1040. </div>
  1041. </div>
  1042. <div>
  1043. <h4>Parameters</h4>
  1044. <table class="graybox">
  1045. <tbody>
  1046. <tr>
  1047. <td>
  1048. <code>
  1049. <em>validation</em>
  1050. </code>
  1051. </td>
  1052. <td>
  1053. <div>
  1054. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a></code> closure to validate the response.</p>
  1055. </div>
  1056. </td>
  1057. </tr>
  1058. </tbody>
  1059. </table>
  1060. </div>
  1061. <div>
  1062. <h4>Return Value</h4>
  1063. <p>The instance.</p>
  1064. </div>
  1065. </section>
  1066. </div>
  1067. </li>
  1068. </ul>
  1069. </div>
  1070. <div class="task-group">
  1071. <div class="task-name-container">
  1072. <a name="/DataRequest%20%2F%20UploadRequest"></a>
  1073. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  1074. <div class="section-name-container">
  1075. <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
  1076. <h3 class="section-name"><span>DataRequest / UploadRequest</span>
  1077. </h3>
  1078. </div>
  1079. </div>
  1080. <ul class="item-container">
  1081. <li class="item">
  1082. <div>
  1083. <code>
  1084. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF"></a>
  1085. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1086. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1087. </code>
  1088. </div>
  1089. <div class="height-container">
  1090. <div class="pointer-container"></div>
  1091. <section class="section">
  1092. <div class="pointer"></div>
  1093. <div class="abstract">
  1094. <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>
  1095. </div>
  1096. <div class="declaration">
  1097. <h4>Declaration</h4>
  1098. <div class="language">
  1099. <p class="aside-title">Swift</p>
  1100. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1101. <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>
  1102. <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>
  1103. </div>
  1104. </div>
  1105. <div>
  1106. <h4>Parameters</h4>
  1107. <table class="graybox">
  1108. <tbody>
  1109. <tr>
  1110. <td>
  1111. <code>
  1112. <em>serializer</em>
  1113. </code>
  1114. </td>
  1115. <td>
  1116. <div>
  1117. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> used to serialize the response <code>Data</code> from disk.</p>
  1118. </div>
  1119. </td>
  1120. </tr>
  1121. <tr>
  1122. <td>
  1123. <code>
  1124. <em>queue</em>
  1125. </code>
  1126. </td>
  1127. <td>
  1128. <div>
  1129. <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>
  1130. </div>
  1131. </td>
  1132. </tr>
  1133. </tbody>
  1134. </table>
  1135. </div>
  1136. <div>
  1137. <h4>Return Value</h4>
  1138. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1139. </div>
  1140. </section>
  1141. </div>
  1142. </li>
  1143. <li class="item">
  1144. <div>
  1145. <code>
  1146. <a name="/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF"></a>
  1147. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  1148. <a class="token" href="#/s:9Alamofire15DownloadRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0bE18SerializerProtocolRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  1149. </code>
  1150. </div>
  1151. <div class="height-container">
  1152. <div class="pointer-container"></div>
  1153. <section class="section">
  1154. <div class="pointer"></div>
  1155. <div class="abstract">
  1156. <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
  1157. <code>DispatchQueue</code>.</p>
  1158. </div>
  1159. <div class="declaration">
  1160. <h4>Declaration</h4>
  1161. <div class="language">
  1162. <p class="aside-title">Swift</p>
  1163. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1164. <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>
  1165. <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>
  1166. </div>
  1167. </div>
  1168. <div>
  1169. <h4>Parameters</h4>
  1170. <table class="graybox">
  1171. <tbody>
  1172. <tr>
  1173. <td>
  1174. <code>
  1175. <em>serializer</em>
  1176. </code>
  1177. </td>
  1178. <td>
  1179. <div>
  1180. <p><code>DownloadResponseSerializer</code> used to serialize the response <code>Data</code> from disk.</p>
  1181. </div>
  1182. </td>
  1183. </tr>
  1184. <tr>
  1185. <td>
  1186. <code>
  1187. <em>queue</em>
  1188. </code>
  1189. </td>
  1190. <td>
  1191. <div>
  1192. <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>
  1193. </div>
  1194. </td>
  1195. </tr>
  1196. </tbody>
  1197. </table>
  1198. </div>
  1199. <div>
  1200. <h4>Return Value</h4>
  1201. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1202. </div>
  1203. </section>
  1204. </div>
  1205. </li>
  1206. <li class="item">
  1207. <div>
  1208. <code>
  1209. <a name="/s:9Alamofire15DownloadRequestC10publishURL5queueAA0B17ResponsePublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_tF"></a>
  1210. <a name="//apple_ref/swift/Method/publishURL(queue:)" class="dashAnchor"></a>
  1211. <a class="token" href="#/s:9Alamofire15DownloadRequestC10publishURL5queueAA0B17ResponsePublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_tF">publishURL(queue:<wbr>)</a>
  1212. </code>
  1213. </div>
  1214. <div class="height-container">
  1215. <div class="pointer-container"></div>
  1216. <section class="section">
  1217. <div class="pointer"></div>
  1218. <div class="abstract">
  1219. <p>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
  1220. response.</p>
  1221. </div>
  1222. <div class="declaration">
  1223. <h4>Declaration</h4>
  1224. <div class="language">
  1225. <p class="aside-title">Swift</p>
  1226. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1227. <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>
  1228. </div>
  1229. </div>
  1230. <div>
  1231. <h4>Parameters</h4>
  1232. <table class="graybox">
  1233. <tbody>
  1234. <tr>
  1235. <td>
  1236. <code>
  1237. <em>queue</em>
  1238. </code>
  1239. </td>
  1240. <td>
  1241. <div>
  1242. <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>
  1243. </div>
  1244. </td>
  1245. </tr>
  1246. </tbody>
  1247. </table>
  1248. </div>
  1249. <div>
  1250. <h4>Return Value</h4>
  1251. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1252. </div>
  1253. </section>
  1254. </div>
  1255. </li>
  1256. <li class="item">
  1257. <div>
  1258. <code>
  1259. <a name="/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF"></a>
  1260. <a name="//apple_ref/swift/Method/publishData(queue:preprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1261. <a class="token" href="#/s:9Alamofire15DownloadRequestC11publishData5queue12preprocessor18emptyResponseCodes0hC7MethodsAA0bI9PublisherVy10Foundation0E0VGSo012OS_dispatch_F0C_AA0E12Preprocessor_pShySiGShyAA10HTTPMethodVGtF">publishData(queue:<wbr>preprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1262. </code>
  1263. </div>
  1264. <div class="height-container">
  1265. <div class="pointer-container"></div>
  1266. <section class="section">
  1267. <div class="pointer"></div>
  1268. <div class="abstract">
  1269. <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
  1270. response.</p>
  1271. </div>
  1272. <div class="declaration">
  1273. <h4>Declaration</h4>
  1274. <div class="language">
  1275. <p class="aside-title">Swift</p>
  1276. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1277. <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>
  1278. <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>
  1279. <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>
  1280. <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>
  1281. </div>
  1282. </div>
  1283. <div>
  1284. <h4>Parameters</h4>
  1285. <table class="graybox">
  1286. <tbody>
  1287. <tr>
  1288. <td>
  1289. <code>
  1290. <em>queue</em>
  1291. </code>
  1292. </td>
  1293. <td>
  1294. <div>
  1295. <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>
  1296. </div>
  1297. </td>
  1298. </tr>
  1299. <tr>
  1300. <td>
  1301. <code>
  1302. <em>preprocessor</em>
  1303. </code>
  1304. </td>
  1305. <td>
  1306. <div>
  1307. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1308. by default.</p>
  1309. </div>
  1310. </td>
  1311. </tr>
  1312. <tr>
  1313. <td>
  1314. <code>
  1315. <em>emptyResponseCodes</em>
  1316. </code>
  1317. </td>
  1318. <td>
  1319. <div>
  1320. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1321. default.</p>
  1322. </div>
  1323. </td>
  1324. </tr>
  1325. <tr>
  1326. <td>
  1327. <code>
  1328. <em>emptyRequestMethods</em>
  1329. </code>
  1330. </td>
  1331. <td>
  1332. <div>
  1333. <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
  1334. status code. <code>[.head]</code> by default.</p>
  1335. </div>
  1336. </td>
  1337. </tr>
  1338. </tbody>
  1339. </table>
  1340. </div>
  1341. <div>
  1342. <h4>Return Value</h4>
  1343. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1344. </div>
  1345. </section>
  1346. </div>
  1347. </li>
  1348. <li class="item">
  1349. <div>
  1350. <code>
  1351. <a name="/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  1352. <a name="//apple_ref/swift/Method/publishString(queue:preprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1353. <a class="token" href="#/s:9Alamofire15DownloadRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA16DataPreprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">publishString(queue:<wbr>preprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1354. </code>
  1355. </div>
  1356. <div class="height-container">
  1357. <div class="pointer-container"></div>
  1358. <section class="section">
  1359. <div class="pointer"></div>
  1360. <div class="abstract">
  1361. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to serialize the
  1362. response.</p>
  1363. </div>
  1364. <div class="declaration">
  1365. <h4>Declaration</h4>
  1366. <div class="language">
  1367. <p class="aside-title">Swift</p>
  1368. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1369. <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>
  1370. <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>
  1371. <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>
  1372. <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>
  1373. <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>
  1374. </div>
  1375. </div>
  1376. <div>
  1377. <h4>Parameters</h4>
  1378. <table class="graybox">
  1379. <tbody>
  1380. <tr>
  1381. <td>
  1382. <code>
  1383. <em>queue</em>
  1384. </code>
  1385. </td>
  1386. <td>
  1387. <div>
  1388. <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>
  1389. </div>
  1390. </td>
  1391. </tr>
  1392. <tr>
  1393. <td>
  1394. <code>
  1395. <em>preprocessor</em>
  1396. </code>
  1397. </td>
  1398. <td>
  1399. <div>
  1400. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  1401. by default.</p>
  1402. </div>
  1403. </td>
  1404. </tr>
  1405. <tr>
  1406. <td>
  1407. <code>
  1408. <em>encoding</em>
  1409. </code>
  1410. </td>
  1411. <td>
  1412. <div>
  1413. <p><code>String.Encoding</code> to parse the response. <code>nil</code> by default, in which case the encoding
  1414. will be determined by the server response, falling back to the default HTTP character
  1415. set, <code>ISO-8859-1</code>.</p>
  1416. </div>
  1417. </td>
  1418. </tr>
  1419. <tr>
  1420. <td>
  1421. <code>
  1422. <em>emptyResponseCodes</em>
  1423. </code>
  1424. </td>
  1425. <td>
  1426. <div>
  1427. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1428. default.</p>
  1429. </div>
  1430. </td>
  1431. </tr>
  1432. <tr>
  1433. <td>
  1434. <code>
  1435. <em>emptyRequestMethods</em>
  1436. </code>
  1437. </td>
  1438. <td>
  1439. <div>
  1440. <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
  1441. status code. <code>[.head]</code> by default.</p>
  1442. </div>
  1443. </td>
  1444. </tr>
  1445. </tbody>
  1446. </table>
  1447. </div>
  1448. <div>
  1449. <h4>Return Value</h4>
  1450. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1451. </div>
  1452. </section>
  1453. </div>
  1454. </li>
  1455. <li class="item">
  1456. <div>
  1457. <code>
  1458. <a name="/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1459. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyResponseMethods:)" class="dashAnchor"></a>
  1460. <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>
  1461. </code>
  1462. </div>
  1463. <div class="height-container">
  1464. <div class="pointer-container"></div>
  1465. <section class="section">
  1466. <div class="pointer"></div>
  1467. <div class="abstract">
  1468. <p>Undocumented</p>
  1469. </div>
  1470. <div class="declaration">
  1471. <h4>Declaration</h4>
  1472. <div class="language">
  1473. <p class="aside-title">Swift</p>
  1474. <pre class="highlight swift"><code><span class="kd">@_disfavoredOverload</span>
  1475. <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>
  1476. <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>
  1477. <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>
  1478. <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>
  1479. <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>
  1480. <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>
  1481. </div>
  1482. </div>
  1483. </section>
  1484. </div>
  1485. </li>
  1486. <li class="item">
  1487. <div>
  1488. <code>
  1489. <a name="/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jC7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1490. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1491. <a class="token" href="#/s:9Alamofire15DownloadRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jC7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA16DataPreprocessor_pAA0Q7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">publishDecodable(type:<wbr>queue:<wbr>preprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1492. </code>
  1493. </div>
  1494. <div class="height-container">
  1495. <div class="pointer-container"></div>
  1496. <section class="section">
  1497. <div class="pointer"></div>
  1498. <div class="abstract">
  1499. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance and uses a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to serialize
  1500. the response.</p>
  1501. </div>
  1502. <div class="declaration">
  1503. <h4>Declaration</h4>
  1504. <div class="language">
  1505. <p class="aside-title">Swift</p>
  1506. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1507. <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>
  1508. <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>
  1509. <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>
  1510. <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>
  1511. <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>
  1512. <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> <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>
  1513. </div>
  1514. </div>
  1515. <div>
  1516. <h4>Parameters</h4>
  1517. <table class="graybox">
  1518. <tbody>
  1519. <tr>
  1520. <td>
  1521. <code>
  1522. <em>type</em>
  1523. </code>
  1524. </td>
  1525. <td>
  1526. <div>
  1527. <p><code>Decodable</code> type to which to decode response <code>Data</code>. Inferred from the context by default.</p>
  1528. </div>
  1529. </td>
  1530. </tr>
  1531. <tr>
  1532. <td>
  1533. <code>
  1534. <em>queue</em>
  1535. </code>
  1536. </td>
  1537. <td>
  1538. <div>
  1539. <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>
  1540. </div>
  1541. </td>
  1542. </tr>
  1543. <tr>
  1544. <td>
  1545. <code>
  1546. <em>preprocessor</em>
  1547. </code>
  1548. </td>
  1549. <td>
  1550. <div>
  1551. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization.
  1552. <code>PassthroughPreprocessor()</code> by default.</p>
  1553. </div>
  1554. </td>
  1555. </tr>
  1556. <tr>
  1557. <td>
  1558. <code>
  1559. <em>decoder</em>
  1560. </code>
  1561. </td>
  1562. <td>
  1563. <div>
  1564. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode response <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  1565. </div>
  1566. </td>
  1567. </tr>
  1568. <tr>
  1569. <td>
  1570. <code>
  1571. <em>emptyResponseCodes</em>
  1572. </code>
  1573. </td>
  1574. <td>
  1575. <div>
  1576. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  1577. default.</p>
  1578. </div>
  1579. </td>
  1580. </tr>
  1581. <tr>
  1582. <td>
  1583. <code>
  1584. <em>emptyRequestMethods</em>
  1585. </code>
  1586. </td>
  1587. <td>
  1588. <div>
  1589. <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
  1590. of status code. <code>[.head]</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. <li class="item">
  1605. <div>
  1606. <code>
  1607. <a name="/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF"></a>
  1608. <a name="//apple_ref/swift/Method/publishUnserialized(on:)" class="dashAnchor"></a>
  1609. <a class="token" href="#/s:9Alamofire15DownloadRequestC19publishUnserialized2onAA0B17ResponsePublisherVy10Foundation3URLVSgGSo17OS_dispatch_queueC_tF">publishUnserialized(on:<wbr>)</a>
  1610. </code>
  1611. </div>
  1612. <div class="height-container">
  1613. <div class="pointer-container"></div>
  1614. <section class="section">
  1615. <div class="pointer"></div>
  1616. <div class="abstract">
  1617. <p>Creates a <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code> for this instance which does not serialize the response before publishing.</p>
  1618. </div>
  1619. <div class="declaration">
  1620. <h4>Declaration</h4>
  1621. <div class="language">
  1622. <p class="aside-title">Swift</p>
  1623. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1624. <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>
  1625. </div>
  1626. </div>
  1627. <div>
  1628. <h4>Parameters</h4>
  1629. <table class="graybox">
  1630. <tbody>
  1631. <tr>
  1632. <td>
  1633. <code>
  1634. <em>queue</em>
  1635. </code>
  1636. </td>
  1637. <td>
  1638. <div>
  1639. <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>
  1640. </div>
  1641. </td>
  1642. </tr>
  1643. </tbody>
  1644. </table>
  1645. </div>
  1646. <div>
  1647. <h4>Return Value</h4>
  1648. <p>The <code><a href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a></code>.</p>
  1649. </div>
  1650. </section>
  1651. </div>
  1652. </li>
  1653. </ul>
  1654. </div>
  1655. <div class="task-group">
  1656. <div class="task-name-container">
  1657. <a name="/DownloadTask"></a>
  1658. <a name="//apple_ref/swift/Section/DownloadTask" class="dashAnchor"></a>
  1659. <div class="section-name-container">
  1660. <a class="section-name-link" href="#/DownloadTask"></a>
  1661. <h3 class="section-name"><span>DownloadTask</span>
  1662. </h3>
  1663. </div>
  1664. </div>
  1665. <ul class="item-container">
  1666. <li class="item">
  1667. <div>
  1668. <code>
  1669. <a name="/s:9Alamofire15DownloadRequestC15serializingData23automaticallyCancelling16dataPreprocessor18emptyResponseCodes0jC7MethodsAA0B4TaskVy10Foundation0E0VGSb_AA0eI0_pShySiGShyAA10HTTPMethodVGtF"></a>
  1670. <a name="//apple_ref/swift/Method/serializingData(automaticallyCancelling:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1671. <a class="token" href="#/s:9Alamofire15DownloadRequestC15serializingData23automaticallyCancelling16dataPreprocessor18emptyResponseCodes0jC7MethodsAA0B4TaskVy10Foundation0E0VGSb_AA0eI0_pShySiGShyAA10HTTPMethodVGtF">serializingData(automaticallyCancelling:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1672. </code>
  1673. </div>
  1674. <div class="height-container">
  1675. <div class="pointer-container"></div>
  1676. <section class="section">
  1677. <div class="pointer"></div>
  1678. <div class="abstract">
  1679. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> a <code>Data</code> value.</p>
  1680. </div>
  1681. <div class="declaration">
  1682. <h4>Declaration</h4>
  1683. <div class="language">
  1684. <p class="aside-title">Swift</p>
  1685. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">serializingData</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1686. <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>
  1687. <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>
  1688. <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/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span></code></pre>
  1689. </div>
  1690. </div>
  1691. <div>
  1692. <h4>Parameters</h4>
  1693. <table class="graybox">
  1694. <tbody>
  1695. <tr>
  1696. <td>
  1697. <code>
  1698. <em>shouldAutomaticallyCancel</em>
  1699. </code>
  1700. </td>
  1701. <td>
  1702. <div>
  1703. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1704. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1705. properties. <code>false</code> by default.</p>
  1706. </div>
  1707. </td>
  1708. </tr>
  1709. <tr>
  1710. <td>
  1711. <code>
  1712. <em>dataPreprocessor</em>
  1713. </code>
  1714. </td>
  1715. <td>
  1716. <div>
  1717. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before completion.</p>
  1718. </div>
  1719. </td>
  1720. </tr>
  1721. <tr>
  1722. <td>
  1723. <code>
  1724. <em>emptyResponseCodes</em>
  1725. </code>
  1726. </td>
  1727. <td>
  1728. <div>
  1729. <p>HTTP response codes for which empty responses are allowed. <code>[204, 205]</code> by default.</p>
  1730. </div>
  1731. </td>
  1732. </tr>
  1733. <tr>
  1734. <td>
  1735. <code>
  1736. <em>emptyRequestMethods</em>
  1737. </code>
  1738. </td>
  1739. <td>
  1740. <div>
  1741. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1742. </div>
  1743. </td>
  1744. </tr>
  1745. </tbody>
  1746. </table>
  1747. </div>
  1748. <div>
  1749. <h4>Return Value</h4>
  1750. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  1751. </div>
  1752. </section>
  1753. </div>
  1754. </li>
  1755. <li class="item">
  1756. <div>
  1757. <code>
  1758. <a name="/s:9Alamofire15DownloadRequestC20serializingDecodable_23automaticallyCancelling16dataPreprocessor7decoder18emptyResponseCodes0kC7MethodsAA0B4TaskVyxGxm_SbAA04DataI0_pAA0P7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  1759. <a name="//apple_ref/swift/Method/serializingDecodable(_:automaticallyCancelling:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1760. <a class="token" href="#/s:9Alamofire15DownloadRequestC20serializingDecodable_23automaticallyCancelling16dataPreprocessor7decoder18emptyResponseCodes0kC7MethodsAA0B4TaskVyxGxm_SbAA04DataI0_pAA0P7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">serializingDecodable(_:<wbr>automaticallyCancelling:<wbr>dataPreprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1761. </code>
  1762. </div>
  1763. <div class="height-container">
  1764. <div class="pointer-container"></div>
  1765. <section class="section">
  1766. <div class="pointer"></div>
  1767. <div class="abstract">
  1768. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization of a <code>Decodable</code> value.</p>
  1769. <div class="aside aside-note">
  1770. <p class="aside-title">Note</p>
  1771. <p>This serializer reads the entire response into memory before parsing.</p>
  1772. </div>
  1773. </div>
  1774. <div class="declaration">
  1775. <h4>Declaration</h4>
  1776. <div class="language">
  1777. <p class="aside-title">Swift</p>
  1778. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">serializingDecodable</span><span class="o">&lt;</span><span class="kt">Value</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">Value</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">Value</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1779. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1780. <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">Value</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1781. <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>
  1782. <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">Value</span><span class="o">&gt;.</span><span class="n">defaultEmptyResponseCodes</span><span class="p">,</span>
  1783. <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">Value</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/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">Value</span><span class="o">&gt;</span></code></pre>
  1784. </div>
  1785. </div>
  1786. <div>
  1787. <h4>Parameters</h4>
  1788. <table class="graybox">
  1789. <tbody>
  1790. <tr>
  1791. <td>
  1792. <code>
  1793. <em>type</em>
  1794. </code>
  1795. </td>
  1796. <td>
  1797. <div>
  1798. <p><code>Decodable</code> type to decode from response data.</p>
  1799. </div>
  1800. </td>
  1801. </tr>
  1802. <tr>
  1803. <td>
  1804. <code>
  1805. <em>shouldAutomaticallyCancel</em>
  1806. </code>
  1807. </td>
  1808. <td>
  1809. <div>
  1810. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1811. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1812. properties. <code>false</code> by default.</p>
  1813. </div>
  1814. </td>
  1815. </tr>
  1816. <tr>
  1817. <td>
  1818. <code>
  1819. <em>dataPreprocessor</em>
  1820. </code>
  1821. </td>
  1822. <td>
  1823. <div>
  1824. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the serializer.
  1825. <code>PassthroughPreprocessor()</code> by default.</p>
  1826. </div>
  1827. </td>
  1828. </tr>
  1829. <tr>
  1830. <td>
  1831. <code>
  1832. <em>decoder</em>
  1833. </code>
  1834. </td>
  1835. <td>
  1836. <div>
  1837. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  1838. </div>
  1839. </td>
  1840. </tr>
  1841. <tr>
  1842. <td>
  1843. <code>
  1844. <em>emptyResponseCodes</em>
  1845. </code>
  1846. </td>
  1847. <td>
  1848. <div>
  1849. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1850. </div>
  1851. </td>
  1852. </tr>
  1853. <tr>
  1854. <td>
  1855. <code>
  1856. <em>emptyRequestMethods</em>
  1857. </code>
  1858. </td>
  1859. <td>
  1860. <div>
  1861. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1862. </div>
  1863. </td>
  1864. </tr>
  1865. </tbody>
  1866. </table>
  1867. </div>
  1868. <div>
  1869. <h4>Return Value</h4>
  1870. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  1871. </div>
  1872. </section>
  1873. </div>
  1874. </li>
  1875. <li class="item">
  1876. <div>
  1877. <code>
  1878. <a name="/s:9Alamofire15DownloadRequestC28serializingDownloadedFileURLAA0B4TaskVy10Foundation0G0VGyF"></a>
  1879. <a name="//apple_ref/swift/Method/serializingDownloadedFileURL()" class="dashAnchor"></a>
  1880. <a class="token" href="#/s:9Alamofire15DownloadRequestC28serializingDownloadedFileURLAA0B4TaskVy10Foundation0G0VGyF">serializingDownloadedFileURL()</a>
  1881. </code>
  1882. </div>
  1883. <div class="height-container">
  1884. <div class="pointer-container"></div>
  1885. <section class="section">
  1886. <div class="pointer"></div>
  1887. <div class="abstract">
  1888. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization of the downloaded file&rsquo;s <code>URL</code> on disk.</p>
  1889. </div>
  1890. <div class="declaration">
  1891. <h4>Declaration</h4>
  1892. <div class="language">
  1893. <p class="aside-title">Swift</p>
  1894. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">serializingDownloadedFileURL</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">URL</span><span class="o">&gt;</span></code></pre>
  1895. </div>
  1896. </div>
  1897. <div>
  1898. <h4>Return Value</h4>
  1899. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  1900. </div>
  1901. </section>
  1902. </div>
  1903. </li>
  1904. <li class="item">
  1905. <div>
  1906. <code>
  1907. <a name="/s:9Alamofire15DownloadRequestC17serializingString23automaticallyCancelling16dataPreprocessor8encoding18emptyResponseCodes0kC7MethodsAA0B4TaskVySSGSb_AA04DataI0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  1908. <a name="//apple_ref/swift/Method/serializingString(automaticallyCancelling:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  1909. <a class="token" href="#/s:9Alamofire15DownloadRequestC17serializingString23automaticallyCancelling16dataPreprocessor8encoding18emptyResponseCodes0kC7MethodsAA0B4TaskVySSGSb_AA04DataI0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">serializingString(automaticallyCancelling:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  1910. </code>
  1911. </div>
  1912. <div class="height-container">
  1913. <div class="pointer-container"></div>
  1914. <section class="section">
  1915. <div class="pointer"></div>
  1916. <div class="abstract">
  1917. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization of a <code>String</code> value.</p>
  1918. </div>
  1919. <div class="declaration">
  1920. <h4>Declaration</h4>
  1921. <div class="language">
  1922. <p class="aside-title">Swift</p>
  1923. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">serializingString</span><span class="p">(</span><span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1924. <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>
  1925. <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>
  1926. <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>
  1927. <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/DownloadTask.html">DownloadTask</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  1928. </div>
  1929. </div>
  1930. <div>
  1931. <h4>Parameters</h4>
  1932. <table class="graybox">
  1933. <tbody>
  1934. <tr>
  1935. <td>
  1936. <code>
  1937. <em>shouldAutomaticallyCancel</em>
  1938. </code>
  1939. </td>
  1940. <td>
  1941. <div>
  1942. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  1943. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  1944. properties. <code>false</code> by default.</p>
  1945. </div>
  1946. </td>
  1947. </tr>
  1948. <tr>
  1949. <td>
  1950. <code>
  1951. <em>dataPreprocessor</em>
  1952. </code>
  1953. </td>
  1954. <td>
  1955. <div>
  1956. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1957. serializer. <code>PassthroughPreprocessor()</code> by default.</p>
  1958. </div>
  1959. </td>
  1960. </tr>
  1961. <tr>
  1962. <td>
  1963. <code>
  1964. <em>encoding</em>
  1965. </code>
  1966. </td>
  1967. <td>
  1968. <div>
  1969. <p><code>String.Encoding</code> to use during serialization. Defaults to <code>nil</code>, in which case
  1970. the encoding will be determined from the server response, falling back to the
  1971. default HTTP character set, <code>ISO-8859-1</code>.</p>
  1972. </div>
  1973. </td>
  1974. </tr>
  1975. <tr>
  1976. <td>
  1977. <code>
  1978. <em>emptyResponseCodes</em>
  1979. </code>
  1980. </td>
  1981. <td>
  1982. <div>
  1983. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1984. </div>
  1985. </td>
  1986. </tr>
  1987. <tr>
  1988. <td>
  1989. <code>
  1990. <em>emptyRequestMethods</em>
  1991. </code>
  1992. </td>
  1993. <td>
  1994. <div>
  1995. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1996. </div>
  1997. </td>
  1998. </tr>
  1999. </tbody>
  2000. </table>
  2001. </div>
  2002. <div>
  2003. <h4>Return Value</h4>
  2004. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  2005. </div>
  2006. </section>
  2007. </div>
  2008. </li>
  2009. <li class="item">
  2010. <div>
  2011. <code>
  2012. <a name="/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA18ResponseSerializerRzlF"></a>
  2013. <a name="//apple_ref/swift/Method/serializingDownload(using:automaticallyCancelling:)" class="dashAnchor"></a>
  2014. <a class="token" href="#/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA18ResponseSerializerRzlF">serializingDownload(using:<wbr>automaticallyCancelling:<wbr>)</a>
  2015. </code>
  2016. </div>
  2017. <div class="height-container">
  2018. <div class="pointer-container"></div>
  2019. <section class="section">
  2020. <div class="pointer"></div>
  2021. <div class="abstract">
  2022. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization using the provided <code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> instance.</p>
  2023. </div>
  2024. <div class="declaration">
  2025. <h4>Declaration</h4>
  2026. <div class="language">
  2027. <p class="aside-title">Swift</p>
  2028. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">serializingDownload</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="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>
  2029. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span>
  2030. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</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></code></pre>
  2031. </div>
  2032. </div>
  2033. <div>
  2034. <h4>Parameters</h4>
  2035. <table class="graybox">
  2036. <tbody>
  2037. <tr>
  2038. <td>
  2039. <code>
  2040. <em>serializer</em>
  2041. </code>
  2042. </td>
  2043. <td>
  2044. <div>
  2045. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> responsible for serializing the request, response, and data.</p>
  2046. </div>
  2047. </td>
  2048. </tr>
  2049. <tr>
  2050. <td>
  2051. <code>
  2052. <em>shouldAutomaticallyCancel</em>
  2053. </code>
  2054. </td>
  2055. <td>
  2056. <div>
  2057. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  2058. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  2059. properties. <code>false</code> by default.</p>
  2060. </div>
  2061. </td>
  2062. </tr>
  2063. </tbody>
  2064. </table>
  2065. </div>
  2066. <div>
  2067. <h4>Return Value</h4>
  2068. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  2069. </div>
  2070. </section>
  2071. </div>
  2072. </li>
  2073. <li class="item">
  2074. <div>
  2075. <code>
  2076. <a name="/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA0B26ResponseSerializerProtocolRzlF"></a>
  2077. <a name="//apple_ref/swift/Method/serializingDownload(using:automaticallyCancelling:)" class="dashAnchor"></a>
  2078. <a class="token" href="#/s:9Alamofire15DownloadRequestC011serializingB05using23automaticallyCancellingAA0B4TaskVy16SerializedObjectQzGx_SbtAA0B26ResponseSerializerProtocolRzlF">serializingDownload(using:<wbr>automaticallyCancelling:<wbr>)</a>
  2079. </code>
  2080. </div>
  2081. <div class="height-container">
  2082. <div class="pointer-container"></div>
  2083. <section class="section">
  2084. <div class="pointer"></div>
  2085. <div class="abstract">
  2086. <p>Creates a <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code> to <code>await</code> serialization using the provided <code><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code>
  2087. instance.</p>
  2088. </div>
  2089. <div class="declaration">
  2090. <h4>Declaration</h4>
  2091. <div class="language">
  2092. <p class="aside-title">Swift</p>
  2093. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">serializingDownload</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="n">using</span> <span class="nv">serializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  2094. <span class="n">automaticallyCancelling</span> <span class="nv">shouldAutomaticallyCancel</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span>
  2095. <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/DownloadTask.html">DownloadTask</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></code></pre>
  2096. </div>
  2097. </div>
  2098. <div>
  2099. <h4>Parameters</h4>
  2100. <table class="graybox">
  2101. <tbody>
  2102. <tr>
  2103. <td>
  2104. <code>
  2105. <em>serializer</em>
  2106. </code>
  2107. </td>
  2108. <td>
  2109. <div>
  2110. <p><code><a href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a></code> responsible for serializing the request,
  2111. response, and data.</p>
  2112. </div>
  2113. </td>
  2114. </tr>
  2115. <tr>
  2116. <td>
  2117. <code>
  2118. <em>shouldAutomaticallyCancel</em>
  2119. </code>
  2120. </td>
  2121. <td>
  2122. <div>
  2123. <p><code>Bool</code> determining whether or not the request should be cancelled when the
  2124. enclosing async context is cancelled. Only applies to <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>&lsquo;s async
  2125. properties. <code>false</code> by default.</p>
  2126. </div>
  2127. </td>
  2128. </tr>
  2129. </tbody>
  2130. </table>
  2131. </div>
  2132. <div>
  2133. <h4>Return Value</h4>
  2134. <p>The <code><a href="../Structs/DownloadTask.html">DownloadTask</a></code>.</p>
  2135. </div>
  2136. </section>
  2137. </div>
  2138. </li>
  2139. </ul>
  2140. </div>
  2141. <div class="task-group">
  2142. <div class="task-name-container">
  2143. <a name="/Default"></a>
  2144. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  2145. <div class="section-name-container">
  2146. <a class="section-name-link" href="#/Default"></a>
  2147. <h3 class="section-name"><span>Default</span>
  2148. </h3>
  2149. </div>
  2150. </div>
  2151. <ul class="item-container">
  2152. <li class="item">
  2153. <div>
  2154. <code>
  2155. <a name="/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF"></a>
  2156. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  2157. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation3URLVSgAA7AFErrorOGctF">response(queue:<wbr>completionHandler:<wbr>)</a>
  2158. </code>
  2159. </div>
  2160. <div class="height-container">
  2161. <div class="pointer-container"></div>
  2162. <section class="section">
  2163. <div class="pointer"></div>
  2164. <div class="abstract">
  2165. <p>Adds a handler to be called once the request has finished.</p>
  2166. </div>
  2167. <div class="declaration">
  2168. <h4>Declaration</h4>
  2169. <div class="language">
  2170. <p class="aside-title">Swift</p>
  2171. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2172. <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>
  2173. <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>
  2174. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2175. </div>
  2176. </div>
  2177. <div>
  2178. <h4>Parameters</h4>
  2179. <table class="graybox">
  2180. <tbody>
  2181. <tr>
  2182. <td>
  2183. <code>
  2184. <em>queue</em>
  2185. </code>
  2186. </td>
  2187. <td>
  2188. <div>
  2189. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2190. </div>
  2191. </td>
  2192. </tr>
  2193. <tr>
  2194. <td>
  2195. <code>
  2196. <em>completionHandler</em>
  2197. </code>
  2198. </td>
  2199. <td>
  2200. <div>
  2201. <p>The code to be executed once the request has finished.</p>
  2202. </div>
  2203. </td>
  2204. </tr>
  2205. </tbody>
  2206. </table>
  2207. </div>
  2208. <div>
  2209. <h4>Return Value</h4>
  2210. <p>The request.</p>
  2211. </div>
  2212. </section>
  2213. </div>
  2214. </li>
  2215. <li class="item">
  2216. <div>
  2217. <code>
  2218. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  2219. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  2220. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  2221. </code>
  2222. </div>
  2223. <div class="height-container">
  2224. <div class="pointer-container"></div>
  2225. <section class="section">
  2226. <div class="pointer"></div>
  2227. <div class="abstract">
  2228. <p>Adds a handler to be called once the request has finished.</p>
  2229. </div>
  2230. <div class="declaration">
  2231. <h4>Declaration</h4>
  2232. <div class="language">
  2233. <p class="aside-title">Swift</p>
  2234. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2235. <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>
  2236. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  2237. <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>
  2238. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2239. </div>
  2240. </div>
  2241. <div>
  2242. <h4>Parameters</h4>
  2243. <table class="graybox">
  2244. <tbody>
  2245. <tr>
  2246. <td>
  2247. <code>
  2248. <em>queue</em>
  2249. </code>
  2250. </td>
  2251. <td>
  2252. <div>
  2253. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2254. </div>
  2255. </td>
  2256. </tr>
  2257. <tr>
  2258. <td>
  2259. <code>
  2260. <em>responseSerializer</em>
  2261. </code>
  2262. </td>
  2263. <td>
  2264. <div>
  2265. <p>The response serializer responsible for serializing the request, response, and data
  2266. contained in the destination <code>URL</code>.</p>
  2267. </div>
  2268. </td>
  2269. </tr>
  2270. <tr>
  2271. <td>
  2272. <code>
  2273. <em>completionHandler</em>
  2274. </code>
  2275. </td>
  2276. <td>
  2277. <div>
  2278. <p>The code to be executed once the request has finished.</p>
  2279. </div>
  2280. </td>
  2281. </tr>
  2282. </tbody>
  2283. </table>
  2284. </div>
  2285. <div>
  2286. <h4>Return Value</h4>
  2287. <p>The request.</p>
  2288. </div>
  2289. </section>
  2290. </div>
  2291. </li>
  2292. <li class="item">
  2293. <div>
  2294. <code>
  2295. <a name="/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0kF0RzlF"></a>
  2296. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  2297. <a class="token" href="#/s:9Alamofire15DownloadRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0kF0RzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  2298. </code>
  2299. </div>
  2300. <div class="height-container">
  2301. <div class="pointer-container"></div>
  2302. <section class="section">
  2303. <div class="pointer"></div>
  2304. <div class="abstract">
  2305. <p>Adds a handler to be called once the request has finished.</p>
  2306. </div>
  2307. <div class="declaration">
  2308. <h4>Declaration</h4>
  2309. <div class="language">
  2310. <p class="aside-title">Swift</p>
  2311. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2312. <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/ResponseSerializer.html">ResponseSerializer</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>
  2313. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  2314. <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>
  2315. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2316. </div>
  2317. </div>
  2318. <div>
  2319. <h4>Parameters</h4>
  2320. <table class="graybox">
  2321. <tbody>
  2322. <tr>
  2323. <td>
  2324. <code>
  2325. <em>queue</em>
  2326. </code>
  2327. </td>
  2328. <td>
  2329. <div>
  2330. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2331. </div>
  2332. </td>
  2333. </tr>
  2334. <tr>
  2335. <td>
  2336. <code>
  2337. <em>responseSerializer</em>
  2338. </code>
  2339. </td>
  2340. <td>
  2341. <div>
  2342. <p>The response serializer responsible for serializing the request, response, and data
  2343. contained in the destination <code>URL</code>.</p>
  2344. </div>
  2345. </td>
  2346. </tr>
  2347. <tr>
  2348. <td>
  2349. <code>
  2350. <em>completionHandler</em>
  2351. </code>
  2352. </td>
  2353. <td>
  2354. <div>
  2355. <p>The code to be executed once the request has finished.</p>
  2356. </div>
  2357. </td>
  2358. </tr>
  2359. </tbody>
  2360. </table>
  2361. </div>
  2362. <div>
  2363. <h4>Return Value</h4>
  2364. <p>The request.</p>
  2365. </div>
  2366. </section>
  2367. </div>
  2368. </li>
  2369. </ul>
  2370. </div>
  2371. <div class="task-group">
  2372. <div class="task-name-container">
  2373. <a name="/URL"></a>
  2374. <a name="//apple_ref/swift/Section/URL" class="dashAnchor"></a>
  2375. <div class="section-name-container">
  2376. <a class="section-name-link" href="#/URL"></a>
  2377. <h3 class="section-name"><span>URL</span>
  2378. </h3>
  2379. </div>
  2380. </div>
  2381. <ul class="item-container">
  2382. <li class="item">
  2383. <div>
  2384. <code>
  2385. <a name="/s:9Alamofire15DownloadRequestC11responseURL5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF"></a>
  2386. <a name="//apple_ref/swift/Method/responseURL(queue:completionHandler:)" class="dashAnchor"></a>
  2387. <a class="token" href="#/s:9Alamofire15DownloadRequestC11responseURL5queue17completionHandlerACXDSo012OS_dispatch_F0C_yAA0B8ResponseVy10Foundation0E0VAA7AFErrorOGctF">responseURL(queue:<wbr>completionHandler:<wbr>)</a>
  2388. </code>
  2389. </div>
  2390. <div class="height-container">
  2391. <div class="pointer-container"></div>
  2392. <section class="section">
  2393. <div class="pointer"></div>
  2394. <div class="abstract">
  2395. <p>Adds a handler using a <code><a href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a></code> to be called once the request is finished.</p>
  2396. </div>
  2397. <div class="declaration">
  2398. <h4>Declaration</h4>
  2399. <div class="language">
  2400. <p class="aside-title">Swift</p>
  2401. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2402. <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>
  2403. <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>
  2404. </div>
  2405. </div>
  2406. <div>
  2407. <h4>Parameters</h4>
  2408. <table class="graybox">
  2409. <tbody>
  2410. <tr>
  2411. <td>
  2412. <code>
  2413. <em>queue</em>
  2414. </code>
  2415. </td>
  2416. <td>
  2417. <div>
  2418. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  2419. </div>
  2420. </td>
  2421. </tr>
  2422. <tr>
  2423. <td>
  2424. <code>
  2425. <em>completionHandler</em>
  2426. </code>
  2427. </td>
  2428. <td>
  2429. <div>
  2430. <p>A closure to be executed once the request has finished.</p>
  2431. </div>
  2432. </td>
  2433. </tr>
  2434. </tbody>
  2435. </table>
  2436. </div>
  2437. <div>
  2438. <h4>Return Value</h4>
  2439. <p>The request.</p>
  2440. </div>
  2441. </section>
  2442. </div>
  2443. </li>
  2444. </ul>
  2445. </div>
  2446. <div class="task-group">
  2447. <div class="task-name-container">
  2448. <a name="/Data"></a>
  2449. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  2450. <div class="section-name-container">
  2451. <a class="section-name-link" href="#/Data"></a>
  2452. <h3 class="section-name"><span>Data</span>
  2453. </h3>
  2454. </div>
  2455. </div>
  2456. <ul class="item-container">
  2457. <li class="item">
  2458. <div>
  2459. <code>
  2460. <a name="/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF"></a>
  2461. <a name="//apple_ref/swift/Method/responseData(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2462. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseData5queue16dataPreprocessor18emptyResponseCodes0iC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0eH0_pShySiGShyAA10HTTPMethodVGyAA0bJ0Vy10Foundation0E0VAA7AFErrorOGctF">responseData(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  2463. </code>
  2464. </div>
  2465. <div class="height-container">
  2466. <div class="pointer-container"></div>
  2467. <section class="section">
  2468. <div class="pointer"></div>
  2469. <div class="abstract">
  2470. <p>Adds a handler using a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to be called once the request has finished.</p>
  2471. </div>
  2472. <div class="declaration">
  2473. <h4>Declaration</h4>
  2474. <div class="language">
  2475. <p class="aside-title">Swift</p>
  2476. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2477. <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>
  2478. <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>
  2479. <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>
  2480. <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>
  2481. <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>
  2482. </div>
  2483. </div>
  2484. <div>
  2485. <h4>Parameters</h4>
  2486. <table class="graybox">
  2487. <tbody>
  2488. <tr>
  2489. <td>
  2490. <code>
  2491. <em>queue</em>
  2492. </code>
  2493. </td>
  2494. <td>
  2495. <div>
  2496. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  2497. </div>
  2498. </td>
  2499. </tr>
  2500. <tr>
  2501. <td>
  2502. <code>
  2503. <em>dataPreprocessor</em>
  2504. </code>
  2505. </td>
  2506. <td>
  2507. <div>
  2508. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2509. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2510. </div>
  2511. </td>
  2512. </tr>
  2513. <tr>
  2514. <td>
  2515. <code>
  2516. <em>emptyResponseCodes</em>
  2517. </code>
  2518. </td>
  2519. <td>
  2520. <div>
  2521. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2522. </div>
  2523. </td>
  2524. </tr>
  2525. <tr>
  2526. <td>
  2527. <code>
  2528. <em>emptyRequestMethods</em>
  2529. </code>
  2530. </td>
  2531. <td>
  2532. <div>
  2533. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2534. </div>
  2535. </td>
  2536. </tr>
  2537. <tr>
  2538. <td>
  2539. <code>
  2540. <em>completionHandler</em>
  2541. </code>
  2542. </td>
  2543. <td>
  2544. <div>
  2545. <p>A closure to be executed once the request has finished.</p>
  2546. </div>
  2547. </td>
  2548. </tr>
  2549. </tbody>
  2550. </table>
  2551. </div>
  2552. <div>
  2553. <h4>Return Value</h4>
  2554. <p>The request.</p>
  2555. </div>
  2556. </section>
  2557. </div>
  2558. </li>
  2559. </ul>
  2560. </div>
  2561. <div class="task-group">
  2562. <div class="task-name-container">
  2563. <a name="/String"></a>
  2564. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  2565. <div class="section-name-container">
  2566. <a class="section-name-link" href="#/String"></a>
  2567. <h3 class="section-name"><span>String</span>
  2568. </h3>
  2569. </div>
  2570. </div>
  2571. <ul class="item-container">
  2572. <li class="item">
  2573. <div>
  2574. <code>
  2575. <a name="/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF"></a>
  2576. <a name="//apple_ref/swift/Method/responseString(queue:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2577. <a class="token" href="#/s:9Alamofire15DownloadRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF">responseString(queue:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  2578. </code>
  2579. </div>
  2580. <div class="height-container">
  2581. <div class="pointer-container"></div>
  2582. <section class="section">
  2583. <div class="pointer"></div>
  2584. <div class="abstract">
  2585. <p>Adds a handler using a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to be called once the request has finished.</p>
  2586. </div>
  2587. <div class="declaration">
  2588. <h4>Declaration</h4>
  2589. <div class="language">
  2590. <p class="aside-title">Swift</p>
  2591. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2592. <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>
  2593. <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>
  2594. <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>
  2595. <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>
  2596. <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>
  2597. <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>
  2598. </div>
  2599. </div>
  2600. <div>
  2601. <h4>Parameters</h4>
  2602. <table class="graybox">
  2603. <tbody>
  2604. <tr>
  2605. <td>
  2606. <code>
  2607. <em>queue</em>
  2608. </code>
  2609. </td>
  2610. <td>
  2611. <div>
  2612. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2613. </div>
  2614. </td>
  2615. </tr>
  2616. <tr>
  2617. <td>
  2618. <code>
  2619. <em>dataPreprocessor</em>
  2620. </code>
  2621. </td>
  2622. <td>
  2623. <div>
  2624. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2625. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2626. </div>
  2627. </td>
  2628. </tr>
  2629. <tr>
  2630. <td>
  2631. <code>
  2632. <em>encoding</em>
  2633. </code>
  2634. </td>
  2635. <td>
  2636. <div>
  2637. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2638. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2639. </div>
  2640. </td>
  2641. </tr>
  2642. <tr>
  2643. <td>
  2644. <code>
  2645. <em>emptyResponseCodes</em>
  2646. </code>
  2647. </td>
  2648. <td>
  2649. <div>
  2650. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2651. </div>
  2652. </td>
  2653. </tr>
  2654. <tr>
  2655. <td>
  2656. <code>
  2657. <em>emptyRequestMethods</em>
  2658. </code>
  2659. </td>
  2660. <td>
  2661. <div>
  2662. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2663. </div>
  2664. </td>
  2665. </tr>
  2666. <tr>
  2667. <td>
  2668. <code>
  2669. <em>completionHandler</em>
  2670. </code>
  2671. </td>
  2672. <td>
  2673. <div>
  2674. <p>A closure to be executed once the request has finished.</p>
  2675. </div>
  2676. </td>
  2677. </tr>
  2678. </tbody>
  2679. </table>
  2680. </div>
  2681. <div>
  2682. <h4>Return Value</h4>
  2683. <p>The request.</p>
  2684. </div>
  2685. </section>
  2686. </div>
  2687. </li>
  2688. </ul>
  2689. </div>
  2690. <div class="task-group">
  2691. <div class="task-name-container">
  2692. <a name="/JSON"></a>
  2693. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  2694. <div class="section-name-container">
  2695. <a class="section-name-link" href="#/JSON"></a>
  2696. <h3 class="section-name"><span>JSON</span>
  2697. </h3>
  2698. </div>
  2699. </div>
  2700. <ul class="item-container">
  2701. <li class="item">
  2702. <div>
  2703. <code>
  2704. <a name="/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF"></a>
  2705. <a name="//apple_ref/swift/Method/responseJSON(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:options:completionHandler:)" class="dashAnchor"></a>
  2706. <a class="token" href="#/s:9Alamofire15DownloadRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA04DataH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF">responseJSON(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>options:<wbr>completionHandler:<wbr>)</a>
  2707. </code>
  2708. </div>
  2709. <div class="height-container">
  2710. <div class="pointer-container"></div>
  2711. <section class="section">
  2712. <div class="pointer"></div>
  2713. <div class="abstract">
  2714. <p>Adds a handler using a <code><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></code> to be called once the request has finished.</p>
  2715. </div>
  2716. <div class="declaration">
  2717. <h4>Declaration</h4>
  2718. <div class="language">
  2719. <p class="aside-title">Swift</p>
  2720. <pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "responseJSON deprecated and will be removed in Alamofire 6. Use responseDecodable instead.")</span>
  2721. <span class="kd">@discardableResult</span>
  2722. <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>
  2723. <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>
  2724. <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>
  2725. <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>
  2726. <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>
  2727. <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>
  2728. </div>
  2729. </div>
  2730. <div>
  2731. <h4>Parameters</h4>
  2732. <table class="graybox">
  2733. <tbody>
  2734. <tr>
  2735. <td>
  2736. <code>
  2737. <em>queue</em>
  2738. </code>
  2739. </td>
  2740. <td>
  2741. <div>
  2742. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2743. </div>
  2744. </td>
  2745. </tr>
  2746. <tr>
  2747. <td>
  2748. <code>
  2749. <em>dataPreprocessor</em>
  2750. </code>
  2751. </td>
  2752. <td>
  2753. <div>
  2754. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2755. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2756. </div>
  2757. </td>
  2758. </tr>
  2759. <tr>
  2760. <td>
  2761. <code>
  2762. <em>encoding</em>
  2763. </code>
  2764. </td>
  2765. <td>
  2766. <div>
  2767. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2768. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2769. </div>
  2770. </td>
  2771. </tr>
  2772. <tr>
  2773. <td>
  2774. <code>
  2775. <em>emptyResponseCodes</em>
  2776. </code>
  2777. </td>
  2778. <td>
  2779. <div>
  2780. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2781. </div>
  2782. </td>
  2783. </tr>
  2784. <tr>
  2785. <td>
  2786. <code>
  2787. <em>emptyRequestMethods</em>
  2788. </code>
  2789. </td>
  2790. <td>
  2791. <div>
  2792. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2793. </div>
  2794. </td>
  2795. </tr>
  2796. <tr>
  2797. <td>
  2798. <code>
  2799. <em>options</em>
  2800. </code>
  2801. </td>
  2802. <td>
  2803. <div>
  2804. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  2805. by default.</p>
  2806. </div>
  2807. </td>
  2808. </tr>
  2809. <tr>
  2810. <td>
  2811. <code>
  2812. <em>completionHandler</em>
  2813. </code>
  2814. </td>
  2815. <td>
  2816. <div>
  2817. <p>A closure to be executed once the request has finished.</p>
  2818. </div>
  2819. </td>
  2820. </tr>
  2821. </tbody>
  2822. </table>
  2823. </div>
  2824. <div>
  2825. <h4>Return Value</h4>
  2826. <p>The request.</p>
  2827. </div>
  2828. </section>
  2829. </div>
  2830. </li>
  2831. </ul>
  2832. </div>
  2833. <div class="task-group">
  2834. <div class="task-name-container">
  2835. <a name="/Decodable"></a>
  2836. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  2837. <div class="section-name-container">
  2838. <a class="section-name-link" href="#/Decodable"></a>
  2839. <h3 class="section-name"><span>Decodable</span>
  2840. </h3>
  2841. </div>
  2842. </div>
  2843. <ul class="item-container">
  2844. <li class="item">
  2845. <div>
  2846. <code>
  2847. <a name="/s:9Alamofire15DownloadRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA04DataI0_pAA0S7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF"></a>
  2848. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  2849. <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>
  2850. </code>
  2851. </div>
  2852. <div class="height-container">
  2853. <div class="pointer-container"></div>
  2854. <section class="section">
  2855. <div class="pointer"></div>
  2856. <div class="abstract">
  2857. <p>Adds a handler using a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to be called once the request has finished.</p>
  2858. </div>
  2859. <div class="declaration">
  2860. <h4>Declaration</h4>
  2861. <div class="language">
  2862. <p class="aside-title">Swift</p>
  2863. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2864. <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>
  2865. <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>
  2866. <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>
  2867. <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>
  2868. <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>
  2869. <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>
  2870. <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>
  2871. </div>
  2872. </div>
  2873. <div>
  2874. <h4>Parameters</h4>
  2875. <table class="graybox">
  2876. <tbody>
  2877. <tr>
  2878. <td>
  2879. <code>
  2880. <em>type</em>
  2881. </code>
  2882. </td>
  2883. <td>
  2884. <div>
  2885. <p><code>Decodable</code> type to decode from response data.</p>
  2886. </div>
  2887. </td>
  2888. </tr>
  2889. <tr>
  2890. <td>
  2891. <code>
  2892. <em>queue</em>
  2893. </code>
  2894. </td>
  2895. <td>
  2896. <div>
  2897. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  2898. </div>
  2899. </td>
  2900. </tr>
  2901. <tr>
  2902. <td>
  2903. <code>
  2904. <em>dataPreprocessor</em>
  2905. </code>
  2906. </td>
  2907. <td>
  2908. <div>
  2909. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  2910. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  2911. </div>
  2912. </td>
  2913. </tr>
  2914. <tr>
  2915. <td>
  2916. <code>
  2917. <em>decoder</em>
  2918. </code>
  2919. </td>
  2920. <td>
  2921. <div>
  2922. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  2923. </div>
  2924. </td>
  2925. </tr>
  2926. <tr>
  2927. <td>
  2928. <code>
  2929. <em>encoding</em>
  2930. </code>
  2931. </td>
  2932. <td>
  2933. <div>
  2934. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  2935. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  2936. </div>
  2937. </td>
  2938. </tr>
  2939. <tr>
  2940. <td>
  2941. <code>
  2942. <em>emptyResponseCodes</em>
  2943. </code>
  2944. </td>
  2945. <td>
  2946. <div>
  2947. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  2948. </div>
  2949. </td>
  2950. </tr>
  2951. <tr>
  2952. <td>
  2953. <code>
  2954. <em>emptyRequestMethods</em>
  2955. </code>
  2956. </td>
  2957. <td>
  2958. <div>
  2959. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  2960. </div>
  2961. </td>
  2962. </tr>
  2963. <tr>
  2964. <td>
  2965. <code>
  2966. <em>completionHandler</em>
  2967. </code>
  2968. </td>
  2969. <td>
  2970. <div>
  2971. <p>A closure to be executed once the request has finished.</p>
  2972. </div>
  2973. </td>
  2974. </tr>
  2975. </tbody>
  2976. </table>
  2977. </div>
  2978. <div>
  2979. <h4>Return Value</h4>
  2980. <p>The request.</p>
  2981. </div>
  2982. </section>
  2983. </div>
  2984. </li>
  2985. </ul>
  2986. </div>
  2987. <div class="task-group">
  2988. <ul class="item-container">
  2989. <li class="item">
  2990. <div>
  2991. <code>
  2992. <a name="/s:9Alamofire15DownloadRequestC10Validationa"></a>
  2993. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  2994. <a class="token" href="#/s:9Alamofire15DownloadRequestC10Validationa">Validation</a>
  2995. </code>
  2996. </div>
  2997. <div class="height-container">
  2998. <div class="pointer-container"></div>
  2999. <section class="section">
  3000. <div class="pointer"></div>
  3001. <div class="abstract">
  3002. <p>A closure used to validate a request that takes a URL request, a URL response, a temporary URL and a
  3003. destination URL, and returns whether the request was valid.</p>
  3004. </div>
  3005. <div class="declaration">
  3006. <h4>Declaration</h4>
  3007. <div class="language">
  3008. <p class="aside-title">Swift</p>
  3009. <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>
  3010. <span class="n">_</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span>
  3011. <span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span>
  3012. <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  3013. </div>
  3014. </div>
  3015. </section>
  3016. </div>
  3017. </li>
  3018. <li class="item">
  3019. <div>
  3020. <code>
  3021. <a name="/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  3022. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  3023. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  3024. </code>
  3025. </div>
  3026. <div class="height-container">
  3027. <div class="pointer-container"></div>
  3028. <section class="section">
  3029. <div class="pointer"></div>
  3030. <div class="abstract">
  3031. <p>Validates that the response has a status code in the specified sequence.</p>
  3032. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  3033. </div>
  3034. <div class="declaration">
  3035. <h4>Declaration</h4>
  3036. <div class="language">
  3037. <p class="aside-title">Swift</p>
  3038. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  3039. <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>
  3040. </div>
  3041. </div>
  3042. <div>
  3043. <h4>Parameters</h4>
  3044. <table class="graybox">
  3045. <tbody>
  3046. <tr>
  3047. <td>
  3048. <code>
  3049. <em>acceptableStatusCodes</em>
  3050. </code>
  3051. </td>
  3052. <td>
  3053. <div>
  3054. <p><code>Sequence</code> of acceptable response status codes.</p>
  3055. </div>
  3056. </td>
  3057. </tr>
  3058. </tbody>
  3059. </table>
  3060. </div>
  3061. <div>
  3062. <h4>Return Value</h4>
  3063. <p>The instance.</p>
  3064. </div>
  3065. </section>
  3066. </div>
  3067. </li>
  3068. <li class="item">
  3069. <div>
  3070. <code>
  3071. <a name="/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  3072. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  3073. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  3074. </code>
  3075. </div>
  3076. <div class="height-container">
  3077. <div class="pointer-container"></div>
  3078. <section class="section">
  3079. <div class="pointer"></div>
  3080. <div class="abstract">
  3081. <p>Validates that the response has a content type in the specified sequence.</p>
  3082. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  3083. </div>
  3084. <div class="declaration">
  3085. <h4>Declaration</h4>
  3086. <div class="language">
  3087. <p class="aside-title">Swift</p>
  3088. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  3089. <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>
  3090. </div>
  3091. </div>
  3092. <div>
  3093. <h4>Parameters</h4>
  3094. <table class="graybox">
  3095. <tbody>
  3096. <tr>
  3097. <td>
  3098. <code>
  3099. <em>contentType</em>
  3100. </code>
  3101. </td>
  3102. <td>
  3103. <div>
  3104. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  3105. </div>
  3106. </td>
  3107. </tr>
  3108. </tbody>
  3109. </table>
  3110. </div>
  3111. <div>
  3112. <h4>Return Value</h4>
  3113. <p>The request.</p>
  3114. </div>
  3115. </section>
  3116. </div>
  3117. </li>
  3118. <li class="item">
  3119. <div>
  3120. <code>
  3121. <a name="/s:9Alamofire15DownloadRequestC8validateACXDyF"></a>
  3122. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  3123. <a class="token" href="#/s:9Alamofire15DownloadRequestC8validateACXDyF">validate()</a>
  3124. </code>
  3125. </div>
  3126. <div class="height-container">
  3127. <div class="pointer-container"></div>
  3128. <section class="section">
  3129. <div class="pointer"></div>
  3130. <div class="abstract">
  3131. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  3132. type matches any specified in the Accept HTTP header field.</p>
  3133. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  3134. </div>
  3135. <div class="declaration">
  3136. <h4>Declaration</h4>
  3137. <div class="language">
  3138. <p class="aside-title">Swift</p>
  3139. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  3140. <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>
  3141. </div>
  3142. </div>
  3143. <div>
  3144. <h4>Return Value</h4>
  3145. <p>The request.</p>
  3146. </div>
  3147. </section>
  3148. </div>
  3149. </li>
  3150. </ul>
  3151. </div>
  3152. </div>
  3153. </section>
  3154. </article>
  3155. </div>
  3156. <section class="footer">
  3157. <p>&copy; 2021 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2021-12-13)</p>
  3158. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  3159. </section>
  3160. </body>
  3161. </html>