DataRequest.html 180 KB

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