Request.html 170 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157
  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 5.8.0 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  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" alt="GitHub"/>
  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.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  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" alt=""/>
  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/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  208. </li>
  209. <li class="nav-group-task">
  210. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  211. </li>
  212. <li class="nav-group-task">
  213. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  214. </li>
  215. </ul>
  216. </li>
  217. <li class="nav-group-name">
  218. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  219. <ul class="nav-group-tasks">
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  222. </li>
  223. </ul>
  224. </li>
  225. <li class="nav-group-name">
  226. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  227. <ul class="nav-group-tasks">
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  260. </li>
  261. </ul>
  262. </li>
  263. <li class="nav-group-name">
  264. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  265. <ul class="nav-group-tasks">
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  319. </li>
  320. </ul>
  321. </li>
  322. <li class="nav-group-name">
  323. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  324. <ul class="nav-group-tasks">
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  387. </li>
  388. <li class="nav-group-task">
  389. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  390. </li>
  391. <li class="nav-group-task">
  392. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  393. </li>
  394. <li class="nav-group-task">
  395. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  396. </li>
  397. </ul>
  398. </li>
  399. <li class="nav-group-name">
  400. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  401. <ul class="nav-group-tasks">
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  488. </li>
  489. <li class="nav-group-task">
  490. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  491. </li>
  492. <li class="nav-group-task">
  493. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  494. </li>
  495. <li class="nav-group-task">
  496. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  497. </li>
  498. <li class="nav-group-task">
  499. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  500. </li>
  501. <li class="nav-group-task">
  502. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  503. </li>
  504. <li class="nav-group-task">
  505. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  506. </li>
  507. </ul>
  508. </li>
  509. <li class="nav-group-name">
  510. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  511. <ul class="nav-group-tasks">
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  514. </li>
  515. <li class="nav-group-task">
  516. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  517. </li>
  518. <li class="nav-group-task">
  519. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  520. </li>
  521. <li class="nav-group-task">
  522. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  523. </li>
  524. <li class="nav-group-task">
  525. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  526. </li>
  527. <li class="nav-group-task">
  528. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  529. </li>
  530. <li class="nav-group-task">
  531. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  532. </li>
  533. </ul>
  534. </li>
  535. </ul>
  536. </nav>
  537. <article class="main-content">
  538. <section class="section">
  539. <div class="section-content top-matter">
  540. <h1>Request</h1>
  541. <div class="declaration">
  542. <div class="language">
  543. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Request</span></code></pre>
  544. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Request</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
  545. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Request</span><span class="p">:</span> <span class="kt">Hashable</span></code></pre>
  546. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Request</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
  547. </div>
  548. </div>
  549. <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
  550. handling.</p>
  551. </div>
  552. </section>
  553. <section class="section">
  554. <div class="section-content">
  555. <div class="task-group">
  556. <ul class="item-container">
  557. <li class="item">
  558. <div>
  559. <code>
  560. <a name="/s:9Alamofire7RequestC5StateO"></a>
  561. <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
  562. <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
  563. </code>
  564. </div>
  565. <div class="height-container">
  566. <div class="pointer-container"></div>
  567. <section class="section">
  568. <div class="pointer"></div>
  569. <div class="abstract">
  570. <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
  571. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
  572. <a href="../Classes/Request/State.html" class="slightly-smaller">See more</a>
  573. </div>
  574. <div class="declaration">
  575. <h4>Declaration</h4>
  576. <div class="language">
  577. <p class="aside-title">Swift</p>
  578. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span></code></pre>
  579. </div>
  580. </div>
  581. </section>
  582. </div>
  583. </li>
  584. </ul>
  585. </div>
  586. <div class="task-group">
  587. <div class="task-name-container">
  588. <a name="/Initial%20State"></a>
  589. <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
  590. <div class="section-name-container">
  591. <a class="section-name-link" href="#/Initial%20State"></a>
  592. <h3 class="section-name"><span>Initial State</span>
  593. </h3>
  594. </div>
  595. </div>
  596. <ul class="item-container">
  597. <li class="item">
  598. <div>
  599. <code>
  600. <a name="/s:9Alamofire7RequestC2id10Foundation4UUIDVvp"></a>
  601. <a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
  602. <a class="token" href="#/s:9Alamofire7RequestC2id10Foundation4UUIDVvp">id</a>
  603. </code>
  604. </div>
  605. <div class="height-container">
  606. <div class="pointer-container"></div>
  607. <section class="section">
  608. <div class="pointer"></div>
  609. <div class="abstract">
  610. <p><code>UUID</code> providing a unique identifier for the <code>Request</code>, used in the <code>Hashable</code> and <code>Equatable</code> conformances.</p>
  611. </div>
  612. <div class="declaration">
  613. <h4>Declaration</h4>
  614. <div class="language">
  615. <p class="aside-title">Swift</p>
  616. <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>
  617. </div>
  618. </div>
  619. </section>
  620. </div>
  621. </li>
  622. <li class="item">
  623. <div>
  624. <code>
  625. <a name="/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp"></a>
  626. <a name="//apple_ref/swift/Property/underlyingQueue" class="dashAnchor"></a>
  627. <a class="token" href="#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a>
  628. </code>
  629. </div>
  630. <div class="height-container">
  631. <div class="pointer-container"></div>
  632. <section class="section">
  633. <div class="pointer"></div>
  634. <div class="abstract">
  635. <p>The serial queue for all internal async actions.</p>
  636. </div>
  637. <div class="declaration">
  638. <h4>Declaration</h4>
  639. <div class="language">
  640. <p class="aside-title">Swift</p>
  641. <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>
  642. </div>
  643. </div>
  644. </section>
  645. </div>
  646. </li>
  647. <li class="item">
  648. <div>
  649. <code>
  650. <a name="/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp"></a>
  651. <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
  652. <a class="token" href="#/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
  653. </code>
  654. </div>
  655. <div class="height-container">
  656. <div class="pointer-container"></div>
  657. <section class="section">
  658. <div class="pointer"></div>
  659. <div class="abstract">
  660. <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>
  661. </div>
  662. <div class="declaration">
  663. <h4>Declaration</h4>
  664. <div class="language">
  665. <p class="aside-title">Swift</p>
  666. <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>
  667. </div>
  668. </div>
  669. </section>
  670. </div>
  671. </li>
  672. <li class="item">
  673. <div>
  674. <code>
  675. <a name="/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp"></a>
  676. <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
  677. <a class="token" href="#/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp">eventMonitor</a>
  678. </code>
  679. </div>
  680. <div class="height-container">
  681. <div class="pointer-container"></div>
  682. <section class="section">
  683. <div class="pointer"></div>
  684. <div class="abstract">
  685. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks.</p>
  686. </div>
  687. <div class="declaration">
  688. <h4>Declaration</h4>
  689. <div class="language">
  690. <p class="aside-title">Swift</p>
  691. <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>
  692. </div>
  693. </div>
  694. </section>
  695. </div>
  696. </li>
  697. <li class="item">
  698. <div>
  699. <code>
  700. <a name="/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp"></a>
  701. <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
  702. <a class="token" href="#/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp">interceptor</a>
  703. </code>
  704. </div>
  705. <div class="height-container">
  706. <div class="pointer-container"></div>
  707. <section class="section">
  708. <div class="pointer"></div>
  709. <div class="abstract">
  710. <p>The <code>Request</code>&lsquo;s interceptor.</p>
  711. </div>
  712. <div class="declaration">
  713. <h4>Declaration</h4>
  714. <div class="language">
  715. <p class="aside-title">Swift</p>
  716. <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>
  717. </div>
  718. </div>
  719. </section>
  720. </div>
  721. </li>
  722. <li class="item">
  723. <div>
  724. <code>
  725. <a name="/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp"></a>
  726. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  727. <a class="token" href="#/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp">delegate</a>
  728. </code>
  729. </div>
  730. <div class="height-container">
  731. <div class="pointer-container"></div>
  732. <section class="section">
  733. <div class="pointer"></div>
  734. <div class="abstract">
  735. <p>The <code>Request</code>&lsquo;s delegate.</p>
  736. </div>
  737. <div class="declaration">
  738. <h4>Declaration</h4>
  739. <div class="language">
  740. <p class="aside-title">Swift</p>
  741. <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> <span class="k">get</span> <span class="p">}</span></code></pre>
  742. </div>
  743. </div>
  744. </section>
  745. </div>
  746. </li>
  747. </ul>
  748. </div>
  749. <div class="task-group">
  750. <div class="task-name-container">
  751. <a name="/Mutable%20State"></a>
  752. <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
  753. <div class="section-name-container">
  754. <a class="section-name-link" href="#/Mutable%20State"></a>
  755. <h3 class="section-name"><span>Mutable State</span>
  756. </h3>
  757. </div>
  758. </div>
  759. <ul class="item-container">
  760. <li class="item">
  761. <div>
  762. <code>
  763. <a name="/s:9Alamofire7RequestC5stateAC5StateOvp"></a>
  764. <a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
  765. <a class="token" href="#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a>
  766. </code>
  767. </div>
  768. <div class="height-container">
  769. <div class="pointer-container"></div>
  770. <section class="section">
  771. <div class="pointer"></div>
  772. <div class="abstract">
  773. <p><code><a href="../Classes/Request/State.html">State</a></code> of the <code>Request</code>.</p>
  774. </div>
  775. <div class="declaration">
  776. <h4>Declaration</h4>
  777. <div class="language">
  778. <p class="aside-title">Swift</p>
  779. <pre class="highlight swift"><code><span class="kd">public</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="p">}</span></code></pre>
  780. </div>
  781. </div>
  782. </section>
  783. </div>
  784. </li>
  785. <li class="item">
  786. <div>
  787. <code>
  788. <a name="/s:9Alamofire7RequestC13isInitializedSbvp"></a>
  789. <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
  790. <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</a>
  791. </code>
  792. </div>
  793. <div class="height-container">
  794. <div class="pointer-container"></div>
  795. <section class="section">
  796. <div class="pointer"></div>
  797. <div class="abstract">
  798. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.initialized</code>.</p>
  799. </div>
  800. <div class="declaration">
  801. <h4>Declaration</h4>
  802. <div class="language">
  803. <p class="aside-title">Swift</p>
  804. <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>
  805. </div>
  806. </div>
  807. </section>
  808. </div>
  809. </li>
  810. <li class="item">
  811. <div>
  812. <code>
  813. <a name="/s:9Alamofire7RequestC9isResumedSbvp"></a>
  814. <a name="//apple_ref/swift/Property/isResumed" class="dashAnchor"></a>
  815. <a class="token" href="#/s:9Alamofire7RequestC9isResumedSbvp">isResumed</a>
  816. </code>
  817. </div>
  818. <div class="height-container">
  819. <div class="pointer-container"></div>
  820. <section class="section">
  821. <div class="pointer"></div>
  822. <div class="abstract">
  823. <p>Returns whether <code>state is</code>.resumed`.</p>
  824. </div>
  825. <div class="declaration">
  826. <h4>Declaration</h4>
  827. <div class="language">
  828. <p class="aside-title">Swift</p>
  829. <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>
  830. </div>
  831. </div>
  832. </section>
  833. </div>
  834. </li>
  835. <li class="item">
  836. <div>
  837. <code>
  838. <a name="/s:9Alamofire7RequestC11isSuspendedSbvp"></a>
  839. <a name="//apple_ref/swift/Property/isSuspended" class="dashAnchor"></a>
  840. <a class="token" href="#/s:9Alamofire7RequestC11isSuspendedSbvp">isSuspended</a>
  841. </code>
  842. </div>
  843. <div class="height-container">
  844. <div class="pointer-container"></div>
  845. <section class="section">
  846. <div class="pointer"></div>
  847. <div class="abstract">
  848. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.suspended</code>.</p>
  849. </div>
  850. <div class="declaration">
  851. <h4>Declaration</h4>
  852. <div class="language">
  853. <p class="aside-title">Swift</p>
  854. <pre class="highlight swift"><code><span class="kd">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>
  855. </div>
  856. </div>
  857. </section>
  858. </div>
  859. </li>
  860. <li class="item">
  861. <div>
  862. <code>
  863. <a name="/s:9Alamofire7RequestC11isCancelledSbvp"></a>
  864. <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
  865. <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</a>
  866. </code>
  867. </div>
  868. <div class="height-container">
  869. <div class="pointer-container"></div>
  870. <section class="section">
  871. <div class="pointer"></div>
  872. <div class="abstract">
  873. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.cancelled</code>.</p>
  874. </div>
  875. <div class="declaration">
  876. <h4>Declaration</h4>
  877. <div class="language">
  878. <p class="aside-title">Swift</p>
  879. <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>
  880. </div>
  881. </div>
  882. </section>
  883. </div>
  884. </li>
  885. <li class="item">
  886. <div>
  887. <code>
  888. <a name="/s:9Alamofire7RequestC10isFinishedSbvp"></a>
  889. <a name="//apple_ref/swift/Property/isFinished" class="dashAnchor"></a>
  890. <a class="token" href="#/s:9Alamofire7RequestC10isFinishedSbvp">isFinished</a>
  891. </code>
  892. </div>
  893. <div class="height-container">
  894. <div class="pointer-container"></div>
  895. <section class="section">
  896. <div class="pointer"></div>
  897. <div class="abstract">
  898. <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.finished</code>.</p>
  899. </div>
  900. <div class="declaration">
  901. <h4>Declaration</h4>
  902. <div class="language">
  903. <p class="aside-title">Swift</p>
  904. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isFinished</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>
  905. </div>
  906. </div>
  907. </section>
  908. </div>
  909. </li>
  910. </ul>
  911. </div>
  912. <div class="task-group">
  913. <div class="task-name-container">
  914. <a name="/Progress"></a>
  915. <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
  916. <div class="section-name-container">
  917. <a class="section-name-link" href="#/Progress"></a>
  918. <h3 class="section-name"><span>Progress</span>
  919. </h3>
  920. </div>
  921. </div>
  922. <ul class="item-container">
  923. <li class="item">
  924. <div>
  925. <code>
  926. <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
  927. <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
  928. <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
  929. </code>
  930. </div>
  931. <div class="height-container">
  932. <div class="pointer-container"></div>
  933. <section class="section">
  934. <div class="pointer"></div>
  935. <div class="abstract">
  936. <p>Closure type executed when monitoring the upload or download progress of a request.</p>
  937. </div>
  938. <div class="declaration">
  939. <h4>Declaration</h4>
  940. <div class="language">
  941. <p class="aside-title">Swift</p>
  942. <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>
  943. </div>
  944. </div>
  945. </section>
  946. </div>
  947. </li>
  948. <li class="item">
  949. <div>
  950. <code>
  951. <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
  952. <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
  953. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
  954. </code>
  955. </div>
  956. <div class="height-container">
  957. <div class="pointer-container"></div>
  958. <section class="section">
  959. <div class="pointer"></div>
  960. <div class="abstract">
  961. <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>
  962. </div>
  963. <div class="declaration">
  964. <h4>Declaration</h4>
  965. <div class="language">
  966. <p class="aside-title">Swift</p>
  967. <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>
  968. </div>
  969. </div>
  970. </section>
  971. </div>
  972. </li>
  973. <li class="item">
  974. <div>
  975. <code>
  976. <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
  977. <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
  978. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
  979. </code>
  980. </div>
  981. <div class="height-container">
  982. <div class="pointer-container"></div>
  983. <section class="section">
  984. <div class="pointer"></div>
  985. <div class="abstract">
  986. <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
  987. </div>
  988. <div class="declaration">
  989. <h4>Declaration</h4>
  990. <div class="language">
  991. <p class="aside-title">Swift</p>
  992. <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>
  993. </div>
  994. </div>
  995. </section>
  996. </div>
  997. </li>
  998. </ul>
  999. </div>
  1000. <div class="task-group">
  1001. <div class="task-name-container">
  1002. <a name="/Redirect%20Handling"></a>
  1003. <a name="//apple_ref/swift/Section/Redirect Handling" class="dashAnchor"></a>
  1004. <div class="section-name-container">
  1005. <a class="section-name-link" href="#/Redirect%20Handling"></a>
  1006. <h3 class="section-name"><span>Redirect Handling</span>
  1007. </h3>
  1008. </div>
  1009. </div>
  1010. <ul class="item-container">
  1011. <li class="item">
  1012. <div>
  1013. <code>
  1014. <a name="/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp"></a>
  1015. <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
  1016. <a class="token" href="#/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
  1017. </code>
  1018. </div>
  1019. <div class="height-container">
  1020. <div class="pointer-container"></div>
  1021. <section class="section">
  1022. <div class="pointer"></div>
  1023. <div class="abstract">
  1024. <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> set on the instance.</p>
  1025. </div>
  1026. <div class="declaration">
  1027. <h4>Declaration</h4>
  1028. <div class="language">
  1029. <p class="aside-title">Swift</p>
  1030. <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>
  1031. </div>
  1032. </div>
  1033. </section>
  1034. </div>
  1035. </li>
  1036. </ul>
  1037. </div>
  1038. <div class="task-group">
  1039. <div class="task-name-container">
  1040. <a name="/Cached%20Response%20Handling"></a>
  1041. <a name="//apple_ref/swift/Section/Cached Response Handling" class="dashAnchor"></a>
  1042. <div class="section-name-container">
  1043. <a class="section-name-link" href="#/Cached%20Response%20Handling"></a>
  1044. <h3 class="section-name"><span>Cached Response Handling</span>
  1045. </h3>
  1046. </div>
  1047. </div>
  1048. <ul class="item-container">
  1049. <li class="item">
  1050. <div>
  1051. <code>
  1052. <a name="/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
  1053. <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
  1054. <a class="token" href="#/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
  1055. </code>
  1056. </div>
  1057. <div class="height-container">
  1058. <div class="pointer-container"></div>
  1059. <section class="section">
  1060. <div class="pointer"></div>
  1061. <div class="abstract">
  1062. <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> set on the instance.</p>
  1063. </div>
  1064. <div class="declaration">
  1065. <h4>Declaration</h4>
  1066. <div class="language">
  1067. <p class="aside-title">Swift</p>
  1068. <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>
  1069. </div>
  1070. </div>
  1071. </section>
  1072. </div>
  1073. </li>
  1074. </ul>
  1075. </div>
  1076. <div class="task-group">
  1077. <div class="task-name-container">
  1078. <a name="/URLCredential"></a>
  1079. <a name="//apple_ref/swift/Section/URLCredential" class="dashAnchor"></a>
  1080. <div class="section-name-container">
  1081. <a class="section-name-link" href="#/URLCredential"></a>
  1082. <h3 class="section-name"><span>URLCredential</span>
  1083. </h3>
  1084. </div>
  1085. </div>
  1086. <ul class="item-container">
  1087. <li class="item">
  1088. <div>
  1089. <code>
  1090. <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
  1091. <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
  1092. <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
  1093. </code>
  1094. </div>
  1095. <div class="height-container">
  1096. <div class="pointer-container"></div>
  1097. <section class="section">
  1098. <div class="pointer"></div>
  1099. <div class="abstract">
  1100. <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
  1101. </div>
  1102. <div class="declaration">
  1103. <h4>Declaration</h4>
  1104. <div class="language">
  1105. <p class="aside-title">Swift</p>
  1106. <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>
  1107. </div>
  1108. </div>
  1109. </section>
  1110. </div>
  1111. </li>
  1112. </ul>
  1113. </div>
  1114. <div class="task-group">
  1115. <div class="task-name-container">
  1116. <a name="/URLRequests"></a>
  1117. <a name="//apple_ref/swift/Section/URLRequests" class="dashAnchor"></a>
  1118. <div class="section-name-container">
  1119. <a class="section-name-link" href="#/URLRequests"></a>
  1120. <h3 class="section-name"><span>URLRequests</span>
  1121. </h3>
  1122. </div>
  1123. </div>
  1124. <ul class="item-container">
  1125. <li class="item">
  1126. <div>
  1127. <code>
  1128. <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
  1129. <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
  1130. <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a>
  1131. </code>
  1132. </div>
  1133. <div class="height-container">
  1134. <div class="pointer-container"></div>
  1135. <section class="section">
  1136. <div class="pointer"></div>
  1137. <div class="abstract">
  1138. <p>All <code>URLRequests</code> created on behalf of the <code>Request</code>, including original and adapted requests.</p>
  1139. </div>
  1140. <div class="declaration">
  1141. <h4>Declaration</h4>
  1142. <div class="language">
  1143. <p class="aside-title">Swift</p>
  1144. <pre class="highlight swift"><code><span class="kd">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>
  1145. </div>
  1146. </div>
  1147. </section>
  1148. </div>
  1149. </li>
  1150. <li class="item">
  1151. <div>
  1152. <code>
  1153. <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
  1154. <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
  1155. <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
  1156. </code>
  1157. </div>
  1158. <div class="height-container">
  1159. <div class="pointer-container"></div>
  1160. <section class="section">
  1161. <div class="pointer"></div>
  1162. <div class="abstract">
  1163. <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
  1164. </div>
  1165. <div class="declaration">
  1166. <h4>Declaration</h4>
  1167. <div class="language">
  1168. <p class="aside-title">Swift</p>
  1169. <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>
  1170. </div>
  1171. </div>
  1172. </section>
  1173. </div>
  1174. </li>
  1175. <li class="item">
  1176. <div>
  1177. <code>
  1178. <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
  1179. <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
  1180. <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
  1181. </code>
  1182. </div>
  1183. <div class="height-container">
  1184. <div class="pointer-container"></div>
  1185. <section class="section">
  1186. <div class="pointer"></div>
  1187. <div class="abstract">
  1188. <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  1189. </div>
  1190. <div class="declaration">
  1191. <h4>Declaration</h4>
  1192. <div class="language">
  1193. <p class="aside-title">Swift</p>
  1194. <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>
  1195. </div>
  1196. </div>
  1197. </section>
  1198. </div>
  1199. </li>
  1200. <li class="item">
  1201. <div>
  1202. <code>
  1203. <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
  1204. <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
  1205. <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
  1206. </code>
  1207. </div>
  1208. <div class="height-container">
  1209. <div class="pointer-container"></div>
  1210. <section class="section">
  1211. <div class="pointer"></div>
  1212. <div class="abstract">
  1213. <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
  1214. </div>
  1215. <div class="declaration">
  1216. <h4>Declaration</h4>
  1217. <div class="language">
  1218. <p class="aside-title">Swift</p>
  1219. <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>
  1220. </div>
  1221. </div>
  1222. </section>
  1223. </div>
  1224. </li>
  1225. <li class="item">
  1226. <div>
  1227. <code>
  1228. <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
  1229. <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
  1230. <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
  1231. </code>
  1232. </div>
  1233. <div class="height-container">
  1234. <div class="pointer-container"></div>
  1235. <section class="section">
  1236. <div class="pointer"></div>
  1237. <div class="abstract">
  1238. <p><code>URLRequest</code>s from all of the <code>URLSessionTask</code>s executed on behalf of the <code>Request</code>. May be different from
  1239. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a></code> due to <code>URLSession</code> manipulation.</p>
  1240. </div>
  1241. <div class="declaration">
  1242. <h4>Declaration</h4>
  1243. <div class="language">
  1244. <p class="aside-title">Swift</p>
  1245. <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>
  1246. </div>
  1247. </div>
  1248. </section>
  1249. </div>
  1250. </li>
  1251. </ul>
  1252. </div>
  1253. <div class="task-group">
  1254. <div class="task-name-container">
  1255. <a name="/HTTPURLResponse"></a>
  1256. <a name="//apple_ref/swift/Section/HTTPURLResponse" class="dashAnchor"></a>
  1257. <div class="section-name-container">
  1258. <a class="section-name-link" href="#/HTTPURLResponse"></a>
  1259. <h3 class="section-name"><span>HTTPURLResponse</span>
  1260. </h3>
  1261. </div>
  1262. </div>
  1263. <ul class="item-container">
  1264. <li class="item">
  1265. <div>
  1266. <code>
  1267. <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
  1268. <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
  1269. <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
  1270. </code>
  1271. </div>
  1272. <div class="height-container">
  1273. <div class="pointer-container"></div>
  1274. <section class="section">
  1275. <div class="pointer"></div>
  1276. <div class="abstract">
  1277. <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
  1278. last <code>URLSessionTask</code>.</p>
  1279. </div>
  1280. <div class="declaration">
  1281. <h4>Declaration</h4>
  1282. <div class="language">
  1283. <p class="aside-title">Swift</p>
  1284. <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>
  1285. </div>
  1286. </div>
  1287. </section>
  1288. </div>
  1289. </li>
  1290. </ul>
  1291. </div>
  1292. <div class="task-group">
  1293. <div class="task-name-container">
  1294. <a name="/Tasks"></a>
  1295. <a name="//apple_ref/swift/Section/Tasks" class="dashAnchor"></a>
  1296. <div class="section-name-container">
  1297. <a class="section-name-link" href="#/Tasks"></a>
  1298. <h3 class="section-name"><span>Tasks</span>
  1299. </h3>
  1300. </div>
  1301. </div>
  1302. <ul class="item-container">
  1303. <li class="item">
  1304. <div>
  1305. <code>
  1306. <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
  1307. <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
  1308. <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
  1309. </code>
  1310. </div>
  1311. <div class="height-container">
  1312. <div class="pointer-container"></div>
  1313. <section class="section">
  1314. <div class="pointer"></div>
  1315. <div class="abstract">
  1316. <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
  1317. </div>
  1318. <div class="declaration">
  1319. <h4>Declaration</h4>
  1320. <div class="language">
  1321. <p class="aside-title">Swift</p>
  1322. <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>
  1323. </div>
  1324. </div>
  1325. </section>
  1326. </div>
  1327. </li>
  1328. <li class="item">
  1329. <div>
  1330. <code>
  1331. <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
  1332. <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
  1333. <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
  1334. </code>
  1335. </div>
  1336. <div class="height-container">
  1337. <div class="pointer-container"></div>
  1338. <section class="section">
  1339. <div class="pointer"></div>
  1340. <div class="abstract">
  1341. <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1342. </div>
  1343. <div class="declaration">
  1344. <h4>Declaration</h4>
  1345. <div class="language">
  1346. <p class="aside-title">Swift</p>
  1347. <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>
  1348. </div>
  1349. </div>
  1350. </section>
  1351. </div>
  1352. </li>
  1353. <li class="item">
  1354. <div>
  1355. <code>
  1356. <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
  1357. <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
  1358. <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
  1359. </code>
  1360. </div>
  1361. <div class="height-container">
  1362. <div class="pointer-container"></div>
  1363. <section class="section">
  1364. <div class="pointer"></div>
  1365. <div class="abstract">
  1366. <p>Last <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1367. </div>
  1368. <div class="declaration">
  1369. <h4>Declaration</h4>
  1370. <div class="language">
  1371. <p class="aside-title">Swift</p>
  1372. <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>
  1373. </div>
  1374. </div>
  1375. </section>
  1376. </div>
  1377. </li>
  1378. <li class="item">
  1379. <div>
  1380. <code>
  1381. <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
  1382. <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
  1383. <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
  1384. </code>
  1385. </div>
  1386. <div class="height-container">
  1387. <div class="pointer-container"></div>
  1388. <section class="section">
  1389. <div class="pointer"></div>
  1390. <div class="abstract">
  1391. <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
  1392. </div>
  1393. <div class="declaration">
  1394. <h4>Declaration</h4>
  1395. <div class="language">
  1396. <p class="aside-title">Swift</p>
  1397. <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>
  1398. </div>
  1399. </div>
  1400. </section>
  1401. </div>
  1402. </li>
  1403. </ul>
  1404. </div>
  1405. <div class="task-group">
  1406. <div class="task-name-container">
  1407. <a name="/Metrics"></a>
  1408. <a name="//apple_ref/swift/Section/Metrics" class="dashAnchor"></a>
  1409. <div class="section-name-container">
  1410. <a class="section-name-link" href="#/Metrics"></a>
  1411. <h3 class="section-name"><span>Metrics</span>
  1412. </h3>
  1413. </div>
  1414. </div>
  1415. <ul class="item-container">
  1416. <li class="item">
  1417. <div>
  1418. <code>
  1419. <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
  1420. <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
  1421. <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
  1422. </code>
  1423. </div>
  1424. <div class="height-container">
  1425. <div class="pointer-container"></div>
  1426. <section class="section">
  1427. <div class="pointer"></div>
  1428. <div class="abstract">
  1429. <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>
  1430. </div>
  1431. <div class="declaration">
  1432. <h4>Declaration</h4>
  1433. <div class="language">
  1434. <p class="aside-title">Swift</p>
  1435. <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>
  1436. </div>
  1437. </div>
  1438. </section>
  1439. </div>
  1440. </li>
  1441. <li class="item">
  1442. <div>
  1443. <code>
  1444. <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1445. <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
  1446. <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
  1447. </code>
  1448. </div>
  1449. <div class="height-container">
  1450. <div class="pointer-container"></div>
  1451. <section class="section">
  1452. <div class="pointer"></div>
  1453. <div class="abstract">
  1454. <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1455. </div>
  1456. <div class="declaration">
  1457. <h4>Declaration</h4>
  1458. <div class="language">
  1459. <p class="aside-title">Swift</p>
  1460. <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>
  1461. </div>
  1462. </div>
  1463. </section>
  1464. </div>
  1465. </li>
  1466. <li class="item">
  1467. <div>
  1468. <code>
  1469. <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
  1470. <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
  1471. <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
  1472. </code>
  1473. </div>
  1474. <div class="height-container">
  1475. <div class="pointer-container"></div>
  1476. <section class="section">
  1477. <div class="pointer"></div>
  1478. <div class="abstract">
  1479. <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1480. </div>
  1481. <div class="declaration">
  1482. <h4>Declaration</h4>
  1483. <div class="language">
  1484. <p class="aside-title">Swift</p>
  1485. <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>
  1486. </div>
  1487. </div>
  1488. </section>
  1489. </div>
  1490. </li>
  1491. <li class="item">
  1492. <div>
  1493. <code>
  1494. <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
  1495. <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
  1496. <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
  1497. </code>
  1498. </div>
  1499. <div class="height-container">
  1500. <div class="pointer-container"></div>
  1501. <section class="section">
  1502. <div class="pointer"></div>
  1503. <div class="abstract">
  1504. <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
  1505. </div>
  1506. <div class="declaration">
  1507. <h4>Declaration</h4>
  1508. <div class="language">
  1509. <p class="aside-title">Swift</p>
  1510. <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>
  1511. </div>
  1512. </div>
  1513. </section>
  1514. </div>
  1515. </li>
  1516. </ul>
  1517. </div>
  1518. <div class="task-group">
  1519. <div class="task-name-container">
  1520. <a name="/Retry%20Count"></a>
  1521. <a name="//apple_ref/swift/Section/Retry Count" class="dashAnchor"></a>
  1522. <div class="section-name-container">
  1523. <a class="section-name-link" href="#/Retry%20Count"></a>
  1524. <h3 class="section-name"><span>Retry Count</span>
  1525. </h3>
  1526. </div>
  1527. </div>
  1528. <ul class="item-container">
  1529. <li class="item">
  1530. <div>
  1531. <code>
  1532. <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
  1533. <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
  1534. <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
  1535. </code>
  1536. </div>
  1537. <div class="height-container">
  1538. <div class="pointer-container"></div>
  1539. <section class="section">
  1540. <div class="pointer"></div>
  1541. <div class="abstract">
  1542. <p>Number of times the <code>Request</code> has been retried.</p>
  1543. </div>
  1544. <div class="declaration">
  1545. <h4>Declaration</h4>
  1546. <div class="language">
  1547. <p class="aside-title">Swift</p>
  1548. <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>
  1549. </div>
  1550. </div>
  1551. </section>
  1552. </div>
  1553. </li>
  1554. </ul>
  1555. </div>
  1556. <div class="task-group">
  1557. <div class="task-name-container">
  1558. <a name="/Error"></a>
  1559. <a name="//apple_ref/swift/Section/Error" class="dashAnchor"></a>
  1560. <div class="section-name-container">
  1561. <a class="section-name-link" href="#/Error"></a>
  1562. <h3 class="section-name"><span>Error</span>
  1563. </h3>
  1564. </div>
  1565. </div>
  1566. <ul class="item-container">
  1567. <li class="item">
  1568. <div>
  1569. <code>
  1570. <a name="/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp"></a>
  1571. <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
  1572. <a class="token" href="#/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp">error</a>
  1573. </code>
  1574. </div>
  1575. <div class="height-container">
  1576. <div class="pointer-container"></div>
  1577. <section class="section">
  1578. <div class="pointer"></div>
  1579. <div class="abstract">
  1580. <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
  1581. </div>
  1582. <div class="declaration">
  1583. <h4>Declaration</h4>
  1584. <div class="language">
  1585. <p class="aside-title">Swift</p>
  1586. <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">error</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError.html">AFError</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>
  1587. </div>
  1588. </div>
  1589. </section>
  1590. </div>
  1591. </li>
  1592. </ul>
  1593. </div>
  1594. <div class="task-group">
  1595. <div class="task-name-container">
  1596. <a name="/State"></a>
  1597. <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
  1598. <div class="section-name-container">
  1599. <a class="section-name-link" href="#/State"></a>
  1600. <h3 class="section-name"><span>State</span>
  1601. </h3>
  1602. </div>
  1603. </div>
  1604. <ul class="item-container">
  1605. <li class="item">
  1606. <div>
  1607. <code>
  1608. <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
  1609. <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
  1610. <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
  1611. </code>
  1612. </div>
  1613. <div class="height-container">
  1614. <div class="pointer-container"></div>
  1615. <section class="section">
  1616. <div class="pointer"></div>
  1617. <div class="abstract">
  1618. <p>Cancels the instance. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
  1619. </div>
  1620. <div class="declaration">
  1621. <h4>Declaration</h4>
  1622. <div class="language">
  1623. <p class="aside-title">Swift</p>
  1624. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1625. <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>
  1626. </div>
  1627. </div>
  1628. <div>
  1629. <h4>Return Value</h4>
  1630. <p>The instance.</p>
  1631. </div>
  1632. </section>
  1633. </div>
  1634. </li>
  1635. <li class="item">
  1636. <div>
  1637. <code>
  1638. <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
  1639. <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
  1640. <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
  1641. </code>
  1642. </div>
  1643. <div class="height-container">
  1644. <div class="pointer-container"></div>
  1645. <section class="section">
  1646. <div class="pointer"></div>
  1647. <div class="abstract">
  1648. <p>Suspends the instance.</p>
  1649. </div>
  1650. <div class="declaration">
  1651. <h4>Declaration</h4>
  1652. <div class="language">
  1653. <p class="aside-title">Swift</p>
  1654. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1655. <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>
  1656. </div>
  1657. </div>
  1658. <div>
  1659. <h4>Return Value</h4>
  1660. <p>The instance.</p>
  1661. </div>
  1662. </section>
  1663. </div>
  1664. </li>
  1665. <li class="item">
  1666. <div>
  1667. <code>
  1668. <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
  1669. <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
  1670. <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
  1671. </code>
  1672. </div>
  1673. <div class="height-container">
  1674. <div class="pointer-container"></div>
  1675. <section class="section">
  1676. <div class="pointer"></div>
  1677. <div class="abstract">
  1678. <p>Resumes the instance.</p>
  1679. </div>
  1680. <div class="declaration">
  1681. <h4>Declaration</h4>
  1682. <div class="language">
  1683. <p class="aside-title">Swift</p>
  1684. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1685. <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>
  1686. </div>
  1687. </div>
  1688. <div>
  1689. <h4>Return Value</h4>
  1690. <p>The instance.</p>
  1691. </div>
  1692. </section>
  1693. </div>
  1694. </li>
  1695. </ul>
  1696. </div>
  1697. <div class="task-group">
  1698. <div class="task-name-container">
  1699. <a name="/Closure%20API"></a>
  1700. <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
  1701. <div class="section-name-container">
  1702. <a class="section-name-link" href="#/Closure%20API"></a>
  1703. <h3 class="section-name"><span>Closure API</span>
  1704. </h3>
  1705. </div>
  1706. </div>
  1707. <ul class="item-container">
  1708. <li class="item">
  1709. <div>
  1710. <code>
  1711. <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
  1712. <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
  1713. <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:<wbr>password:<wbr>persistence:<wbr>)</a>
  1714. </code>
  1715. </div>
  1716. <div class="height-container">
  1717. <div class="pointer-container"></div>
  1718. <section class="section">
  1719. <div class="pointer"></div>
  1720. <div class="abstract">
  1721. <p>Associates a credential using the provided values with the instance.</p>
  1722. </div>
  1723. <div class="declaration">
  1724. <h4>Declaration</h4>
  1725. <div class="language">
  1726. <p class="aside-title">Swift</p>
  1727. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1728. <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>
  1729. </div>
  1730. </div>
  1731. <div>
  1732. <h4>Parameters</h4>
  1733. <table class="graybox">
  1734. <tbody>
  1735. <tr>
  1736. <td>
  1737. <code>
  1738. <em>username</em>
  1739. </code>
  1740. </td>
  1741. <td>
  1742. <div>
  1743. <p>The username.</p>
  1744. </div>
  1745. </td>
  1746. </tr>
  1747. <tr>
  1748. <td>
  1749. <code>
  1750. <em>password</em>
  1751. </code>
  1752. </td>
  1753. <td>
  1754. <div>
  1755. <p>The password.</p>
  1756. </div>
  1757. </td>
  1758. </tr>
  1759. <tr>
  1760. <td>
  1761. <code>
  1762. <em>persistence</em>
  1763. </code>
  1764. </td>
  1765. <td>
  1766. <div>
  1767. <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>. <code>.forSession</code> by default.</p>
  1768. </div>
  1769. </td>
  1770. </tr>
  1771. </tbody>
  1772. </table>
  1773. </div>
  1774. <div>
  1775. <h4>Return Value</h4>
  1776. <p>The instance.</p>
  1777. </div>
  1778. </section>
  1779. </div>
  1780. </li>
  1781. <li class="item">
  1782. <div>
  1783. <code>
  1784. <a name="/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
  1785. <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
  1786. <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:<wbr>)</a>
  1787. </code>
  1788. </div>
  1789. <div class="height-container">
  1790. <div class="pointer-container"></div>
  1791. <section class="section">
  1792. <div class="pointer"></div>
  1793. <div class="abstract">
  1794. <p>Associates the provided credential with the instance.</p>
  1795. </div>
  1796. <div class="declaration">
  1797. <h4>Declaration</h4>
  1798. <div class="language">
  1799. <p class="aside-title">Swift</p>
  1800. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1801. <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>
  1802. </div>
  1803. </div>
  1804. <div>
  1805. <h4>Parameters</h4>
  1806. <table class="graybox">
  1807. <tbody>
  1808. <tr>
  1809. <td>
  1810. <code>
  1811. <em>credential</em>
  1812. </code>
  1813. </td>
  1814. <td>
  1815. <div>
  1816. <p>The <code>URLCredential</code>.</p>
  1817. </div>
  1818. </td>
  1819. </tr>
  1820. </tbody>
  1821. </table>
  1822. </div>
  1823. <div>
  1824. <h4>Return Value</h4>
  1825. <p>The instance.</p>
  1826. </div>
  1827. </section>
  1828. </div>
  1829. </li>
  1830. <li class="item">
  1831. <div>
  1832. <code>
  1833. <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1834. <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
  1835. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:<wbr>closure:<wbr>)</a>
  1836. </code>
  1837. </div>
  1838. <div class="height-container">
  1839. <div class="pointer-container"></div>
  1840. <section class="section">
  1841. <div class="pointer"></div>
  1842. <div class="abstract">
  1843. <p>Sets a closure to be called periodically during the lifecycle of the instance as data is read from the server.</p>
  1844. <div class="aside aside-note">
  1845. <p class="aside-title">Note</p>
  1846. <p>Only the last closure provided is used.</p>
  1847. </div>
  1848. </div>
  1849. <div class="declaration">
  1850. <h4>Declaration</h4>
  1851. <div class="language">
  1852. <p class="aside-title">Swift</p>
  1853. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1854. <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>
  1855. </div>
  1856. </div>
  1857. <div>
  1858. <h4>Parameters</h4>
  1859. <table class="graybox">
  1860. <tbody>
  1861. <tr>
  1862. <td>
  1863. <code>
  1864. <em>queue</em>
  1865. </code>
  1866. </td>
  1867. <td>
  1868. <div>
  1869. <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
  1870. </div>
  1871. </td>
  1872. </tr>
  1873. <tr>
  1874. <td>
  1875. <code>
  1876. <em>closure</em>
  1877. </code>
  1878. </td>
  1879. <td>
  1880. <div>
  1881. <p>The closure to be executed periodically as data is read from the server.</p>
  1882. </div>
  1883. </td>
  1884. </tr>
  1885. </tbody>
  1886. </table>
  1887. </div>
  1888. <div>
  1889. <h4>Return Value</h4>
  1890. <p>The instance.</p>
  1891. </div>
  1892. </section>
  1893. </div>
  1894. </li>
  1895. <li class="item">
  1896. <div>
  1897. <code>
  1898. <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
  1899. <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
  1900. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:<wbr>closure:<wbr>)</a>
  1901. </code>
  1902. </div>
  1903. <div class="height-container">
  1904. <div class="pointer-container"></div>
  1905. <section class="section">
  1906. <div class="pointer"></div>
  1907. <div class="abstract">
  1908. <p>Sets a closure to be called periodically during the lifecycle of the instance as data is sent to the server.</p>
  1909. <div class="aside aside-note">
  1910. <p class="aside-title">Note</p>
  1911. <p>Only the last closure provided is used.</p>
  1912. </div>
  1913. </div>
  1914. <div class="declaration">
  1915. <h4>Declaration</h4>
  1916. <div class="language">
  1917. <p class="aside-title">Swift</p>
  1918. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1919. <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>
  1920. </div>
  1921. </div>
  1922. <div>
  1923. <h4>Parameters</h4>
  1924. <table class="graybox">
  1925. <tbody>
  1926. <tr>
  1927. <td>
  1928. <code>
  1929. <em>queue</em>
  1930. </code>
  1931. </td>
  1932. <td>
  1933. <div>
  1934. <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
  1935. </div>
  1936. </td>
  1937. </tr>
  1938. <tr>
  1939. <td>
  1940. <code>
  1941. <em>closure</em>
  1942. </code>
  1943. </td>
  1944. <td>
  1945. <div>
  1946. <p>The closure to be executed periodically as data is sent to the server.</p>
  1947. </div>
  1948. </td>
  1949. </tr>
  1950. </tbody>
  1951. </table>
  1952. </div>
  1953. <div>
  1954. <h4>Return Value</h4>
  1955. <p>The instance.</p>
  1956. </div>
  1957. </section>
  1958. </div>
  1959. </li>
  1960. </ul>
  1961. </div>
  1962. <div class="task-group">
  1963. <div class="task-name-container">
  1964. <a name="/Redirects"></a>
  1965. <a name="//apple_ref/swift/Section/Redirects" class="dashAnchor"></a>
  1966. <div class="section-name-container">
  1967. <a class="section-name-link" href="#/Redirects"></a>
  1968. <h3 class="section-name"><span>Redirects</span>
  1969. </h3>
  1970. </div>
  1971. </div>
  1972. <ul class="item-container">
  1973. <li class="item">
  1974. <div>
  1975. <code>
  1976. <a name="/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF"></a>
  1977. <a name="//apple_ref/swift/Method/redirect(using:)" class="dashAnchor"></a>
  1978. <a class="token" href="#/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF">redirect(using:<wbr>)</a>
  1979. </code>
  1980. </div>
  1981. <div class="height-container">
  1982. <div class="pointer-container"></div>
  1983. <section class="section">
  1984. <div class="pointer"></div>
  1985. <div class="abstract">
  1986. <p>Sets the redirect handler for the instance which will be used if a redirect response is encountered.</p>
  1987. <div class="aside aside-note">
  1988. <p class="aside-title">Note</p>
  1989. <p>Attempting to set the redirect handler more than once is a logic error and will crash.</p>
  1990. </div>
  1991. </div>
  1992. <div class="declaration">
  1993. <h4>Declaration</h4>
  1994. <div class="language">
  1995. <p class="aside-title">Swift</p>
  1996. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1997. <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>
  1998. </div>
  1999. </div>
  2000. <div>
  2001. <h4>Parameters</h4>
  2002. <table class="graybox">
  2003. <tbody>
  2004. <tr>
  2005. <td>
  2006. <code>
  2007. <em>handler</em>
  2008. </code>
  2009. </td>
  2010. <td>
  2011. <div>
  2012. <p>The <code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code>.</p>
  2013. </div>
  2014. </td>
  2015. </tr>
  2016. </tbody>
  2017. </table>
  2018. </div>
  2019. <div>
  2020. <h4>Return Value</h4>
  2021. <p>The instance.</p>
  2022. </div>
  2023. </section>
  2024. </div>
  2025. </li>
  2026. </ul>
  2027. </div>
  2028. <div class="task-group">
  2029. <div class="task-name-container">
  2030. <a name="/Cached%20Responses"></a>
  2031. <a name="//apple_ref/swift/Section/Cached Responses" class="dashAnchor"></a>
  2032. <div class="section-name-container">
  2033. <a class="section-name-link" href="#/Cached%20Responses"></a>
  2034. <h3 class="section-name"><span>Cached Responses</span>
  2035. </h3>
  2036. </div>
  2037. </div>
  2038. <ul class="item-container">
  2039. <li class="item">
  2040. <div>
  2041. <code>
  2042. <a name="/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF"></a>
  2043. <a name="//apple_ref/swift/Method/cacheResponse(using:)" class="dashAnchor"></a>
  2044. <a class="token" href="#/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF">cacheResponse(using:<wbr>)</a>
  2045. </code>
  2046. </div>
  2047. <div class="height-container">
  2048. <div class="pointer-container"></div>
  2049. <section class="section">
  2050. <div class="pointer"></div>
  2051. <div class="abstract">
  2052. <p>Sets the cached response handler for the <code>Request</code> which will be used when attempting to cache a response.</p>
  2053. <div class="aside aside-note">
  2054. <p class="aside-title">Note</p>
  2055. <p>Attempting to set the cache handler more than once is a logic error and will crash.</p>
  2056. </div>
  2057. </div>
  2058. <div class="declaration">
  2059. <h4>Declaration</h4>
  2060. <div class="language">
  2061. <p class="aside-title">Swift</p>
  2062. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2063. <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>
  2064. </div>
  2065. </div>
  2066. <div>
  2067. <h4>Parameters</h4>
  2068. <table class="graybox">
  2069. <tbody>
  2070. <tr>
  2071. <td>
  2072. <code>
  2073. <em>handler</em>
  2074. </code>
  2075. </td>
  2076. <td>
  2077. <div>
  2078. <p>The <code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code>.</p>
  2079. </div>
  2080. </td>
  2081. </tr>
  2082. </tbody>
  2083. </table>
  2084. </div>
  2085. <div>
  2086. <h4>Return Value</h4>
  2087. <p>The instance.</p>
  2088. </div>
  2089. </section>
  2090. </div>
  2091. </li>
  2092. </ul>
  2093. </div>
  2094. <div class="task-group">
  2095. <div class="task-name-container">
  2096. <a name="/Lifetime%20APIs"></a>
  2097. <a name="//apple_ref/swift/Section/Lifetime APIs" class="dashAnchor"></a>
  2098. <div class="section-name-container">
  2099. <a class="section-name-link" href="#/Lifetime%20APIs"></a>
  2100. <h3 class="section-name"><span>Lifetime APIs</span>
  2101. </h3>
  2102. </div>
  2103. </div>
  2104. <ul class="item-container">
  2105. <li class="item">
  2106. <div>
  2107. <code>
  2108. <a name="/s:9Alamofire7RequestC15cURLDescription2on7callingACXDSo17OS_dispatch_queueC_ySSctF"></a>
  2109. <a name="//apple_ref/swift/Method/cURLDescription(on:calling:)" class="dashAnchor"></a>
  2110. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription2on7callingACXDSo17OS_dispatch_queueC_ySSctF">cURLDescription(on:<wbr>calling:<wbr>)</a>
  2111. </code>
  2112. </div>
  2113. <div class="height-container">
  2114. <div class="pointer-container"></div>
  2115. <section class="section">
  2116. <div class="pointer"></div>
  2117. <div class="abstract">
  2118. <p>Sets a handler to be called when the cURL description of the request is available.</p>
  2119. <div class="aside aside-note">
  2120. <p class="aside-title">Note</p>
  2121. <p>When waiting for a <code>Request</code>&lsquo;s <code>URLRequest</code> to be created, only the last <code>handler</code> will be called.</p>
  2122. </div>
  2123. </div>
  2124. <div class="declaration">
  2125. <h4>Declaration</h4>
  2126. <div class="language">
  2127. <p class="aside-title">Swift</p>
  2128. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2129. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span> <span class="n">calling</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2130. </div>
  2131. </div>
  2132. <div>
  2133. <h4>Parameters</h4>
  2134. <table class="graybox">
  2135. <tbody>
  2136. <tr>
  2137. <td>
  2138. <code>
  2139. <em>queue</em>
  2140. </code>
  2141. </td>
  2142. <td>
  2143. <div>
  2144. <p><code>DispatchQueue</code> on which <code>handler</code> will be called.</p>
  2145. </div>
  2146. </td>
  2147. </tr>
  2148. <tr>
  2149. <td>
  2150. <code>
  2151. <em>handler</em>
  2152. </code>
  2153. </td>
  2154. <td>
  2155. <div>
  2156. <p>Closure to be called when the cURL description is available.</p>
  2157. </div>
  2158. </td>
  2159. </tr>
  2160. </tbody>
  2161. </table>
  2162. </div>
  2163. <div>
  2164. <h4>Return Value</h4>
  2165. <p>The instance.</p>
  2166. </div>
  2167. </section>
  2168. </div>
  2169. </li>
  2170. <li class="item">
  2171. <div>
  2172. <code>
  2173. <a name="/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF"></a>
  2174. <a name="//apple_ref/swift/Method/cURLDescription(calling:)" class="dashAnchor"></a>
  2175. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF">cURLDescription(calling:<wbr>)</a>
  2176. </code>
  2177. </div>
  2178. <div class="height-container">
  2179. <div class="pointer-container"></div>
  2180. <section class="section">
  2181. <div class="pointer"></div>
  2182. <div class="abstract">
  2183. <p>Sets a handler to be called when the cURL description of the request is available.</p>
  2184. <div class="aside aside-note">
  2185. <p class="aside-title">Note</p>
  2186. <p>When waiting for a <code>Request</code>&lsquo;s <code>URLRequest</code> to be created, only the last <code>handler</code> will be called.</p>
  2187. </div>
  2188. </div>
  2189. <div class="declaration">
  2190. <h4>Declaration</h4>
  2191. <div class="language">
  2192. <p class="aside-title">Swift</p>
  2193. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2194. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">(</span><span class="n">calling</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2195. </div>
  2196. </div>
  2197. <div>
  2198. <h4>Parameters</h4>
  2199. <table class="graybox">
  2200. <tbody>
  2201. <tr>
  2202. <td>
  2203. <code>
  2204. <em>handler</em>
  2205. </code>
  2206. </td>
  2207. <td>
  2208. <div>
  2209. <p>Closure to be called when the cURL description is available. Called on the instance&rsquo;s
  2210. <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code> by default.</p>
  2211. </div>
  2212. </td>
  2213. </tr>
  2214. </tbody>
  2215. </table>
  2216. </div>
  2217. <div>
  2218. <h4>Return Value</h4>
  2219. <p>The instance.</p>
  2220. </div>
  2221. </section>
  2222. </div>
  2223. </li>
  2224. <li class="item">
  2225. <div>
  2226. <code>
  2227. <a name="/s:9Alamofire7RequestC20onURLRequestCreation0C07performACXDSo17OS_dispatch_queueC_y10Foundation0D0VctF"></a>
  2228. <a name="//apple_ref/swift/Method/onURLRequestCreation(on:perform:)" class="dashAnchor"></a>
  2229. <a class="token" href="#/s:9Alamofire7RequestC20onURLRequestCreation0C07performACXDSo17OS_dispatch_queueC_y10Foundation0D0VctF">onURLRequestCreation(on:<wbr>perform:<wbr>)</a>
  2230. </code>
  2231. </div>
  2232. <div class="height-container">
  2233. <div class="pointer-container"></div>
  2234. <section class="section">
  2235. <div class="pointer"></div>
  2236. <div class="abstract">
  2237. <p>Sets a closure to called whenever Alamofire creates a <code>URLRequest</code> for this instance.</p>
  2238. <div class="aside aside-note">
  2239. <p class="aside-title">Note</p>
  2240. <p>This closure will be called multiple times if the instance adapts incoming <code>URLRequest</code>s or is retried.</p>
  2241. </div>
  2242. </div>
  2243. <div class="declaration">
  2244. <h4>Declaration</h4>
  2245. <div class="language">
  2246. <p class="aside-title">Swift</p>
  2247. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2248. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onURLRequestCreation</span><span class="p">(</span><span class="n">on</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="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">URLRequest</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2249. </div>
  2250. </div>
  2251. <div>
  2252. <h4>Parameters</h4>
  2253. <table class="graybox">
  2254. <tbody>
  2255. <tr>
  2256. <td>
  2257. <code>
  2258. <em>queue</em>
  2259. </code>
  2260. </td>
  2261. <td>
  2262. <div>
  2263. <p><code>DispatchQueue</code> on which <code>handler</code> will be called. <code>.main</code> by default.</p>
  2264. </div>
  2265. </td>
  2266. </tr>
  2267. <tr>
  2268. <td>
  2269. <code>
  2270. <em>handler</em>
  2271. </code>
  2272. </td>
  2273. <td>
  2274. <div>
  2275. <p>Closure to be called when a <code>URLRequest</code> is available.</p>
  2276. </div>
  2277. </td>
  2278. </tr>
  2279. </tbody>
  2280. </table>
  2281. </div>
  2282. <div>
  2283. <h4>Return Value</h4>
  2284. <p>The instance.</p>
  2285. </div>
  2286. </section>
  2287. </div>
  2288. </li>
  2289. <li class="item">
  2290. <div>
  2291. <code>
  2292. <a name="/s:9Alamofire7RequestC24onURLSessionTaskCreation0C07performACXDSo17OS_dispatch_queueC_ySo012NSURLSessionE0CctF"></a>
  2293. <a name="//apple_ref/swift/Method/onURLSessionTaskCreation(on:perform:)" class="dashAnchor"></a>
  2294. <a class="token" href="#/s:9Alamofire7RequestC24onURLSessionTaskCreation0C07performACXDSo17OS_dispatch_queueC_ySo012NSURLSessionE0CctF">onURLSessionTaskCreation(on:<wbr>perform:<wbr>)</a>
  2295. </code>
  2296. </div>
  2297. <div class="height-container">
  2298. <div class="pointer-container"></div>
  2299. <section class="section">
  2300. <div class="pointer"></div>
  2301. <div class="abstract">
  2302. <p>Sets a closure to be called whenever the instance creates a <code>URLSessionTask</code>.</p>
  2303. <div class="aside aside-note">
  2304. <p class="aside-title">Note</p>
  2305. <p>This API should only be used to provide <code>URLSessionTask</code>s to existing API, like <code>NSFileProvider</code>. It
  2306. <strong>SHOULD NOT</strong> be used to interact with tasks directly, as that may be break Alamofire features.
  2307. Additionally, this closure may be called multiple times if the instance is retried.</p>
  2308. </div>
  2309. </div>
  2310. <div class="declaration">
  2311. <h4>Declaration</h4>
  2312. <div class="language">
  2313. <p class="aside-title">Swift</p>
  2314. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  2315. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onURLSessionTaskCreation</span><span class="p">(</span><span class="n">on</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="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">URLSessionTask</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
  2316. </div>
  2317. </div>
  2318. <div>
  2319. <h4>Parameters</h4>
  2320. <table class="graybox">
  2321. <tbody>
  2322. <tr>
  2323. <td>
  2324. <code>
  2325. <em>queue</em>
  2326. </code>
  2327. </td>
  2328. <td>
  2329. <div>
  2330. <p><code>DispatchQueue</code> on which <code>handler</code> will be called. <code>.main</code> by default.</p>
  2331. </div>
  2332. </td>
  2333. </tr>
  2334. <tr>
  2335. <td>
  2336. <code>
  2337. <em>handler</em>
  2338. </code>
  2339. </td>
  2340. <td>
  2341. <div>
  2342. <p>Closure to be called when the <code>URLSessionTask</code> is available.</p>
  2343. </div>
  2344. </td>
  2345. </tr>
  2346. </tbody>
  2347. </table>
  2348. </div>
  2349. <div>
  2350. <h4>Return Value</h4>
  2351. <p>The instance.</p>
  2352. </div>
  2353. </section>
  2354. </div>
  2355. </li>
  2356. </ul>
  2357. </div>
  2358. <div class="task-group">
  2359. <div class="task-name-container">
  2360. <a name="/Request%20Event%20Streams"></a>
  2361. <a name="//apple_ref/swift/Section/Request Event Streams" class="dashAnchor"></a>
  2362. <div class="section-name-container">
  2363. <a class="section-name-link" href="#/Request%20Event%20Streams"></a>
  2364. <h3 class="section-name"><span>Request Event Streams</span>
  2365. </h3>
  2366. </div>
  2367. </div>
  2368. <ul class="item-container">
  2369. <li class="item">
  2370. <div>
  2371. <code>
  2372. <a name="/s:9Alamofire7RequestC14uploadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF"></a>
  2373. <a name="//apple_ref/swift/Method/uploadProgress(bufferingPolicy:)" class="dashAnchor"></a>
  2374. <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF">uploadProgress(bufferingPolicy:<wbr>)</a>
  2375. </code>
  2376. </div>
  2377. <div class="height-container">
  2378. <div class="pointer-container"></div>
  2379. <section class="section">
  2380. <div class="pointer"></div>
  2381. <div class="abstract">
  2382. <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf&lt;Progress&gt;</a></code> for the instance&rsquo;s upload progress.</p>
  2383. </div>
  2384. <div class="declaration">
  2385. <h4>Declaration</h4>
  2386. <div class="language">
  2387. <p class="aside-title">Swift</p>
  2388. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">uploadProgress</span><span class="p">(</span><span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">Progress</span><span class="o">&gt;.</span><span class="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">Progress</span><span class="o">&gt;</span></code></pre>
  2389. </div>
  2390. </div>
  2391. <div>
  2392. <h4>Parameters</h4>
  2393. <table class="graybox">
  2394. <tbody>
  2395. <tr>
  2396. <td>
  2397. <code>
  2398. <em>bufferingPolicy</em>
  2399. </code>
  2400. </td>
  2401. <td>
  2402. <div>
  2403. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  2404. </div>
  2405. </td>
  2406. </tr>
  2407. </tbody>
  2408. </table>
  2409. </div>
  2410. <div>
  2411. <h4>Return Value</h4>
  2412. <p>The <code><a href="../Structs/StreamOf.html">StreamOf&lt;Progress&gt;</a></code>.</p>
  2413. </div>
  2414. </section>
  2415. </div>
  2416. </li>
  2417. <li class="item">
  2418. <div>
  2419. <code>
  2420. <a name="/s:9Alamofire7RequestC16downloadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF"></a>
  2421. <a name="//apple_ref/swift/Method/downloadProgress(bufferingPolicy:)" class="dashAnchor"></a>
  2422. <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF">downloadProgress(bufferingPolicy:<wbr>)</a>
  2423. </code>
  2424. </div>
  2425. <div class="height-container">
  2426. <div class="pointer-container"></div>
  2427. <section class="section">
  2428. <div class="pointer"></div>
  2429. <div class="abstract">
  2430. <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf&lt;Progress&gt;</a></code> for the instance&rsquo;s download progress.</p>
  2431. </div>
  2432. <div class="declaration">
  2433. <h4>Declaration</h4>
  2434. <div class="language">
  2435. <p class="aside-title">Swift</p>
  2436. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">downloadProgress</span><span class="p">(</span><span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">Progress</span><span class="o">&gt;.</span><span class="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">Progress</span><span class="o">&gt;</span></code></pre>
  2437. </div>
  2438. </div>
  2439. <div>
  2440. <h4>Parameters</h4>
  2441. <table class="graybox">
  2442. <tbody>
  2443. <tr>
  2444. <td>
  2445. <code>
  2446. <em>bufferingPolicy</em>
  2447. </code>
  2448. </td>
  2449. <td>
  2450. <div>
  2451. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  2452. </div>
  2453. </td>
  2454. </tr>
  2455. </tbody>
  2456. </table>
  2457. </div>
  2458. <div>
  2459. <h4>Return Value</h4>
  2460. <p>The <code><a href="../Structs/StreamOf.html">StreamOf&lt;Progress&gt;</a></code>.</p>
  2461. </div>
  2462. </section>
  2463. </div>
  2464. </li>
  2465. <li class="item">
  2466. <div>
  2467. <code>
  2468. <a name="/s:9Alamofire7RequestC11urlRequests15bufferingPolicyAA8StreamOfVy10Foundation10URLRequestVGScS12ContinuationV09BufferingF0OyAJ__G_tF"></a>
  2469. <a name="//apple_ref/swift/Method/urlRequests(bufferingPolicy:)" class="dashAnchor"></a>
  2470. <a class="token" href="#/s:9Alamofire7RequestC11urlRequests15bufferingPolicyAA8StreamOfVy10Foundation10URLRequestVGScS12ContinuationV09BufferingF0OyAJ__G_tF">urlRequests(bufferingPolicy:<wbr>)</a>
  2471. </code>
  2472. </div>
  2473. <div class="height-container">
  2474. <div class="pointer-container"></div>
  2475. <section class="section">
  2476. <div class="pointer"></div>
  2477. <div class="abstract">
  2478. <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf&lt;URLRequest&gt;</a></code> for the <code>URLRequest</code>s produced for the instance.</p>
  2479. </div>
  2480. <div class="declaration">
  2481. <h4>Declaration</h4>
  2482. <div class="language">
  2483. <p class="aside-title">Swift</p>
  2484. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">urlRequests</span><span class="p">(</span><span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">URLRequest</span><span class="o">&gt;.</span><span class="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">URLRequest</span><span class="o">&gt;</span></code></pre>
  2485. </div>
  2486. </div>
  2487. <div>
  2488. <h4>Parameters</h4>
  2489. <table class="graybox">
  2490. <tbody>
  2491. <tr>
  2492. <td>
  2493. <code>
  2494. <em>bufferingPolicy</em>
  2495. </code>
  2496. </td>
  2497. <td>
  2498. <div>
  2499. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  2500. </div>
  2501. </td>
  2502. </tr>
  2503. </tbody>
  2504. </table>
  2505. </div>
  2506. <div>
  2507. <h4>Return Value</h4>
  2508. <p>The <code><a href="../Structs/StreamOf.html">StreamOf&lt;URLRequest&gt;</a></code>.</p>
  2509. </div>
  2510. </section>
  2511. </div>
  2512. </li>
  2513. <li class="item">
  2514. <div>
  2515. <code>
  2516. <a name="/s:9Alamofire7RequestC15urlSessionTasks15bufferingPolicyAA8StreamOfVySo16NSURLSessionTaskCGScS12ContinuationV09BufferingG0OyAI__G_tF"></a>
  2517. <a name="//apple_ref/swift/Method/urlSessionTasks(bufferingPolicy:)" class="dashAnchor"></a>
  2518. <a class="token" href="#/s:9Alamofire7RequestC15urlSessionTasks15bufferingPolicyAA8StreamOfVySo16NSURLSessionTaskCGScS12ContinuationV09BufferingG0OyAI__G_tF">urlSessionTasks(bufferingPolicy:<wbr>)</a>
  2519. </code>
  2520. </div>
  2521. <div class="height-container">
  2522. <div class="pointer-container"></div>
  2523. <section class="section">
  2524. <div class="pointer"></div>
  2525. <div class="abstract">
  2526. <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf&lt;URLSessionTask&gt;</a></code> for the <code>URLSessionTask</code>s produced for the instance.</p>
  2527. </div>
  2528. <div class="declaration">
  2529. <h4>Declaration</h4>
  2530. <div class="language">
  2531. <p class="aside-title">Swift</p>
  2532. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">urlSessionTasks</span><span class="p">(</span><span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">URLSessionTask</span><span class="o">&gt;.</span><span class="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">URLSessionTask</span><span class="o">&gt;</span></code></pre>
  2533. </div>
  2534. </div>
  2535. <div>
  2536. <h4>Parameters</h4>
  2537. <table class="graybox">
  2538. <tbody>
  2539. <tr>
  2540. <td>
  2541. <code>
  2542. <em>bufferingPolicy</em>
  2543. </code>
  2544. </td>
  2545. <td>
  2546. <div>
  2547. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  2548. </div>
  2549. </td>
  2550. </tr>
  2551. </tbody>
  2552. </table>
  2553. </div>
  2554. <div>
  2555. <h4>Return Value</h4>
  2556. <p>The <code><a href="../Structs/StreamOf.html">StreamOf&lt;URLSessionTask&gt;</a></code>.</p>
  2557. </div>
  2558. </section>
  2559. </div>
  2560. </li>
  2561. <li class="item">
  2562. <div>
  2563. <code>
  2564. <a name="/s:9Alamofire7RequestC16cURLDescriptions15bufferingPolicyAA8StreamOfVySSGScS12ContinuationV09BufferingE0OySS__G_tF"></a>
  2565. <a name="//apple_ref/swift/Method/cURLDescriptions(bufferingPolicy:)" class="dashAnchor"></a>
  2566. <a class="token" href="#/s:9Alamofire7RequestC16cURLDescriptions15bufferingPolicyAA8StreamOfVySSGScS12ContinuationV09BufferingE0OySS__G_tF">cURLDescriptions(bufferingPolicy:<wbr>)</a>
  2567. </code>
  2568. </div>
  2569. <div class="height-container">
  2570. <div class="pointer-container"></div>
  2571. <section class="section">
  2572. <div class="pointer"></div>
  2573. <div class="abstract">
  2574. <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf&lt;String&gt;</a></code> for the cURL descriptions produced for the instance.</p>
  2575. </div>
  2576. <div class="declaration">
  2577. <h4>Declaration</h4>
  2578. <div class="language">
  2579. <p class="aside-title">Swift</p>
  2580. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescriptions</span><span class="p">(</span><span class="nv">bufferingPolicy</span><span class="p">:</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;.</span><span class="kt">BufferingPolicy</span> <span class="o">=</span> <span class="o">.</span><span class="n">unbounded</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
  2581. </div>
  2582. </div>
  2583. <div>
  2584. <h4>Parameters</h4>
  2585. <table class="graybox">
  2586. <tbody>
  2587. <tr>
  2588. <td>
  2589. <code>
  2590. <em>bufferingPolicy</em>
  2591. </code>
  2592. </td>
  2593. <td>
  2594. <div>
  2595. <p><code>BufferingPolicy</code> that determines the stream&rsquo;s buffering behavior.<code>.unbounded</code> by default.</p>
  2596. </div>
  2597. </td>
  2598. </tr>
  2599. </tbody>
  2600. </table>
  2601. </div>
  2602. <div>
  2603. <h4>Return Value</h4>
  2604. <p>The <code><a href="../Structs/StreamOf.html">StreamOf&lt;String&gt;</a></code>.</p>
  2605. </div>
  2606. </section>
  2607. </div>
  2608. </li>
  2609. <li class="item">
  2610. <div>
  2611. <code>
  2612. <a name="/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ"></a>
  2613. <a name="//apple_ref/swift/Variable/didResumeNotification" class="dashAnchor"></a>
  2614. <a class="token" href="#/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ">didResumeNotification</a>
  2615. </code>
  2616. </div>
  2617. <div class="height-container">
  2618. <div class="pointer-container"></div>
  2619. <section class="section">
  2620. <div class="pointer"></div>
  2621. <div class="abstract">
  2622. <p>Posted when a <code>Request</code> is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
  2623. </div>
  2624. <div class="declaration">
  2625. <h4>Declaration</h4>
  2626. <div class="language">
  2627. <p class="aside-title">Swift</p>
  2628. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2629. </div>
  2630. </div>
  2631. </section>
  2632. </div>
  2633. </li>
  2634. <li class="item">
  2635. <div>
  2636. <code>
  2637. <a name="/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ"></a>
  2638. <a name="//apple_ref/swift/Variable/didSuspendNotification" class="dashAnchor"></a>
  2639. <a class="token" href="#/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ">didSuspendNotification</a>
  2640. </code>
  2641. </div>
  2642. <div class="height-container">
  2643. <div class="pointer-container"></div>
  2644. <section class="section">
  2645. <div class="pointer"></div>
  2646. <div class="abstract">
  2647. <p>Posted when a <code>Request</code> is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
  2648. </div>
  2649. <div class="declaration">
  2650. <h4>Declaration</h4>
  2651. <div class="language">
  2652. <p class="aside-title">Swift</p>
  2653. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2654. </div>
  2655. </div>
  2656. </section>
  2657. </div>
  2658. </li>
  2659. <li class="item">
  2660. <div>
  2661. <code>
  2662. <a name="/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ"></a>
  2663. <a name="//apple_ref/swift/Variable/didCancelNotification" class="dashAnchor"></a>
  2664. <a class="token" href="#/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ">didCancelNotification</a>
  2665. </code>
  2666. </div>
  2667. <div class="height-container">
  2668. <div class="pointer-container"></div>
  2669. <section class="section">
  2670. <div class="pointer"></div>
  2671. <div class="abstract">
  2672. <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
  2673. </div>
  2674. <div class="declaration">
  2675. <h4>Declaration</h4>
  2676. <div class="language">
  2677. <p class="aside-title">Swift</p>
  2678. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2679. </div>
  2680. </div>
  2681. </section>
  2682. </div>
  2683. </li>
  2684. <li class="item">
  2685. <div>
  2686. <code>
  2687. <a name="/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ"></a>
  2688. <a name="//apple_ref/swift/Variable/didFinishNotification" class="dashAnchor"></a>
  2689. <a class="token" href="#/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ">didFinishNotification</a>
  2690. </code>
  2691. </div>
  2692. <div class="height-container">
  2693. <div class="pointer-container"></div>
  2694. <section class="section">
  2695. <div class="pointer"></div>
  2696. <div class="abstract">
  2697. <p>Posted when a <code>Request</code> is finished. The <code>Notification</code> contains the completed <code>Request</code>.</p>
  2698. </div>
  2699. <div class="declaration">
  2700. <h4>Declaration</h4>
  2701. <div class="language">
  2702. <p class="aside-title">Swift</p>
  2703. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2704. </div>
  2705. </div>
  2706. </section>
  2707. </div>
  2708. </li>
  2709. <li class="item">
  2710. <div>
  2711. <code>
  2712. <a name="/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ"></a>
  2713. <a name="//apple_ref/swift/Variable/didResumeTaskNotification" class="dashAnchor"></a>
  2714. <a class="token" href="#/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ">didResumeTaskNotification</a>
  2715. </code>
  2716. </div>
  2717. <div class="height-container">
  2718. <div class="pointer-container"></div>
  2719. <section class="section">
  2720. <div class="pointer"></div>
  2721. <div class="abstract">
  2722. <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>
  2723. </div>
  2724. <div class="declaration">
  2725. <h4>Declaration</h4>
  2726. <div class="language">
  2727. <p class="aside-title">Swift</p>
  2728. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2729. </div>
  2730. </div>
  2731. </section>
  2732. </div>
  2733. </li>
  2734. <li class="item">
  2735. <div>
  2736. <code>
  2737. <a name="/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ"></a>
  2738. <a name="//apple_ref/swift/Variable/didSuspendTaskNotification" class="dashAnchor"></a>
  2739. <a class="token" href="#/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ">didSuspendTaskNotification</a>
  2740. </code>
  2741. </div>
  2742. <div class="height-container">
  2743. <div class="pointer-container"></div>
  2744. <section class="section">
  2745. <div class="pointer"></div>
  2746. <div class="abstract">
  2747. <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>
  2748. </div>
  2749. <div class="declaration">
  2750. <h4>Declaration</h4>
  2751. <div class="language">
  2752. <p class="aside-title">Swift</p>
  2753. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2754. </div>
  2755. </div>
  2756. </section>
  2757. </div>
  2758. </li>
  2759. <li class="item">
  2760. <div>
  2761. <code>
  2762. <a name="/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ"></a>
  2763. <a name="//apple_ref/swift/Variable/didCancelTaskNotification" class="dashAnchor"></a>
  2764. <a class="token" href="#/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ">didCancelTaskNotification</a>
  2765. </code>
  2766. </div>
  2767. <div class="height-container">
  2768. <div class="pointer-container"></div>
  2769. <section class="section">
  2770. <div class="pointer"></div>
  2771. <div class="abstract">
  2772. <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>
  2773. </div>
  2774. <div class="declaration">
  2775. <h4>Declaration</h4>
  2776. <div class="language">
  2777. <p class="aside-title">Swift</p>
  2778. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2779. </div>
  2780. </div>
  2781. </section>
  2782. </div>
  2783. </li>
  2784. <li class="item">
  2785. <div>
  2786. <code>
  2787. <a name="/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ"></a>
  2788. <a name="//apple_ref/swift/Variable/didCompleteTaskNotification" class="dashAnchor"></a>
  2789. <a class="token" href="#/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ">didCompleteTaskNotification</a>
  2790. </code>
  2791. </div>
  2792. <div class="height-container">
  2793. <div class="pointer-container"></div>
  2794. <section class="section">
  2795. <div class="pointer"></div>
  2796. <div class="abstract">
  2797. <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>
  2798. </div>
  2799. <div class="declaration">
  2800. <h4>Declaration</h4>
  2801. <div class="language">
  2802. <p class="aside-title">Swift</p>
  2803. <pre class="highlight swift"><code><span class="kd">public</span> <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>
  2804. </div>
  2805. </div>
  2806. </section>
  2807. </div>
  2808. </li>
  2809. <li class="item">
  2810. <div>
  2811. <code>
  2812. <a name="/s:9Alamofire7RequestC19ResponseDispositionO"></a>
  2813. <a name="//apple_ref/swift/Enum/ResponseDisposition" class="dashAnchor"></a>
  2814. <a class="token" href="#/s:9Alamofire7RequestC19ResponseDispositionO">ResponseDisposition</a>
  2815. </code>
  2816. </div>
  2817. <div class="height-container">
  2818. <div class="pointer-container"></div>
  2819. <section class="section">
  2820. <div class="pointer"></div>
  2821. <div class="abstract">
  2822. <p>Type indicating how a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> or <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should proceed after receiving an <code>HTTPURLResponse</code>.</p>
  2823. <a href="../Classes/Request/ResponseDisposition.html" class="slightly-smaller">See more</a>
  2824. </div>
  2825. <div class="declaration">
  2826. <h4>Declaration</h4>
  2827. <div class="language">
  2828. <p class="aside-title">Swift</p>
  2829. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ResponseDisposition</span></code></pre>
  2830. </div>
  2831. </div>
  2832. </section>
  2833. </div>
  2834. </li>
  2835. </ul>
  2836. </div>
  2837. <div class="task-group">
  2838. <div class="task-name-container">
  2839. <a name="/Protocol%20Conformances"></a>
  2840. <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
  2841. <div class="section-name-container">
  2842. <a class="section-name-link" href="#/Protocol%20Conformances"></a>
  2843. <h3 class="section-name"><span>Protocol Conformances</span>
  2844. </h3>
  2845. </div>
  2846. </div>
  2847. <ul class="item-container">
  2848. <li class="item">
  2849. <div>
  2850. <code>
  2851. <a name="/s:SQ2eeoiySbx_xtFZ"></a>
  2852. <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
  2853. <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:<wbr>_:<wbr>)</a>
  2854. </code>
  2855. </div>
  2856. <div class="height-container">
  2857. <div class="pointer-container"></div>
  2858. <section class="section">
  2859. <div class="pointer"></div>
  2860. <div class="abstract">
  2861. </div>
  2862. <div class="declaration">
  2863. <h4>Declaration</h4>
  2864. <div class="language">
  2865. <p class="aside-title">Swift</p>
  2866. <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>
  2867. </div>
  2868. </div>
  2869. </section>
  2870. </div>
  2871. </li>
  2872. <li class="item">
  2873. <div>
  2874. <code>
  2875. <a name="/s:SH4hash4intoys6HasherVz_tF"></a>
  2876. <a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
  2877. <a class="token" href="#/s:SH4hash4intoys6HasherVz_tF">hash(into:<wbr>)</a>
  2878. </code>
  2879. </div>
  2880. <div class="height-container">
  2881. <div class="pointer-container"></div>
  2882. <section class="section">
  2883. <div class="pointer"></div>
  2884. <div class="abstract">
  2885. </div>
  2886. <div class="declaration">
  2887. <h4>Declaration</h4>
  2888. <div class="language">
  2889. <p class="aside-title">Swift</p>
  2890. <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>
  2891. </div>
  2892. </div>
  2893. </section>
  2894. </div>
  2895. </li>
  2896. <li class="item">
  2897. <div>
  2898. <code>
  2899. <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
  2900. <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
  2901. <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
  2902. </code>
  2903. </div>
  2904. <div class="height-container">
  2905. <div class="pointer-container"></div>
  2906. <section class="section">
  2907. <div class="pointer"></div>
  2908. <div class="abstract">
  2909. <p>A textual representation of this instance, including the <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> and <code>URL</code> if the <code>URLRequest</code> has been
  2910. created, as well as the response status code, if a response has been received.</p>
  2911. </div>
  2912. <div class="declaration">
  2913. <h4>Declaration</h4>
  2914. <div class="language">
  2915. <p class="aside-title">Swift</p>
  2916. <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>
  2917. </div>
  2918. </div>
  2919. </section>
  2920. </div>
  2921. </li>
  2922. <li class="item">
  2923. <div>
  2924. <code>
  2925. <a name="/s:9Alamofire7RequestC15cURLDescriptionSSyF"></a>
  2926. <a name="//apple_ref/swift/Method/cURLDescription()" class="dashAnchor"></a>
  2927. <a class="token" href="#/s:9Alamofire7RequestC15cURLDescriptionSSyF">cURLDescription()</a>
  2928. </code>
  2929. </div>
  2930. <div class="height-container">
  2931. <div class="pointer-container"></div>
  2932. <section class="section">
  2933. <div class="pointer"></div>
  2934. <div class="abstract">
  2935. <p>cURL representation of the instance.</p>
  2936. </div>
  2937. <div class="declaration">
  2938. <h4>Declaration</h4>
  2939. <div class="language">
  2940. <p class="aside-title">Swift</p>
  2941. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
  2942. </div>
  2943. </div>
  2944. <div>
  2945. <h4>Return Value</h4>
  2946. <p>The cURL equivalent of the instance.</p>
  2947. </div>
  2948. </section>
  2949. </div>
  2950. </li>
  2951. </ul>
  2952. </div>
  2953. <div class="task-group">
  2954. <div class="task-name-container">
  2955. <a name="/Helper%20Types"></a>
  2956. <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
  2957. <div class="section-name-container">
  2958. <a class="section-name-link" href="#/Helper%20Types"></a>
  2959. <h3 class="section-name"><span>Helper Types</span>
  2960. </h3>
  2961. </div>
  2962. </div>
  2963. <ul class="item-container">
  2964. <li class="item">
  2965. <div>
  2966. <code>
  2967. <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
  2968. <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
  2969. <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
  2970. </code>
  2971. </div>
  2972. <div class="height-container">
  2973. <div class="pointer-container"></div>
  2974. <section class="section">
  2975. <div class="pointer"></div>
  2976. <div class="abstract">
  2977. <p>Used to represent whether a validation succeeded or failed.</p>
  2978. </div>
  2979. <div class="declaration">
  2980. <h4>Declaration</h4>
  2981. <div class="language">
  2982. <p class="aside-title">Swift</p>
  2983. <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">Result</span><span class="o">&lt;</span><span class="kt">Void</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span></code></pre>
  2984. </div>
  2985. </div>
  2986. </section>
  2987. </div>
  2988. </li>
  2989. </ul>
  2990. </div>
  2991. </div>
  2992. </section>
  2993. </article>
  2994. </div>
  2995. <section class="footer">
  2996. <p>&copy; 2023 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2023-08-31)</p>
  2997. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  2998. </section>
  2999. </body>
  3000. </html>