Request.html 109 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Request 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/Request" class="dashAnchor"></a>
  16. <a title="Request 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. Request 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>Request</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">Request</span></code></pre>
  361. </div>
  362. </div>
  363. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  364. handling.</p>
  365. </div>
  366. </section>
  367. <section class="section">
  368. <div class="section-content">
  369. <div class="task-group">
  370. <ul class="item-container">
  371. <li class="item">
  372. <div>
  373. <code>
  374. <a name="/s:9Alamofire7RequestC5StateO"></a>
  375. <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
  376. <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
  377. </code>
  378. </div>
  379. <div class="height-container">
  380. <div class="pointer-container"></div>
  381. <section class="section">
  382. <div class="pointer"></div>
  383. <div class="abstract">
  384. <p>State of the <code><a href="../Classes/Request.html">Request</a></code>, with managed transitions between states set when calling <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a></code>, <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a></code>, or
  385. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  386. <ul>
  387. <li>initialized: Initial state of the <code><a href="../Classes/Request.html">Request</a></code>.</li>
  388. <li>resumed: Set when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a></code> is called. Any tasks created for the <code><a href="../Classes/Request.html">Request</a></code> will have <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a></code> called on
  389. them in this state.</li>
  390. <li>suspended: Set when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a></code> is called. Any tasks created for the <code><a href="../Classes/Request.html">Request</a></code> will have <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a></code> called on
  391. them in this state.</li>
  392. <li>cancelled: Set when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> is called. Any tasks created for the <code><a href="../Classes/Request.html">Request</a></code> will have <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> called on
  393. them. Unlike <code>resumed</code> or <code>suspended</code>, once in the <code>cancelled</code> state, the <code><a href="../Classes/Request.html">Request</a></code> can no longer
  394. transition to any other state.</li>
  395. </ul>
  396. <a href="../Classes/Request/State.html" class="slightly-smaller">See more</a>
  397. </div>
  398. <div class="declaration">
  399. <h4>Declaration</h4>
  400. <div class="language">
  401. <p class="aside-title">Swift</p>
  402. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span></code></pre>
  403. </div>
  404. </div>
  405. </section>
  406. </div>
  407. </li>
  408. </ul>
  409. </div>
  410. <div class="task-group">
  411. <div class="task-name-container">
  412. <a name="/Initial%20State"></a>
  413. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  414. <a href="#/Initial%20State">
  415. <h3 class="section-name">Initial State</h3>
  416. </a>
  417. </div>
  418. <ul class="item-container">
  419. <li class="item">
  420. <div>
  421. <code>
  422. <a name="/s:9Alamofire7RequestC2id10Foundation4UUIDVvp"></a>
  423. <a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
  424. <a class="token" href="#/s:9Alamofire7RequestC2id10Foundation4UUIDVvp">id</a>
  425. </code>
  426. </div>
  427. <div class="height-container">
  428. <div class="pointer-container"></div>
  429. <section class="section">
  430. <div class="pointer"></div>
  431. <div class="abstract">
  432. <p><code>UUID</code> prividing a unique identifier for the <code>Request</code>, used in the <code>Hashable</code> and <code>Equatable</code> conformances.</p>
  433. </div>
  434. <div class="declaration">
  435. <h4>Declaration</h4>
  436. <div class="language">
  437. <p class="aside-title">Swift</p>
  438. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">UUID</span></code></pre>
  439. </div>
  440. </div>
  441. </section>
  442. </div>
  443. </li>
  444. <li class="item">
  445. <div>
  446. <code>
  447. <a name="/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp"></a>
  448. <a name="//apple_ref/swift/Property/underlyingQueue" class="dashAnchor"></a>
  449. <a class="token" href="#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a>
  450. </code>
  451. </div>
  452. <div class="height-container">
  453. <div class="pointer-container"></div>
  454. <section class="section">
  455. <div class="pointer"></div>
  456. <div class="abstract">
  457. <p>The serial queue for all internal async actions.</p>
  458. </div>
  459. <div class="declaration">
  460. <h4>Declaration</h4>
  461. <div class="language">
  462. <p class="aside-title">Swift</p>
  463. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">underlyingQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  464. </div>
  465. </div>
  466. </section>
  467. </div>
  468. </li>
  469. <li class="item">
  470. <div>
  471. <code>
  472. <a name="/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp"></a>
  473. <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
  474. <a class="token" href="#/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
  475. </code>
  476. </div>
  477. <div class="height-container">
  478. <div class="pointer-container"></div>
  479. <section class="section">
  480. <div class="pointer"></div>
  481. <div class="abstract">
  482. <p>The queue used for all serialization actions. By default it&rsquo;s a serial queue that targets <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code>.</p>
  483. </div>
  484. <div class="declaration">
  485. <h4>Declaration</h4>
  486. <div class="language">
  487. <p class="aside-title">Swift</p>
  488. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  489. </div>
  490. </div>
  491. </section>
  492. </div>
  493. </li>
  494. <li class="item">
  495. <div>
  496. <code>
  497. <a name="/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp"></a>
  498. <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
  499. <a class="token" href="#/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp">eventMonitor</a>
  500. </code>
  501. </div>
  502. <div class="height-container">
  503. <div class="pointer-container"></div>
  504. <section class="section">
  505. <div class="pointer"></div>
  506. <div class="abstract">
  507. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks.</p>
  508. </div>
  509. <div class="declaration">
  510. <h4>Declaration</h4>
  511. <div class="language">
  512. <p class="aside-title">Swift</p>
  513. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">?</span></code></pre>
  514. </div>
  515. </div>
  516. </section>
  517. </div>
  518. </li>
  519. <li class="item">
  520. <div>
  521. <code>
  522. <a name="/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgXwvp"></a>
  523. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  524. <a class="token" href="#/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgXwvp">delegate</a>
  525. </code>
  526. </div>
  527. <div class="height-container">
  528. <div class="pointer-container"></div>
  529. <section class="section">
  530. <div class="pointer"></div>
  531. <div class="abstract">
  532. <p>The <code>Request</code>&lsquo;s delegate.</p>
  533. </div>
  534. <div class="declaration">
  535. <h4>Declaration</h4>
  536. <div class="language">
  537. <p class="aside-title">Swift</p>
  538. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></span><span class="p">?</span></code></pre>
  539. </div>
  540. </div>
  541. </section>
  542. </div>
  543. </li>
  544. </ul>
  545. </div>
  546. <div class="task-group">
  547. <div class="task-name-container">
  548. <a name="/Updated%20State"></a>
  549. <a name="//apple_ref/swift/Section/Updated State" class="dashAnchor"></a>
  550. <a href="#/Updated%20State">
  551. <h3 class="section-name">Updated State</h3>
  552. </a>
  553. </div>
  554. <ul class="item-container">
  555. <li class="item">
  556. <div>
  557. <code>
  558. <a name="/s:9Alamofire7RequestC5stateAC5StateOvp"></a>
  559. <a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
  560. <a class="token" href="#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a>
  561. </code>
  562. </div>
  563. <div class="height-container">
  564. <div class="pointer-container"></div>
  565. <section class="section">
  566. <div class="pointer"></div>
  567. <div class="abstract">
  568. <p><code><a href="../Classes/Request/State.html">State</a></code> of the <code>Request</code>.</p>
  569. </div>
  570. <div class="declaration">
  571. <h4>Declaration</h4>
  572. <div class="language">
  573. <p class="aside-title">Swift</p>
  574. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="k">var</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request/State.html">State</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  575. </div>
  576. </div>
  577. </section>
  578. </div>
  579. </li>
  580. <li class="item">
  581. <div>
  582. <code>
  583. <a name="/s:9Alamofire7RequestC11isCancelledSbvp"></a>
  584. <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
  585. <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</a>
  586. </code>
  587. </div>
  588. <div class="height-container">
  589. <div class="pointer-container"></div>
  590. <section class="section">
  591. <div class="pointer"></div>
  592. <div class="abstract">
  593. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.cancelled</code>.</p>
  594. </div>
  595. <div class="declaration">
  596. <h4>Declaration</h4>
  597. <div class="language">
  598. <p class="aside-title">Swift</p>
  599. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isCancelled</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  600. </div>
  601. </div>
  602. </section>
  603. </div>
  604. </li>
  605. <li class="item">
  606. <div>
  607. <code>
  608. <a name="/s:9Alamofire7RequestC9isResumedSbvp"></a>
  609. <a name="//apple_ref/swift/Property/isResumed" class="dashAnchor"></a>
  610. <a class="token" href="#/s:9Alamofire7RequestC9isResumedSbvp">isResumed</a>
  611. </code>
  612. </div>
  613. <div class="height-container">
  614. <div class="pointer-container"></div>
  615. <section class="section">
  616. <div class="pointer"></div>
  617. <div class="abstract">
  618. <p>Returns whether <code>state is</code>.resumed`.</p>
  619. </div>
  620. <div class="declaration">
  621. <h4>Declaration</h4>
  622. <div class="language">
  623. <p class="aside-title">Swift</p>
  624. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isResumed</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  625. </div>
  626. </div>
  627. </section>
  628. </div>
  629. </li>
  630. <li class="item">
  631. <div>
  632. <code>
  633. <a name="/s:9Alamofire7RequestC11isSuspendedSbvp"></a>
  634. <a name="//apple_ref/swift/Property/isSuspended" class="dashAnchor"></a>
  635. <a class="token" href="#/s:9Alamofire7RequestC11isSuspendedSbvp">isSuspended</a>
  636. </code>
  637. </div>
  638. <div class="height-container">
  639. <div class="pointer-container"></div>
  640. <section class="section">
  641. <div class="pointer"></div>
  642. <div class="abstract">
  643. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.suspended</code>.</p>
  644. </div>
  645. <div class="declaration">
  646. <h4>Declaration</h4>
  647. <div class="language">
  648. <p class="aside-title">Swift</p>
  649. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isSuspended</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  650. </div>
  651. </div>
  652. </section>
  653. </div>
  654. </li>
  655. <li class="item">
  656. <div>
  657. <code>
  658. <a name="/s:9Alamofire7RequestC13isInitializedSbvp"></a>
  659. <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
  660. <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</a>
  661. </code>
  662. </div>
  663. <div class="height-container">
  664. <div class="pointer-container"></div>
  665. <section class="section">
  666. <div class="pointer"></div>
  667. <div class="abstract">
  668. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.initialized</code>.</p>
  669. </div>
  670. <div class="declaration">
  671. <h4>Declaration</h4>
  672. <div class="language">
  673. <p class="aside-title">Swift</p>
  674. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isInitialized</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  675. </div>
  676. </div>
  677. </section>
  678. </div>
  679. </li>
  680. <li class="item">
  681. <div>
  682. <code>
  683. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  684. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  685. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  686. </code>
  687. </div>
  688. <div class="height-container">
  689. <div class="pointer-container"></div>
  690. <section class="section">
  691. <div class="pointer"></div>
  692. <div class="abstract">
  693. <p>Closure type executed when monitoring the upload or download progress of a request.</p>
  694. </div>
  695. <div class="declaration">
  696. <h4>Declaration</h4>
  697. <div class="language">
  698. <p class="aside-title">Swift</p>
  699. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">ProgressHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt">Progress</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>
  700. </div>
  701. </div>
  702. </section>
  703. </div>
  704. </li>
  705. <li class="item">
  706. <div>
  707. <code>
  708. <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
  709. <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
  710. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
  711. </code>
  712. </div>
  713. <div class="height-container">
  714. <div class="pointer-container"></div>
  715. <section class="section">
  716. <div class="pointer"></div>
  717. <div class="abstract">
  718. <p><code>Progress</code> of the upload of the body of the executed <code>URLRequest</code>. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  719. </div>
  720. <div class="declaration">
  721. <h4>Declaration</h4>
  722. <div class="language">
  723. <p class="aside-title">Swift</p>
  724. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">uploadProgress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
  725. </div>
  726. </div>
  727. </section>
  728. </div>
  729. </li>
  730. <li class="item">
  731. <div>
  732. <code>
  733. <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
  734. <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
  735. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
  736. </code>
  737. </div>
  738. <div class="height-container">
  739. <div class="pointer-container"></div>
  740. <section class="section">
  741. <div class="pointer"></div>
  742. <div class="abstract">
  743. <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  744. </div>
  745. <div class="declaration">
  746. <h4>Declaration</h4>
  747. <div class="language">
  748. <p class="aside-title">Swift</p>
  749. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">downloadProgress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
  750. </div>
  751. </div>
  752. </section>
  753. </div>
  754. </li>
  755. <li class="item">
  756. <div>
  757. <code>
  758. <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
  759. <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
  760. <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
  761. </code>
  762. </div>
  763. <div class="height-container">
  764. <div class="pointer-container"></div>
  765. <section class="section">
  766. <div class="pointer"></div>
  767. <div class="abstract">
  768. <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
  769. </div>
  770. <div class="declaration">
  771. <h4>Declaration</h4>
  772. <div class="language">
  773. <p class="aside-title">Swift</p>
  774. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  775. </div>
  776. </div>
  777. </section>
  778. </div>
  779. </li>
  780. <li class="item">
  781. <div>
  782. <code>
  783. <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
  784. <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
  785. <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a>
  786. </code>
  787. </div>
  788. <div class="height-container">
  789. <div class="pointer-container"></div>
  790. <section class="section">
  791. <div class="pointer"></div>
  792. <div class="abstract">
  793. <p>All <code>URLRequests</code> created on behalf of the <code>Request</code>, including original and adapted requests.</p>
  794. </div>
  795. <div class="declaration">
  796. <h4>Declaration</h4>
  797. <div class="language">
  798. <p class="aside-title">Swift</p>
  799. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLRequest</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  800. </div>
  801. </div>
  802. </section>
  803. </div>
  804. </li>
  805. <li class="item">
  806. <div>
  807. <code>
  808. <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
  809. <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
  810. <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
  811. </code>
  812. </div>
  813. <div class="height-container">
  814. <div class="pointer-container"></div>
  815. <section class="section">
  816. <div class="pointer"></div>
  817. <div class="abstract">
  818. <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
  819. </div>
  820. <div class="declaration">
  821. <h4>Declaration</h4>
  822. <div class="language">
  823. <p class="aside-title">Swift</p>
  824. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">firstRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  825. </div>
  826. </div>
  827. </section>
  828. </div>
  829. </li>
  830. <li class="item">
  831. <div>
  832. <code>
  833. <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
  834. <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
  835. <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
  836. </code>
  837. </div>
  838. <div class="height-container">
  839. <div class="pointer-container"></div>
  840. <section class="section">
  841. <div class="pointer"></div>
  842. <div class="abstract">
  843. <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  844. </div>
  845. <div class="declaration">
  846. <h4>Declaration</h4>
  847. <div class="language">
  848. <p class="aside-title">Swift</p>
  849. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lastRequest</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  850. </div>
  851. </div>
  852. </section>
  853. </div>
  854. </li>
  855. <li class="item">
  856. <div>
  857. <code>
  858. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  859. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  860. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  861. </code>
  862. </div>
  863. <div class="height-container">
  864. <div class="pointer-container"></div>
  865. <section class="section">
  866. <div class="pointer"></div>
  867. <div class="abstract">
  868. <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  869. </div>
  870. <div class="declaration">
  871. <h4>Declaration</h4>
  872. <div class="language">
  873. <p class="aside-title">Swift</p>
  874. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  875. </div>
  876. </div>
  877. </section>
  878. </div>
  879. </li>
  880. <li class="item">
  881. <div>
  882. <code>
  883. <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
  884. <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
  885. <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
  886. </code>
  887. </div>
  888. <div class="height-container">
  889. <div class="pointer-container"></div>
  890. <section class="section">
  891. <div class="pointer"></div>
  892. <div class="abstract">
  893. <p><code>URLRequest</code>s from all of the <code>URLSessionTask</code>s executed on behalf of the <code>Request</code>.</p>
  894. </div>
  895. <div class="declaration">
  896. <h4>Declaration</h4>
  897. <div class="language">
  898. <p class="aside-title">Swift</p>
  899. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">performedRequests</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLRequest</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  900. </div>
  901. </div>
  902. </section>
  903. </div>
  904. </li>
  905. <li class="item">
  906. <div>
  907. <code>
  908. <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
  909. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  910. <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
  911. </code>
  912. </div>
  913. <div class="height-container">
  914. <div class="pointer-container"></div>
  915. <section class="section">
  916. <div class="pointer"></div>
  917. <div class="abstract">
  918. <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
  919. last <code>URLSessionTask</code>.</p>
  920. </div>
  921. <div class="declaration">
  922. <h4>Declaration</h4>
  923. <div class="language">
  924. <p class="aside-title">Swift</p>
  925. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">HTTPURLResponse</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  926. </div>
  927. </div>
  928. </section>
  929. </div>
  930. </li>
  931. <li class="item">
  932. <div>
  933. <code>
  934. <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
  935. <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
  936. <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
  937. </code>
  938. </div>
  939. <div class="height-container">
  940. <div class="pointer-container"></div>
  941. <section class="section">
  942. <div class="pointer"></div>
  943. <div class="abstract">
  944. <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
  945. </div>
  946. <div class="declaration">
  947. <h4>Declaration</h4>
  948. <div class="language">
  949. <p class="aside-title">Swift</p>
  950. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">tasks</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLSessionTask</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  951. </div>
  952. </div>
  953. </section>
  954. </div>
  955. </li>
  956. <li class="item">
  957. <div>
  958. <code>
  959. <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
  960. <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
  961. <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
  962. </code>
  963. </div>
  964. <div class="height-container">
  965. <div class="pointer-container"></div>
  966. <section class="section">
  967. <div class="pointer"></div>
  968. <div class="abstract">
  969. <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  970. </div>
  971. <div class="declaration">
  972. <h4>Declaration</h4>
  973. <div class="language">
  974. <p class="aside-title">Swift</p>
  975. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">firstTask</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  976. </div>
  977. </div>
  978. </section>
  979. </div>
  980. </li>
  981. <li class="item">
  982. <div>
  983. <code>
  984. <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
  985. <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
  986. <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
  987. </code>
  988. </div>
  989. <div class="height-container">
  990. <div class="pointer-container"></div>
  991. <section class="section">
  992. <div class="pointer"></div>
  993. <div class="abstract">
  994. <p>Last <code>URLSessionTask</code> crated on behalf of the <code>Request</code>.</p>
  995. </div>
  996. <div class="declaration">
  997. <h4>Declaration</h4>
  998. <div class="language">
  999. <p class="aside-title">Swift</p>
  1000. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lastTask</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1001. </div>
  1002. </div>
  1003. </section>
  1004. </div>
  1005. </li>
  1006. <li class="item">
  1007. <div>
  1008. <code>
  1009. <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
  1010. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  1011. <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
  1012. </code>
  1013. </div>
  1014. <div class="height-container">
  1015. <div class="pointer-container"></div>
  1016. <section class="section">
  1017. <div class="pointer"></div>
  1018. <div class="abstract">
  1019. <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1020. </div>
  1021. <div class="declaration">
  1022. <h4>Declaration</h4>
  1023. <div class="language">
  1024. <p class="aside-title">Swift</p>
  1025. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">task</span><span class="p">:</span> <span class="kt">URLSessionTask</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1026. </div>
  1027. </div>
  1028. </section>
  1029. </div>
  1030. </li>
  1031. <li class="item">
  1032. <div>
  1033. <code>
  1034. <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
  1035. <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
  1036. <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
  1037. </code>
  1038. </div>
  1039. <div class="height-container">
  1040. <div class="pointer-container"></div>
  1041. <section class="section">
  1042. <div class="pointer"></div>
  1043. <div class="abstract">
  1044. <p>All <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>. Should correspond to the <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a></code> created.</p>
  1045. </div>
  1046. <div class="declaration">
  1047. <h4>Declaration</h4>
  1048. <div class="language">
  1049. <p class="aside-title">Swift</p>
  1050. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">allMetrics</span><span class="p">:</span> <span class="p">[</span><span class="kt">URLSessionTaskMetrics</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1051. </div>
  1052. </div>
  1053. </section>
  1054. </div>
  1055. </li>
  1056. <li class="item">
  1057. <div>
  1058. <code>
  1059. <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1060. <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
  1061. <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
  1062. </code>
  1063. </div>
  1064. <div class="height-container">
  1065. <div class="pointer-container"></div>
  1066. <section class="section">
  1067. <div class="pointer"></div>
  1068. <div class="abstract">
  1069. <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1070. </div>
  1071. <div class="declaration">
  1072. <h4>Declaration</h4>
  1073. <div class="language">
  1074. <p class="aside-title">Swift</p>
  1075. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">firstMetrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1076. </div>
  1077. </div>
  1078. </section>
  1079. </div>
  1080. </li>
  1081. <li class="item">
  1082. <div>
  1083. <code>
  1084. <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1085. <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
  1086. <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
  1087. </code>
  1088. </div>
  1089. <div class="height-container">
  1090. <div class="pointer-container"></div>
  1091. <section class="section">
  1092. <div class="pointer"></div>
  1093. <div class="abstract">
  1094. <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1095. </div>
  1096. <div class="declaration">
  1097. <h4>Declaration</h4>
  1098. <div class="language">
  1099. <p class="aside-title">Swift</p>
  1100. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lastMetrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1101. </div>
  1102. </div>
  1103. </section>
  1104. </div>
  1105. </li>
  1106. <li class="item">
  1107. <div>
  1108. <code>
  1109. <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  1110. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  1111. <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  1112. </code>
  1113. </div>
  1114. <div class="height-container">
  1115. <div class="pointer-container"></div>
  1116. <section class="section">
  1117. <div class="pointer"></div>
  1118. <div class="abstract">
  1119. <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1120. </div>
  1121. <div class="declaration">
  1122. <h4>Declaration</h4>
  1123. <div class="language">
  1124. <p class="aside-title">Swift</p>
  1125. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">metrics</span><span class="p">:</span> <span class="kt">URLSessionTaskMetrics</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1126. </div>
  1127. </div>
  1128. </section>
  1129. </div>
  1130. </li>
  1131. <li class="item">
  1132. <div>
  1133. <code>
  1134. <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
  1135. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  1136. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
  1137. </code>
  1138. </div>
  1139. <div class="height-container">
  1140. <div class="pointer-container"></div>
  1141. <section class="section">
  1142. <div class="pointer"></div>
  1143. <div class="abstract">
  1144. <p>Number of times the <code>Request</code> has been retried.</p>
  1145. </div>
  1146. <div class="declaration">
  1147. <h4>Declaration</h4>
  1148. <div class="language">
  1149. <p class="aside-title">Swift</p>
  1150. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">retryCount</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1151. </div>
  1152. </div>
  1153. </section>
  1154. </div>
  1155. </li>
  1156. <li class="item">
  1157. <div>
  1158. <code>
  1159. <a name="/s:9Alamofire7RequestC5errors5Error_pSgvp"></a>
  1160. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  1161. <a class="token" href="#/s:9Alamofire7RequestC5errors5Error_pSgvp">error</a>
  1162. </code>
  1163. </div>
  1164. <div class="height-container">
  1165. <div class="pointer-container"></div>
  1166. <section class="section">
  1167. <div class="pointer"></div>
  1168. <div class="abstract">
  1169. <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
  1170. </div>
  1171. <div class="declaration">
  1172. <h4>Declaration</h4>
  1173. <div class="language">
  1174. <p class="aside-title">Swift</p>
  1175. <pre class="highlight swift"><code><span class="nf">fileprivate</span><span class="p">(</span><span class="k">set</span><span class="p">)</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  1176. </div>
  1177. </div>
  1178. </section>
  1179. </div>
  1180. </li>
  1181. <li class="item">
  1182. <div>
  1183. <code>
  1184. <a name="/s:9Alamofire7RequestC2id15underlyingQueue013serializationE012eventMonitor8delegateAC10Foundation4UUIDV_So17OS_dispatch_queueCAmA05EventH0_pSgAA0B8Delegate_ptcfc"></a>
  1185. <a name="//apple_ref/swift/Method/init(id:underlyingQueue:serializationQueue:eventMonitor:delegate:)" class="dashAnchor"></a>
  1186. <a class="token" href="#/s:9Alamofire7RequestC2id15underlyingQueue013serializationE012eventMonitor8delegateAC10Foundation4UUIDV_So17OS_dispatch_queueCAmA05EventH0_pSgAA0B8Delegate_ptcfc">init(id:underlyingQueue:serializationQueue:eventMonitor:delegate:)</a>
  1187. </code>
  1188. </div>
  1189. <div class="height-container">
  1190. <div class="pointer-container"></div>
  1191. <section class="section">
  1192. <div class="pointer"></div>
  1193. <div class="abstract">
  1194. <p>Default initializer for the <code>Request</code> superclass.</p>
  1195. </div>
  1196. <div class="declaration">
  1197. <h4>Declaration</h4>
  1198. <div class="language">
  1199. <p class="aside-title">Swift</p>
  1200. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">id</span><span class="p">:</span> <span class="kt">UUID</span> <span class="o">=</span> <span class="kt">UUID</span><span class="p">(),</span>
  1201. <span class="nv">underlyingQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  1202. <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  1203. <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">?,</span>
  1204. <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></span><span class="p">)</span></code></pre>
  1205. </div>
  1206. </div>
  1207. <div>
  1208. <h4>Parameters</h4>
  1209. <table class="graybox">
  1210. <tbody>
  1211. <tr>
  1212. <td>
  1213. <code>
  1214. <em>id</em>
  1215. </code>
  1216. </td>
  1217. <td>
  1218. <div>
  1219. <p><code>UUID</code> used for the <code>Hashable</code> and <code>Equatable</code> implementations. Defaults to a random <code>UUID</code>.</p>
  1220. </div>
  1221. </td>
  1222. </tr>
  1223. <tr>
  1224. <td>
  1225. <code>
  1226. <em>underlyingQueue</em>
  1227. </code>
  1228. </td>
  1229. <td>
  1230. <div>
  1231. <p><code>DispatchQueue</code> on which all internal <code>Request</code> work is performed.</p>
  1232. </div>
  1233. </td>
  1234. </tr>
  1235. <tr>
  1236. <td>
  1237. <code>
  1238. <em>serializationQueue</em>
  1239. </code>
  1240. </td>
  1241. <td>
  1242. <div>
  1243. <p><code>DispatchQueue</code> on which all serialization work is performed. Targets the
  1244. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code> when created by a <code>SessionManager</code>.</p>
  1245. </div>
  1246. </td>
  1247. </tr>
  1248. <tr>
  1249. <td>
  1250. <code>
  1251. <em>eventMonitor</em>
  1252. </code>
  1253. </td>
  1254. <td>
  1255. <div>
  1256. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks from internal <code>Request</code> actions.</p>
  1257. </div>
  1258. </td>
  1259. </tr>
  1260. <tr>
  1261. <td>
  1262. <code>
  1263. <em>delegate</em>
  1264. </code>
  1265. </td>
  1266. <td>
  1267. <div>
  1268. <p><code><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></code> that provides an interface to actions not performed by the <code>Request</code>.</p>
  1269. </div>
  1270. </td>
  1271. </tr>
  1272. </tbody>
  1273. </table>
  1274. </div>
  1275. </section>
  1276. </div>
  1277. </li>
  1278. </ul>
  1279. </div>
  1280. <div class="task-group">
  1281. <div class="task-name-container">
  1282. <a name="/State"></a>
  1283. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  1284. <a href="#/State">
  1285. <h3 class="section-name">State</h3>
  1286. </a>
  1287. </div>
  1288. <ul class="item-container">
  1289. <li class="item">
  1290. <div>
  1291. <code>
  1292. <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
  1293. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  1294. <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
  1295. </code>
  1296. </div>
  1297. <div class="height-container">
  1298. <div class="pointer-container"></div>
  1299. <section class="section">
  1300. <div class="pointer"></div>
  1301. <div class="abstract">
  1302. <p>Cancels the <code>Request</code>. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
  1303. </div>
  1304. <div class="declaration">
  1305. <h4>Declaration</h4>
  1306. <div class="language">
  1307. <p class="aside-title">Swift</p>
  1308. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1309. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1310. </div>
  1311. </div>
  1312. <div>
  1313. <h4>Return Value</h4>
  1314. <p>The <code>Request</code>.</p>
  1315. </div>
  1316. </section>
  1317. </div>
  1318. </li>
  1319. <li class="item">
  1320. <div>
  1321. <code>
  1322. <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
  1323. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  1324. <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
  1325. </code>
  1326. </div>
  1327. <div class="height-container">
  1328. <div class="pointer-container"></div>
  1329. <section class="section">
  1330. <div class="pointer"></div>
  1331. <div class="abstract">
  1332. <p>Suspends the <code>Request</code>.</p>
  1333. </div>
  1334. <div class="declaration">
  1335. <h4>Declaration</h4>
  1336. <div class="language">
  1337. <p class="aside-title">Swift</p>
  1338. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1339. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1340. </div>
  1341. </div>
  1342. <div>
  1343. <h4>Return Value</h4>
  1344. <p>The <code>Request</code>.</p>
  1345. </div>
  1346. </section>
  1347. </div>
  1348. </li>
  1349. <li class="item">
  1350. <div>
  1351. <code>
  1352. <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
  1353. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  1354. <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
  1355. </code>
  1356. </div>
  1357. <div class="height-container">
  1358. <div class="pointer-container"></div>
  1359. <section class="section">
  1360. <div class="pointer"></div>
  1361. <div class="abstract">
  1362. <p>Resumes the <code>Request</code>.</p>
  1363. </div>
  1364. <div class="declaration">
  1365. <h4>Declaration</h4>
  1366. <div class="language">
  1367. <p class="aside-title">Swift</p>
  1368. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1369. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1370. </div>
  1371. </div>
  1372. <div>
  1373. <h4>Return Value</h4>
  1374. <p>The <code>Request</code>.</p>
  1375. </div>
  1376. </section>
  1377. </div>
  1378. </li>
  1379. </ul>
  1380. </div>
  1381. <div class="task-group">
  1382. <div class="task-name-container">
  1383. <a name="/Closure%20API"></a>
  1384. <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
  1385. <a href="#/Closure%20API">
  1386. <h3 class="section-name">Closure API</h3>
  1387. </a>
  1388. </div>
  1389. <ul class="item-container">
  1390. <li class="item">
  1391. <div>
  1392. <code>
  1393. <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
  1394. <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
  1395. <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:password:persistence:)</a>
  1396. </code>
  1397. </div>
  1398. <div class="height-container">
  1399. <div class="pointer-container"></div>
  1400. <section class="section">
  1401. <div class="pointer"></div>
  1402. <div class="abstract">
  1403. <p>Associates a credential using the provided values with the <code>Request</code>.</p>
  1404. </div>
  1405. <div class="declaration">
  1406. <h4>Declaration</h4>
  1407. <div class="language">
  1408. <p class="aside-title">Swift</p>
  1409. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1410. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="nv">username</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">persistence</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="o">.</span><span class="kt">Persistence</span> <span class="o">=</span> <span class="o">.</span><span class="n">forSession</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1411. </div>
  1412. </div>
  1413. <div>
  1414. <h4>Parameters</h4>
  1415. <table class="graybox">
  1416. <tbody>
  1417. <tr>
  1418. <td>
  1419. <code>
  1420. <em>username</em>
  1421. </code>
  1422. </td>
  1423. <td>
  1424. <div>
  1425. <p>The username.</p>
  1426. </div>
  1427. </td>
  1428. </tr>
  1429. <tr>
  1430. <td>
  1431. <code>
  1432. <em>password</em>
  1433. </code>
  1434. </td>
  1435. <td>
  1436. <div>
  1437. <p>The password.</p>
  1438. </div>
  1439. </td>
  1440. </tr>
  1441. <tr>
  1442. <td>
  1443. <code>
  1444. <em>persistence</em>
  1445. </code>
  1446. </td>
  1447. <td>
  1448. <div>
  1449. <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>.</p>
  1450. </div>
  1451. </td>
  1452. </tr>
  1453. </tbody>
  1454. </table>
  1455. </div>
  1456. <div>
  1457. <h4>Return Value</h4>
  1458. <p>The <code>Request</code>.</p>
  1459. </div>
  1460. </section>
  1461. </div>
  1462. </li>
  1463. <li class="item">
  1464. <div>
  1465. <code>
  1466. <a name="/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
  1467. <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
  1468. <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:)</a>
  1469. </code>
  1470. </div>
  1471. <div class="height-container">
  1472. <div class="pointer-container"></div>
  1473. <section class="section">
  1474. <div class="pointer"></div>
  1475. <div class="abstract">
  1476. <p>Associates the provided credential with the <code>Request</code>.</p>
  1477. </div>
  1478. <div class="declaration">
  1479. <h4>Declaration</h4>
  1480. <div class="language">
  1481. <p class="aside-title">Swift</p>
  1482. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1483. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">authenticate</span><span class="p">(</span><span class="n">with</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1484. </div>
  1485. </div>
  1486. <div>
  1487. <h4>Parameters</h4>
  1488. <table class="graybox">
  1489. <tbody>
  1490. <tr>
  1491. <td>
  1492. <code>
  1493. <em>credential</em>
  1494. </code>
  1495. </td>
  1496. <td>
  1497. <div>
  1498. <p>The <code>URLCredential</code>.</p>
  1499. </div>
  1500. </td>
  1501. </tr>
  1502. </tbody>
  1503. </table>
  1504. </div>
  1505. <div>
  1506. <h4>Return Value</h4>
  1507. <p>The <code>Request</code>.</p>
  1508. </div>
  1509. </section>
  1510. </div>
  1511. </li>
  1512. <li class="item">
  1513. <div>
  1514. <code>
  1515. <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1516. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  1517. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:closure:)</a>
  1518. </code>
  1519. </div>
  1520. <div class="height-container">
  1521. <div class="pointer-container"></div>
  1522. <section class="section">
  1523. <div class="pointer"></div>
  1524. <div class="abstract">
  1525. <p>Sets a closure to be called periodically during the lifecycle of the <code>Request</code> as data is read from the server.</p>
  1526. <p>Only the last closure provided is used.</p>
  1527. </div>
  1528. <div class="declaration">
  1529. <h4>Declaration</h4>
  1530. <div class="language">
  1531. <p class="aside-title">Swift</p>
  1532. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1533. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">downloadProgress</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">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1534. </div>
  1535. </div>
  1536. <div>
  1537. <h4>Parameters</h4>
  1538. <table class="graybox">
  1539. <tbody>
  1540. <tr>
  1541. <td>
  1542. <code>
  1543. <em>queue</em>
  1544. </code>
  1545. </td>
  1546. <td>
  1547. <div>
  1548. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1549. </div>
  1550. </td>
  1551. </tr>
  1552. <tr>
  1553. <td>
  1554. <code>
  1555. <em>closure</em>
  1556. </code>
  1557. </td>
  1558. <td>
  1559. <div>
  1560. <p>The code to be executed periodically as data is read from the server.</p>
  1561. </div>
  1562. </td>
  1563. </tr>
  1564. <tr>
  1565. <td>
  1566. <code>
  1567. <em>queue</em>
  1568. </code>
  1569. </td>
  1570. <td>
  1571. <div>
  1572. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1573. </div>
  1574. </td>
  1575. </tr>
  1576. <tr>
  1577. <td>
  1578. <code>
  1579. <em>closure</em>
  1580. </code>
  1581. </td>
  1582. <td>
  1583. <div>
  1584. <p>The code to be executed periodically as data is read from the server.</p>
  1585. </div>
  1586. </td>
  1587. </tr>
  1588. </tbody>
  1589. </table>
  1590. </div>
  1591. <div>
  1592. <h4>Return Value</h4>
  1593. <p>The <code>Request</code>.</p>
  1594. </div>
  1595. </section>
  1596. </div>
  1597. </li>
  1598. <li class="item">
  1599. <div>
  1600. <code>
  1601. <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1602. <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
  1603. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:closure:)</a>
  1604. </code>
  1605. </div>
  1606. <div class="height-container">
  1607. <div class="pointer-container"></div>
  1608. <section class="section">
  1609. <div class="pointer"></div>
  1610. <div class="abstract">
  1611. <p>Sets a closure to be called periodically during the lifecycle of the <code>Request</code> as data is sent to the server.</p>
  1612. <p>Only the last closure provided is used.</p>
  1613. </div>
  1614. <div class="declaration">
  1615. <h4>Declaration</h4>
  1616. <div class="language">
  1617. <p class="aside-title">Swift</p>
  1618. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1619. <span class="kd">open</span> <span class="kd">func</span> <span class="nf">uploadProgress</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">closure</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1620. </div>
  1621. </div>
  1622. <div>
  1623. <h4>Parameters</h4>
  1624. <table class="graybox">
  1625. <tbody>
  1626. <tr>
  1627. <td>
  1628. <code>
  1629. <em>queue</em>
  1630. </code>
  1631. </td>
  1632. <td>
  1633. <div>
  1634. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1635. </div>
  1636. </td>
  1637. </tr>
  1638. <tr>
  1639. <td>
  1640. <code>
  1641. <em>closure</em>
  1642. </code>
  1643. </td>
  1644. <td>
  1645. <div>
  1646. <p>The closure to be executed periodically as data is sent to the server.</p>
  1647. </div>
  1648. </td>
  1649. </tr>
  1650. </tbody>
  1651. </table>
  1652. </div>
  1653. <div>
  1654. <h4>Return Value</h4>
  1655. <p>The <code>Request</code>.</p>
  1656. </div>
  1657. </section>
  1658. </div>
  1659. </li>
  1660. </ul>
  1661. </div>
  1662. <div class="task-group">
  1663. <ul class="item-container">
  1664. <li class="item">
  1665. <div>
  1666. <code>
  1667. <a name="/s:9Alamofire7RequestC9didResumeSo18NSNotificationNameavpZ"></a>
  1668. <a name="//apple_ref/swift/Variable/didResume" class="dashAnchor"></a>
  1669. <a class="token" href="#/s:9Alamofire7RequestC9didResumeSo18NSNotificationNameavpZ">didResume</a>
  1670. </code>
  1671. </div>
  1672. <div class="height-container">
  1673. <div class="pointer-container"></div>
  1674. <section class="section">
  1675. <div class="pointer"></div>
  1676. <div class="abstract">
  1677. <p>Posted when a <code>Request</code>&lsquo;s task is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
  1678. </div>
  1679. <div class="declaration">
  1680. <h4>Declaration</h4>
  1681. <div class="language">
  1682. <p class="aside-title">Swift</p>
  1683. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didResume</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1684. </div>
  1685. </div>
  1686. </section>
  1687. </div>
  1688. </li>
  1689. <li class="item">
  1690. <div>
  1691. <code>
  1692. <a name="/s:9Alamofire7RequestC10didSuspendSo18NSNotificationNameavpZ"></a>
  1693. <a name="//apple_ref/swift/Variable/didSuspend" class="dashAnchor"></a>
  1694. <a class="token" href="#/s:9Alamofire7RequestC10didSuspendSo18NSNotificationNameavpZ">didSuspend</a>
  1695. </code>
  1696. </div>
  1697. <div class="height-container">
  1698. <div class="pointer-container"></div>
  1699. <section class="section">
  1700. <div class="pointer"></div>
  1701. <div class="abstract">
  1702. <p>Posted when a <code>Request</code>&lsquo;s task is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
  1703. </div>
  1704. <div class="declaration">
  1705. <h4>Declaration</h4>
  1706. <div class="language">
  1707. <p class="aside-title">Swift</p>
  1708. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didSuspend</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1709. </div>
  1710. </div>
  1711. </section>
  1712. </div>
  1713. </li>
  1714. <li class="item">
  1715. <div>
  1716. <code>
  1717. <a name="/s:9Alamofire7RequestC9didCancelSo18NSNotificationNameavpZ"></a>
  1718. <a name="//apple_ref/swift/Variable/didCancel" class="dashAnchor"></a>
  1719. <a class="token" href="#/s:9Alamofire7RequestC9didCancelSo18NSNotificationNameavpZ">didCancel</a>
  1720. </code>
  1721. </div>
  1722. <div class="height-container">
  1723. <div class="pointer-container"></div>
  1724. <section class="section">
  1725. <div class="pointer"></div>
  1726. <div class="abstract">
  1727. <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
  1728. </div>
  1729. <div class="declaration">
  1730. <h4>Declaration</h4>
  1731. <div class="language">
  1732. <p class="aside-title">Swift</p>
  1733. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCancel</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1734. </div>
  1735. </div>
  1736. </section>
  1737. </div>
  1738. </li>
  1739. <li class="item">
  1740. <div>
  1741. <code>
  1742. <a name="/s:9Alamofire7RequestC11didCompleteSo18NSNotificationNameavpZ"></a>
  1743. <a name="//apple_ref/swift/Variable/didComplete" class="dashAnchor"></a>
  1744. <a class="token" href="#/s:9Alamofire7RequestC11didCompleteSo18NSNotificationNameavpZ">didComplete</a>
  1745. </code>
  1746. </div>
  1747. <div class="height-container">
  1748. <div class="pointer-container"></div>
  1749. <section class="section">
  1750. <div class="pointer"></div>
  1751. <div class="abstract">
  1752. <p>Posted when a <code>Request</code>&lsquo;s task is completed. The <code>Notification</code> contains the completed <code>Request</code>.</p>
  1753. </div>
  1754. <div class="declaration">
  1755. <h4>Declaration</h4>
  1756. <div class="language">
  1757. <p class="aside-title">Swift</p>
  1758. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didComplete</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1759. </div>
  1760. </div>
  1761. </section>
  1762. </div>
  1763. </li>
  1764. </ul>
  1765. </div>
  1766. <div class="task-group">
  1767. <div class="task-name-container">
  1768. <a name="/Protocol%20Conformances"></a>
  1769. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  1770. <a href="#/Protocol%20Conformances">
  1771. <h3 class="section-name">Protocol Conformances</h3>
  1772. </a>
  1773. </div>
  1774. <ul class="item-container">
  1775. <li class="item">
  1776. <div>
  1777. <code>
  1778. <a name="/s:SQ2eeoiySbx_xtFZ"></a>
  1779. <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
  1780. <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:_:)</a>
  1781. </code>
  1782. </div>
  1783. <div class="height-container">
  1784. <div class="pointer-container"></div>
  1785. <section class="section">
  1786. <div class="pointer"></div>
  1787. <div class="abstract">
  1788. </div>
  1789. <div class="declaration">
  1790. <h4>Declaration</h4>
  1791. <div class="language">
  1792. <p class="aside-title">Swift</p>
  1793. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">Request</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
  1794. </div>
  1795. </div>
  1796. </section>
  1797. </div>
  1798. </li>
  1799. </ul>
  1800. </div>
  1801. <div class="task-group">
  1802. <div class="task-name-container">
  1803. <a name="/Protocol%20Conformances2"></a>
  1804. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  1805. <a href="#/Protocol%20Conformances2">
  1806. <h3 class="section-name">Protocol Conformances</h3>
  1807. </a>
  1808. </div>
  1809. <ul class="item-container">
  1810. <li class="item">
  1811. <div>
  1812. <code>
  1813. <a name="/s:SH9hashValueSivp"></a>
  1814. <a name="//apple_ref/swift/Property/hashValue" class="dashAnchor"></a>
  1815. <a class="token" href="#/s:SH9hashValueSivp">hashValue</a>
  1816. </code>
  1817. </div>
  1818. <div class="height-container">
  1819. <div class="pointer-container"></div>
  1820. <section class="section">
  1821. <div class="pointer"></div>
  1822. <div class="abstract">
  1823. </div>
  1824. <div class="declaration">
  1825. <h4>Declaration</h4>
  1826. <div class="language">
  1827. <p class="aside-title">Swift</p>
  1828. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">hashValue</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1829. </div>
  1830. </div>
  1831. </section>
  1832. </div>
  1833. </li>
  1834. </ul>
  1835. </div>
  1836. <div class="task-group">
  1837. <div class="task-name-container">
  1838. <a name="/Protocol%20Conformances3"></a>
  1839. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  1840. <a href="#/Protocol%20Conformances3">
  1841. <h3 class="section-name">Protocol Conformances</h3>
  1842. </a>
  1843. </div>
  1844. <ul class="item-container">
  1845. <li class="item">
  1846. <div>
  1847. <code>
  1848. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  1849. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  1850. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  1851. </code>
  1852. </div>
  1853. <div class="height-container">
  1854. <div class="pointer-container"></div>
  1855. <section class="section">
  1856. <div class="pointer"></div>
  1857. <div class="abstract">
  1858. <p>A textual representation of this instance, including the <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code> and <code>URL</code> if the <code>URLRequest</code> has been
  1859. created, as well as the response status code, if a response has been received.</p>
  1860. </div>
  1861. <div class="declaration">
  1862. <h4>Declaration</h4>
  1863. <div class="language">
  1864. <p class="aside-title">Swift</p>
  1865. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1866. </div>
  1867. </div>
  1868. </section>
  1869. </div>
  1870. </li>
  1871. </ul>
  1872. </div>
  1873. <div class="task-group">
  1874. <div class="task-name-container">
  1875. <a name="/Protocol%20Conformances4"></a>
  1876. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  1877. <a href="#/Protocol%20Conformances4">
  1878. <h3 class="section-name">Protocol Conformances</h3>
  1879. </a>
  1880. </div>
  1881. <ul class="item-container">
  1882. <li class="item">
  1883. <div>
  1884. <code>
  1885. <a name="/s:9Alamofire7RequestC16debugDescriptionSSvp"></a>
  1886. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  1887. <a class="token" href="#/s:9Alamofire7RequestC16debugDescriptionSSvp">debugDescription</a>
  1888. </code>
  1889. </div>
  1890. <div class="height-container">
  1891. <div class="pointer-container"></div>
  1892. <section class="section">
  1893. <div class="pointer"></div>
  1894. <div class="abstract">
  1895. <p>A textual representation of this instance in the form of a cURL command.</p>
  1896. </div>
  1897. <div class="declaration">
  1898. <h4>Declaration</h4>
  1899. <div class="language">
  1900. <p class="aside-title">Swift</p>
  1901. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">debugDescription</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1902. </div>
  1903. </div>
  1904. </section>
  1905. </div>
  1906. </li>
  1907. </ul>
  1908. </div>
  1909. <div class="task-group">
  1910. <div class="task-name-container">
  1911. <a name="/Helper%20Types"></a>
  1912. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  1913. <a href="#/Helper%20Types">
  1914. <h3 class="section-name">Helper Types</h3>
  1915. </a>
  1916. </div>
  1917. <ul class="item-container">
  1918. <li class="item">
  1919. <div>
  1920. <code>
  1921. <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
  1922. <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
  1923. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
  1924. </code>
  1925. </div>
  1926. <div class="height-container">
  1927. <div class="pointer-container"></div>
  1928. <section class="section">
  1929. <div class="pointer"></div>
  1930. <div class="abstract">
  1931. <p>Used to represent whether a validation succeeded or failed.</p>
  1932. </div>
  1933. <div class="declaration">
  1934. <h4>Declaration</h4>
  1935. <div class="language">
  1936. <p class="aside-title">Swift</p>
  1937. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">ValidationResult</span> <span class="o">=</span> <span class="kt"><a href="../Enums/Result.html">Result</a></span><span class="o">&lt;</span><span class="kt">Void</span><span class="o">&gt;</span></code></pre>
  1938. </div>
  1939. </div>
  1940. </section>
  1941. </div>
  1942. </li>
  1943. </ul>
  1944. </div>
  1945. </div>
  1946. </section>
  1947. </article>
  1948. </div>
  1949. <section class="footer">
  1950. <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>
  1951. <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>
  1952. </section>
  1953. </body>
  1954. </div>
  1955. </html>