| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>Request Class Reference</title>
- <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
- <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
- <meta charset="utf-8">
- <script src="../js/jquery.min.js" defer></script>
- <script src="../js/jazzy.js" defer></script>
-
- <script src="../js/lunr.min.js" defer></script>
- <script src="../js/typeahead.jquery.js" defer></script>
- <script src="../js/jazzy.search.js" defer></script>
- </head>
- <body>
- <a name="//apple_ref/swift/Class/Request" class="dashAnchor"></a>
- <a title="Request Class Reference"></a>
- <header class="header">
- <p class="header-col header-col--primary">
- <a class="header-link" href="../index.html">
- Alamofire 5.10.1 Docs
- </a>
- (96% documented)
- </p>
-
- <div class="header-col--secondary">
- <form role="search" action="../search.json">
- <input type="text" placeholder="Search documentation" data-typeahead>
- </form>
- </div>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="https://github.com/Alamofire/Alamofire">
- <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
- View on GitHub
- </a>
- </p>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
- <img class="header-icon" src="../img/dash.png" alt="Dash"/>
- Install in Dash
- </a>
- </p>
- </header>
- <p class="breadcrumbs">
- <a class="breadcrumb" href="../index.html">Alamofire</a>
- <img class="carat" src="../img/carat.png" alt=""/>
- <a class="breadcrumb" href="../Classes.html">Classes</a>
- <img class="carat" src="../img/carat.png" alt=""/>
- Request Class Reference
- </p>
- <div class="content-wrapper">
- <nav class="navigation">
- <ul class="nav-groups">
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Classes.html">Classes</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Request/ResponseDisposition.html">– ResponseDisposition</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyPathEncoding.html">– KeyPathEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/NilEncoding.html">– NilEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFInfo.html">AFInfo</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/Protected">Protected</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/%5BServerTrustEvaluating%5D.html">[ServerTrustEvaluating]</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/WebSocketMessageSerializer.html">WebSocketMessageSerializer</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Structs.html">Structures</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder.html">DecodableWebSocketMessageDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DecodableWebSocketMessageDecoder/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html">DeflateRequestCompressor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor/DuplicateHeaderBehavior.html">– DuplicateHeaderBehavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DeflateRequestCompressor.html#/s:9Alamofire24DeflateRequestCompressorV20DuplicateHeaderErrorV">– DuplicateHeaderError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section class="section">
- <div class="section-content top-matter">
- <h1>Request</h1>
- <div class="declaration">
- <div class="language">
-
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Request</span> <span class="p">:</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
- <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>
- <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>
- <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>
- </div>
- </div>
- <p><code>Request</code> is the common superclass of all Alamofire request types and provides common state, delegate, and callback
- handling.</p>
- </div>
- </section>
- <section class="section">
- <div class="section-content">
- <div class="task-group">
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC5StateO"></a>
- <a name="//apple_ref/swift/Enum/State" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC5StateO">State</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a></code> on the <code><a href="../Classes/Request.html">Request</a></code>.</p>
- <a href="../Classes/Request/State.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">State</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Initial%20State"></a>
- <a name="//apple_ref/swift/Section/Initial State" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Initial%20State"></a>
- <h3 class="section-name"><span>Initial State</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC2id10Foundation4UUIDVvp"></a>
- <a name="//apple_ref/swift/Property/id" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC2id10Foundation4UUIDVvp">id</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp"></a>
- <a name="//apple_ref/swift/Property/underlyingQueue" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The serial queue for all internal async actions.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp"></a>
- <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The queue used for all serialization actions. By default it’s a serial queue that targets <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp"></a>
- <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC12eventMonitorAA05EventD0_pSgvp">eventMonitor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> used for event callbacks.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">eventMonitor</span><span class="p">:</span> <span class="p">(</span><span class="n">any</span> <span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">)?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp"></a>
- <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC11interceptorAA0B11Interceptor_pSgvp">interceptor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>Request</code>‘s interceptor.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="p">(</span><span class="n">any</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">)?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp"></a>
- <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC8delegateAA0B8Delegate_pSgvp">delegate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The <code>Request</code>‘s delegate.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="p">(</span><span class="n">any</span> <span class="kt"><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Mutable%20State"></a>
- <a name="//apple_ref/swift/Section/Mutable State" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Mutable%20State"></a>
- <h3 class="section-name"><span>Mutable State</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC5stateAC5StateOvp"></a>
- <a name="//apple_ref/swift/Property/state" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Classes/Request/State.html">State</a></code> of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC13isInitializedSbvp"></a>
- <a name="//apple_ref/swift/Property/isInitialized" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC13isInitializedSbvp">isInitialized</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.initialized</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC9isResumedSbvp"></a>
- <a name="//apple_ref/swift/Property/isResumed" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC9isResumedSbvp">isResumed</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.resumed</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC11isSuspendedSbvp"></a>
- <a name="//apple_ref/swift/Property/isSuspended" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC11isSuspendedSbvp">isSuspended</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.suspended</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC11isCancelledSbvp"></a>
- <a name="//apple_ref/swift/Property/isCancelled" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC11isCancelledSbvp">isCancelled</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.cancelled</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC10isFinishedSbvp"></a>
- <a name="//apple_ref/swift/Property/isFinished" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC10isFinishedSbvp">isFinished</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Returns whether <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC5stateAC5StateOvp">state</a></code> is <code>.finished</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Progress"></a>
- <a name="//apple_ref/swift/Section/Progress" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Progress"></a>
- <h3 class="section-name"><span>Progress</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15ProgressHandlera"></a>
- <a name="//apple_ref/swift/Alias/ProgressHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Closure type executed when monitoring the upload or download progress of a request.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">ProgressHandler</span> <span class="o">=</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="n">_</span> <span class="nv">progress</span><span class="p">:</span> <span class="kt">Progress</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp"></a>
- <a name="//apple_ref/swift/Property/uploadProgress" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp"></a>
- <a name="//apple_ref/swift/Property/downloadProgress" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>Progress</code> of the download of any response data. Reset to <code>0</code> if the <code>Request</code> is retried.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC21uploadProgressHandlerySo10NSProgressCYbc7handler_So17OS_dispatch_queueC0J0tSgvp"></a>
- <a name="//apple_ref/swift/Property/uploadProgressHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC21uploadProgressHandlerySo10NSProgressCYbc7handler_So17OS_dispatch_queueC0J0tSgvp">uploadProgressHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></code> called when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC14uploadProgressSo10NSProgressCvp">uploadProgress</a></code> is updated, on the provided <code>DispatchQueue</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">uploadProgressHandler</span><span class="p">:</span> <span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></span><span class="p">,</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC23downloadProgressHandlerySo10NSProgressCYbc7handler_So17OS_dispatch_queueC0J0tSgvp"></a>
- <a name="//apple_ref/swift/Property/downloadProgressHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC23downloadProgressHandlerySo10NSProgressCYbc7handler_So17OS_dispatch_queueC0J0tSgvp">downloadProgressHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></code> called when <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC16downloadProgressSo10NSProgressCvp">downloadProgress</a></code> is updated, on the provided <code>DispatchQueue</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">downloadProgressHandler</span><span class="p">:</span> <span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html#/s:9Alamofire7RequestC15ProgressHandlera">ProgressHandler</a></span><span class="p">,</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Redirect%20Handling"></a>
- <a name="//apple_ref/swift/Section/Redirect Handling" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Redirect%20Handling"></a>
- <h3 class="section-name"><span>Redirect Handling</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp"></a>
- <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> set on the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">redirectHandler</span><span class="p">:</span> <span class="p">(</span><span class="n">any</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Cached%20Response%20Handling"></a>
- <a name="//apple_ref/swift/Section/Cached Response Handling" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Cached%20Response%20Handling"></a>
- <h3 class="section-name"><span>Cached Response Handling</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
- <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> set on the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="p">(</span><span class="n">any</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">)?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/URLCredential"></a>
- <a name="//apple_ref/swift/Section/URLCredential" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/URLCredential"></a>
- <h3 class="section-name"><span>URLCredential</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp"></a>
- <a name="//apple_ref/swift/Property/credential" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC10credentialSo15NSURLCredentialCSgvp">credential</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>URLCredential</code> used for authentication challenges. Created by calling one of the <code>authenticate</code> methods.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">credential</span><span class="p">:</span> <span class="kt">URLCredential</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/URLRequests"></a>
- <a name="//apple_ref/swift/Section/URLRequests" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/URLRequests"></a>
- <h3 class="section-name"><span>URLRequests</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp"></a>
- <a name="//apple_ref/swift/Property/requests" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>All <code>URLRequest</code>s created on behalf of the <code>Request</code>, including original and adapted requests.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp"></a>
- <a name="//apple_ref/swift/Property/firstRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC05firstB010Foundation10URLRequestVSgvp">firstRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>First <code>URLRequest</code> created on behalf of the <code>Request</code>. May not be the first one actually executed.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp"></a>
- <a name="//apple_ref/swift/Property/lastRequest" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC04lastB010Foundation10URLRequestVSgvp">lastRequest</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Last <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp"></a>
- <a name="//apple_ref/swift/Property/request" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC7request10Foundation10URLRequestVSgvp">request</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Current <code>URLRequest</code> created on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp"></a>
- <a name="//apple_ref/swift/Property/performedRequests" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC17performedRequestsSay10Foundation10URLRequestVGvp">performedRequests</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC8requestsSay10Foundation10URLRequestVGvp">requests</a></code> due to <code>URLSession</code> manipulation.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/HTTPURLResponse"></a>
- <a name="//apple_ref/swift/Section/HTTPURLResponse" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/HTTPURLResponse"></a>
- <h3 class="section-name"><span>HTTPURLResponse</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp"></a>
- <a name="//apple_ref/swift/Property/response" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC8responseSo17NSHTTPURLResponseCSgvp">response</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>HTTPURLResponse</code> received from the server, if any. If the <code>Request</code> was retried, this is the response of the
- last <code>URLSessionTask</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Tasks"></a>
- <a name="//apple_ref/swift/Section/Tasks" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Tasks"></a>
- <h3 class="section-name"><span>Tasks</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp"></a>
- <a name="//apple_ref/swift/Property/tasks" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC5tasksSaySo16NSURLSessionTaskCGvp">tasks</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>All <code>URLSessionTask</code>s created on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp"></a>
- <a name="//apple_ref/swift/Property/firstTask" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC9firstTaskSo012NSURLSessionD0CSgvp">firstTask</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>First <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp"></a>
- <a name="//apple_ref/swift/Property/lastTask" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC8lastTaskSo012NSURLSessionD0CSgvp">lastTask</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Last <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp"></a>
- <a name="//apple_ref/swift/Property/task" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC4taskSo16NSURLSessionTaskCSgvp">task</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Current <code>URLSessionTask</code> created on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Metrics"></a>
- <a name="//apple_ref/swift/Section/Metrics" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Metrics"></a>
- <h3 class="section-name"><span>Metrics</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp"></a>
- <a name="//apple_ref/swift/Property/allMetrics" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC10allMetricsSaySo016NSURLSessionTaskD0CGvp">allMetrics</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp"></a>
- <a name="//apple_ref/swift/Property/firstMetrics" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC12firstMetricsSo016NSURLSessionTaskD0CSgvp">firstMetrics</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>First <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp"></a>
- <a name="//apple_ref/swift/Property/lastMetrics" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC11lastMetricsSo016NSURLSessionTaskD0CSgvp">lastMetrics</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Last <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp"></a>
- <a name="//apple_ref/swift/Property/metrics" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC7metricsSo23NSURLSessionTaskMetricsCSgvp">metrics</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Current <code>URLSessionTaskMetrics</code> gathered on behalf of the <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Retry%20Count"></a>
- <a name="//apple_ref/swift/Section/Retry Count" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Retry%20Count"></a>
- <h3 class="section-name"><span>Retry Count</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC10retryCountSivp"></a>
- <a name="//apple_ref/swift/Property/retryCount" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC10retryCountSivp">retryCount</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Number of times the <code>Request</code> has been retried.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Error"></a>
- <a name="//apple_ref/swift/Section/Error" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Error"></a>
- <h3 class="section-name"><span>Error</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp"></a>
- <a name="//apple_ref/swift/Property/error" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC5errorAA7AFErrorOSgvp">error</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code>Error</code> returned from Alamofire internally, from the network request directly, or any validators executed.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span> <span class="kt"><a href="../Enums/AFError.html">AFError</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/State"></a>
- <a name="//apple_ref/swift/Section/State" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/State"></a>
- <h3 class="section-name"><span>State</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC6cancelACXDyF"></a>
- <a name="//apple_ref/swift/Method/cancel()" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC6cancelACXDyF">cancel()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Cancels the instance. Once cancelled, a <code>Request</code> can no longer be resumed or suspended.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancel</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC7suspendACXDyF"></a>
- <a name="//apple_ref/swift/Method/suspend()" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC7suspendACXDyF">suspend()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Suspends the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">suspend</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC6resumeACXDyF"></a>
- <a name="//apple_ref/swift/Method/resume()" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC6resumeACXDyF">resume()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Resumes the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">resume</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Closure%20API"></a>
- <a name="//apple_ref/swift/Section/Closure API" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Closure%20API"></a>
- <h3 class="section-name"><span>Closure API</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF"></a>
- <a name="//apple_ref/swift/Method/authenticate(username:password:persistence:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC12authenticate8username8password11persistenceACXDSS_SSSo26NSURLCredentialPersistenceVtF">authenticate(username:<wbr>password:<wbr>persistence:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Associates a credential using the provided values with the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <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">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>username</em>
- </code>
- </td>
- <td>
- <div>
- <p>The username.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>password</em>
- </code>
- </td>
- <td>
- <div>
- <p>The password.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>persistence</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>URLCredential.Persistence</code> for the created <code>URLCredential</code>. <code>.forSession</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF"></a>
- <a name="//apple_ref/swift/Method/authenticate(with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC12authenticate4withACXDSo15NSURLCredentialC_tF">authenticate(with:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Associates the provided credential with the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <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">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>credential</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>URLCredential</code>.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
- <a name="//apple_ref/swift/Method/downloadProgress(queue:closure:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">downloadProgress(queue:<wbr>closure:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets a closure to be called periodically during the lifecycle of the instance as data is read from the server.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>Only the last closure provided is used.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <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">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>queue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>closure</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure to be executed periodically as data is read from the server.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF"></a>
- <a name="//apple_ref/swift/Method/uploadProgress(queue:closure:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress5queue7closureACXDSo012OS_dispatch_E0C_ySo10NSProgressCctF">uploadProgress(queue:<wbr>closure:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets a closure to be called periodically during the lifecycle of the instance as data is sent to the server.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>Only the last closure provided is used.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <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">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>queue</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>DispatchQueue</code> to execute the closure on. <code>.main</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>closure</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure to be executed periodically as data is sent to the server.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Redirects"></a>
- <a name="//apple_ref/swift/Section/Redirects" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Redirects"></a>
- <h3 class="section-name"><span>Redirects</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF"></a>
- <a name="//apple_ref/swift/Method/redirect(using:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC8redirect5usingACXDAA15RedirectHandler_p_tF">redirect(using:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the redirect handler for the instance which will be used if a redirect response is encountered.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>Attempting to set the redirect handler more than once is a logic error and will crash.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">redirect</span><span class="p">(</span><span class="n">using</span> <span class="nv">handler</span><span class="p">:</span> <span class="n">any</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>handler</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code>.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Cached%20Responses"></a>
- <a name="//apple_ref/swift/Section/Cached Responses" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Cached%20Responses"></a>
- <h3 class="section-name"><span>Cached Responses</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF"></a>
- <a name="//apple_ref/swift/Method/cacheResponse(using:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC13cacheResponse5usingACXDAA06CachedD7Handler_p_tF">cacheResponse(using:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets the cached response handler for the <code>Request</code> which will be used when attempting to cache a response.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>Attempting to set the cache handler more than once is a logic error and will crash.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cacheResponse</span><span class="p">(</span><span class="n">using</span> <span class="nv">handler</span><span class="p">:</span> <span class="n">any</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>handler</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code>.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Lifetime%20APIs"></a>
- <a name="//apple_ref/swift/Section/Lifetime APIs" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Lifetime%20APIs"></a>
- <h3 class="section-name"><span>Lifetime APIs</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15cURLDescription2on7callingACXDSo17OS_dispatch_queueC_ySSctF"></a>
- <a name="//apple_ref/swift/Method/cURLDescription(on:calling:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription2on7callingACXDSo17OS_dispatch_queueC_ySSctF">cURLDescription(on:<wbr>calling:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets a handler to be called when the cURL description of the request is available.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>When waiting for a <code>Request</code>‘s <code>URLRequest</code> to be created, only the last <code>handler</code> will be called.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span> <span class="n">calling</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>queue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which <code>handler</code> will be called.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>handler</em>
- </code>
- </td>
- <td>
- <div>
- <p>Closure to be called when the cURL description is available.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF"></a>
- <a name="//apple_ref/swift/Method/cURLDescription(calling:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15cURLDescription7callingACXDySSc_tF">cURLDescription(calling:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets a handler to be called when the cURL description of the request is available.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>When waiting for a <code>Request</code>‘s <code>URLRequest</code> to be created, only the last <code>handler</code> will be called.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">cURLDescription</span><span class="p">(</span><span class="n">calling</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>handler</em>
- </code>
- </td>
- <td>
- <div>
- <p>Closure to be called when the cURL description is available. Called on the instance’s
- <code><a href="../Classes/Request.html#/s:9Alamofire7RequestC15underlyingQueueSo17OS_dispatch_queueCvp">underlyingQueue</a></code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC20onURLRequestCreation0C07performACXDSo17OS_dispatch_queueC_y10Foundation0D0VctF"></a>
- <a name="//apple_ref/swift/Method/onURLRequestCreation(on:perform:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC20onURLRequestCreation0C07performACXDSo17OS_dispatch_queueC_y10Foundation0D0VctF">onURLRequestCreation(on:<wbr>perform:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets a closure to called whenever Alamofire creates a <code>URLRequest</code> for this instance.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This closure will be called multiple times if the instance adapts incoming <code>URLRequest</code>s or is retried.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onURLRequestCreation</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="kt">URLRequest</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>queue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which <code>handler</code> will be called. <code>.main</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>handler</em>
- </code>
- </td>
- <td>
- <div>
- <p>Closure to be called when a <code>URLRequest</code> is available.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC24onURLSessionTaskCreation0C07performACXDSo17OS_dispatch_queueC_ySo012NSURLSessionE0CctF"></a>
- <a name="//apple_ref/swift/Method/onURLSessionTaskCreation(on:perform:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC24onURLSessionTaskCreation0C07performACXDSo17OS_dispatch_queueC_ySo012NSURLSessionE0CctF">onURLSessionTaskCreation(on:<wbr>perform:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Sets a closure to be called whenever the instance creates a <code>URLSessionTask</code>.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This API should only be used to provide <code>URLSessionTask</code>s to existing API, like <code>NSFileProvider</code>. It
- <strong>SHOULD NOT</strong> be used to interact with tasks directly, as that may be break Alamofire features.
- Additionally, this closure may be called multiple times if the instance is retried.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">@preconcurrency</span>
- <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onURLSessionTaskCreation</span><span class="p">(</span><span class="n">on</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="o">.</span><span class="n">main</span><span class="p">,</span> <span class="n">perform</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kd">@Sendable</span> <span class="p">(</span><span class="kt">URLSessionTask</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>queue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which <code>handler</code> will be called. <code>.main</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>handler</em>
- </code>
- </td>
- <td>
- <div>
- <p>Closure to be called when the <code>URLSessionTask</code> is available.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didResumeNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC21didResumeNotificationSo18NSNotificationNameavpZ">didResumeNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Posted when a <code>Request</code> is resumed. The <code>Notification</code> contains the resumed <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didSuspendNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC22didSuspendNotificationSo18NSNotificationNameavpZ">didSuspendNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Posted when a <code>Request</code> is suspended. The <code>Notification</code> contains the suspended <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didCancelNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC21didCancelNotificationSo18NSNotificationNameavpZ">didCancelNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Posted when a <code>Request</code> is cancelled. The <code>Notification</code> contains the cancelled <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didFinishNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC21didFinishNotificationSo18NSNotificationNameavpZ">didFinishNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Posted when a <code>Request</code> is finished. The <code>Notification</code> contains the completed <code>Request</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didResumeTaskNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC25didResumeTaskNotificationSo18NSNotificationNameavpZ">didResumeTaskNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didSuspendTaskNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC26didSuspendTaskNotificationSo18NSNotificationNameavpZ">didSuspendTaskNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didCancelTaskNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC25didCancelTaskNotificationSo18NSNotificationNameavpZ">didCancelTaskNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ"></a>
- <a name="//apple_ref/swift/Variable/didCompleteTaskNotification" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC27didCompleteTaskNotificationSo18NSNotificationNameavpZ">didCompleteTaskNotification</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC19ResponseDispositionO"></a>
- <a name="//apple_ref/swift/Enum/ResponseDisposition" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC19ResponseDispositionO">ResponseDisposition</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Type indicating how a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> or <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> should proceed after receiving an <code>HTTPURLResponse</code>.</p>
- <a href="../Classes/Request/ResponseDisposition.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ResponseDisposition</span> <span class="p">:</span> <span class="kt">Sendable</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Protocol%20Conformances"></a>
- <a name="//apple_ref/swift/Section/Protocol Conformances" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Protocol%20Conformances"></a>
- <h3 class="section-name"><span>Protocol Conformances</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:SQ2eeoiySbx_xtFZ"></a>
- <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:SQ2eeoiySbx_xtFZ">==(_:<wbr>_:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">Bool</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:SH4hash4intoys6HasherVz_tF"></a>
- <a name="//apple_ref/swift/Method/hash(into:)" class="dashAnchor"></a>
- <a class="token" href="#/s:SH4hash4intoys6HasherVz_tF">hash(into:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC11descriptionSSvp"></a>
- <a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC11descriptionSSvp">description</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- created, as well as the response status code, if a response has been received.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15cURLDescriptionSSyF"></a>
- <a name="//apple_ref/swift/Method/cURLDescription()" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15cURLDescriptionSSyF">cURLDescription()</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>cURL representation of the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt">String</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The cURL equivalent of the instance.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Request%20Event%20Streams"></a>
- <a name="//apple_ref/swift/Section/Request Event Streams" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Request%20Event%20Streams"></a>
- <h3 class="section-name"><span>Request Event Streams</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC14uploadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF"></a>
- <a name="//apple_ref/swift/Method/uploadProgress(bufferingPolicy:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC14uploadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF">uploadProgress(bufferingPolicy:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf<Progress></a></code> for the instance’s upload progress.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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"><</span><span class="kt">Progress</span><span class="o">>.</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">-></span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o"><</span><span class="kt">Progress</span><span class="o">></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>bufferingPolicy</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>BufferingPolicy</code> that determines the stream’s buffering behavior.<code>.unbounded</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Structs/StreamOf.html">StreamOf<Progress></a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC16downloadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF"></a>
- <a name="//apple_ref/swift/Method/downloadProgress(bufferingPolicy:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC16downloadProgress15bufferingPolicyAA8StreamOfVySo10NSProgressCGScS12ContinuationV09BufferingF0OyAI__G_tF">downloadProgress(bufferingPolicy:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf<Progress></a></code> for the instance’s download progress.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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"><</span><span class="kt">Progress</span><span class="o">>.</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">-></span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o"><</span><span class="kt">Progress</span><span class="o">></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>bufferingPolicy</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>BufferingPolicy</code> that determines the stream’s buffering behavior.<code>.unbounded</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Structs/StreamOf.html">StreamOf<Progress></a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC11urlRequests15bufferingPolicyAA8StreamOfVy10Foundation10URLRequestVGScS12ContinuationV09BufferingF0OyAJ__G_tF"></a>
- <a name="//apple_ref/swift/Method/urlRequests(bufferingPolicy:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC11urlRequests15bufferingPolicyAA8StreamOfVy10Foundation10URLRequestVGScS12ContinuationV09BufferingF0OyAJ__G_tF">urlRequests(bufferingPolicy:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf<URLRequest></a></code> for the <code>URLRequest</code>s produced for the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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"><</span><span class="kt">URLRequest</span><span class="o">>.</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">-></span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o"><</span><span class="kt">URLRequest</span><span class="o">></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>bufferingPolicy</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>BufferingPolicy</code> that determines the stream’s buffering behavior.<code>.unbounded</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Structs/StreamOf.html">StreamOf<URLRequest></a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC15urlSessionTasks15bufferingPolicyAA8StreamOfVySo16NSURLSessionTaskCGScS12ContinuationV09BufferingG0OyAI__G_tF"></a>
- <a name="//apple_ref/swift/Method/urlSessionTasks(bufferingPolicy:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC15urlSessionTasks15bufferingPolicyAA8StreamOfVySo16NSURLSessionTaskCGScS12ContinuationV09BufferingG0OyAI__G_tF">urlSessionTasks(bufferingPolicy:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf<URLSessionTask></a></code> for the <code>URLSessionTask</code>s produced for the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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"><</span><span class="kt">URLSessionTask</span><span class="o">>.</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">-></span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o"><</span><span class="kt">URLSessionTask</span><span class="o">></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>bufferingPolicy</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>BufferingPolicy</code> that determines the stream’s buffering behavior.<code>.unbounded</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Structs/StreamOf.html">StreamOf<URLSessionTask></a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC16cURLDescriptions15bufferingPolicyAA8StreamOfVySSGScS12ContinuationV09BufferingE0OySS__G_tF"></a>
- <a name="//apple_ref/swift/Method/cURLDescriptions(bufferingPolicy:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC16cURLDescriptions15bufferingPolicyAA8StreamOfVySSGScS12ContinuationV09BufferingE0OySS__G_tF">cURLDescriptions(bufferingPolicy:<wbr>)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Structs/StreamOf.html">StreamOf<String></a></code> for the cURL descriptions produced for the instance.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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"><</span><span class="kt">String</span><span class="o">>.</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">-></span> <span class="kt"><a href="../Structs/StreamOf.html">StreamOf</a></span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>bufferingPolicy</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>BufferingPolicy</code> that determines the stream’s buffering behavior.<code>.unbounded</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The <code><a href="../Structs/StreamOf.html">StreamOf<String></a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Helper%20Types"></a>
- <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
- <div class="section-name-container">
- <a class="section-name-link" href="#/Helper%20Types"></a>
- <h3 class="section-name"><span>Helper Types</span>
- </h3>
- </div>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7RequestC16ValidationResulta"></a>
- <a name="//apple_ref/swift/Alias/ValidationResult" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7RequestC16ValidationResulta">ValidationResult</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Used to represent whether a validation succeeded or failed.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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"><</span><span class="kt">Void</span><span class="p">,</span> <span class="n">any</span> <span class="kt">Error</span><span class="o">></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </div>
- </section>
- </article>
- </div>
- <section class="footer">
- <p>© 2024 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2024-10-19)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
- </section>
- </body>
- </html>
|