Request.html 190 KB

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