Request.html 168 KB

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