DataRequest.html 65 KB

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