DataRequest.html 120 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972
  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.4.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. DataRequest Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  307. </li>
  308. </ul>
  309. </li>
  310. <li class="nav-group-name">
  311. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  312. <ul class="nav-group-tasks">
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  384. </li>
  385. </ul>
  386. </li>
  387. <li class="nav-group-name">
  388. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  389. <ul class="nav-group-tasks">
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  464. </li>
  465. </ul>
  466. </li>
  467. <li class="nav-group-name">
  468. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  469. <ul class="nav-group-tasks">
  470. <li class="nav-group-task">
  471. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  472. </li>
  473. <li class="nav-group-task">
  474. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  475. </li>
  476. <li class="nav-group-task">
  477. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  478. </li>
  479. <li class="nav-group-task">
  480. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  481. </li>
  482. <li class="nav-group-task">
  483. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  484. </li>
  485. <li class="nav-group-task">
  486. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  487. </li>
  488. <li class="nav-group-task">
  489. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  490. </li>
  491. </ul>
  492. </li>
  493. </ul>
  494. </nav>
  495. <article class="main-content">
  496. <section class="section">
  497. <div class="section-content top-matter">
  498. <h1>DataRequest</h1>
  499. <div class="declaration">
  500. <div class="language">
  501. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">DataRequest</span> <span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span></code></pre>
  502. </div>
  503. </div>
  504. <p><code><a href="../Classes/Request.html">Request</a></code> subclass which handles in-memory <code>Data</code> download using <code>URLSessionDataTask</code>.</p>
  505. </div>
  506. </section>
  507. <section class="section">
  508. <div class="section-content">
  509. <div class="task-group">
  510. <ul class="item-container">
  511. <li class="item">
  512. <div>
  513. <code>
  514. <a name="/s:9Alamofire11DataRequestC11convertibleAA21URLRequestConvertible_pvp"></a>
  515. <a name="//apple_ref/swift/Property/convertible" class="dashAnchor"></a>
  516. <a class="token" href="#/s:9Alamofire11DataRequestC11convertibleAA21URLRequestConvertible_pvp">convertible</a>
  517. </code>
  518. </div>
  519. <div class="height-container">
  520. <div class="pointer-container"></div>
  521. <section class="section">
  522. <div class="pointer"></div>
  523. <div class="abstract">
  524. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value used to create <code>URLRequest</code>s for this instance.</p>
  525. </div>
  526. <div class="declaration">
  527. <h4>Declaration</h4>
  528. <div class="language">
  529. <p class="aside-title">Swift</p>
  530. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span></code></pre>
  531. </div>
  532. </div>
  533. </section>
  534. </div>
  535. </li>
  536. <li class="item">
  537. <div>
  538. <code>
  539. <a name="/s:9Alamofire11DataRequestC4data10Foundation0B0VSgvp"></a>
  540. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  541. <a class="token" href="#/s:9Alamofire11DataRequestC4data10Foundation0B0VSgvp">data</a>
  542. </code>
  543. </div>
  544. <div class="height-container">
  545. <div class="pointer-container"></div>
  546. <section class="section">
  547. <div class="pointer"></div>
  548. <div class="abstract">
  549. <p><code>Data</code> read from the server so far.</p>
  550. </div>
  551. <div class="declaration">
  552. <h4>Declaration</h4>
  553. <div class="language">
  554. <p class="aside-title">Swift</p>
  555. <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>
  556. </div>
  557. </div>
  558. </section>
  559. </div>
  560. </li>
  561. <li class="item">
  562. <div>
  563. <code>
  564. <a name="/s:9Alamofire11DataRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI0B0VSgtcF"></a>
  565. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  566. <a class="token" href="#/s:9Alamofire11DataRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI0B0VSgtcF">validate(_:<wbr>)</a>
  567. </code>
  568. </div>
  569. <div class="height-container">
  570. <div class="pointer-container"></div>
  571. <section class="section">
  572. <div class="pointer"></div>
  573. <div class="abstract">
  574. <p>Validates the request, using the specified closure.</p>
  575. <div class="aside aside-note">
  576. <p class="aside-title">Note</p>
  577. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  578. </div>
  579. </div>
  580. <div class="declaration">
  581. <h4>Declaration</h4>
  582. <div class="language">
  583. <p class="aside-title">Swift</p>
  584. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  585. <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>
  586. </div>
  587. </div>
  588. <div>
  589. <h4>Parameters</h4>
  590. <table class="graybox">
  591. <tbody>
  592. <tr>
  593. <td>
  594. <code>
  595. <em>validation</em>
  596. </code>
  597. </td>
  598. <td>
  599. <div>
  600. <p><code><a href="../Classes/DataRequest.html#/s:9Alamofire11DataRequestC10Validationa">Validation</a></code> closure used to validate the response.</p>
  601. </div>
  602. </td>
  603. </tr>
  604. </tbody>
  605. </table>
  606. </div>
  607. <div>
  608. <h4>Return Value</h4>
  609. <p>The instance.</p>
  610. </div>
  611. </section>
  612. </div>
  613. </li>
  614. </ul>
  615. </div>
  616. <div class="task-group">
  617. <div class="task-name-container">
  618. <a name="/DataRequest%20%2F%20UploadRequest"></a>
  619. <a name="//apple_ref/swift/Section/DataRequest / UploadRequest" class="dashAnchor"></a>
  620. <div class="section-name-container">
  621. <a class="section-name-link" href="#/DataRequest%20%2F%20UploadRequest"></a>
  622. <h3 class="section-name"><p>DataRequest / UploadRequest</p>
  623. </h3>
  624. </div>
  625. </div>
  626. <ul class="item-container">
  627. <li class="item">
  628. <div>
  629. <code>
  630. <a name="/s:9Alamofire11DataRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF"></a>
  631. <a name="//apple_ref/swift/Method/publishResponse(using:on:)" class="dashAnchor"></a>
  632. <a class="token" href="#/s:9Alamofire11DataRequestC15publishResponse5using2onAA0bE9PublisherVyq_Gx_So17OS_dispatch_queueCtAA0E10SerializerRz16SerializedObjectQzRs_r0_lF">publishResponse(using:<wbr>on:<wbr>)</a>
  633. </code>
  634. </div>
  635. <div class="height-container">
  636. <div class="pointer-container"></div>
  637. <section class="section">
  638. <div class="pointer"></div>
  639. <div class="abstract">
  640. <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>
  641. </div>
  642. <div class="declaration">
  643. <h4>Declaration</h4>
  644. <div class="language">
  645. <p class="aside-title">Swift</p>
  646. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  647. <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>
  648. <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>
  649. </div>
  650. </div>
  651. <div>
  652. <h4>Parameters</h4>
  653. <table class="graybox">
  654. <tbody>
  655. <tr>
  656. <td>
  657. <code>
  658. <em>serializer</em>
  659. </code>
  660. </td>
  661. <td>
  662. <div>
  663. <p><code><a href="../Protocols/ResponseSerializer.html">ResponseSerializer</a></code> used to serialize response <code>Data</code>.</p>
  664. </div>
  665. </td>
  666. </tr>
  667. <tr>
  668. <td>
  669. <code>
  670. <em>queue</em>
  671. </code>
  672. </td>
  673. <td>
  674. <div>
  675. <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>
  676. </div>
  677. </td>
  678. </tr>
  679. </tbody>
  680. </table>
  681. </div>
  682. <div>
  683. <h4>Return Value</h4>
  684. <p>The <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code>.</p>
  685. </div>
  686. </section>
  687. </div>
  688. </li>
  689. <li class="item">
  690. <div>
  691. <code>
  692. <a name="/s:9Alamofire11DataRequestC07publishB05queue12preprocessor18emptyResponseCodes0gC7MethodsAA0bH9PublisherVy10Foundation0B0VGSo012OS_dispatch_E0C_AA0B12Preprocessor_pShySiGShyAA10HTTPMethodVGtF"></a>
  693. <a name="//apple_ref/swift/Method/publishData(queue:preprocessor:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  694. <a class="token" href="#/s:9Alamofire11DataRequestC07publishB05queue12preprocessor18emptyResponseCodes0gC7MethodsAA0bH9PublisherVy10Foundation0B0VGSo012OS_dispatch_E0C_AA0B12Preprocessor_pShySiGShyAA10HTTPMethodVGtF">publishData(queue:<wbr>preprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  695. </code>
  696. </div>
  697. <div class="height-container">
  698. <div class="pointer-container"></div>
  699. <section class="section">
  700. <div class="pointer"></div>
  701. <div class="abstract">
  702. <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
  703. response.</p>
  704. </div>
  705. <div class="declaration">
  706. <h4>Declaration</h4>
  707. <div class="language">
  708. <p class="aside-title">Swift</p>
  709. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  710. <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>
  711. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  712. <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>
  713. <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>
  714. </div>
  715. </div>
  716. <div>
  717. <h4>Parameters</h4>
  718. <table class="graybox">
  719. <tbody>
  720. <tr>
  721. <td>
  722. <code>
  723. <em>queue</em>
  724. </code>
  725. </td>
  726. <td>
  727. <div>
  728. <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>
  729. </div>
  730. </td>
  731. </tr>
  732. <tr>
  733. <td>
  734. <code>
  735. <em>preprocessor</em>
  736. </code>
  737. </td>
  738. <td>
  739. <div>
  740. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  741. by default.</p>
  742. </div>
  743. </td>
  744. </tr>
  745. <tr>
  746. <td>
  747. <code>
  748. <em>emptyResponseCodes</em>
  749. </code>
  750. </td>
  751. <td>
  752. <div>
  753. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  754. default.</p>
  755. </div>
  756. </td>
  757. </tr>
  758. <tr>
  759. <td>
  760. <code>
  761. <em>emptyRequestMethods</em>
  762. </code>
  763. </td>
  764. <td>
  765. <div>
  766. <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
  767. status code. <code>[.head]</code> by default.</p>
  768. </div>
  769. </td>
  770. </tr>
  771. </tbody>
  772. </table>
  773. </div>
  774. <div>
  775. <h4>Return Value</h4>
  776. <p>The <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code>.</p>
  777. </div>
  778. </section>
  779. </div>
  780. </li>
  781. <li class="item">
  782. <div>
  783. <code>
  784. <a name="/s:9Alamofire11DataRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA0B12Preprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF"></a>
  785. <a name="//apple_ref/swift/Method/publishString(queue:preprocessor:encoding:emptyResponseCodes:emptyRequestMethods:)" class="dashAnchor"></a>
  786. <a class="token" href="#/s:9Alamofire11DataRequestC13publishString5queue12preprocessor8encoding18emptyResponseCodes0iC7MethodsAA0bJ9PublisherVySSGSo012OS_dispatch_F0C_AA0B12Preprocessor_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGtF">publishString(queue:<wbr>preprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>)</a>
  787. </code>
  788. </div>
  789. <div class="height-container">
  790. <div class="pointer-container"></div>
  791. <section class="section">
  792. <div class="pointer"></div>
  793. <div class="abstract">
  794. <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
  795. response.</p>
  796. </div>
  797. <div class="declaration">
  798. <h4>Declaration</h4>
  799. <div class="language">
  800. <p class="aside-title">Swift</p>
  801. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  802. <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>
  803. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  804. <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>
  805. <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>
  806. <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>
  807. </div>
  808. </div>
  809. <div>
  810. <h4>Parameters</h4>
  811. <table class="graybox">
  812. <tbody>
  813. <tr>
  814. <td>
  815. <code>
  816. <em>queue</em>
  817. </code>
  818. </td>
  819. <td>
  820. <div>
  821. <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>
  822. </div>
  823. </td>
  824. </tr>
  825. <tr>
  826. <td>
  827. <code>
  828. <em>preprocessor</em>
  829. </code>
  830. </td>
  831. <td>
  832. <div>
  833. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  834. by default.</p>
  835. </div>
  836. </td>
  837. </tr>
  838. <tr>
  839. <td>
  840. <code>
  841. <em>encoding</em>
  842. </code>
  843. </td>
  844. <td>
  845. <div>
  846. <p><code>String.Encoding</code> to parse the response. <code>nil</code> by default, in which case the encoding
  847. will be determined by the server response, falling back to the default HTTP character
  848. set, <code>ISO-8859-1</code>.</p>
  849. </div>
  850. </td>
  851. </tr>
  852. <tr>
  853. <td>
  854. <code>
  855. <em>emptyResponseCodes</em>
  856. </code>
  857. </td>
  858. <td>
  859. <div>
  860. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  861. default.</p>
  862. </div>
  863. </td>
  864. </tr>
  865. <tr>
  866. <td>
  867. <code>
  868. <em>emptyRequestMethods</em>
  869. </code>
  870. </td>
  871. <td>
  872. <div>
  873. <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
  874. status code. <code>[.head]</code> by default.</p>
  875. </div>
  876. </td>
  877. </tr>
  878. </tbody>
  879. </table>
  880. </div>
  881. <div>
  882. <h4>Return Value</h4>
  883. <p>The <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code>.</p>
  884. </div>
  885. </section>
  886. </div>
  887. </li>
  888. <li class="item">
  889. <div>
  890. <code>
  891. <a name="/s:9Alamofire11DataRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA0B12Preprocessor_pAA0B7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF"></a>
  892. <a name="//apple_ref/swift/Method/publishDecodable(type:queue:preprocessor:decoder:emptyResponseCodes:emptyResponseMethods:)" class="dashAnchor"></a>
  893. <a class="token" href="#/s:9Alamofire11DataRequestC16publishDecodable4type5queue12preprocessor7decoder18emptyResponseCodes0jK7MethodsAA0bK9PublisherVyxGxm_So012OS_dispatch_G0CAA0B12Preprocessor_pAA0B7Decoder_pShySiGShyAA10HTTPMethodVGtSeRzlF">publishDecodable(type:<wbr>queue:<wbr>preprocessor:<wbr>decoder:<wbr>emptyResponseCodes:<wbr>emptyResponseMethods:<wbr>)</a>
  894. </code>
  895. </div>
  896. <div class="height-container">
  897. <div class="pointer-container"></div>
  898. <section class="section">
  899. <div class="pointer"></div>
  900. <div class="abstract">
  901. <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
  902. response.</p>
  903. </div>
  904. <div class="declaration">
  905. <h4>Declaration</h4>
  906. <div class="language">
  907. <p class="aside-title">Swift</p>
  908. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  909. <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>
  910. <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>
  911. <span class="nv">preprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  912. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  913. <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>
  914. <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>
  915. </div>
  916. </div>
  917. <div>
  918. <h4>Parameters</h4>
  919. <table class="graybox">
  920. <tbody>
  921. <tr>
  922. <td>
  923. <code>
  924. <em>type</em>
  925. </code>
  926. </td>
  927. <td>
  928. <div>
  929. <p><code>Decodable</code> type to which to decode response <code>Data</code>. Inferred from the context by default.</p>
  930. </div>
  931. </td>
  932. </tr>
  933. <tr>
  934. <td>
  935. <code>
  936. <em>queue</em>
  937. </code>
  938. </td>
  939. <td>
  940. <div>
  941. <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>
  942. </div>
  943. </td>
  944. </tr>
  945. <tr>
  946. <td>
  947. <code>
  948. <em>preprocessor</em>
  949. </code>
  950. </td>
  951. <td>
  952. <div>
  953. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which filters the <code>Data</code> before serialization. <code>PassthroughPreprocessor()</code>
  954. by default.</p>
  955. </div>
  956. </td>
  957. </tr>
  958. <tr>
  959. <td>
  960. <code>
  961. <em>decoder</em>
  962. </code>
  963. </td>
  964. <td>
  965. <div>
  966. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> instance used to decode response <code>Data</code>. <code>JSONDecoder()</code> by default.</p>
  967. </div>
  968. </td>
  969. </tr>
  970. <tr>
  971. <td>
  972. <code>
  973. <em>emptyResponseCodes</em>
  974. </code>
  975. </td>
  976. <td>
  977. <div>
  978. <p><code>Set&lt;Int&gt;</code> of HTTP status codes for which empty responses are allowed. <code>[204, 205]</code> by
  979. default.</p>
  980. </div>
  981. </td>
  982. </tr>
  983. <tr>
  984. <td>
  985. <code>
  986. <em>emptyRequestMethods</em>
  987. </code>
  988. </td>
  989. <td>
  990. <div>
  991. <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
  992. status code. <code>[.head]</code> by default.</p>
  993. </div>
  994. </td>
  995. </tr>
  996. </tbody>
  997. </table>
  998. </div>
  999. <div>
  1000. <h4>Return Value</h4>
  1001. <p>The <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code>.</p>
  1002. </div>
  1003. </section>
  1004. </div>
  1005. </li>
  1006. <li class="item">
  1007. <div>
  1008. <code>
  1009. <a name="/s:9Alamofire11DataRequestC19publishUnserialized5queueAA0B17ResponsePublisherVy10Foundation0B0VSgGSo012OS_dispatch_F0C_tF"></a>
  1010. <a name="//apple_ref/swift/Method/publishUnserialized(queue:)" class="dashAnchor"></a>
  1011. <a class="token" href="#/s:9Alamofire11DataRequestC19publishUnserialized5queueAA0B17ResponsePublisherVy10Foundation0B0VSgGSo012OS_dispatch_F0C_tF">publishUnserialized(queue:<wbr>)</a>
  1012. </code>
  1013. </div>
  1014. <div class="height-container">
  1015. <div class="pointer-container"></div>
  1016. <section class="section">
  1017. <div class="pointer"></div>
  1018. <div class="abstract">
  1019. <p>Creates a <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code> for this instance which does not serialize the response before publishing.</p>
  1020. <ul>
  1021. <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>
  1022. </ul>
  1023. </div>
  1024. <div class="declaration">
  1025. <h4>Declaration</h4>
  1026. <div class="language">
  1027. <p class="aside-title">Swift</p>
  1028. <pre class="highlight swift"><code><span class="kd">@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)</span>
  1029. <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>
  1030. </div>
  1031. </div>
  1032. <div>
  1033. <h4>Return Value</h4>
  1034. <p>The <code><a href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a></code>.</p>
  1035. </div>
  1036. </section>
  1037. </div>
  1038. </li>
  1039. </ul>
  1040. </div>
  1041. <div class="task-group">
  1042. <div class="task-name-container">
  1043. <a name="/Default"></a>
  1044. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  1045. <div class="section-name-container">
  1046. <a class="section-name-link" href="#/Default"></a>
  1047. <h3 class="section-name"><p>Default</p>
  1048. </h3>
  1049. </div>
  1050. </div>
  1051. <ul class="item-container">
  1052. <li class="item">
  1053. <div>
  1054. <code>
  1055. <a name="/s:9Alamofire11DataRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation0B0VSgAA7AFErrorOGctF"></a>
  1056. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  1057. <a class="token" href="#/s:9Alamofire11DataRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation0B0VSgAA7AFErrorOGctF">response(queue:<wbr>completionHandler:<wbr>)</a>
  1058. </code>
  1059. </div>
  1060. <div class="height-container">
  1061. <div class="pointer-container"></div>
  1062. <section class="section">
  1063. <div class="pointer"></div>
  1064. <div class="abstract">
  1065. <p>Adds a handler to be called once the request has finished.</p>
  1066. </div>
  1067. <div class="declaration">
  1068. <h4>Declaration</h4>
  1069. <div class="language">
  1070. <p class="aside-title">Swift</p>
  1071. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1072. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">response</span><span class="p">(</span><span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="p">?</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1073. </div>
  1074. </div>
  1075. <div>
  1076. <h4>Parameters</h4>
  1077. <table class="graybox">
  1078. <tbody>
  1079. <tr>
  1080. <td>
  1081. <code>
  1082. <em>queue</em>
  1083. </code>
  1084. </td>
  1085. <td>
  1086. <div>
  1087. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1088. </div>
  1089. </td>
  1090. </tr>
  1091. <tr>
  1092. <td>
  1093. <code>
  1094. <em>completionHandler</em>
  1095. </code>
  1096. </td>
  1097. <td>
  1098. <div>
  1099. <p>The code to be executed once the request has finished.</p>
  1100. </div>
  1101. </td>
  1102. </tr>
  1103. </tbody>
  1104. </table>
  1105. </div>
  1106. <div>
  1107. <h4>Return Value</h4>
  1108. <p>The request.</p>
  1109. </div>
  1110. </section>
  1111. </div>
  1112. </li>
  1113. <li class="item">
  1114. <div>
  1115. <code>
  1116. <a name="/s:9Alamofire11DataRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  1117. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  1118. <a class="token" href="#/s:9Alamofire11DataRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:<wbr>responseSerializer:<wbr>completionHandler:<wbr>)</a>
  1119. </code>
  1120. </div>
  1121. <div class="height-container">
  1122. <div class="pointer-container"></div>
  1123. <section class="section">
  1124. <div class="pointer"></div>
  1125. <div class="abstract">
  1126. <p>Adds a handler to be called once the request has finished.</p>
  1127. </div>
  1128. <div class="declaration">
  1129. <h4>Declaration</h4>
  1130. <div class="language">
  1131. <p class="aside-title">Swift</p>
  1132. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1133. <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>
  1134. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  1135. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a></span><span class="o">&lt;</span><span class="kt">Serializer</span><span class="o">.</span><span class="kt">SerializedObject</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span>
  1136. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1137. </div>
  1138. </div>
  1139. <div>
  1140. <h4>Parameters</h4>
  1141. <table class="graybox">
  1142. <tbody>
  1143. <tr>
  1144. <td>
  1145. <code>
  1146. <em>queue</em>
  1147. </code>
  1148. </td>
  1149. <td>
  1150. <div>
  1151. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default</p>
  1152. </div>
  1153. </td>
  1154. </tr>
  1155. <tr>
  1156. <td>
  1157. <code>
  1158. <em>responseSerializer</em>
  1159. </code>
  1160. </td>
  1161. <td>
  1162. <div>
  1163. <p>The response serializer responsible for serializing the request, response, and data.</p>
  1164. </div>
  1165. </td>
  1166. </tr>
  1167. <tr>
  1168. <td>
  1169. <code>
  1170. <em>completionHandler</em>
  1171. </code>
  1172. </td>
  1173. <td>
  1174. <div>
  1175. <p>The code to be executed once the request has finished.</p>
  1176. </div>
  1177. </td>
  1178. </tr>
  1179. </tbody>
  1180. </table>
  1181. </div>
  1182. <div>
  1183. <h4>Return Value</h4>
  1184. <p>The request.</p>
  1185. </div>
  1186. </section>
  1187. </div>
  1188. </li>
  1189. </ul>
  1190. </div>
  1191. <div class="task-group">
  1192. <div class="task-name-container">
  1193. <a name="/Data"></a>
  1194. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  1195. <div class="section-name-container">
  1196. <a class="section-name-link" href="#/Data"></a>
  1197. <h3 class="section-name"><p>Data</p>
  1198. </h3>
  1199. </div>
  1200. </div>
  1201. <ul class="item-container">
  1202. <li class="item">
  1203. <div>
  1204. <code>
  1205. <a name="/s:9Alamofire11DataRequestC08responseB05queue16dataPreprocessor18emptyResponseCodes0hC7Methods17completionHandlerACXDSo012OS_dispatch_E0C_AA0bG0_pShySiGShyAA10HTTPMethodVGyAA0bI0Vy10Foundation0B0VAA7AFErrorOGctF"></a>
  1206. <a name="//apple_ref/swift/Method/responseData(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1207. <a class="token" href="#/s:9Alamofire11DataRequestC08responseB05queue16dataPreprocessor18emptyResponseCodes0hC7Methods17completionHandlerACXDSo012OS_dispatch_E0C_AA0bG0_pShySiGShyAA10HTTPMethodVGyAA0bI0Vy10Foundation0B0VAA7AFErrorOGctF">responseData(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  1208. </code>
  1209. </div>
  1210. <div class="height-container">
  1211. <div class="pointer-container"></div>
  1212. <section class="section">
  1213. <div class="pointer"></div>
  1214. <div class="abstract">
  1215. <p>Adds a handler using a <code><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></code> to be called once the request has finished.</p>
  1216. </div>
  1217. <div class="declaration">
  1218. <h4>Declaration</h4>
  1219. <div class="language">
  1220. <p class="aside-title">Swift</p>
  1221. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1222. <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>
  1223. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1224. <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>
  1225. <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>
  1226. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a></span><span class="o">&lt;</span><span class="kt">Data</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1227. </div>
  1228. </div>
  1229. <div>
  1230. <h4>Parameters</h4>
  1231. <table class="graybox">
  1232. <tbody>
  1233. <tr>
  1234. <td>
  1235. <code>
  1236. <em>queue</em>
  1237. </code>
  1238. </td>
  1239. <td>
  1240. <div>
  1241. <p>The queue on which the completion handler is called. <code>.main</code> by default.</p>
  1242. </div>
  1243. </td>
  1244. </tr>
  1245. <tr>
  1246. <td>
  1247. <code>
  1248. <em>dataPreprocessor</em>
  1249. </code>
  1250. </td>
  1251. <td>
  1252. <div>
  1253. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1254. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1255. </div>
  1256. </td>
  1257. </tr>
  1258. <tr>
  1259. <td>
  1260. <code>
  1261. <em>emptyResponseCodes</em>
  1262. </code>
  1263. </td>
  1264. <td>
  1265. <div>
  1266. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1267. </div>
  1268. </td>
  1269. </tr>
  1270. <tr>
  1271. <td>
  1272. <code>
  1273. <em>emptyRequestMethods</em>
  1274. </code>
  1275. </td>
  1276. <td>
  1277. <div>
  1278. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1279. </div>
  1280. </td>
  1281. </tr>
  1282. <tr>
  1283. <td>
  1284. <code>
  1285. <em>completionHandler</em>
  1286. </code>
  1287. </td>
  1288. <td>
  1289. <div>
  1290. <p>A closure to be executed once the request has finished.</p>
  1291. </div>
  1292. </td>
  1293. </tr>
  1294. </tbody>
  1295. </table>
  1296. </div>
  1297. <div>
  1298. <h4>Return Value</h4>
  1299. <p>The request.</p>
  1300. </div>
  1301. </section>
  1302. </div>
  1303. </li>
  1304. </ul>
  1305. </div>
  1306. <div class="task-group">
  1307. <div class="task-name-container">
  1308. <a name="/String"></a>
  1309. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  1310. <div class="section-name-container">
  1311. <a class="section-name-link" href="#/String"></a>
  1312. <h3 class="section-name"><p>String</p>
  1313. </h3>
  1314. </div>
  1315. </div>
  1316. <ul class="item-container">
  1317. <li class="item">
  1318. <div>
  1319. <code>
  1320. <a name="/s:9Alamofire11DataRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0bH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF"></a>
  1321. <a name="//apple_ref/swift/Method/responseString(queue:dataPreprocessor:encoding:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1322. <a class="token" href="#/s:9Alamofire11DataRequestC14responseString5queue16dataPreprocessor8encoding18emptyResponseCodes0jC7Methods17completionHandlerACXDSo012OS_dispatch_F0C_AA0bH0_pSS10FoundationE8EncodingVSgShySiGShyAA10HTTPMethodVGyAA0bK0VySSAA7AFErrorOGctF">responseString(queue:<wbr>dataPreprocessor:<wbr>encoding:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>completionHandler:<wbr>)</a>
  1323. </code>
  1324. </div>
  1325. <div class="height-container">
  1326. <div class="pointer-container"></div>
  1327. <section class="section">
  1328. <div class="pointer"></div>
  1329. <div class="abstract">
  1330. <p>Adds a handler using a <code><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></code> to be called once the request has finished.</p>
  1331. </div>
  1332. <div class="declaration">
  1333. <h4>Declaration</h4>
  1334. <div class="language">
  1335. <p class="aside-title">Swift</p>
  1336. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1337. <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>
  1338. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1339. <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>
  1340. <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>
  1341. <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>
  1342. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1343. </div>
  1344. </div>
  1345. <div>
  1346. <h4>Parameters</h4>
  1347. <table class="graybox">
  1348. <tbody>
  1349. <tr>
  1350. <td>
  1351. <code>
  1352. <em>queue</em>
  1353. </code>
  1354. </td>
  1355. <td>
  1356. <div>
  1357. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1358. </div>
  1359. </td>
  1360. </tr>
  1361. <tr>
  1362. <td>
  1363. <code>
  1364. <em>dataPreprocessor</em>
  1365. </code>
  1366. </td>
  1367. <td>
  1368. <div>
  1369. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1370. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1371. </div>
  1372. </td>
  1373. </tr>
  1374. <tr>
  1375. <td>
  1376. <code>
  1377. <em>encoding</em>
  1378. </code>
  1379. </td>
  1380. <td>
  1381. <div>
  1382. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  1383. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1384. </div>
  1385. </td>
  1386. </tr>
  1387. <tr>
  1388. <td>
  1389. <code>
  1390. <em>emptyResponseCodes</em>
  1391. </code>
  1392. </td>
  1393. <td>
  1394. <div>
  1395. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1396. </div>
  1397. </td>
  1398. </tr>
  1399. <tr>
  1400. <td>
  1401. <code>
  1402. <em>emptyRequestMethods</em>
  1403. </code>
  1404. </td>
  1405. <td>
  1406. <div>
  1407. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1408. </div>
  1409. </td>
  1410. </tr>
  1411. <tr>
  1412. <td>
  1413. <code>
  1414. <em>completionHandler</em>
  1415. </code>
  1416. </td>
  1417. <td>
  1418. <div>
  1419. <p>A closure to be executed once the request has finished.</p>
  1420. </div>
  1421. </td>
  1422. </tr>
  1423. </tbody>
  1424. </table>
  1425. </div>
  1426. <div>
  1427. <h4>Return Value</h4>
  1428. <p>The request.</p>
  1429. </div>
  1430. </section>
  1431. </div>
  1432. </li>
  1433. </ul>
  1434. </div>
  1435. <div class="task-group">
  1436. <div class="task-name-container">
  1437. <a name="/JSON"></a>
  1438. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  1439. <div class="section-name-container">
  1440. <a class="section-name-link" href="#/JSON"></a>
  1441. <h3 class="section-name"><p>JSON</p>
  1442. </h3>
  1443. </div>
  1444. </div>
  1445. <ul class="item-container">
  1446. <li class="item">
  1447. <div>
  1448. <code>
  1449. <a name="/s:9Alamofire11DataRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA0bH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF"></a>
  1450. <a name="//apple_ref/swift/Method/responseJSON(queue:dataPreprocessor:emptyResponseCodes:emptyRequestMethods:options:completionHandler:)" class="dashAnchor"></a>
  1451. <a class="token" href="#/s:9Alamofire11DataRequestC12responseJSON5queue16dataPreprocessor18emptyResponseCodes0iC7Methods7options17completionHandlerACXDSo012OS_dispatch_F0C_AA0bH0_pShySiGShyAA10HTTPMethodVGSo20NSJSONReadingOptionsVyAA0bJ0VyypAA7AFErrorOGctF">responseJSON(queue:<wbr>dataPreprocessor:<wbr>emptyResponseCodes:<wbr>emptyRequestMethods:<wbr>options:<wbr>completionHandler:<wbr>)</a>
  1452. </code>
  1453. </div>
  1454. <div class="height-container">
  1455. <div class="pointer-container"></div>
  1456. <section class="section">
  1457. <div class="pointer"></div>
  1458. <div class="abstract">
  1459. <p>Adds a handler using a <code><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></code> to be called once the request has finished.</p>
  1460. </div>
  1461. <div class="declaration">
  1462. <h4>Declaration</h4>
  1463. <div class="language">
  1464. <p class="aside-title">Swift</p>
  1465. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1466. <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>
  1467. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a></span><span class="o">.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1468. <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>
  1469. <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>
  1470. <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>
  1471. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a></span><span class="o">&lt;</span><span class="kt">Any</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1472. </div>
  1473. </div>
  1474. <div>
  1475. <h4>Parameters</h4>
  1476. <table class="graybox">
  1477. <tbody>
  1478. <tr>
  1479. <td>
  1480. <code>
  1481. <em>queue</em>
  1482. </code>
  1483. </td>
  1484. <td>
  1485. <div>
  1486. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1487. </div>
  1488. </td>
  1489. </tr>
  1490. <tr>
  1491. <td>
  1492. <code>
  1493. <em>dataPreprocessor</em>
  1494. </code>
  1495. </td>
  1496. <td>
  1497. <div>
  1498. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1499. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1500. </div>
  1501. </td>
  1502. </tr>
  1503. <tr>
  1504. <td>
  1505. <code>
  1506. <em>encoding</em>
  1507. </code>
  1508. </td>
  1509. <td>
  1510. <div>
  1511. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  1512. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1513. </div>
  1514. </td>
  1515. </tr>
  1516. <tr>
  1517. <td>
  1518. <code>
  1519. <em>emptyResponseCodes</em>
  1520. </code>
  1521. </td>
  1522. <td>
  1523. <div>
  1524. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1525. </div>
  1526. </td>
  1527. </tr>
  1528. <tr>
  1529. <td>
  1530. <code>
  1531. <em>emptyRequestMethods</em>
  1532. </code>
  1533. </td>
  1534. <td>
  1535. <div>
  1536. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1537. </div>
  1538. </td>
  1539. </tr>
  1540. <tr>
  1541. <td>
  1542. <code>
  1543. <em>options</em>
  1544. </code>
  1545. </td>
  1546. <td>
  1547. <div>
  1548. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  1549. by default.</p>
  1550. </div>
  1551. </td>
  1552. </tr>
  1553. <tr>
  1554. <td>
  1555. <code>
  1556. <em>completionHandler</em>
  1557. </code>
  1558. </td>
  1559. <td>
  1560. <div>
  1561. <p>A closure to be executed once the request has finished.</p>
  1562. </div>
  1563. </td>
  1564. </tr>
  1565. </tbody>
  1566. </table>
  1567. </div>
  1568. <div>
  1569. <h4>Return Value</h4>
  1570. <p>The request.</p>
  1571. </div>
  1572. </section>
  1573. </div>
  1574. </li>
  1575. </ul>
  1576. </div>
  1577. <div class="task-group">
  1578. <div class="task-name-container">
  1579. <a name="/Decodable"></a>
  1580. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  1581. <div class="section-name-container">
  1582. <a class="section-name-link" href="#/Decodable"></a>
  1583. <h3 class="section-name"><p>Decodable</p>
  1584. </h3>
  1585. </div>
  1586. </div>
  1587. <ul class="item-container">
  1588. <li class="item">
  1589. <div>
  1590. <code>
  1591. <a name="/s:9Alamofire11DataRequestC17responseDecodable2of5queue16dataPreprocessor7decoder18emptyResponseCodes0kC7Methods17completionHandlerACXDxm_So012OS_dispatch_G0CAA0bI0_pAA0B7Decoder_pShySiGShyAA10HTTPMethodVGyAA0bL0VyxAA7AFErrorOGctSeRzlF"></a>
  1592. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:dataPreprocessor:decoder:emptyResponseCodes:emptyRequestMethods:completionHandler:)" class="dashAnchor"></a>
  1593. <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>
  1594. </code>
  1595. </div>
  1596. <div class="height-container">
  1597. <div class="pointer-container"></div>
  1598. <section class="section">
  1599. <div class="pointer"></div>
  1600. <div class="abstract">
  1601. <p>Adds a handler using a <code><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></code> to be called once the request has finished.</p>
  1602. </div>
  1603. <div class="declaration">
  1604. <h4>Declaration</h4>
  1605. <div class="language">
  1606. <p class="aside-title">Swift</p>
  1607. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1608. <span class="kd">public</span> <span class="kd">func</span> <span class="n">responseDecodable</span><span class="o">&lt;</span><span class="kt">T</span><span class="p">:</span> <span class="kt">Decodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">of</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span> <span class="o">=</span> <span class="kt">T</span><span class="o">.</span><span class="k">self</span><span class="p">,</span>
  1609. <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>
  1610. <span class="nv">dataPreprocessor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;.</span><span class="n">defaultDataPreprocessor</span><span class="p">,</span>
  1611. <span class="nv">decoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/DataDecoder.html">DataDecoder</a></span> <span class="o">=</span> <span class="kt">JSONDecoder</span><span class="p">(),</span>
  1612. <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>
  1613. <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>
  1614. <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a></span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1615. </div>
  1616. </div>
  1617. <div>
  1618. <h4>Parameters</h4>
  1619. <table class="graybox">
  1620. <tbody>
  1621. <tr>
  1622. <td>
  1623. <code>
  1624. <em>type</em>
  1625. </code>
  1626. </td>
  1627. <td>
  1628. <div>
  1629. <p><code>Decodable</code> type to decode from response data.</p>
  1630. </div>
  1631. </td>
  1632. </tr>
  1633. <tr>
  1634. <td>
  1635. <code>
  1636. <em>queue</em>
  1637. </code>
  1638. </td>
  1639. <td>
  1640. <div>
  1641. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1642. </div>
  1643. </td>
  1644. </tr>
  1645. <tr>
  1646. <td>
  1647. <code>
  1648. <em>dataPreprocessor</em>
  1649. </code>
  1650. </td>
  1651. <td>
  1652. <div>
  1653. <p><code><a href="../Protocols/DataPreprocessor.html">DataPreprocessor</a></code> which processes the received <code>Data</code> before calling the
  1654. <code>completionHandler</code>. <code>PassthroughPreprocessor()</code> by default.</p>
  1655. </div>
  1656. </td>
  1657. </tr>
  1658. <tr>
  1659. <td>
  1660. <code>
  1661. <em>decoder</em>
  1662. </code>
  1663. </td>
  1664. <td>
  1665. <div>
  1666. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  1667. </div>
  1668. </td>
  1669. </tr>
  1670. <tr>
  1671. <td>
  1672. <code>
  1673. <em>encoding</em>
  1674. </code>
  1675. </td>
  1676. <td>
  1677. <div>
  1678. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined
  1679. from the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  1680. </div>
  1681. </td>
  1682. </tr>
  1683. <tr>
  1684. <td>
  1685. <code>
  1686. <em>emptyResponseCodes</em>
  1687. </code>
  1688. </td>
  1689. <td>
  1690. <div>
  1691. <p>HTTP status codes for which empty responses are always valid. <code>[204, 205]</code> by default.</p>
  1692. </div>
  1693. </td>
  1694. </tr>
  1695. <tr>
  1696. <td>
  1697. <code>
  1698. <em>emptyRequestMethods</em>
  1699. </code>
  1700. </td>
  1701. <td>
  1702. <div>
  1703. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>s for which empty responses are always valid. <code>[.head]</code> by default.</p>
  1704. </div>
  1705. </td>
  1706. </tr>
  1707. <tr>
  1708. <td>
  1709. <code>
  1710. <em>options</em>
  1711. </code>
  1712. </td>
  1713. <td>
  1714. <div>
  1715. <p><code>JSONSerialization.ReadingOptions</code> used when parsing the response. <code>.allowFragments</code>
  1716. by default.</p>
  1717. </div>
  1718. </td>
  1719. </tr>
  1720. <tr>
  1721. <td>
  1722. <code>
  1723. <em>completionHandler</em>
  1724. </code>
  1725. </td>
  1726. <td>
  1727. <div>
  1728. <p>A closure to be executed once the request has finished.</p>
  1729. </div>
  1730. </td>
  1731. </tr>
  1732. </tbody>
  1733. </table>
  1734. </div>
  1735. <div>
  1736. <h4>Return Value</h4>
  1737. <p>The request.</p>
  1738. </div>
  1739. </section>
  1740. </div>
  1741. </li>
  1742. </ul>
  1743. </div>
  1744. <div class="task-group">
  1745. <ul class="item-container">
  1746. <li class="item">
  1747. <div>
  1748. <code>
  1749. <a name="/s:9Alamofire11DataRequestC10Validationa"></a>
  1750. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1751. <a class="token" href="#/s:9Alamofire11DataRequestC10Validationa">Validation</a>
  1752. </code>
  1753. </div>
  1754. <div class="height-container">
  1755. <div class="pointer-container"></div>
  1756. <section class="section">
  1757. <div class="pointer"></div>
  1758. <div class="abstract">
  1759. <p>A closure used to validate a request that takes a URL request, a URL response and data, and returns whether the
  1760. request was valid.</p>
  1761. </div>
  1762. <div class="declaration">
  1763. <h4>Declaration</h4>
  1764. <div class="language">
  1765. <p class="aside-title">Swift</p>
  1766. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">Validation</span> <span class="o">=</span> <span class="p">(</span><span class="kt">URLRequest</span><span class="p">?,</span> <span class="kt">HTTPURLResponse</span><span class="p">,</span> <span class="kt">Data</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">ValidationResult</span></code></pre>
  1767. </div>
  1768. </div>
  1769. </section>
  1770. </div>
  1771. </li>
  1772. <li class="item">
  1773. <div>
  1774. <code>
  1775. <a name="/s:9Alamofire11DataRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1776. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1777. <a class="token" href="#/s:9Alamofire11DataRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:<wbr>)</a>
  1778. </code>
  1779. </div>
  1780. <div class="height-container">
  1781. <div class="pointer-container"></div>
  1782. <section class="section">
  1783. <div class="pointer"></div>
  1784. <div class="abstract">
  1785. <p>Validates that the response has a status code in the specified sequence.</p>
  1786. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1787. </div>
  1788. <div class="declaration">
  1789. <h4>Declaration</h4>
  1790. <div class="language">
  1791. <p class="aside-title">Swift</p>
  1792. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1793. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</span><span class="p">(</span><span class="n">statusCode</span> <span class="nv">acceptableStatusCodes</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">Int</span></code></pre>
  1794. </div>
  1795. </div>
  1796. <div>
  1797. <h4>Parameters</h4>
  1798. <table class="graybox">
  1799. <tbody>
  1800. <tr>
  1801. <td>
  1802. <code>
  1803. <em>statusCode</em>
  1804. </code>
  1805. </td>
  1806. <td>
  1807. <div>
  1808. <p><code>Sequence</code> of acceptable response status codes.</p>
  1809. </div>
  1810. </td>
  1811. </tr>
  1812. </tbody>
  1813. </table>
  1814. </div>
  1815. <div>
  1816. <h4>Return Value</h4>
  1817. <p>The instance.</p>
  1818. </div>
  1819. </section>
  1820. </div>
  1821. </li>
  1822. <li class="item">
  1823. <div>
  1824. <code>
  1825. <a name="/s:9Alamofire11DataRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1826. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1827. <a class="token" href="#/s:9Alamofire11DataRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:<wbr>)</a>
  1828. </code>
  1829. </div>
  1830. <div class="height-container">
  1831. <div class="pointer-container"></div>
  1832. <section class="section">
  1833. <div class="pointer"></div>
  1834. <div class="abstract">
  1835. <p>Validates that the response has a content type in the specified sequence.</p>
  1836. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1837. </div>
  1838. <div class="declaration">
  1839. <h4>Declaration</h4>
  1840. <div class="language">
  1841. <p class="aside-title">Swift</p>
  1842. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1843. <span class="kd">public</span> <span class="kd">func</span> <span class="n">validate</span><span class="o">&lt;</span><span class="kt">S</span><span class="o">&gt;</span><span class="p">(</span><span class="n">contentType</span> <span class="nv">acceptableContentTypes</span><span class="p">:</span> <span class="kd">@autoclosure</span> <span class="kd">@escaping</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span> <span class="k">where</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">Sequence</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span></code></pre>
  1844. </div>
  1845. </div>
  1846. <div>
  1847. <h4>Parameters</h4>
  1848. <table class="graybox">
  1849. <tbody>
  1850. <tr>
  1851. <td>
  1852. <code>
  1853. <em>contentType</em>
  1854. </code>
  1855. </td>
  1856. <td>
  1857. <div>
  1858. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1859. </div>
  1860. </td>
  1861. </tr>
  1862. </tbody>
  1863. </table>
  1864. </div>
  1865. <div>
  1866. <h4>Return Value</h4>
  1867. <p>The request.</p>
  1868. </div>
  1869. </section>
  1870. </div>
  1871. </li>
  1872. <li class="item">
  1873. <div>
  1874. <code>
  1875. <a name="/s:9Alamofire11DataRequestC8validateACXDyF"></a>
  1876. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1877. <a class="token" href="#/s:9Alamofire11DataRequestC8validateACXDyF">validate()</a>
  1878. </code>
  1879. </div>
  1880. <div class="height-container">
  1881. <div class="pointer-container"></div>
  1882. <section class="section">
  1883. <div class="pointer"></div>
  1884. <div class="abstract">
  1885. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1886. type matches any specified in the Accept HTTP header field.</p>
  1887. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1888. </div>
  1889. <div class="declaration">
  1890. <h4>Declaration</h4>
  1891. <div class="language">
  1892. <p class="aside-title">Swift</p>
  1893. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1894. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">validate</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1895. </div>
  1896. </div>
  1897. <div>
  1898. <h4>Return Value</h4>
  1899. <p>The request.</p>
  1900. </div>
  1901. </section>
  1902. </div>
  1903. </li>
  1904. </ul>
  1905. </div>
  1906. </div>
  1907. </section>
  1908. </article>
  1909. </div>
  1910. <section class="footer">
  1911. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-12-20)</p>
  1912. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1913. </section>
  1914. </body>
  1915. </div>
  1916. </html>