DataRequest.html 183 KB

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