Request.html 176 KB

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