2
0

Request.html 130 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449
  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/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  178. </li>
  179. </ul>
  180. </li>
  181. <li class="nav-group-name">
  182. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  183. <ul class="nav-group-tasks">
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  256. </li>
  257. </ul>
  258. </li>
  259. <li class="nav-group-name">
  260. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  261. <ul class="nav-group-tasks">
  262. <li class="nav-group-task">
  263. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  264. </li>
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  321. </li>
  322. </ul>
  323. </li>
  324. <li class="nav-group-name">
  325. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  326. <ul class="nav-group-tasks">
  327. <li class="nav-group-task">
  328. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  329. </li>
  330. <li class="nav-group-task">
  331. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  332. </li>
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  371. </li>
  372. </ul>
  373. </li>
  374. <li class="nav-group-name">
  375. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  376. <ul class="nav-group-tasks">
  377. <li class="nav-group-task">
  378. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  379. </li>
  380. <li class="nav-group-task">
  381. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  382. </li>
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  388. </li>
  389. </ul>
  390. </li>
  391. </ul>
  392. </nav>
  393. <article class="main-content">
  394. <section class="section">
  395. <div class="section-content">
  396. <h1>Request</h1>
  397. <div class="declaration">
  398. <div class="language">
  399. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  400. </div>
  401. </div>
  402. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  403. handling.</p>
  404. </div>
  405. </section>
  406. <section class="section">
  407. <div class="section-content">
  408. <div class="task-group">
  409. <ul class="item-container">
  410. <li class="item">
  411. <div>
  412. <code>
  413. <a name="/s:9Alamofire7RequestC5StateO"></a>
  414. <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
  415. <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
  416. </code>
  417. </div>
  418. <div class="height-container">
  419. <div class="pointer-container"></div>
  420. <section class="section">
  421. <div class="pointer"></div>
  422. <div class="abstract">
  423. <p>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
  424. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  425. <ul>
  426. <li>initialized: Initial state of the <code><a href="../Classes/Request.html">Request</a></code>.</li>
  427. <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
  428. them in this state.</li>
  429. <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
  430. them in this state.</li>
  431. <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
  432. 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
  433. transition to any other state.</li>
  434. </ul>
  435. <a href="../Classes/Request/State.html" class="slightly-smaller">See more</a>
  436. </div>
  437. <div class="declaration">
  438. <h4>Declaration</h4>
  439. <div class="language">
  440. <p class="aside-title">Swift</p>
  441. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span></code></pre>
  442. </div>
  443. </div>
  444. </section>
  445. </div>
  446. </li>
  447. </ul>
  448. </div>
  449. <div class="task-group">
  450. <div class="task-name-container">
  451. <a name="/Initial%20State"></a>
  452. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  453. <a href="#/Initial%20State">
  454. <h3 class="section-name">Initial State</h3>
  455. </a>
  456. </div>
  457. <ul class="item-container">
  458. <li class="item">
  459. <div>
  460. <code>
  461. <a name="/s:9Alamofire7RequestC2id10Foundation4UUIDVvp"></a>
  462. <a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
  463. <a class="token" href="#/s:9Alamofire7RequestC2id10Foundation4UUIDVvp">id</a>
  464. </code>
  465. </div>
  466. <div class="height-container">
  467. <div class="pointer-container"></div>
  468. <section class="section">
  469. <div class="pointer"></div>
  470. <div class="abstract">
  471. <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>
  472. </div>
  473. <div class="declaration">
  474. <h4>Declaration</h4>
  475. <div class="language">
  476. <p class="aside-title">Swift</p>
  477. <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>
  478. </div>
  479. </div>
  480. </section>
  481. </div>
  482. </li>
  483. <li class="item">
  484. <div>
  485. <code>
  486. <a name="/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp"></a>
  487. <a name="//apple_ref/swift/Property/underlyingQueue" class="dashAnchor"></a>
  488. <a class="token" href="#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a>
  489. </code>
  490. </div>
  491. <div class="height-container">
  492. <div class="pointer-container"></div>
  493. <section class="section">
  494. <div class="pointer"></div>
  495. <div class="abstract">
  496. <p>The serial queue for all internal async actions.</p>
  497. </div>
  498. <div class="declaration">
  499. <h4>Declaration</h4>
  500. <div class="language">
  501. <p class="aside-title">Swift</p>
  502. <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>
  503. </div>
  504. </div>
  505. </section>
  506. </div>
  507. </li>
  508. <li class="item">
  509. <div>
  510. <code>
  511. <a name="/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp"></a>
  512. <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
  513. <a class="token" href="#/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
  514. </code>
  515. </div>
  516. <div class="height-container">
  517. <div class="pointer-container"></div>
  518. <section class="section">
  519. <div class="pointer"></div>
  520. <div class="abstract">
  521. <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>
  522. </div>
  523. <div class="declaration">
  524. <h4>Declaration</h4>
  525. <div class="language">
  526. <p class="aside-title">Swift</p>
  527. <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>
  528. </div>
  529. </div>
  530. </section>
  531. </div>
  532. </li>
  533. <li class="item">
  534. <div>
  535. <code>
  536. <a name="/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp"></a>
  537. <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
  538. <a class="token" href="#/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp">eventMonitor</a>
  539. </code>
  540. </div>
  541. <div class="height-container">
  542. <div class="pointer-container"></div>
  543. <section class="section">
  544. <div class="pointer"></div>
  545. <div class="abstract">
  546. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks.</p>
  547. </div>
  548. <div class="declaration">
  549. <h4>Declaration</h4>
  550. <div class="language">
  551. <p class="aside-title">Swift</p>
  552. <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>
  553. </div>
  554. </div>
  555. </section>
  556. </div>
  557. </li>
  558. <li class="item">
  559. <div>
  560. <code>
  561. <a name="/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp"></a>
  562. <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
  563. <a class="token" href="#/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp">interceptor</a>
  564. </code>
  565. </div>
  566. <div class="height-container">
  567. <div class="pointer-container"></div>
  568. <section class="section">
  569. <div class="pointer"></div>
  570. <div class="abstract">
  571. <p>The <code>Request</code>&lsquo;s interceptor.</p>
  572. </div>
  573. <div class="declaration">
  574. <h4>Declaration</h4>
  575. <div class="language">
  576. <p class="aside-title">Swift</p>
  577. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span></code></pre>
  578. </div>
  579. </div>
  580. </section>
  581. </div>
  582. </li>
  583. <li class="item">
  584. <div>
  585. <code>
  586. <a name="/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp"></a>
  587. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  588. <a class="token" href="#/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp">delegate</a>
  589. </code>
  590. </div>
  591. <div class="height-container">
  592. <div class="pointer-container"></div>
  593. <section class="section">
  594. <div class="pointer"></div>
  595. <div class="abstract">
  596. <p>The <code>Request</code>&lsquo;s delegate.</p>
  597. </div>
  598. <div class="declaration">
  599. <h4>Declaration</h4>
  600. <div class="language">
  601. <p class="aside-title">Swift</p>
  602. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</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> <span class="p">{</span>
  603. <span class="k">get</span>
  604. <span class="p">}</span></code></pre>
  605. </div>
  606. </div>
  607. </section>
  608. </div>
  609. </li>
  610. </ul>
  611. </div>
  612. <div class="task-group">
  613. <div class="task-name-container">
  614. <a name="/Updated%20State"></a>
  615. <a name="//apple_ref/swift/Section/Updated State" class="dashAnchor"></a>
  616. <a href="#/Updated%20State">
  617. <h3 class="section-name">Updated State</h3>
  618. </a>
  619. </div>
  620. <ul class="item-container">
  621. <li class="item">
  622. <div>
  623. <code>
  624. <a name="/s:9Alamofire7RequestC5stateAC5StateOvp"></a>
  625. <a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
  626. <a class="token" href="#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a>
  627. </code>
  628. </div>
  629. <div class="height-container">
  630. <div class="pointer-container"></div>
  631. <section class="section">
  632. <div class="pointer"></div>
  633. <div class="abstract">
  634. <p><code><a href="../Classes/Request/State.html">State</a></code> of the <code>Request</code>.</p>
  635. </div>
  636. <div class="declaration">
  637. <h4>Declaration</h4>
  638. <div class="language">
  639. <p class="aside-title">Swift</p>
  640. <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>
  641. </div>
  642. </div>
  643. </section>
  644. </div>
  645. </li>
  646. <li class="item">
  647. <div>
  648. <code>
  649. <a name="/s:9Alamofire7RequestC11isCancelledSbvp"></a>
  650. <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
  651. <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</a>
  652. </code>
  653. </div>
  654. <div class="height-container">
  655. <div class="pointer-container"></div>
  656. <section class="section">
  657. <div class="pointer"></div>
  658. <div class="abstract">
  659. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.cancelled</code>.</p>
  660. </div>
  661. <div class="declaration">
  662. <h4>Declaration</h4>
  663. <div class="language">
  664. <p class="aside-title">Swift</p>
  665. <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>
  666. </div>
  667. </div>
  668. </section>
  669. </div>
  670. </li>
  671. <li class="item">
  672. <div>
  673. <code>
  674. <a name="/s:9Alamofire7RequestC9isResumedSbvp"></a>
  675. <a name="//apple_ref/swift/Property/isResumed" class="dashAnchor"></a>
  676. <a class="token" href="#/s:9Alamofire7RequestC9isResumedSbvp">isResumed</a>
  677. </code>
  678. </div>
  679. <div class="height-container">
  680. <div class="pointer-container"></div>
  681. <section class="section">
  682. <div class="pointer"></div>
  683. <div class="abstract">
  684. <p>Returns whether <code>state is</code>.resumed`.</p>
  685. </div>
  686. <div class="declaration">
  687. <h4>Declaration</h4>
  688. <div class="language">
  689. <p class="aside-title">Swift</p>
  690. <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>
  691. </div>
  692. </div>
  693. </section>
  694. </div>
  695. </li>
  696. <li class="item">
  697. <div>
  698. <code>
  699. <a name="/s:9Alamofire7RequestC11isSuspendedSbvp"></a>
  700. <a name="//apple_ref/swift/Property/isSuspended" class="dashAnchor"></a>
  701. <a class="token" href="#/s:9Alamofire7RequestC11isSuspendedSbvp">isSuspended</a>
  702. </code>
  703. </div>
  704. <div class="height-container">
  705. <div class="pointer-container"></div>
  706. <section class="section">
  707. <div class="pointer"></div>
  708. <div class="abstract">
  709. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.suspended</code>.</p>
  710. </div>
  711. <div class="declaration">
  712. <h4>Declaration</h4>
  713. <div class="language">
  714. <p class="aside-title">Swift</p>
  715. <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>
  716. </div>
  717. </div>
  718. </section>
  719. </div>
  720. </li>
  721. <li class="item">
  722. <div>
  723. <code>
  724. <a name="/s:9Alamofire7RequestC13isInitializedSbvp"></a>
  725. <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
  726. <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</a>
  727. </code>
  728. </div>
  729. <div class="height-container">
  730. <div class="pointer-container"></div>
  731. <section class="section">
  732. <div class="pointer"></div>
  733. <div class="abstract">
  734. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.initialized</code>.</p>
  735. </div>
  736. <div class="declaration">
  737. <h4>Declaration</h4>
  738. <div class="language">
  739. <p class="aside-title">Swift</p>
  740. <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>
  741. </div>
  742. </div>
  743. </section>
  744. </div>
  745. </li>
  746. <li class="item">
  747. <div>
  748. <code>
  749. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  750. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  751. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  752. </code>
  753. </div>
  754. <div class="height-container">
  755. <div class="pointer-container"></div>
  756. <section class="section">
  757. <div class="pointer"></div>
  758. <div class="abstract">
  759. <p>Closure type executed when monitoring the upload or download progress of a request.</p>
  760. </div>
  761. <div class="declaration">
  762. <h4>Declaration</h4>
  763. <div class="language">
  764. <p class="aside-title">Swift</p>
  765. <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>
  766. </div>
  767. </div>
  768. </section>
  769. </div>
  770. </li>
  771. <li class="item">
  772. <div>
  773. <code>
  774. <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
  775. <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
  776. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
  777. </code>
  778. </div>
  779. <div class="height-container">
  780. <div class="pointer-container"></div>
  781. <section class="section">
  782. <div class="pointer"></div>
  783. <div class="abstract">
  784. <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>
  785. </div>
  786. <div class="declaration">
  787. <h4>Declaration</h4>
  788. <div class="language">
  789. <p class="aside-title">Swift</p>
  790. <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>
  791. </div>
  792. </div>
  793. </section>
  794. </div>
  795. </li>
  796. <li class="item">
  797. <div>
  798. <code>
  799. <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
  800. <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
  801. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
  802. </code>
  803. </div>
  804. <div class="height-container">
  805. <div class="pointer-container"></div>
  806. <section class="section">
  807. <div class="pointer"></div>
  808. <div class="abstract">
  809. <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  810. </div>
  811. <div class="declaration">
  812. <h4>Declaration</h4>
  813. <div class="language">
  814. <p class="aside-title">Swift</p>
  815. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">downloadProgress</span><span class="p">:</span> <span class="kt">Progress</span></code></pre>
  816. </div>
  817. </div>
  818. </section>
  819. </div>
  820. </li>
  821. <li class="item">
  822. <div>
  823. <code>
  824. <a name="/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp"></a>
  825. <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
  826. <a class="token" href="#/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
  827. </code>
  828. </div>
  829. <div class="height-container">
  830. <div class="pointer-container"></div>
  831. <section class="section">
  832. <div class="pointer"></div>
  833. <div class="abstract">
  834. <p>Undocumented</p>
  835. </div>
  836. <div class="declaration">
  837. <h4>Declaration</h4>
  838. <div class="language">
  839. <p class="aside-title">Swift</p>
  840. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">redirectHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></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>
  841. </div>
  842. </div>
  843. </section>
  844. </div>
  845. </li>
  846. <li class="item">
  847. <div>
  848. <code>
  849. <a name="/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
  850. <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
  851. <a class="token" href="#/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
  852. </code>
  853. </div>
  854. <div class="height-container">
  855. <div class="pointer-container"></div>
  856. <section class="section">
  857. <div class="pointer"></div>
  858. <div class="abstract">
  859. <p>Undocumented</p>
  860. </div>
  861. <div class="declaration">
  862. <h4>Declaration</h4>
  863. <div class="language">
  864. <p class="aside-title">Swift</p>
  865. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></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>
  866. </div>
  867. </div>
  868. </section>
  869. </div>
  870. </li>
  871. <li class="item">
  872. <div>
  873. <code>
  874. <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
  875. <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
  876. <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
  877. </code>
  878. </div>
  879. <div class="height-container">
  880. <div class="pointer-container"></div>
  881. <section class="section">
  882. <div class="pointer"></div>
  883. <div class="abstract">
  884. <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
  885. </div>
  886. <div class="declaration">
  887. <h4>Declaration</h4>
  888. <div class="language">
  889. <p class="aside-title">Swift</p>
  890. <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>
  891. </div>
  892. </div>
  893. </section>
  894. </div>
  895. </li>
  896. <li class="item">
  897. <div>
  898. <code>
  899. <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
  900. <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
  901. <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a>
  902. </code>
  903. </div>
  904. <div class="height-container">
  905. <div class="pointer-container"></div>
  906. <section class="section">
  907. <div class="pointer"></div>
  908. <div class="abstract">
  909. <p>All <code>URLRequests</code> created on behalf of the <code>Request</code>, including original and adapted requests.</p>
  910. </div>
  911. <div class="declaration">
  912. <h4>Declaration</h4>
  913. <div class="language">
  914. <p class="aside-title">Swift</p>
  915. <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>
  916. </div>
  917. </div>
  918. </section>
  919. </div>
  920. </li>
  921. <li class="item">
  922. <div>
  923. <code>
  924. <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
  925. <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
  926. <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
  927. </code>
  928. </div>
  929. <div class="height-container">
  930. <div class="pointer-container"></div>
  931. <section class="section">
  932. <div class="pointer"></div>
  933. <div class="abstract">
  934. <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
  935. </div>
  936. <div class="declaration">
  937. <h4>Declaration</h4>
  938. <div class="language">
  939. <p class="aside-title">Swift</p>
  940. <pre class="highlight swift"><code><span class="kd">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>
  941. </div>
  942. </div>
  943. </section>
  944. </div>
  945. </li>
  946. <li class="item">
  947. <div>
  948. <code>
  949. <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
  950. <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
  951. <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
  952. </code>
  953. </div>
  954. <div class="height-container">
  955. <div class="pointer-container"></div>
  956. <section class="section">
  957. <div class="pointer"></div>
  958. <div class="abstract">
  959. <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  960. </div>
  961. <div class="declaration">
  962. <h4>Declaration</h4>
  963. <div class="language">
  964. <p class="aside-title">Swift</p>
  965. <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>
  966. </div>
  967. </div>
  968. </section>
  969. </div>
  970. </li>
  971. <li class="item">
  972. <div>
  973. <code>
  974. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  975. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  976. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  977. </code>
  978. </div>
  979. <div class="height-container">
  980. <div class="pointer-container"></div>
  981. <section class="section">
  982. <div class="pointer"></div>
  983. <div class="abstract">
  984. <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  985. </div>
  986. <div class="declaration">
  987. <h4>Declaration</h4>
  988. <div class="language">
  989. <p class="aside-title">Swift</p>
  990. <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>
  991. </div>
  992. </div>
  993. </section>
  994. </div>
  995. </li>
  996. <li class="item">
  997. <div>
  998. <code>
  999. <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
  1000. <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
  1001. <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
  1002. </code>
  1003. </div>
  1004. <div class="height-container">
  1005. <div class="pointer-container"></div>
  1006. <section class="section">
  1007. <div class="pointer"></div>
  1008. <div class="abstract">
  1009. <p><code>URLRequest</code>s from all of the <code>URLSessionTask</code>s executed on behalf of the <code>Request</code>.</p>
  1010. </div>
  1011. <div class="declaration">
  1012. <h4>Declaration</h4>
  1013. <div class="language">
  1014. <p class="aside-title">Swift</p>
  1015. <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>
  1016. </div>
  1017. </div>
  1018. </section>
  1019. </div>
  1020. </li>
  1021. <li class="item">
  1022. <div>
  1023. <code>
  1024. <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
  1025. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  1026. <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
  1027. </code>
  1028. </div>
  1029. <div class="height-container">
  1030. <div class="pointer-container"></div>
  1031. <section class="section">
  1032. <div class="pointer"></div>
  1033. <div class="abstract">
  1034. <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
  1035. last <code>URLSessionTask</code>.</p>
  1036. </div>
  1037. <div class="declaration">
  1038. <h4>Declaration</h4>
  1039. <div class="language">
  1040. <p class="aside-title">Swift</p>
  1041. <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>
  1042. </div>
  1043. </div>
  1044. </section>
  1045. </div>
  1046. </li>
  1047. <li class="item">
  1048. <div>
  1049. <code>
  1050. <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
  1051. <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
  1052. <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
  1053. </code>
  1054. </div>
  1055. <div class="height-container">
  1056. <div class="pointer-container"></div>
  1057. <section class="section">
  1058. <div class="pointer"></div>
  1059. <div class="abstract">
  1060. <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
  1061. </div>
  1062. <div class="declaration">
  1063. <h4>Declaration</h4>
  1064. <div class="language">
  1065. <p class="aside-title">Swift</p>
  1066. <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>
  1067. </div>
  1068. </div>
  1069. </section>
  1070. </div>
  1071. </li>
  1072. <li class="item">
  1073. <div>
  1074. <code>
  1075. <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
  1076. <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
  1077. <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
  1078. </code>
  1079. </div>
  1080. <div class="height-container">
  1081. <div class="pointer-container"></div>
  1082. <section class="section">
  1083. <div class="pointer"></div>
  1084. <div class="abstract">
  1085. <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1086. </div>
  1087. <div class="declaration">
  1088. <h4>Declaration</h4>
  1089. <div class="language">
  1090. <p class="aside-title">Swift</p>
  1091. <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>
  1092. </div>
  1093. </div>
  1094. </section>
  1095. </div>
  1096. </li>
  1097. <li class="item">
  1098. <div>
  1099. <code>
  1100. <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
  1101. <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
  1102. <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
  1103. </code>
  1104. </div>
  1105. <div class="height-container">
  1106. <div class="pointer-container"></div>
  1107. <section class="section">
  1108. <div class="pointer"></div>
  1109. <div class="abstract">
  1110. <p>Last <code>URLSessionTask</code> crated on behalf of the <code>Request</code>.</p>
  1111. </div>
  1112. <div class="declaration">
  1113. <h4>Declaration</h4>
  1114. <div class="language">
  1115. <p class="aside-title">Swift</p>
  1116. <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>
  1117. </div>
  1118. </div>
  1119. </section>
  1120. </div>
  1121. </li>
  1122. <li class="item">
  1123. <div>
  1124. <code>
  1125. <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
  1126. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  1127. <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
  1128. </code>
  1129. </div>
  1130. <div class="height-container">
  1131. <div class="pointer-container"></div>
  1132. <section class="section">
  1133. <div class="pointer"></div>
  1134. <div class="abstract">
  1135. <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1136. </div>
  1137. <div class="declaration">
  1138. <h4>Declaration</h4>
  1139. <div class="language">
  1140. <p class="aside-title">Swift</p>
  1141. <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>
  1142. </div>
  1143. </div>
  1144. </section>
  1145. </div>
  1146. </li>
  1147. <li class="item">
  1148. <div>
  1149. <code>
  1150. <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
  1151. <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
  1152. <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
  1153. </code>
  1154. </div>
  1155. <div class="height-container">
  1156. <div class="pointer-container"></div>
  1157. <section class="section">
  1158. <div class="pointer"></div>
  1159. <div class="abstract">
  1160. <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>
  1161. </div>
  1162. <div class="declaration">
  1163. <h4>Declaration</h4>
  1164. <div class="language">
  1165. <p class="aside-title">Swift</p>
  1166. <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>
  1167. </div>
  1168. </div>
  1169. </section>
  1170. </div>
  1171. </li>
  1172. <li class="item">
  1173. <div>
  1174. <code>
  1175. <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1176. <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
  1177. <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
  1178. </code>
  1179. </div>
  1180. <div class="height-container">
  1181. <div class="pointer-container"></div>
  1182. <section class="section">
  1183. <div class="pointer"></div>
  1184. <div class="abstract">
  1185. <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1186. </div>
  1187. <div class="declaration">
  1188. <h4>Declaration</h4>
  1189. <div class="language">
  1190. <p class="aside-title">Swift</p>
  1191. <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>
  1192. </div>
  1193. </div>
  1194. </section>
  1195. </div>
  1196. </li>
  1197. <li class="item">
  1198. <div>
  1199. <code>
  1200. <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1201. <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
  1202. <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
  1203. </code>
  1204. </div>
  1205. <div class="height-container">
  1206. <div class="pointer-container"></div>
  1207. <section class="section">
  1208. <div class="pointer"></div>
  1209. <div class="abstract">
  1210. <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1211. </div>
  1212. <div class="declaration">
  1213. <h4>Declaration</h4>
  1214. <div class="language">
  1215. <p class="aside-title">Swift</p>
  1216. <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>
  1217. </div>
  1218. </div>
  1219. </section>
  1220. </div>
  1221. </li>
  1222. <li class="item">
  1223. <div>
  1224. <code>
  1225. <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  1226. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  1227. <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  1228. </code>
  1229. </div>
  1230. <div class="height-container">
  1231. <div class="pointer-container"></div>
  1232. <section class="section">
  1233. <div class="pointer"></div>
  1234. <div class="abstract">
  1235. <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1236. </div>
  1237. <div class="declaration">
  1238. <h4>Declaration</h4>
  1239. <div class="language">
  1240. <p class="aside-title">Swift</p>
  1241. <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>
  1242. </div>
  1243. </div>
  1244. </section>
  1245. </div>
  1246. </li>
  1247. <li class="item">
  1248. <div>
  1249. <code>
  1250. <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
  1251. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  1252. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
  1253. </code>
  1254. </div>
  1255. <div class="height-container">
  1256. <div class="pointer-container"></div>
  1257. <section class="section">
  1258. <div class="pointer"></div>
  1259. <div class="abstract">
  1260. <p>Number of times the <code>Request</code> has been retried.</p>
  1261. </div>
  1262. <div class="declaration">
  1263. <h4>Declaration</h4>
  1264. <div class="language">
  1265. <p class="aside-title">Swift</p>
  1266. <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>
  1267. </div>
  1268. </div>
  1269. </section>
  1270. </div>
  1271. </li>
  1272. <li class="item">
  1273. <div>
  1274. <code>
  1275. <a name="/s:9Alamofire7RequestC5errors5Error_pSgvp"></a>
  1276. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  1277. <a class="token" href="#/s:9Alamofire7RequestC5errors5Error_pSgvp">error</a>
  1278. </code>
  1279. </div>
  1280. <div class="height-container">
  1281. <div class="pointer-container"></div>
  1282. <section class="section">
  1283. <div class="pointer"></div>
  1284. <div class="abstract">
  1285. <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
  1286. </div>
  1287. <div class="declaration">
  1288. <h4>Declaration</h4>
  1289. <div class="language">
  1290. <p class="aside-title">Swift</p>
  1291. <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>
  1292. </div>
  1293. </div>
  1294. </section>
  1295. </div>
  1296. </li>
  1297. <li class="item">
  1298. <div>
  1299. <code>
  1300. <a name="/s:9Alamofire7RequestC2id15underlyingQueue013serializationE012eventMonitor11interceptor8delegateAC10Foundation4UUIDV_So17OS_dispatch_queueCAnA05EventH0_pSgAA0B11Interceptor_pSgAA0B8Delegate_ptcfc"></a>
  1301. <a name="//apple_ref/swift/Method/init(id:underlyingQueue:serializationQueue:eventMonitor:interceptor:delegate:)" class="dashAnchor"></a>
  1302. <a class="token" href="#/s:9Alamofire7RequestC2id15underlyingQueue013serializationE012eventMonitor11interceptor8delegateAC10Foundation4UUIDV_So17OS_dispatch_queueCAnA05EventH0_pSgAA0B11Interceptor_pSgAA0B8Delegate_ptcfc">init(id:underlyingQueue:serializationQueue:eventMonitor:interceptor:delegate:)</a>
  1303. </code>
  1304. </div>
  1305. <div class="height-container">
  1306. <div class="pointer-container"></div>
  1307. <section class="section">
  1308. <div class="pointer"></div>
  1309. <div class="abstract">
  1310. <p>Default initializer for the <code>Request</code> superclass.</p>
  1311. </div>
  1312. <div class="declaration">
  1313. <h4>Declaration</h4>
  1314. <div class="language">
  1315. <p class="aside-title">Swift</p>
  1316. <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>
  1317. <span class="nv">underlyingQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  1318. <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  1319. <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">?,</span>
  1320. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?,</span>
  1321. <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>
  1322. </div>
  1323. </div>
  1324. <div>
  1325. <h4>Parameters</h4>
  1326. <table class="graybox">
  1327. <tbody>
  1328. <tr>
  1329. <td>
  1330. <code>
  1331. <em>id</em>
  1332. </code>
  1333. </td>
  1334. <td>
  1335. <div>
  1336. <p><code>UUID</code> used for the <code>Hashable</code> and <code>Equatable</code> implementations. Defaults to a random <code>UUID</code>.</p>
  1337. </div>
  1338. </td>
  1339. </tr>
  1340. <tr>
  1341. <td>
  1342. <code>
  1343. <em>underlyingQueue</em>
  1344. </code>
  1345. </td>
  1346. <td>
  1347. <div>
  1348. <p><code>DispatchQueue</code> on which all internal <code>Request</code> work is performed.</p>
  1349. </div>
  1350. </td>
  1351. </tr>
  1352. <tr>
  1353. <td>
  1354. <code>
  1355. <em>serializationQueue</em>
  1356. </code>
  1357. </td>
  1358. <td>
  1359. <div>
  1360. <p><code>DispatchQueue</code> on which all serialization work is performed. Targets the
  1361. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code> when created by a <code>SessionManager</code>.</p>
  1362. </div>
  1363. </td>
  1364. </tr>
  1365. <tr>
  1366. <td>
  1367. <code>
  1368. <em>eventMonitor</em>
  1369. </code>
  1370. </td>
  1371. <td>
  1372. <div>
  1373. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks from internal <code>Request</code> actions.</p>
  1374. </div>
  1375. </td>
  1376. </tr>
  1377. <tr>
  1378. <td>
  1379. <code>
  1380. <em>interceptor</em>
  1381. </code>
  1382. </td>
  1383. <td>
  1384. <div>
  1385. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> used throughout the request lifecycle.</p>
  1386. </div>
  1387. </td>
  1388. </tr>
  1389. <tr>
  1390. <td>
  1391. <code>
  1392. <em>delegate</em>
  1393. </code>
  1394. </td>
  1395. <td>
  1396. <div>
  1397. <p><code><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></code> that provides an interface to actions not performed by the <code>Request</code>.</p>
  1398. </div>
  1399. </td>
  1400. </tr>
  1401. </tbody>
  1402. </table>
  1403. </div>
  1404. </section>
  1405. </div>
  1406. </li>
  1407. </ul>
  1408. </div>
  1409. <div class="task-group">
  1410. <div class="task-name-container">
  1411. <a name="/State"></a>
  1412. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  1413. <a href="#/State">
  1414. <h3 class="section-name">State</h3>
  1415. </a>
  1416. </div>
  1417. <ul class="item-container">
  1418. <li class="item">
  1419. <div>
  1420. <code>
  1421. <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
  1422. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  1423. <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
  1424. </code>
  1425. </div>
  1426. <div class="height-container">
  1427. <div class="pointer-container"></div>
  1428. <section class="section">
  1429. <div class="pointer"></div>
  1430. <div class="abstract">
  1431. <p>Cancels the <code>Request</code>. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
  1432. </div>
  1433. <div class="declaration">
  1434. <h4>Declaration</h4>
  1435. <div class="language">
  1436. <p class="aside-title">Swift</p>
  1437. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1438. <span class="kd">public</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>
  1439. </div>
  1440. </div>
  1441. <div>
  1442. <h4>Return Value</h4>
  1443. <p>The <code>Request</code>.</p>
  1444. </div>
  1445. </section>
  1446. </div>
  1447. </li>
  1448. <li class="item">
  1449. <div>
  1450. <code>
  1451. <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
  1452. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  1453. <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
  1454. </code>
  1455. </div>
  1456. <div class="height-container">
  1457. <div class="pointer-container"></div>
  1458. <section class="section">
  1459. <div class="pointer"></div>
  1460. <div class="abstract">
  1461. <p>Suspends the <code>Request</code>.</p>
  1462. </div>
  1463. <div class="declaration">
  1464. <h4>Declaration</h4>
  1465. <div class="language">
  1466. <p class="aside-title">Swift</p>
  1467. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1468. <span class="kd">public</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>
  1469. </div>
  1470. </div>
  1471. <div>
  1472. <h4>Return Value</h4>
  1473. <p>The <code>Request</code>.</p>
  1474. </div>
  1475. </section>
  1476. </div>
  1477. </li>
  1478. <li class="item">
  1479. <div>
  1480. <code>
  1481. <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
  1482. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  1483. <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
  1484. </code>
  1485. </div>
  1486. <div class="height-container">
  1487. <div class="pointer-container"></div>
  1488. <section class="section">
  1489. <div class="pointer"></div>
  1490. <div class="abstract">
  1491. <p>Resumes the <code>Request</code>.</p>
  1492. </div>
  1493. <div class="declaration">
  1494. <h4>Declaration</h4>
  1495. <div class="language">
  1496. <p class="aside-title">Swift</p>
  1497. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1498. <span class="kd">public</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>
  1499. </div>
  1500. </div>
  1501. <div>
  1502. <h4>Return Value</h4>
  1503. <p>The <code>Request</code>.</p>
  1504. </div>
  1505. </section>
  1506. </div>
  1507. </li>
  1508. </ul>
  1509. </div>
  1510. <div class="task-group">
  1511. <div class="task-name-container">
  1512. <a name="/Closure%20API"></a>
  1513. <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
  1514. <a href="#/Closure%20API">
  1515. <h3 class="section-name">Closure API</h3>
  1516. </a>
  1517. </div>
  1518. <ul class="item-container">
  1519. <li class="item">
  1520. <div>
  1521. <code>
  1522. <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
  1523. <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
  1524. <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:password:persistence:)</a>
  1525. </code>
  1526. </div>
  1527. <div class="height-container">
  1528. <div class="pointer-container"></div>
  1529. <section class="section">
  1530. <div class="pointer"></div>
  1531. <div class="abstract">
  1532. <p>Associates a credential using the provided values with the <code>Request</code>.</p>
  1533. </div>
  1534. <div class="declaration">
  1535. <h4>Declaration</h4>
  1536. <div class="language">
  1537. <p class="aside-title">Swift</p>
  1538. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1539. <span class="kd">public</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>
  1540. </div>
  1541. </div>
  1542. <div>
  1543. <h4>Parameters</h4>
  1544. <table class="graybox">
  1545. <tbody>
  1546. <tr>
  1547. <td>
  1548. <code>
  1549. <em>username</em>
  1550. </code>
  1551. </td>
  1552. <td>
  1553. <div>
  1554. <p>The username.</p>
  1555. </div>
  1556. </td>
  1557. </tr>
  1558. <tr>
  1559. <td>
  1560. <code>
  1561. <em>password</em>
  1562. </code>
  1563. </td>
  1564. <td>
  1565. <div>
  1566. <p>The password.</p>
  1567. </div>
  1568. </td>
  1569. </tr>
  1570. <tr>
  1571. <td>
  1572. <code>
  1573. <em>persistence</em>
  1574. </code>
  1575. </td>
  1576. <td>
  1577. <div>
  1578. <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>.</p>
  1579. </div>
  1580. </td>
  1581. </tr>
  1582. </tbody>
  1583. </table>
  1584. </div>
  1585. <div>
  1586. <h4>Return Value</h4>
  1587. <p>The <code>Request</code>.</p>
  1588. </div>
  1589. </section>
  1590. </div>
  1591. </li>
  1592. <li class="item">
  1593. <div>
  1594. <code>
  1595. <a name="/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
  1596. <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
  1597. <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:)</a>
  1598. </code>
  1599. </div>
  1600. <div class="height-container">
  1601. <div class="pointer-container"></div>
  1602. <section class="section">
  1603. <div class="pointer"></div>
  1604. <div class="abstract">
  1605. <p>Associates the provided credential with the <code>Request</code>.</p>
  1606. </div>
  1607. <div class="declaration">
  1608. <h4>Declaration</h4>
  1609. <div class="language">
  1610. <p class="aside-title">Swift</p>
  1611. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1612. <span class="kd">public</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>
  1613. </div>
  1614. </div>
  1615. <div>
  1616. <h4>Parameters</h4>
  1617. <table class="graybox">
  1618. <tbody>
  1619. <tr>
  1620. <td>
  1621. <code>
  1622. <em>credential</em>
  1623. </code>
  1624. </td>
  1625. <td>
  1626. <div>
  1627. <p>The <code>URLCredential</code>.</p>
  1628. </div>
  1629. </td>
  1630. </tr>
  1631. </tbody>
  1632. </table>
  1633. </div>
  1634. <div>
  1635. <h4>Return Value</h4>
  1636. <p>The <code>Request</code>.</p>
  1637. </div>
  1638. </section>
  1639. </div>
  1640. </li>
  1641. <li class="item">
  1642. <div>
  1643. <code>
  1644. <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1645. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  1646. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:closure:)</a>
  1647. </code>
  1648. </div>
  1649. <div class="height-container">
  1650. <div class="pointer-container"></div>
  1651. <section class="section">
  1652. <div class="pointer"></div>
  1653. <div class="abstract">
  1654. <p>Sets a closure to be called periodically during the lifecycle of the <code>Request</code> as data is read from the server.</p>
  1655. <p>Only the last closure provided is used.</p>
  1656. </div>
  1657. <div class="declaration">
  1658. <h4>Declaration</h4>
  1659. <div class="language">
  1660. <p class="aside-title">Swift</p>
  1661. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1662. <span class="kd">public</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>
  1663. </div>
  1664. </div>
  1665. <div>
  1666. <h4>Parameters</h4>
  1667. <table class="graybox">
  1668. <tbody>
  1669. <tr>
  1670. <td>
  1671. <code>
  1672. <em>queue</em>
  1673. </code>
  1674. </td>
  1675. <td>
  1676. <div>
  1677. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1678. </div>
  1679. </td>
  1680. </tr>
  1681. <tr>
  1682. <td>
  1683. <code>
  1684. <em>closure</em>
  1685. </code>
  1686. </td>
  1687. <td>
  1688. <div>
  1689. <p>The code to be executed periodically as data is read from the server.</p>
  1690. </div>
  1691. </td>
  1692. </tr>
  1693. </tbody>
  1694. </table>
  1695. </div>
  1696. <div>
  1697. <h4>Return Value</h4>
  1698. <p>The <code>Request</code>.</p>
  1699. </div>
  1700. </section>
  1701. </div>
  1702. </li>
  1703. <li class="item">
  1704. <div>
  1705. <code>
  1706. <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1707. <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
  1708. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:closure:)</a>
  1709. </code>
  1710. </div>
  1711. <div class="height-container">
  1712. <div class="pointer-container"></div>
  1713. <section class="section">
  1714. <div class="pointer"></div>
  1715. <div class="abstract">
  1716. <p>Sets a closure to be called periodically during the lifecycle of the <code>Request</code> as data is sent to the server.</p>
  1717. <p>Only the last closure provided is used.</p>
  1718. </div>
  1719. <div class="declaration">
  1720. <h4>Declaration</h4>
  1721. <div class="language">
  1722. <p class="aside-title">Swift</p>
  1723. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1724. <span class="kd">public</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>
  1725. </div>
  1726. </div>
  1727. <div>
  1728. <h4>Parameters</h4>
  1729. <table class="graybox">
  1730. <tbody>
  1731. <tr>
  1732. <td>
  1733. <code>
  1734. <em>queue</em>
  1735. </code>
  1736. </td>
  1737. <td>
  1738. <div>
  1739. <p>The <code>DispatchQueue</code> to execute the closure on. Defaults to <code>.main</code>.</p>
  1740. </div>
  1741. </td>
  1742. </tr>
  1743. <tr>
  1744. <td>
  1745. <code>
  1746. <em>closure</em>
  1747. </code>
  1748. </td>
  1749. <td>
  1750. <div>
  1751. <p>The closure to be executed periodically as data is sent to the server.</p>
  1752. </div>
  1753. </td>
  1754. </tr>
  1755. </tbody>
  1756. </table>
  1757. </div>
  1758. <div>
  1759. <h4>Return Value</h4>
  1760. <p>The <code>Request</code>.</p>
  1761. </div>
  1762. </section>
  1763. </div>
  1764. </li>
  1765. </ul>
  1766. </div>
  1767. <div class="task-group">
  1768. <div class="task-name-container">
  1769. <a name="/Redirects"></a>
  1770. <a name="//apple_ref/swift/Section/Redirects" class="dashAnchor"></a>
  1771. <a href="#/Redirects">
  1772. <h3 class="section-name">Redirects</h3>
  1773. </a>
  1774. </div>
  1775. <ul class="item-container">
  1776. <li class="item">
  1777. <div>
  1778. <code>
  1779. <a name="/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF"></a>
  1780. <a name="//apple_ref/swift/Method/redirect(using:)" class="dashAnchor"></a>
  1781. <a class="token" href="#/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF">redirect(using:)</a>
  1782. </code>
  1783. </div>
  1784. <div class="height-container">
  1785. <div class="pointer-container"></div>
  1786. <section class="section">
  1787. <div class="pointer"></div>
  1788. <div class="abstract">
  1789. <p>Sets the redirect handler for the <code>Request</code> which will be used if a redirect response is encountered.</p>
  1790. </div>
  1791. <div class="declaration">
  1792. <h4>Declaration</h4>
  1793. <div class="language">
  1794. <p class="aside-title">Swift</p>
  1795. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1796. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">redirect</span><span class="p">(</span><span class="n">using</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1797. </div>
  1798. </div>
  1799. <div>
  1800. <h4>Parameters</h4>
  1801. <table class="graybox">
  1802. <tbody>
  1803. <tr>
  1804. <td>
  1805. <code>
  1806. <em>handler</em>
  1807. </code>
  1808. </td>
  1809. <td>
  1810. <div>
  1811. <p>The <code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code>.</p>
  1812. </div>
  1813. </td>
  1814. </tr>
  1815. </tbody>
  1816. </table>
  1817. </div>
  1818. <div>
  1819. <h4>Return Value</h4>
  1820. <p>The <code>Request</code>.</p>
  1821. </div>
  1822. </section>
  1823. </div>
  1824. </li>
  1825. </ul>
  1826. </div>
  1827. <div class="task-group">
  1828. <div class="task-name-container">
  1829. <a name="/Cached%20Responses"></a>
  1830. <a name="//apple_ref/swift/Section/Cached Responses" class="dashAnchor"></a>
  1831. <a href="#/Cached%20Responses">
  1832. <h3 class="section-name">Cached Responses</h3>
  1833. </a>
  1834. </div>
  1835. <ul class="item-container">
  1836. <li class="item">
  1837. <div>
  1838. <code>
  1839. <a name="/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF"></a>
  1840. <a name="//apple_ref/swift/Method/cacheResponse(using:)" class="dashAnchor"></a>
  1841. <a class="token" href="#/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF">cacheResponse(using:)</a>
  1842. </code>
  1843. </div>
  1844. <div class="height-container">
  1845. <div class="pointer-container"></div>
  1846. <section class="section">
  1847. <div class="pointer"></div>
  1848. <div class="abstract">
  1849. <p>Sets the cached response handler for the <code>Request</code> which will be used when attempting to cache a response.</p>
  1850. </div>
  1851. <div class="declaration">
  1852. <h4>Declaration</h4>
  1853. <div class="language">
  1854. <p class="aside-title">Swift</p>
  1855. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1856. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cacheResponse</span><span class="p">(</span><span class="n">using</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  1857. </div>
  1858. </div>
  1859. <div>
  1860. <h4>Parameters</h4>
  1861. <table class="graybox">
  1862. <tbody>
  1863. <tr>
  1864. <td>
  1865. <code>
  1866. <em>handler</em>
  1867. </code>
  1868. </td>
  1869. <td>
  1870. <div>
  1871. <p>The <code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code>.</p>
  1872. </div>
  1873. </td>
  1874. </tr>
  1875. </tbody>
  1876. </table>
  1877. </div>
  1878. <div>
  1879. <h4>Return Value</h4>
  1880. <p>The <code>Request</code>.</p>
  1881. </div>
  1882. </section>
  1883. </div>
  1884. </li>
  1885. </ul>
  1886. </div>
  1887. <div class="task-group">
  1888. <div class="task-name-container">
  1889. <a name="/Cleanup"></a>
  1890. <a name="//apple_ref/swift/Section/Cleanup" class="dashAnchor"></a>
  1891. <a href="#/Cleanup">
  1892. <h3 class="section-name">Cleanup</h3>
  1893. </a>
  1894. </div>
  1895. <ul class="item-container">
  1896. <li class="item">
  1897. <div>
  1898. <code>
  1899. <a name="/s:9Alamofire7RequestC7cleanupyyF"></a>
  1900. <a name="//apple_ref/swift/Method/cleanup()" class="dashAnchor"></a>
  1901. <a class="token" href="#/s:9Alamofire7RequestC7cleanupyyF">cleanup()</a>
  1902. </code>
  1903. </div>
  1904. <div class="height-container">
  1905. <div class="pointer-container"></div>
  1906. <section class="section">
  1907. <div class="pointer"></div>
  1908. <div class="abstract">
  1909. <p>Final cleanup step executed when a <code>Request</code> finishes response serialization.</p>
  1910. </div>
  1911. <div class="declaration">
  1912. <h4>Declaration</h4>
  1913. <div class="language">
  1914. <p class="aside-title">Swift</p>
  1915. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">cleanup</span><span class="p">()</span></code></pre>
  1916. </div>
  1917. </div>
  1918. </section>
  1919. </div>
  1920. </li>
  1921. </ul>
  1922. </div>
  1923. <div class="task-group">
  1924. <ul class="item-container">
  1925. <li class="item">
  1926. <div>
  1927. <code>
  1928. <a name="/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ"></a>
  1929. <a name="//apple_ref/swift/Variable/didResumeNotification" class="dashAnchor"></a>
  1930. <a class="token" href="#/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ">didResumeNotification</a>
  1931. </code>
  1932. </div>
  1933. <div class="height-container">
  1934. <div class="pointer-container"></div>
  1935. <section class="section">
  1936. <div class="pointer"></div>
  1937. <div class="abstract">
  1938. <p>Posted when a <code>Request</code> is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
  1939. </div>
  1940. <div class="declaration">
  1941. <h4>Declaration</h4>
  1942. <div class="language">
  1943. <p class="aside-title">Swift</p>
  1944. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didResumeNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1945. </div>
  1946. </div>
  1947. </section>
  1948. </div>
  1949. </li>
  1950. <li class="item">
  1951. <div>
  1952. <code>
  1953. <a name="/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ"></a>
  1954. <a name="//apple_ref/swift/Variable/didSuspendNotification" class="dashAnchor"></a>
  1955. <a class="token" href="#/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ">didSuspendNotification</a>
  1956. </code>
  1957. </div>
  1958. <div class="height-container">
  1959. <div class="pointer-container"></div>
  1960. <section class="section">
  1961. <div class="pointer"></div>
  1962. <div class="abstract">
  1963. <p>Posted when a <code>Request</code> is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
  1964. </div>
  1965. <div class="declaration">
  1966. <h4>Declaration</h4>
  1967. <div class="language">
  1968. <p class="aside-title">Swift</p>
  1969. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didSuspendNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1970. </div>
  1971. </div>
  1972. </section>
  1973. </div>
  1974. </li>
  1975. <li class="item">
  1976. <div>
  1977. <code>
  1978. <a name="/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ"></a>
  1979. <a name="//apple_ref/swift/Variable/didCancelNotification" class="dashAnchor"></a>
  1980. <a class="token" href="#/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ">didCancelNotification</a>
  1981. </code>
  1982. </div>
  1983. <div class="height-container">
  1984. <div class="pointer-container"></div>
  1985. <section class="section">
  1986. <div class="pointer"></div>
  1987. <div class="abstract">
  1988. <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
  1989. </div>
  1990. <div class="declaration">
  1991. <h4>Declaration</h4>
  1992. <div class="language">
  1993. <p class="aside-title">Swift</p>
  1994. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCancelNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  1995. </div>
  1996. </div>
  1997. </section>
  1998. </div>
  1999. </li>
  2000. <li class="item">
  2001. <div>
  2002. <code>
  2003. <a name="/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ"></a>
  2004. <a name="//apple_ref/swift/Variable/didFinishNotification" class="dashAnchor"></a>
  2005. <a class="token" href="#/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ">didFinishNotification</a>
  2006. </code>
  2007. </div>
  2008. <div class="height-container">
  2009. <div class="pointer-container"></div>
  2010. <section class="section">
  2011. <div class="pointer"></div>
  2012. <div class="abstract">
  2013. <p>Posted when a <code>Request</code> is finished. The <code>Notification</code> contains the completed <code>Request</code>.</p>
  2014. </div>
  2015. <div class="declaration">
  2016. <h4>Declaration</h4>
  2017. <div class="language">
  2018. <p class="aside-title">Swift</p>
  2019. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didFinishNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2020. </div>
  2021. </div>
  2022. </section>
  2023. </div>
  2024. </li>
  2025. <li class="item">
  2026. <div>
  2027. <code>
  2028. <a name="/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ"></a>
  2029. <a name="//apple_ref/swift/Variable/didResumeTaskNotification" class="dashAnchor"></a>
  2030. <a class="token" href="#/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ">didResumeTaskNotification</a>
  2031. </code>
  2032. </div>
  2033. <div class="height-container">
  2034. <div class="pointer-container"></div>
  2035. <section class="section">
  2036. <div class="pointer"></div>
  2037. <div class="abstract">
  2038. <p>Posted when a <code>URLSessionTask</code> is resumed. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2039. </div>
  2040. <div class="declaration">
  2041. <h4>Declaration</h4>
  2042. <div class="language">
  2043. <p class="aside-title">Swift</p>
  2044. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didResumeTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2045. </div>
  2046. </div>
  2047. </section>
  2048. </div>
  2049. </li>
  2050. <li class="item">
  2051. <div>
  2052. <code>
  2053. <a name="/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ"></a>
  2054. <a name="//apple_ref/swift/Variable/didSuspendTaskNotification" class="dashAnchor"></a>
  2055. <a class="token" href="#/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ">didSuspendTaskNotification</a>
  2056. </code>
  2057. </div>
  2058. <div class="height-container">
  2059. <div class="pointer-container"></div>
  2060. <section class="section">
  2061. <div class="pointer"></div>
  2062. <div class="abstract">
  2063. <p>Posted when a <code>URLSessionTask</code> is suspended. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2064. </div>
  2065. <div class="declaration">
  2066. <h4>Declaration</h4>
  2067. <div class="language">
  2068. <p class="aside-title">Swift</p>
  2069. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didSuspendTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2070. </div>
  2071. </div>
  2072. </section>
  2073. </div>
  2074. </li>
  2075. <li class="item">
  2076. <div>
  2077. <code>
  2078. <a name="/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ"></a>
  2079. <a name="//apple_ref/swift/Variable/didCancelTaskNotification" class="dashAnchor"></a>
  2080. <a class="token" href="#/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ">didCancelTaskNotification</a>
  2081. </code>
  2082. </div>
  2083. <div class="height-container">
  2084. <div class="pointer-container"></div>
  2085. <section class="section">
  2086. <div class="pointer"></div>
  2087. <div class="abstract">
  2088. <p>Posted when a <code>URLSessionTask</code> is cancelled. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2089. </div>
  2090. <div class="declaration">
  2091. <h4>Declaration</h4>
  2092. <div class="language">
  2093. <p class="aside-title">Swift</p>
  2094. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCancelTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2095. </div>
  2096. </div>
  2097. </section>
  2098. </div>
  2099. </li>
  2100. <li class="item">
  2101. <div>
  2102. <code>
  2103. <a name="/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ"></a>
  2104. <a name="//apple_ref/swift/Variable/didCompleteTaskNotification" class="dashAnchor"></a>
  2105. <a class="token" href="#/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ">didCompleteTaskNotification</a>
  2106. </code>
  2107. </div>
  2108. <div class="height-container">
  2109. <div class="pointer-container"></div>
  2110. <section class="section">
  2111. <div class="pointer"></div>
  2112. <div class="abstract">
  2113. <p>Posted when a <code>URLSessionTask</code> is completed. The <code>Notification</code> contains the <code>Request</code> associated with the <code>URLSessionTask</code>.</p>
  2114. </div>
  2115. <div class="declaration">
  2116. <h4>Declaration</h4>
  2117. <div class="language">
  2118. <p class="aside-title">Swift</p>
  2119. <pre class="highlight swift"><code><span class="kd">static</span> <span class="k">let</span> <span class="nv">didCompleteTaskNotification</span><span class="p">:</span> <span class="kt">Notification</span><span class="o">.</span><span class="kt">Name</span></code></pre>
  2120. </div>
  2121. </div>
  2122. </section>
  2123. </div>
  2124. </li>
  2125. </ul>
  2126. </div>
  2127. <div class="task-group">
  2128. <div class="task-name-container">
  2129. <a name="/Protocol%20Conformances"></a>
  2130. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2131. <a href="#/Protocol%20Conformances">
  2132. <h3 class="section-name">Protocol Conformances</h3>
  2133. </a>
  2134. </div>
  2135. <ul class="item-container">
  2136. <li class="item">
  2137. <div>
  2138. <code>
  2139. <a name="/s:SQ2eeoiySbx_xtFZ"></a>
  2140. <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
  2141. <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:_:)</a>
  2142. </code>
  2143. </div>
  2144. <div class="height-container">
  2145. <div class="pointer-container"></div>
  2146. <section class="section">
  2147. <div class="pointer"></div>
  2148. <div class="abstract">
  2149. </div>
  2150. <div class="declaration">
  2151. <h4>Declaration</h4>
  2152. <div class="language">
  2153. <p class="aside-title">Swift</p>
  2154. <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>
  2155. </div>
  2156. </div>
  2157. </section>
  2158. </div>
  2159. </li>
  2160. </ul>
  2161. </div>
  2162. <div class="task-group">
  2163. <div class="task-name-container">
  2164. <a name="/Protocol%20Conformances2"></a>
  2165. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2166. <a href="#/Protocol%20Conformances2">
  2167. <h3 class="section-name">Protocol Conformances</h3>
  2168. </a>
  2169. </div>
  2170. <ul class="item-container">
  2171. <li class="item">
  2172. <div>
  2173. <code>
  2174. <a name="/s:SH4hash4intoys6HasherVz_tF"></a>
  2175. <a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
  2176. <a class="token" href="#/s:SH4hash4intoys6HasherVz_tF">hash(into:)</a>
  2177. </code>
  2178. </div>
  2179. <div class="height-container">
  2180. <div class="pointer-container"></div>
  2181. <section class="section">
  2182. <div class="pointer"></div>
  2183. <div class="abstract">
  2184. </div>
  2185. <div class="declaration">
  2186. <h4>Declaration</h4>
  2187. <div class="language">
  2188. <p class="aside-title">Swift</p>
  2189. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hash</span><span class="p">(</span><span class="n">into</span> <span class="nv">hasher</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">Hasher</span><span class="p">)</span></code></pre>
  2190. </div>
  2191. </div>
  2192. </section>
  2193. </div>
  2194. </li>
  2195. </ul>
  2196. </div>
  2197. <div class="task-group">
  2198. <div class="task-name-container">
  2199. <a name="/Protocol%20Conformances3"></a>
  2200. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2201. <a href="#/Protocol%20Conformances3">
  2202. <h3 class="section-name">Protocol Conformances</h3>
  2203. </a>
  2204. </div>
  2205. <ul class="item-container">
  2206. <li class="item">
  2207. <div>
  2208. <code>
  2209. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  2210. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  2211. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  2212. </code>
  2213. </div>
  2214. <div class="height-container">
  2215. <div class="pointer-container"></div>
  2216. <section class="section">
  2217. <div class="pointer"></div>
  2218. <div class="abstract">
  2219. <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
  2220. created, as well as the response status code, if a response has been received.</p>
  2221. </div>
  2222. <div class="declaration">
  2223. <h4>Declaration</h4>
  2224. <div class="language">
  2225. <p class="aside-title">Swift</p>
  2226. <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>
  2227. </div>
  2228. </div>
  2229. </section>
  2230. </div>
  2231. </li>
  2232. </ul>
  2233. </div>
  2234. <div class="task-group">
  2235. <div class="task-name-container">
  2236. <a name="/Protocol%20Conformances4"></a>
  2237. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2238. <a href="#/Protocol%20Conformances4">
  2239. <h3 class="section-name">Protocol Conformances</h3>
  2240. </a>
  2241. </div>
  2242. <ul class="item-container">
  2243. <li class="item">
  2244. <div>
  2245. <code>
  2246. <a name="/s:9Alamofire7RequestC16debugDescriptionSSvp"></a>
  2247. <a name="//apple_ref/swift/Property/debugDescription" class="dashAnchor"></a>
  2248. <a class="token" href="#/s:9Alamofire7RequestC16debugDescriptionSSvp">debugDescription</a>
  2249. </code>
  2250. </div>
  2251. <div class="height-container">
  2252. <div class="pointer-container"></div>
  2253. <section class="section">
  2254. <div class="pointer"></div>
  2255. <div class="abstract">
  2256. <p>A textual representation of this instance in the form of a cURL command.</p>
  2257. </div>
  2258. <div class="declaration">
  2259. <h4>Declaration</h4>
  2260. <div class="language">
  2261. <p class="aside-title">Swift</p>
  2262. <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>
  2263. </div>
  2264. </div>
  2265. </section>
  2266. </div>
  2267. </li>
  2268. </ul>
  2269. </div>
  2270. <div class="task-group">
  2271. <div class="task-name-container">
  2272. <a name="/Helper%20Types"></a>
  2273. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  2274. <a href="#/Helper%20Types">
  2275. <h3 class="section-name">Helper Types</h3>
  2276. </a>
  2277. </div>
  2278. <ul class="item-container">
  2279. <li class="item">
  2280. <div>
  2281. <code>
  2282. <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
  2283. <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
  2284. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
  2285. </code>
  2286. </div>
  2287. <div class="height-container">
  2288. <div class="pointer-container"></div>
  2289. <section class="section">
  2290. <div class="pointer"></div>
  2291. <div class="abstract">
  2292. <p>Used to represent whether a validation succeeded or failed.</p>
  2293. </div>
  2294. <div class="declaration">
  2295. <h4>Declaration</h4>
  2296. <div class="language">
  2297. <p class="aside-title">Swift</p>
  2298. <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="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a></span><span class="o">&lt;</span><span class="kt">Void</span><span class="o">&gt;</span></code></pre>
  2299. </div>
  2300. </div>
  2301. </section>
  2302. </div>
  2303. </li>
  2304. </ul>
  2305. </div>
  2306. </div>
  2307. </section>
  2308. </article>
  2309. </div>
  2310. <section class="footer">
  2311. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-12)</p>
  2312. <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>
  2313. </section>
  2314. </body>
  2315. </div>
  2316. </html>