DataRequest.html 66 KB

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