DataRequest.html 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276
  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 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%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  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/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  192. </li>
  193. </ul>
  194. </li>
  195. <li class="nav-group-name">
  196. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  197. <ul class="nav-group-tasks">
  198. <li class="nav-group-task">
  199. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  200. </li>
  201. <li class="nav-group-task">
  202. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  203. </li>
  204. <li class="nav-group-task">
  205. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  206. </li>
  207. <li class="nav-group-task">
  208. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  209. </li>
  210. <li class="nav-group-task">
  211. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  212. </li>
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  224. </li>
  225. </ul>
  226. </li>
  227. <li class="nav-group-name">
  228. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  229. <ul class="nav-group-tasks">
  230. <li class="nav-group-task">
  231. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  232. </li>
  233. <li class="nav-group-task">
  234. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  235. </li>
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  280. </li>
  281. </ul>
  282. </li>
  283. <li class="nav-group-name">
  284. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  285. <ul class="nav-group-tasks">
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  348. </li>
  349. </ul>
  350. </li>
  351. <li class="nav-group-name">
  352. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  353. <ul class="nav-group-tasks">
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  407. </li>
  408. </ul>
  409. </li>
  410. <li class="nav-group-name">
  411. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  412. <ul class="nav-group-tasks">
  413. <li class="nav-group-task">
  414. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  415. </li>
  416. <li class="nav-group-task">
  417. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  418. </li>
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  430. </li>
  431. </ul>
  432. </li>
  433. </ul>
  434. </nav>
  435. <article class="main-content">
  436. <section class="section">
  437. <div class="section-content top-matter">
  438. <h1>DataRequest</h1>
  439. <div class="declaration">
  440. <div class="language">
  441. <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>
  442. </div>
  443. </div>
  444. <p><code><a href="../Classes/Request.html">Request</a></code> subclass which handles in-memory <code>Data</code> download using <code>URLSessionDataTask</code>.</p>
  445. </div>
  446. </section>
  447. <section class="section">
  448. <div class="section-content">
  449. <div class="task-group">
  450. <ul class="item-container">
  451. <li class="item">
  452. <div>
  453. <code>
  454. <a name="/s:9Alamofire11DataRequestC11convertibleAA21URLRequestConvertible_pvp"></a>
  455. <a name="//apple_ref/swift/Property/convertible" class="dashAnchor"></a>
  456. <a class="token" href="#/s:9Alamofire11DataRequestC11convertibleAA21URLRequestConvertible_pvp">convertible</a>
  457. </code>
  458. </div>
  459. <div class="height-container">
  460. <div class="pointer-container"></div>
  461. <section class="section">
  462. <div class="pointer"></div>
  463. <div class="abstract">
  464. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value used to create <code>URLRequest</code>s for this instance.</p>
  465. </div>
  466. <div class="declaration">
  467. <h4>Declaration</h4>
  468. <div class="language">
  469. <p class="aside-title">Swift</p>
  470. <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>
  471. </div>
  472. </div>
  473. </section>
  474. </div>
  475. </li>
  476. <li class="item">
  477. <div>
  478. <code>
  479. <a name="/s:9Alamofire11DataRequestC4data10Foundation0B0VSgvp"></a>
  480. <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
  481. <a class="token" href="#/s:9Alamofire11DataRequestC4data10Foundation0B0VSgvp">data</a>
  482. </code>
  483. </div>
  484. <div class="height-container">
  485. <div class="pointer-container"></div>
  486. <section class="section">
  487. <div class="pointer"></div>
  488. <div class="abstract">
  489. <p><code>Data</code> read from the server so far.</p>
  490. </div>
  491. <div class="declaration">
  492. <h4>Declaration</h4>
  493. <div class="language">
  494. <p class="aside-title">Swift</p>
  495. <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>
  496. </div>
  497. </div>
  498. </section>
  499. </div>
  500. </li>
  501. <li class="item">
  502. <div>
  503. <code>
  504. <a name="/s:9Alamofire11DataRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI0B0VSgtcF"></a>
  505. <a name="//apple_ref/swift/Method/validate(_:)" class="dashAnchor"></a>
  506. <a class="token" href="#/s:9Alamofire11DataRequestC8validateyACXDs6ResultOyyts5Error_pG10Foundation10URLRequestVSg_So17NSHTTPURLResponseCAI0B0VSgtcF">validate(_:)</a>
  507. </code>
  508. </div>
  509. <div class="height-container">
  510. <div class="pointer-container"></div>
  511. <section class="section">
  512. <div class="pointer"></div>
  513. <div class="abstract">
  514. <p>Validates the request, using the specified closure.</p>
  515. <div class="aside aside-note">
  516. <p class="aside-title">Note</p>
  517. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  518. </div>
  519. </div>
  520. <div class="declaration">
  521. <h4>Declaration</h4>
  522. <div class="language">
  523. <p class="aside-title">Swift</p>
  524. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  525. <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>
  526. </div>
  527. </div>
  528. <div>
  529. <h4>Parameters</h4>
  530. <table class="graybox">
  531. <tbody>
  532. <tr>
  533. <td>
  534. <code>
  535. <em>validation</em>
  536. </code>
  537. </td>
  538. <td>
  539. <div>
  540. <p><code><a href="../Classes/DataRequest.html#/s:9Alamofire11DataRequestC10Validationa">Validation</a></code> closure used to validate the response.</p>
  541. </div>
  542. </td>
  543. </tr>
  544. </tbody>
  545. </table>
  546. </div>
  547. <div>
  548. <h4>Return Value</h4>
  549. <p>The instance.</p>
  550. </div>
  551. </section>
  552. </div>
  553. </li>
  554. </ul>
  555. </div>
  556. <div class="task-group">
  557. <div class="task-name-container">
  558. <a name="/Default"></a>
  559. <a name="//apple_ref/swift/Section/Default" class="dashAnchor"></a>
  560. <div class="section-name-container">
  561. <a class="section-name-link" href="#/Default"></a>
  562. <h3 class="section-name"><p>Default</p>
  563. </h3>
  564. </div>
  565. </div>
  566. <ul class="item-container">
  567. <li class="item">
  568. <div>
  569. <code>
  570. <a name="/s:9Alamofire11DataRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation0B0VSgAA7AFErrorOGctF"></a>
  571. <a name="//apple_ref/swift/Method/response(queue:completionHandler:)" class="dashAnchor"></a>
  572. <a class="token" href="#/s:9Alamofire11DataRequestC8response5queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation0B0VSgAA7AFErrorOGctF">response(queue:completionHandler:)</a>
  573. </code>
  574. </div>
  575. <div class="height-container">
  576. <div class="pointer-container"></div>
  577. <section class="section">
  578. <div class="pointer"></div>
  579. <div class="abstract">
  580. <p>Adds a handler to be called once the request has finished.</p>
  581. </div>
  582. <div class="declaration">
  583. <h4>Declaration</h4>
  584. <div class="language">
  585. <p class="aside-title">Swift</p>
  586. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  587. <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>
  588. </div>
  589. </div>
  590. <div>
  591. <h4>Parameters</h4>
  592. <table class="graybox">
  593. <tbody>
  594. <tr>
  595. <td>
  596. <code>
  597. <em>queue</em>
  598. </code>
  599. </td>
  600. <td>
  601. <div>
  602. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  603. </div>
  604. </td>
  605. </tr>
  606. <tr>
  607. <td>
  608. <code>
  609. <em>completionHandler</em>
  610. </code>
  611. </td>
  612. <td>
  613. <div>
  614. <p>The code to be executed once the request has finished.</p>
  615. </div>
  616. </td>
  617. </tr>
  618. </tbody>
  619. </table>
  620. </div>
  621. <div>
  622. <h4>Return Value</h4>
  623. <p>The request.</p>
  624. </div>
  625. </section>
  626. </div>
  627. </li>
  628. <li class="item">
  629. <div>
  630. <code>
  631. <a name="/s:9Alamofire11DataRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF"></a>
  632. <a name="//apple_ref/swift/Method/response(queue:responseSerializer:completionHandler:)" class="dashAnchor"></a>
  633. <a class="token" href="#/s:9Alamofire11DataRequestC8response5queue0D10Serializer17completionHandlerACXDSo012OS_dispatch_E0C_xyAA0B8ResponseVy16SerializedObjectQzAA7AFErrorOGctAA0bkF8ProtocolRzlF">response(queue:responseSerializer:completionHandler:)</a>
  634. </code>
  635. </div>
  636. <div class="height-container">
  637. <div class="pointer-container"></div>
  638. <section class="section">
  639. <div class="pointer"></div>
  640. <div class="abstract">
  641. <p>Adds a handler to be called once the request has finished.</p>
  642. </div>
  643. <div class="declaration">
  644. <h4>Declaration</h4>
  645. <div class="language">
  646. <p class="aside-title">Swift</p>
  647. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  648. <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>
  649. <span class="nv">responseSerializer</span><span class="p">:</span> <span class="kt">Serializer</span><span class="p">,</span>
  650. <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>
  651. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  652. </div>
  653. </div>
  654. <div>
  655. <h4>Parameters</h4>
  656. <table class="graybox">
  657. <tbody>
  658. <tr>
  659. <td>
  660. <code>
  661. <em>queue</em>
  662. </code>
  663. </td>
  664. <td>
  665. <div>
  666. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default</p>
  667. </div>
  668. </td>
  669. </tr>
  670. <tr>
  671. <td>
  672. <code>
  673. <em>responseSerializer</em>
  674. </code>
  675. </td>
  676. <td>
  677. <div>
  678. <p>The response serializer responsible for serializing the request, response, and data.</p>
  679. </div>
  680. </td>
  681. </tr>
  682. <tr>
  683. <td>
  684. <code>
  685. <em>completionHandler</em>
  686. </code>
  687. </td>
  688. <td>
  689. <div>
  690. <p>The code to be executed once the request has finished.</p>
  691. </div>
  692. </td>
  693. </tr>
  694. </tbody>
  695. </table>
  696. </div>
  697. <div>
  698. <h4>Return Value</h4>
  699. <p>The request.</p>
  700. </div>
  701. </section>
  702. </div>
  703. </li>
  704. </ul>
  705. </div>
  706. <div class="task-group">
  707. <div class="task-name-container">
  708. <a name="/Data"></a>
  709. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  710. <div class="section-name-container">
  711. <a class="section-name-link" href="#/Data"></a>
  712. <h3 class="section-name"><p>Data</p>
  713. </h3>
  714. </div>
  715. </div>
  716. <ul class="item-container">
  717. <li class="item">
  718. <div>
  719. <code>
  720. <a name="/s:9Alamofire11DataRequestC08responseB05queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation0B0VAA7AFErrorOGctF"></a>
  721. <a name="//apple_ref/swift/Method/responseData(queue:completionHandler:)" class="dashAnchor"></a>
  722. <a class="token" href="#/s:9Alamofire11DataRequestC08responseB05queue17completionHandlerACXDSo012OS_dispatch_E0C_yAA0B8ResponseVy10Foundation0B0VAA7AFErrorOGctF">responseData(queue:completionHandler:)</a>
  723. </code>
  724. </div>
  725. <div class="height-container">
  726. <div class="pointer-container"></div>
  727. <section class="section">
  728. <div class="pointer"></div>
  729. <div class="abstract">
  730. <p>Adds a handler to be called once the request has finished.</p>
  731. </div>
  732. <div class="declaration">
  733. <h4>Declaration</h4>
  734. <div class="language">
  735. <p class="aside-title">Swift</p>
  736. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  737. <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>
  738. <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>
  739. <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  740. </div>
  741. </div>
  742. <div>
  743. <h4>Parameters</h4>
  744. <table class="graybox">
  745. <tbody>
  746. <tr>
  747. <td>
  748. <code>
  749. <em>queue</em>
  750. </code>
  751. </td>
  752. <td>
  753. <div>
  754. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  755. </div>
  756. </td>
  757. </tr>
  758. <tr>
  759. <td>
  760. <code>
  761. <em>completionHandler</em>
  762. </code>
  763. </td>
  764. <td>
  765. <div>
  766. <p>The code to be executed once the request has finished.</p>
  767. </div>
  768. </td>
  769. </tr>
  770. </tbody>
  771. </table>
  772. </div>
  773. <div>
  774. <h4>Return Value</h4>
  775. <p>The request.</p>
  776. </div>
  777. </section>
  778. </div>
  779. </li>
  780. </ul>
  781. </div>
  782. <div class="task-group">
  783. <div class="task-name-container">
  784. <a name="/String"></a>
  785. <a name="//apple_ref/swift/Section/String" class="dashAnchor"></a>
  786. <div class="section-name-container">
  787. <a class="section-name-link" href="#/String"></a>
  788. <h3 class="section-name"><p>String</p>
  789. </h3>
  790. </div>
  791. </div>
  792. <ul class="item-container">
  793. <li class="item">
  794. <div>
  795. <code>
  796. <a name="/s:9Alamofire11DataRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0C_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSAA7AFErrorOGctF"></a>
  797. <a name="//apple_ref/swift/Method/responseString(queue:encoding:completionHandler:)" class="dashAnchor"></a>
  798. <a class="token" href="#/s:9Alamofire11DataRequestC14responseString5queue8encoding17completionHandlerACXDSo012OS_dispatch_F0C_SS10FoundationE8EncodingVSgyAA0B8ResponseVySSAA7AFErrorOGctF">responseString(queue:encoding:completionHandler:)</a>
  799. </code>
  800. </div>
  801. <div class="height-container">
  802. <div class="pointer-container"></div>
  803. <section class="section">
  804. <div class="pointer"></div>
  805. <div class="abstract">
  806. <p>Adds a handler to be called once the request has finished.</p>
  807. </div>
  808. <div class="declaration">
  809. <h4>Declaration</h4>
  810. <div class="language">
  811. <p class="aside-title">Swift</p>
  812. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  813. <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>
  814. <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>
  815. <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>
  816. </div>
  817. </div>
  818. <div>
  819. <h4>Parameters</h4>
  820. <table class="graybox">
  821. <tbody>
  822. <tr>
  823. <td>
  824. <code>
  825. <em>queue</em>
  826. </code>
  827. </td>
  828. <td>
  829. <div>
  830. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  831. </div>
  832. </td>
  833. </tr>
  834. <tr>
  835. <td>
  836. <code>
  837. <em>encoding</em>
  838. </code>
  839. </td>
  840. <td>
  841. <div>
  842. <p>The string encoding. Defaults to <code>nil</code>, in which case the encoding will be determined from
  843. the server response, falling back to the default HTTP character set, <code>ISO-8859-1</code>.</p>
  844. </div>
  845. </td>
  846. </tr>
  847. <tr>
  848. <td>
  849. <code>
  850. <em>completionHandler</em>
  851. </code>
  852. </td>
  853. <td>
  854. <div>
  855. <p>A closure to be executed once the request has finished.</p>
  856. </div>
  857. </td>
  858. </tr>
  859. </tbody>
  860. </table>
  861. </div>
  862. <div>
  863. <h4>Return Value</h4>
  864. <p>The request.</p>
  865. </div>
  866. </section>
  867. </div>
  868. </li>
  869. </ul>
  870. </div>
  871. <div class="task-group">
  872. <div class="task-name-container">
  873. <a name="/JSON"></a>
  874. <a name="//apple_ref/swift/Section/JSON" class="dashAnchor"></a>
  875. <div class="section-name-container">
  876. <a class="section-name-link" href="#/JSON"></a>
  877. <h3 class="section-name"><p>JSON</p>
  878. </h3>
  879. </div>
  880. </div>
  881. <ul class="item-container">
  882. <li class="item">
  883. <div>
  884. <code>
  885. <a name="/s:9Alamofire11DataRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0C_So20NSJSONReadingOptionsVyAA0B8ResponseVyypAA7AFErrorOGctF"></a>
  886. <a name="//apple_ref/swift/Method/responseJSON(queue:options:completionHandler:)" class="dashAnchor"></a>
  887. <a class="token" href="#/s:9Alamofire11DataRequestC12responseJSON5queue7options17completionHandlerACXDSo012OS_dispatch_F0C_So20NSJSONReadingOptionsVyAA0B8ResponseVyypAA7AFErrorOGctF">responseJSON(queue:options:completionHandler:)</a>
  888. </code>
  889. </div>
  890. <div class="height-container">
  891. <div class="pointer-container"></div>
  892. <section class="section">
  893. <div class="pointer"></div>
  894. <div class="abstract">
  895. <p>Adds a handler to be called once the request has finished.</p>
  896. </div>
  897. <div class="declaration">
  898. <h4>Declaration</h4>
  899. <div class="language">
  900. <p class="aside-title">Swift</p>
  901. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  902. <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>
  903. <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>
  904. <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>
  905. </div>
  906. </div>
  907. <div>
  908. <h4>Parameters</h4>
  909. <table class="graybox">
  910. <tbody>
  911. <tr>
  912. <td>
  913. <code>
  914. <em>queue</em>
  915. </code>
  916. </td>
  917. <td>
  918. <div>
  919. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  920. </div>
  921. </td>
  922. </tr>
  923. <tr>
  924. <td>
  925. <code>
  926. <em>options</em>
  927. </code>
  928. </td>
  929. <td>
  930. <div>
  931. <p>The JSON serialization reading options. <code>.allowFragments</code> by default.</p>
  932. </div>
  933. </td>
  934. </tr>
  935. <tr>
  936. <td>
  937. <code>
  938. <em>completionHandler</em>
  939. </code>
  940. </td>
  941. <td>
  942. <div>
  943. <p>A closure to be executed once the request has finished.</p>
  944. </div>
  945. </td>
  946. </tr>
  947. </tbody>
  948. </table>
  949. </div>
  950. <div>
  951. <h4>Return Value</h4>
  952. <p>The request.</p>
  953. </div>
  954. </section>
  955. </div>
  956. </li>
  957. </ul>
  958. </div>
  959. <div class="task-group">
  960. <div class="task-name-container">
  961. <a name="/Decodable"></a>
  962. <a name="//apple_ref/swift/Section/Decodable" class="dashAnchor"></a>
  963. <div class="section-name-container">
  964. <a class="section-name-link" href="#/Decodable"></a>
  965. <h3 class="section-name"><p>Decodable</p>
  966. </h3>
  967. </div>
  968. </div>
  969. <ul class="item-container">
  970. <li class="item">
  971. <div>
  972. <code>
  973. <a name="/s:9Alamofire11DataRequestC17responseDecodable2of5queue7decoder17completionHandlerACXDxm_So012OS_dispatch_G0CAA0B7Decoder_pyAA0B8ResponseVyxAA7AFErrorOGctSeRzlF"></a>
  974. <a name="//apple_ref/swift/Method/responseDecodable(of:queue:decoder:completionHandler:)" class="dashAnchor"></a>
  975. <a class="token" href="#/s:9Alamofire11DataRequestC17responseDecodable2of5queue7decoder17completionHandlerACXDxm_So012OS_dispatch_G0CAA0B7Decoder_pyAA0B8ResponseVyxAA7AFErrorOGctSeRzlF">responseDecodable(of:queue:decoder:completionHandler:)</a>
  976. </code>
  977. </div>
  978. <div class="height-container">
  979. <div class="pointer-container"></div>
  980. <section class="section">
  981. <div class="pointer"></div>
  982. <div class="abstract">
  983. <p>Adds a handler to be called once the request has finished.</p>
  984. </div>
  985. <div class="declaration">
  986. <h4>Declaration</h4>
  987. <div class="language">
  988. <p class="aside-title">Swift</p>
  989. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  990. <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>
  991. <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>
  992. <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>
  993. <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>
  994. </div>
  995. </div>
  996. <div>
  997. <h4>Parameters</h4>
  998. <table class="graybox">
  999. <tbody>
  1000. <tr>
  1001. <td>
  1002. <code>
  1003. <em>type</em>
  1004. </code>
  1005. </td>
  1006. <td>
  1007. <div>
  1008. <p><code>Decodable</code> type to decode from response data.</p>
  1009. </div>
  1010. </td>
  1011. </tr>
  1012. <tr>
  1013. <td>
  1014. <code>
  1015. <em>queue</em>
  1016. </code>
  1017. </td>
  1018. <td>
  1019. <div>
  1020. <p>The queue on which the completion handler is dispatched. <code>.main</code> by default.</p>
  1021. </div>
  1022. </td>
  1023. </tr>
  1024. <tr>
  1025. <td>
  1026. <code>
  1027. <em>decoder</em>
  1028. </code>
  1029. </td>
  1030. <td>
  1031. <div>
  1032. <p><code><a href="../Protocols/DataDecoder.html">DataDecoder</a></code> to use to decode the response. <code>JSONDecoder()</code> by default.</p>
  1033. </div>
  1034. </td>
  1035. </tr>
  1036. <tr>
  1037. <td>
  1038. <code>
  1039. <em>completionHandler</em>
  1040. </code>
  1041. </td>
  1042. <td>
  1043. <div>
  1044. <p>A closure to be executed once the request has finished.</p>
  1045. </div>
  1046. </td>
  1047. </tr>
  1048. </tbody>
  1049. </table>
  1050. </div>
  1051. <div>
  1052. <h4>Return Value</h4>
  1053. <p>The request.</p>
  1054. </div>
  1055. </section>
  1056. </div>
  1057. </li>
  1058. </ul>
  1059. </div>
  1060. <div class="task-group">
  1061. <ul class="item-container">
  1062. <li class="item">
  1063. <div>
  1064. <code>
  1065. <a name="/s:9Alamofire11DataRequestC10Validationa"></a>
  1066. <a name="//apple_ref/swift/Alias/Validation" class="dashAnchor"></a>
  1067. <a class="token" href="#/s:9Alamofire11DataRequestC10Validationa">Validation</a>
  1068. </code>
  1069. </div>
  1070. <div class="height-container">
  1071. <div class="pointer-container"></div>
  1072. <section class="section">
  1073. <div class="pointer"></div>
  1074. <div class="abstract">
  1075. <p>A closure used to validate a request that takes a URL request, a URL response and data, and returns whether the
  1076. request was valid.</p>
  1077. </div>
  1078. <div class="declaration">
  1079. <h4>Declaration</h4>
  1080. <div class="language">
  1081. <p class="aside-title">Swift</p>
  1082. <pre class="highlight swift"><code><span class="kd">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>
  1083. </div>
  1084. </div>
  1085. </section>
  1086. </div>
  1087. </li>
  1088. <li class="item">
  1089. <div>
  1090. <code>
  1091. <a name="/s:9Alamofire11DataRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF"></a>
  1092. <a name="//apple_ref/swift/Method/validate(statusCode:)" class="dashAnchor"></a>
  1093. <a class="token" href="#/s:9Alamofire11DataRequestC8validate10statusCodeACXDx_tSTRzSi7ElementRtzlF">validate(statusCode:)</a>
  1094. </code>
  1095. </div>
  1096. <div class="height-container">
  1097. <div class="pointer-container"></div>
  1098. <section class="section">
  1099. <div class="pointer"></div>
  1100. <div class="abstract">
  1101. <p>Validates that the response has a status code in the specified sequence.</p>
  1102. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1103. </div>
  1104. <div class="declaration">
  1105. <h4>Declaration</h4>
  1106. <div class="language">
  1107. <p class="aside-title">Swift</p>
  1108. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1109. <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>
  1110. </div>
  1111. </div>
  1112. <div>
  1113. <h4>Parameters</h4>
  1114. <table class="graybox">
  1115. <tbody>
  1116. <tr>
  1117. <td>
  1118. <code>
  1119. <em>range</em>
  1120. </code>
  1121. </td>
  1122. <td>
  1123. <div>
  1124. <p>The range of acceptable status codes.</p>
  1125. </div>
  1126. </td>
  1127. </tr>
  1128. </tbody>
  1129. </table>
  1130. </div>
  1131. <div>
  1132. <h4>Return Value</h4>
  1133. <p>The request.</p>
  1134. </div>
  1135. </section>
  1136. </div>
  1137. </li>
  1138. <li class="item">
  1139. <div>
  1140. <code>
  1141. <a name="/s:9Alamofire11DataRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF"></a>
  1142. <a name="//apple_ref/swift/Method/validate(contentType:)" class="dashAnchor"></a>
  1143. <a class="token" href="#/s:9Alamofire11DataRequestC8validate11contentTypeACXDxyXA_tSTRzSS7ElementRtzlF">validate(contentType:)</a>
  1144. </code>
  1145. </div>
  1146. <div class="height-container">
  1147. <div class="pointer-container"></div>
  1148. <section class="section">
  1149. <div class="pointer"></div>
  1150. <div class="abstract">
  1151. <p>Validates that the response has a content type in the specified sequence.</p>
  1152. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1153. </div>
  1154. <div class="declaration">
  1155. <h4>Declaration</h4>
  1156. <div class="language">
  1157. <p class="aside-title">Swift</p>
  1158. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1159. <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>
  1160. </div>
  1161. </div>
  1162. <div>
  1163. <h4>Parameters</h4>
  1164. <table class="graybox">
  1165. <tbody>
  1166. <tr>
  1167. <td>
  1168. <code>
  1169. <em>contentType</em>
  1170. </code>
  1171. </td>
  1172. <td>
  1173. <div>
  1174. <p>The acceptable content types, which may specify wildcard types and/or subtypes.</p>
  1175. </div>
  1176. </td>
  1177. </tr>
  1178. </tbody>
  1179. </table>
  1180. </div>
  1181. <div>
  1182. <h4>Return Value</h4>
  1183. <p>The request.</p>
  1184. </div>
  1185. </section>
  1186. </div>
  1187. </li>
  1188. <li class="item">
  1189. <div>
  1190. <code>
  1191. <a name="/s:9Alamofire11DataRequestC8validateACXDyF"></a>
  1192. <a name="//apple_ref/swift/Method/validate()" class="dashAnchor"></a>
  1193. <a class="token" href="#/s:9Alamofire11DataRequestC8validateACXDyF">validate()</a>
  1194. </code>
  1195. </div>
  1196. <div class="height-container">
  1197. <div class="pointer-container"></div>
  1198. <section class="section">
  1199. <div class="pointer"></div>
  1200. <div class="abstract">
  1201. <p>Validates that the response has a status code in the default acceptable range of 200&hellip;299, and that the content
  1202. type matches any specified in the Accept HTTP header field.</p>
  1203. <p>If validation fails, subsequent calls to response handlers will have an associated error.</p>
  1204. </div>
  1205. <div class="declaration">
  1206. <h4>Declaration</h4>
  1207. <div class="language">
  1208. <p class="aside-title">Swift</p>
  1209. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1210. <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>
  1211. </div>
  1212. </div>
  1213. <div>
  1214. <h4>Return Value</h4>
  1215. <p>The request.</p>
  1216. </div>
  1217. </section>
  1218. </div>
  1219. </li>
  1220. </ul>
  1221. </div>
  1222. </div>
  1223. </section>
  1224. </article>
  1225. </div>
  1226. <section class="footer">
  1227. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-03-23)</p>
  1228. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1229. </section>
  1230. </body>
  1231. </div>
  1232. </html>