DataRequest.html 63 KB

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