Session.html 258 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>Session Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/Session" class="dashAnchor"></a>
  16. <a title="Session Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire 5.6.4 Docs
  21. </a>
  22. (97% documented)
  23. </p>
  24. <div class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </div>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png" alt="GitHub"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire.github.io%2FAlamofire%2Fdocsets%2FAlamofire.xml">
  37. <img class="header-icon" src="../img/dash.png" alt="Dash"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" alt=""/>
  45. Session Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor.html">AuthenticationInterceptor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/AuthenticationInterceptor/RefreshWindow.html">– RefreshWindow</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DataStreamRequest.html">DataStreamRequest</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Stream.html">– Stream</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Event.html">– Event</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/Completion.html">– Completion</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/DataStreamRequest/CancellationToken.html">– CancellationToken</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/DisabledTrustEvaluator.html">DisabledTrustEvaluator</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  205. </li>
  206. </ul>
  207. </li>
  208. <li class="nav-group-name">
  209. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  210. <ul class="nav-group-tasks">
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Enums/AFError/UnexpectedInputStreamLength.html">– UnexpectedInputStreamLength</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Enums/AuthenticationError.html">AuthenticationError</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  251. </li>
  252. </ul>
  253. </li>
  254. <li class="nav-group-name">
  255. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  256. <ul class="nav-group-tasks">
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation19PropertyListDecoderC">PropertyListDecoder</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  310. </li>
  311. </ul>
  312. </li>
  313. <li class="nav-group-name">
  314. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  315. <ul class="nav-group-tasks">
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/AuthenticationCredential.html">AuthenticationCredential</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/Authenticator.html">Authenticator</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/DataStreamSerializer.html">DataStreamSerializer</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  381. </li>
  382. <li class="nav-group-task">
  383. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  384. </li>
  385. <li class="nav-group-task">
  386. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  387. </li>
  388. </ul>
  389. </li>
  390. <li class="nav-group-name">
  391. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  392. <ul class="nav-group-tasks">
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/DataResponsePublisher.html">DataResponsePublisher</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/DataStreamPublisher.html">DataStreamPublisher</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/DataStreamTask.html">DataStreamTask</a>
  407. </li>
  408. <li class="nav-group-task">
  409. <a class="nav-group-task-link" href="../Structs/DataTask.html">DataTask</a>
  410. </li>
  411. <li class="nav-group-task">
  412. <a class="nav-group-task-link" href="../Structs/DecodableStreamSerializer.html">DecodableStreamSerializer</a>
  413. </li>
  414. <li class="nav-group-task">
  415. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  416. </li>
  417. <li class="nav-group-task">
  418. <a class="nav-group-task-link" href="../Structs/DownloadResponsePublisher.html">DownloadResponsePublisher</a>
  419. </li>
  420. <li class="nav-group-task">
  421. <a class="nav-group-task-link" href="../Structs/DownloadTask.html">DownloadTask</a>
  422. </li>
  423. <li class="nav-group-task">
  424. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  425. </li>
  426. <li class="nav-group-task">
  427. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  428. </li>
  429. <li class="nav-group-task">
  430. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  431. </li>
  432. <li class="nav-group-task">
  433. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  434. </li>
  435. <li class="nav-group-task">
  436. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  437. </li>
  438. <li class="nav-group-task">
  439. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  440. </li>
  441. <li class="nav-group-task">
  442. <a class="nav-group-task-link" href="../Structs/JSONEncoding/Error.html">– Error</a>
  443. </li>
  444. <li class="nav-group-task">
  445. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  446. </li>
  447. <li class="nav-group-task">
  448. <a class="nav-group-task-link" href="../Structs/PassthroughStreamSerializer.html">PassthroughStreamSerializer</a>
  449. </li>
  450. <li class="nav-group-task">
  451. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  452. </li>
  453. <li class="nav-group-task">
  454. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  455. </li>
  456. <li class="nav-group-task">
  457. <a class="nav-group-task-link" href="../Structs/RequestAdapterState.html">RequestAdapterState</a>
  458. </li>
  459. <li class="nav-group-task">
  460. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  461. </li>
  462. <li class="nav-group-task">
  463. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  464. </li>
  465. <li class="nav-group-task">
  466. <a class="nav-group-task-link" href="../Structs/StreamOf.html">StreamOf</a>
  467. </li>
  468. <li class="nav-group-task">
  469. <a class="nav-group-task-link" href="../Structs/StreamOf/Iterator.html">– Iterator</a>
  470. </li>
  471. <li class="nav-group-task">
  472. <a class="nav-group-task-link" href="../Structs/StringStreamSerializer.html">StringStreamSerializer</a>
  473. </li>
  474. <li class="nav-group-task">
  475. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  476. </li>
  477. <li class="nav-group-task">
  478. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  479. </li>
  480. <li class="nav-group-task">
  481. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  482. </li>
  483. <li class="nav-group-task">
  484. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  485. </li>
  486. <li class="nav-group-task">
  487. <a class="nav-group-task-link" href="../Structs/URLResponseSerializer.html">URLResponseSerializer</a>
  488. </li>
  489. </ul>
  490. </li>
  491. <li class="nav-group-name">
  492. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  493. <ul class="nav-group-tasks">
  494. <li class="nav-group-task">
  495. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  496. </li>
  497. <li class="nav-group-task">
  498. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  499. </li>
  500. <li class="nav-group-task">
  501. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  502. </li>
  503. <li class="nav-group-task">
  504. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  505. </li>
  506. <li class="nav-group-task">
  507. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire17DisabledEvaluatora">DisabledEvaluator</a>
  508. </li>
  509. <li class="nav-group-task">
  510. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  511. </li>
  512. <li class="nav-group-task">
  513. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  514. </li>
  515. </ul>
  516. </li>
  517. </ul>
  518. </nav>
  519. <article class="main-content">
  520. <section class="section">
  521. <div class="section-content top-matter">
  522. <h1>Session</h1>
  523. <div class="declaration">
  524. <div class="language">
  525. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Session</span></code></pre>
  526. <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Session</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestDelegate.html">RequestDelegate</a></span></code></pre>
  527. </div>
  528. </div>
  529. <p><code>Session</code> creates and manages Alamofire&rsquo;s <code><a href="../Classes/Request.html">Request</a></code> types during their lifetimes. It also provides common
  530. functionality for all <code><a href="../Classes/Request.html">Request</a></code>s, including queuing, interception, trust management, redirect handling, and response
  531. cache handling.</p>
  532. </div>
  533. </section>
  534. <section class="section">
  535. <div class="section-content">
  536. <div class="task-group">
  537. <ul class="item-container">
  538. <li class="item">
  539. <div>
  540. <code>
  541. <a name="/s:9Alamofire7SessionC7defaultACvpZ"></a>
  542. <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
  543. <a class="token" href="#/s:9Alamofire7SessionC7defaultACvpZ">default</a>
  544. </code>
  545. </div>
  546. <div class="height-container">
  547. <div class="pointer-container"></div>
  548. <section class="section">
  549. <div class="pointer"></div>
  550. <div class="abstract">
  551. <p>Shared singleton instance used by all <code>AF.request</code> APIs. Cannot be modified.</p>
  552. </div>
  553. <div class="declaration">
  554. <h4>Declaration</h4>
  555. <div class="language">
  556. <p class="aside-title">Swift</p>
  557. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">let</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">:</span> <span class="kt">Session</span></code></pre>
  558. </div>
  559. </div>
  560. </section>
  561. </div>
  562. </li>
  563. <li class="item">
  564. <div>
  565. <code>
  566. <a name="/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp"></a>
  567. <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
  568. <a class="token" href="#/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp">session</a>
  569. </code>
  570. </div>
  571. <div class="height-container">
  572. <div class="pointer-container"></div>
  573. <section class="section">
  574. <div class="pointer"></div>
  575. <div class="abstract">
  576. <p>Underlying <code>URLSession</code> used to create <code>URLSessionTasks</code> for this instance, and for which this instance&rsquo;s
  577. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC8delegateAA0B8DelegateCvp">delegate</a></code> handles <code>URLSessionDelegate</code> callbacks.</p>
  578. <div class="aside aside-note">
  579. <p class="aside-title">Note</p>
  580. This instance should <strong>NOT</strong> be used to interact with the underlying <code>URLSessionTask</code>s. Doing so will
  581. break internal Alamofire logic that tracks those tasks.
  582. </div>
  583. </div>
  584. <div class="declaration">
  585. <h4>Declaration</h4>
  586. <div class="language">
  587. <p class="aside-title">Swift</p>
  588. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span></code></pre>
  589. </div>
  590. </div>
  591. </section>
  592. </div>
  593. </li>
  594. <li class="item">
  595. <div>
  596. <code>
  597. <a name="/s:9Alamofire7SessionC8delegateAA0B8DelegateCvp"></a>
  598. <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
  599. <a class="token" href="#/s:9Alamofire7SessionC8delegateAA0B8DelegateCvp">delegate</a>
  600. </code>
  601. </div>
  602. <div class="height-container">
  603. <div class="pointer-container"></div>
  604. <section class="section">
  605. <div class="pointer"></div>
  606. <div class="abstract">
  607. <p>Instance&rsquo;s <code><a href="../Classes/SessionDelegate.html">SessionDelegate</a></code>, which handles the <code>URLSessionDelegate</code> methods and <code><a href="../Classes/Request.html">Request</a></code> interaction.</p>
  608. </div>
  609. <div class="declaration">
  610. <h4>Declaration</h4>
  611. <div class="language">
  612. <p class="aside-title">Swift</p>
  613. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SessionDelegate.html">SessionDelegate</a></span></code></pre>
  614. </div>
  615. </div>
  616. </section>
  617. </div>
  618. </li>
  619. <li class="item">
  620. <div>
  621. <code>
  622. <a name="/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp"></a>
  623. <a name="//apple_ref/swift/Property/rootQueue" class="dashAnchor"></a>
  624. <a class="token" href="#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a>
  625. </code>
  626. </div>
  627. <div class="height-container">
  628. <div class="pointer-container"></div>
  629. <section class="section">
  630. <div class="pointer"></div>
  631. <div class="abstract">
  632. <p>Root <code>DispatchQueue</code> for all internal callbacks and state update. <strong>MUST</strong> be a serial queue.</p>
  633. </div>
  634. <div class="declaration">
  635. <h4>Declaration</h4>
  636. <div class="language">
  637. <p class="aside-title">Swift</p>
  638. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">rootQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  639. </div>
  640. </div>
  641. </section>
  642. </div>
  643. </li>
  644. <li class="item">
  645. <div>
  646. <code>
  647. <a name="/s:9Alamofire7SessionC24startRequestsImmediatelySbvp"></a>
  648. <a name="//apple_ref/swift/Property/startRequestsImmediately" class="dashAnchor"></a>
  649. <a class="token" href="#/s:9Alamofire7SessionC24startRequestsImmediatelySbvp">startRequestsImmediately</a>
  650. </code>
  651. </div>
  652. <div class="height-container">
  653. <div class="pointer-container"></div>
  654. <section class="section">
  655. <div class="pointer"></div>
  656. <div class="abstract">
  657. <p>Value determining whether this instance automatically calls <code>resume()</code> on all created <code><a href="../Classes/Request.html">Request</a></code>s.</p>
  658. </div>
  659. <div class="declaration">
  660. <h4>Declaration</h4>
  661. <div class="language">
  662. <p class="aside-title">Swift</p>
  663. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
  664. </div>
  665. </div>
  666. </section>
  667. </div>
  668. </li>
  669. <li class="item">
  670. <div>
  671. <code>
  672. <a name="/s:9Alamofire7SessionC12requestQueueSo17OS_dispatch_queueCvp"></a>
  673. <a name="//apple_ref/swift/Property/requestQueue" class="dashAnchor"></a>
  674. <a class="token" href="#/s:9Alamofire7SessionC12requestQueueSo17OS_dispatch_queueCvp">requestQueue</a>
  675. </code>
  676. </div>
  677. <div class="height-container">
  678. <div class="pointer-container"></div>
  679. <section class="section">
  680. <div class="pointer"></div>
  681. <div class="abstract">
  682. <p><code>DispatchQueue</code> on which <code>URLRequest</code>s are created asynchronously. By default this queue uses <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> as its
  683. <code>target</code>, but a separate queue can be used if request creation is determined to be a bottleneck. Always profile
  684. and test before introducing an additional queue.</p>
  685. </div>
  686. <div class="declaration">
  687. <h4>Declaration</h4>
  688. <div class="language">
  689. <p class="aside-title">Swift</p>
  690. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">requestQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
  691. </div>
  692. </div>
  693. </section>
  694. </div>
  695. </li>
  696. <li class="item">
  697. <div>
  698. <code>
  699. <a name="/s:9Alamofire7SessionC18serializationQueueSo17OS_dispatch_queueCvp"></a>
  700. <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
  701. <a class="token" href="#/s:9Alamofire7SessionC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
  702. </code>
  703. </div>
  704. <div class="height-container">
  705. <div class="pointer-container"></div>
  706. <section class="section">
  707. <div class="pointer"></div>
  708. <div class="abstract">
  709. <p><code>DispatchQueue</code> passed to all <code><a href="../Classes/Request.html">Request</a></code>s on which they perform their response serialization. By default this
  710. queue uses <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> as its <code>target</code> but a separate queue can be used if response serialization is determined
  711. to be a bottleneck. Always profile and test before introducing an additional queue.</p>
  712. </div>
  713. <div class="declaration">
  714. <h4>Declaration</h4>
  715. <div class="language">
  716. <p class="aside-title">Swift</p>
  717. <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>
  718. </div>
  719. </div>
  720. </section>
  721. </div>
  722. </li>
  723. <li class="item">
  724. <div>
  725. <code>
  726. <a name="/s:9Alamofire7SessionC11interceptorAA18RequestInterceptor_pSgvp"></a>
  727. <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
  728. <a class="token" href="#/s:9Alamofire7SessionC11interceptorAA18RequestInterceptor_pSgvp">interceptor</a>
  729. </code>
  730. </div>
  731. <div class="height-container">
  732. <div class="pointer-container"></div>
  733. <section class="section">
  734. <div class="pointer"></div>
  735. <div class="abstract">
  736. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> used for all <code><a href="../Classes/Request.html">Request</a></code> created by the instance. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>s can also be set on a
  737. per-<code><a href="../Classes/Request.html">Request</a></code> basis, in which case the <code><a href="../Classes/Request.html">Request</a></code>&lsquo;s interceptor takes precedence over this value.</p>
  738. </div>
  739. <div class="declaration">
  740. <h4>Declaration</h4>
  741. <div class="language">
  742. <p class="aside-title">Swift</p>
  743. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span></code></pre>
  744. </div>
  745. </div>
  746. </section>
  747. </div>
  748. </li>
  749. <li class="item">
  750. <div>
  751. <code>
  752. <a name="/s:9Alamofire7SessionC18serverTrustManagerAA06ServerdE0CSgvp"></a>
  753. <a name="//apple_ref/swift/Property/serverTrustManager" class="dashAnchor"></a>
  754. <a class="token" href="#/s:9Alamofire7SessionC18serverTrustManagerAA06ServerdE0CSgvp">serverTrustManager</a>
  755. </code>
  756. </div>
  757. <div class="height-container">
  758. <div class="pointer-container"></div>
  759. <section class="section">
  760. <div class="pointer"></div>
  761. <div class="abstract">
  762. <p><code><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></code> instance used to evaluate all trust challenges and provide certificate and key pinning.</p>
  763. </div>
  764. <div class="declaration">
  765. <h4>Declaration</h4>
  766. <div class="language">
  767. <p class="aside-title">Swift</p>
  768. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serverTrustManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></span><span class="p">?</span></code></pre>
  769. </div>
  770. </div>
  771. </section>
  772. </div>
  773. </li>
  774. <li class="item">
  775. <div>
  776. <code>
  777. <a name="/s:9Alamofire7SessionC15redirectHandlerAA08RedirectD0_pSgvp"></a>
  778. <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
  779. <a class="token" href="#/s:9Alamofire7SessionC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
  780. </code>
  781. </div>
  782. <div class="height-container">
  783. <div class="pointer-container"></div>
  784. <section class="section">
  785. <div class="pointer"></div>
  786. <div class="abstract">
  787. <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> instance used to provide customization for request redirection.</p>
  788. </div>
  789. <div class="declaration">
  790. <h4>Declaration</h4>
  791. <div class="language">
  792. <p class="aside-title">Swift</p>
  793. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">redirectHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">?</span></code></pre>
  794. </div>
  795. </div>
  796. </section>
  797. </div>
  798. </li>
  799. <li class="item">
  800. <div>
  801. <code>
  802. <a name="/s:9Alamofire7SessionC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
  803. <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
  804. <a class="token" href="#/s:9Alamofire7SessionC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
  805. </code>
  806. </div>
  807. <div class="height-container">
  808. <div class="pointer-container"></div>
  809. <section class="section">
  810. <div class="pointer"></div>
  811. <div class="abstract">
  812. <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> instance used to provide customization of cached response handling.</p>
  813. </div>
  814. <div class="declaration">
  815. <h4>Declaration</h4>
  816. <div class="language">
  817. <p class="aside-title">Swift</p>
  818. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">?</span></code></pre>
  819. </div>
  820. </div>
  821. </section>
  822. </div>
  823. </li>
  824. <li class="item">
  825. <div>
  826. <code>
  827. <a name="/s:9Alamofire7SessionC12eventMonitorAA014CompositeEventD0Cvp"></a>
  828. <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
  829. <a class="token" href="#/s:9Alamofire7SessionC12eventMonitorAA014CompositeEventD0Cvp">eventMonitor</a>
  830. </code>
  831. </div>
  832. <div class="height-container">
  833. <div class="pointer-container"></div>
  834. <section class="section">
  835. <div class="pointer"></div>
  836. <div class="abstract">
  837. <p><code><a href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a></code> used to compose Alamofire&rsquo;s <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC20defaultEventMonitorsSayAA0D7Monitor_pGvp">defaultEventMonitors</a></code> and any passed <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s.</p>
  838. </div>
  839. <div class="declaration">
  840. <h4>Declaration</h4>
  841. <div class="language">
  842. <p class="aside-title">Swift</p>
  843. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a></span></code></pre>
  844. </div>
  845. </div>
  846. </section>
  847. </div>
  848. </li>
  849. <li class="item">
  850. <div>
  851. <code>
  852. <a name="/s:9Alamofire7SessionC20defaultEventMonitorsSayAA0D7Monitor_pGvp"></a>
  853. <a name="//apple_ref/swift/Property/defaultEventMonitors" class="dashAnchor"></a>
  854. <a class="token" href="#/s:9Alamofire7SessionC20defaultEventMonitorsSayAA0D7Monitor_pGvp">defaultEventMonitors</a>
  855. </code>
  856. </div>
  857. <div class="height-container">
  858. <div class="pointer-container"></div>
  859. <section class="section">
  860. <div class="pointer"></div>
  861. <div class="abstract">
  862. <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s included in all instances. <code>[AlamofireNotifications()]</code> by default.</p>
  863. </div>
  864. <div class="declaration">
  865. <h4>Declaration</h4>
  866. <div class="language">
  867. <p class="aside-title">Swift</p>
  868. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">defaultEventMonitors</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">]</span></code></pre>
  869. </div>
  870. </div>
  871. </section>
  872. </div>
  873. </li>
  874. <li class="item">
  875. <div>
  876. <code>
  877. <a name="/s:9Alamofire7SessionC7session8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo12NSURLSessionC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc"></a>
  878. <a name="//apple_ref/swift/Method/init(session:delegate:rootQueue:startRequestsImmediately:requestQueue:serializationQueue:interceptor:serverTrustManager:redirectHandler:cachedResponseHandler:eventMonitors:)" class="dashAnchor"></a>
  879. <a class="token" href="#/s:9Alamofire7SessionC7session8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo12NSURLSessionC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc">init(session:<wbr>delegate:<wbr>rootQueue:<wbr>startRequestsImmediately:<wbr>requestQueue:<wbr>serializationQueue:<wbr>interceptor:<wbr>serverTrustManager:<wbr>redirectHandler:<wbr>cachedResponseHandler:<wbr>eventMonitors:<wbr>)</a>
  880. </code>
  881. </div>
  882. <div class="height-container">
  883. <div class="pointer-container"></div>
  884. <section class="section">
  885. <div class="pointer"></div>
  886. <div class="abstract">
  887. <p>Creates a <code>Session</code> from a <code>URLSession</code> and other parameters.</p>
  888. <div class="aside aside-note">
  889. <p class="aside-title">Note</p>
  890. <p>When passing a <code>URLSession</code>, you must create the <code>URLSession</code> with a specific <code>delegateQueue</code> value and
  891. pass the <code>delegateQueue</code>&lsquo;s <code>underlyingQueue</code> as the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> parameter of this initializer.</p>
  892. </div>
  893. </div>
  894. <div class="declaration">
  895. <h4>Declaration</h4>
  896. <div class="language">
  897. <p class="aside-title">Swift</p>
  898. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">,</span>
  899. <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SessionDelegate.html">SessionDelegate</a></span><span class="p">,</span>
  900. <span class="nv">rootQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
  901. <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
  902. <span class="nv">requestQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  903. <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  904. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  905. <span class="nv">serverTrustManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  906. <span class="nv">redirectHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  907. <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  908. <span class="nv">eventMonitors</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[])</span></code></pre>
  909. </div>
  910. </div>
  911. <div>
  912. <h4>Parameters</h4>
  913. <table class="graybox">
  914. <tbody>
  915. <tr>
  916. <td>
  917. <code>
  918. <em>session</em>
  919. </code>
  920. </td>
  921. <td>
  922. <div>
  923. <p>Underlying <code>URLSession</code> for this instance.</p>
  924. </div>
  925. </td>
  926. </tr>
  927. <tr>
  928. <td>
  929. <code>
  930. <em>delegate</em>
  931. </code>
  932. </td>
  933. <td>
  934. <div>
  935. <p><code><a href="../Classes/SessionDelegate.html">SessionDelegate</a></code> that handles <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp">session</a></code>&lsquo;s delegate callbacks as well as <code><a href="../Classes/Request.html">Request</a></code>
  936. interaction.</p>
  937. </div>
  938. </td>
  939. </tr>
  940. <tr>
  941. <td>
  942. <code>
  943. <em>rootQueue</em>
  944. </code>
  945. </td>
  946. <td>
  947. <div>
  948. <p>Root <code>DispatchQueue</code> for all internal callbacks and state updates. <strong>MUST</strong> be a
  949. serial queue.</p>
  950. </div>
  951. </td>
  952. </tr>
  953. <tr>
  954. <td>
  955. <code>
  956. <em>startRequestsImmediately</em>
  957. </code>
  958. </td>
  959. <td>
  960. <div>
  961. <p>Determines whether this instance will automatically start all <code><a href="../Classes/Request.html">Request</a></code>s. <code>true</code>
  962. by default. If set to <code>false</code>, all <code><a href="../Classes/Request.html">Request</a></code>s created must have <code>.resume()</code> called.
  963. on them for them to start.</p>
  964. </div>
  965. </td>
  966. </tr>
  967. <tr>
  968. <td>
  969. <code>
  970. <em>requestQueue</em>
  971. </code>
  972. </td>
  973. <td>
  974. <div>
  975. <p><code>DispatchQueue</code> on which to perform <code>URLRequest</code> creation. By default this queue
  976. will use the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> as its <code>target</code>. A separate queue can be used if it&rsquo;s
  977. determined request creation is a bottleneck, but that should only be done after
  978. careful testing and profiling. <code>nil</code> by default.</p>
  979. </div>
  980. </td>
  981. </tr>
  982. <tr>
  983. <td>
  984. <code>
  985. <em>serializationQueue</em>
  986. </code>
  987. </td>
  988. <td>
  989. <div>
  990. <p><code>DispatchQueue</code> on which to perform all response serialization. By default this
  991. queue will use the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> as its <code>target</code>. A separate queue can be used if
  992. it&rsquo;s determined response serialization is a bottleneck, but that should only be
  993. done after careful testing and profiling. <code>nil</code> by default.</p>
  994. </div>
  995. </td>
  996. </tr>
  997. <tr>
  998. <td>
  999. <code>
  1000. <em>interceptor</em>
  1001. </code>
  1002. </td>
  1003. <td>
  1004. <div>
  1005. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> to be used for all <code><a href="../Classes/Request.html">Request</a></code>s created by this instance. <code>nil</code>
  1006. by default.</p>
  1007. </div>
  1008. </td>
  1009. </tr>
  1010. <tr>
  1011. <td>
  1012. <code>
  1013. <em>serverTrustManager</em>
  1014. </code>
  1015. </td>
  1016. <td>
  1017. <div>
  1018. <p><code><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></code> to be used for all trust evaluations by this instance. <code>nil</code>
  1019. by default.</p>
  1020. </div>
  1021. </td>
  1022. </tr>
  1023. <tr>
  1024. <td>
  1025. <code>
  1026. <em>redirectHandler</em>
  1027. </code>
  1028. </td>
  1029. <td>
  1030. <div>
  1031. <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> to be used by all <code><a href="../Classes/Request.html">Request</a></code>s created by this instance. <code>nil</code> by
  1032. default.</p>
  1033. </div>
  1034. </td>
  1035. </tr>
  1036. <tr>
  1037. <td>
  1038. <code>
  1039. <em>cachedResponseHandler</em>
  1040. </code>
  1041. </td>
  1042. <td>
  1043. <div>
  1044. <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> to be used by all <code><a href="../Classes/Request.html">Request</a></code>s created by this instance.
  1045. <code>nil</code> by default.</p>
  1046. </div>
  1047. </td>
  1048. </tr>
  1049. <tr>
  1050. <td>
  1051. <code>
  1052. <em>eventMonitors</em>
  1053. </code>
  1054. </td>
  1055. <td>
  1056. <div>
  1057. <p>Additional <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s used by the instance. Alamofire always adds a
  1058. <code><a href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a></code> <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> to the array passed here. <code>[]</code> by default.</p>
  1059. </div>
  1060. </td>
  1061. </tr>
  1062. </tbody>
  1063. </table>
  1064. </div>
  1065. </section>
  1066. </div>
  1067. </li>
  1068. <li class="item">
  1069. <div>
  1070. <code>
  1071. <a name="/s:9Alamofire7SessionC13configuration8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo25NSURLSessionConfigurationC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc"></a>
  1072. <a name="//apple_ref/swift/Method/init(configuration:delegate:rootQueue:startRequestsImmediately:requestQueue:serializationQueue:interceptor:serverTrustManager:redirectHandler:cachedResponseHandler:eventMonitors:)" class="dashAnchor"></a>
  1073. <a class="token" href="#/s:9Alamofire7SessionC13configuration8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo25NSURLSessionConfigurationC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc">init(configuration:<wbr>delegate:<wbr>rootQueue:<wbr>startRequestsImmediately:<wbr>requestQueue:<wbr>serializationQueue:<wbr>interceptor:<wbr>serverTrustManager:<wbr>redirectHandler:<wbr>cachedResponseHandler:<wbr>eventMonitors:<wbr>)</a>
  1074. </code>
  1075. </div>
  1076. <div class="height-container">
  1077. <div class="pointer-container"></div>
  1078. <section class="section">
  1079. <div class="pointer"></div>
  1080. <div class="abstract">
  1081. <p>Creates a <code>Session</code> from a <code>URLSessionConfiguration</code>.</p>
  1082. <div class="aside aside-note">
  1083. <p class="aside-title">Note</p>
  1084. <p>This initializer lets Alamofire handle the creation of the underlying <code>URLSession</code> and its
  1085. <code>delegateQueue</code>, and is the recommended initializer for most uses.</p>
  1086. </div>
  1087. </div>
  1088. <div class="declaration">
  1089. <h4>Declaration</h4>
  1090. <div class="language">
  1091. <p class="aside-title">Swift</p>
  1092. <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">configuration</span><span class="p">:</span> <span class="kt">URLSessionConfiguration</span> <span class="o">=</span> <span class="kt">URLSessionConfiguration</span><span class="o">.</span><span class="n">af</span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  1093. <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SessionDelegate.html">SessionDelegate</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/SessionDelegate.html">SessionDelegate</a></span><span class="p">(),</span>
  1094. <span class="nv">rootQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="o">=</span> <span class="kt">DispatchQueue</span><span class="p">(</span><span class="nv">label</span><span class="p">:</span> <span class="s">"org.alamofire.session.rootQueue"</span><span class="p">),</span>
  1095. <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span>
  1096. <span class="nv">requestQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1097. <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1098. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1099. <span class="nv">serverTrustManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1100. <span class="nv">redirectHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1101. <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1102. <span class="nv">eventMonitors</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/EventMonitor.html">EventMonitor</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[])</span></code></pre>
  1103. </div>
  1104. </div>
  1105. <div>
  1106. <h4>Parameters</h4>
  1107. <table class="graybox">
  1108. <tbody>
  1109. <tr>
  1110. <td>
  1111. <code>
  1112. <em>configuration</em>
  1113. </code>
  1114. </td>
  1115. <td>
  1116. <div>
  1117. <p><code>URLSessionConfiguration</code> to be used to create the underlying <code>URLSession</code>. Changes
  1118. to this value after being passed to this initializer will have no effect.
  1119. <code>URLSessionConfiguration.af.default</code> by default.</p>
  1120. </div>
  1121. </td>
  1122. </tr>
  1123. <tr>
  1124. <td>
  1125. <code>
  1126. <em>delegate</em>
  1127. </code>
  1128. </td>
  1129. <td>
  1130. <div>
  1131. <p><code><a href="../Classes/SessionDelegate.html">SessionDelegate</a></code> that handles <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp">session</a></code>&lsquo;s delegate callbacks as well as <code><a href="../Classes/Request.html">Request</a></code>
  1132. interaction. <code>SessionDelegate()</code> by default.</p>
  1133. </div>
  1134. </td>
  1135. </tr>
  1136. <tr>
  1137. <td>
  1138. <code>
  1139. <em>rootQueue</em>
  1140. </code>
  1141. </td>
  1142. <td>
  1143. <div>
  1144. <p>Root <code>DispatchQueue</code> for all internal callbacks and state updates. <strong>MUST</strong> be a
  1145. serial queue. <code>DispatchQueue(label: &quot;org.alamofire.session.rootQueue&quot;)</code> by default.</p>
  1146. </div>
  1147. </td>
  1148. </tr>
  1149. <tr>
  1150. <td>
  1151. <code>
  1152. <em>startRequestsImmediately</em>
  1153. </code>
  1154. </td>
  1155. <td>
  1156. <div>
  1157. <p>Determines whether this instance will automatically start all <code><a href="../Classes/Request.html">Request</a></code>s. <code>true</code>
  1158. by default. If set to <code>false</code>, all <code><a href="../Classes/Request.html">Request</a></code>s created must have <code>.resume()</code> called.
  1159. on them for them to start.</p>
  1160. </div>
  1161. </td>
  1162. </tr>
  1163. <tr>
  1164. <td>
  1165. <code>
  1166. <em>requestQueue</em>
  1167. </code>
  1168. </td>
  1169. <td>
  1170. <div>
  1171. <p><code>DispatchQueue</code> on which to perform <code>URLRequest</code> creation. By default this queue
  1172. will use the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> as its <code>target</code>. A separate queue can be used if it&rsquo;s
  1173. determined request creation is a bottleneck, but that should only be done after
  1174. careful testing and profiling. <code>nil</code> by default.</p>
  1175. </div>
  1176. </td>
  1177. </tr>
  1178. <tr>
  1179. <td>
  1180. <code>
  1181. <em>serializationQueue</em>
  1182. </code>
  1183. </td>
  1184. <td>
  1185. <div>
  1186. <p><code>DispatchQueue</code> on which to perform all response serialization. By default this
  1187. queue will use the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> as its <code>target</code>. A separate queue can be used if
  1188. it&rsquo;s determined response serialization is a bottleneck, but that should only be
  1189. done after careful testing and profiling. <code>nil</code> by default.</p>
  1190. </div>
  1191. </td>
  1192. </tr>
  1193. <tr>
  1194. <td>
  1195. <code>
  1196. <em>interceptor</em>
  1197. </code>
  1198. </td>
  1199. <td>
  1200. <div>
  1201. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> to be used for all <code><a href="../Classes/Request.html">Request</a></code>s created by this instance. <code>nil</code>
  1202. by default.</p>
  1203. </div>
  1204. </td>
  1205. </tr>
  1206. <tr>
  1207. <td>
  1208. <code>
  1209. <em>serverTrustManager</em>
  1210. </code>
  1211. </td>
  1212. <td>
  1213. <div>
  1214. <p><code><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></code> to be used for all trust evaluations by this instance. <code>nil</code>
  1215. by default.</p>
  1216. </div>
  1217. </td>
  1218. </tr>
  1219. <tr>
  1220. <td>
  1221. <code>
  1222. <em>redirectHandler</em>
  1223. </code>
  1224. </td>
  1225. <td>
  1226. <div>
  1227. <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> to be used by all <code><a href="../Classes/Request.html">Request</a></code>s created by this instance. <code>nil</code> by
  1228. default.</p>
  1229. </div>
  1230. </td>
  1231. </tr>
  1232. <tr>
  1233. <td>
  1234. <code>
  1235. <em>cachedResponseHandler</em>
  1236. </code>
  1237. </td>
  1238. <td>
  1239. <div>
  1240. <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> to be used by all <code><a href="../Classes/Request.html">Request</a></code>s created by this instance.
  1241. <code>nil</code> by default.</p>
  1242. </div>
  1243. </td>
  1244. </tr>
  1245. <tr>
  1246. <td>
  1247. <code>
  1248. <em>eventMonitors</em>
  1249. </code>
  1250. </td>
  1251. <td>
  1252. <div>
  1253. <p>Additional <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s used by the instance. Alamofire always adds a
  1254. <code><a href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a></code> <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code> to the array passed here. <code>[]</code> by default.</p>
  1255. </div>
  1256. </td>
  1257. </tr>
  1258. </tbody>
  1259. </table>
  1260. </div>
  1261. </section>
  1262. </div>
  1263. </li>
  1264. </ul>
  1265. </div>
  1266. <div class="task-group">
  1267. <div class="task-name-container">
  1268. <a name="/All%20Requests%20API"></a>
  1269. <a name="//apple_ref/swift/Section/All Requests API" class="dashAnchor"></a>
  1270. <div class="section-name-container">
  1271. <a class="section-name-link" href="#/All%20Requests%20API"></a>
  1272. <h3 class="section-name"><span>All Requests API</span>
  1273. </h3>
  1274. </div>
  1275. </div>
  1276. <ul class="item-container">
  1277. <li class="item">
  1278. <div>
  1279. <code>
  1280. <a name="/s:9Alamofire7SessionC15withAllRequests7performyyShyAA7RequestCGc_tF"></a>
  1281. <a name="//apple_ref/swift/Method/withAllRequests(perform:)" class="dashAnchor"></a>
  1282. <a class="token" href="#/s:9Alamofire7SessionC15withAllRequests7performyyShyAA7RequestCGc_tF">withAllRequests(perform:<wbr>)</a>
  1283. </code>
  1284. </div>
  1285. <div class="height-container">
  1286. <div class="pointer-container"></div>
  1287. <section class="section">
  1288. <div class="pointer"></div>
  1289. <div class="abstract">
  1290. <p>Perform an action on all active <code><a href="../Classes/Request.html">Request</a></code>s.</p>
  1291. <div class="aside aside-note">
  1292. <p class="aside-title">Note</p>
  1293. <p>The provided <code>action</code> closure is performed asynchronously, meaning that some <code><a href="../Classes/Request.html">Request</a></code>s may complete and
  1294. be unavailable by time it runs. Additionally, this action is performed on the instances&rsquo;s <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code>,
  1295. so care should be taken that actions are fast. Once the work on the <code><a href="../Classes/Request.html">Request</a></code>s is complete, any
  1296. additional work should be performed on another queue.</p>
  1297. </div>
  1298. </div>
  1299. <div class="declaration">
  1300. <h4>Declaration</h4>
  1301. <div class="language">
  1302. <p class="aside-title">Swift</p>
  1303. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">withAllRequests</span><span class="p">(</span><span class="n">perform</span> <span class="nv">action</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  1304. </div>
  1305. </div>
  1306. <div>
  1307. <h4>Parameters</h4>
  1308. <table class="graybox">
  1309. <tbody>
  1310. <tr>
  1311. <td>
  1312. <code>
  1313. <em>action</em>
  1314. </code>
  1315. </td>
  1316. <td>
  1317. <div>
  1318. <p>Closure to perform with all <code><a href="../Classes/Request.html">Request</a></code>s.</p>
  1319. </div>
  1320. </td>
  1321. </tr>
  1322. </tbody>
  1323. </table>
  1324. </div>
  1325. </section>
  1326. </div>
  1327. </li>
  1328. <li class="item">
  1329. <div>
  1330. <code>
  1331. <a name="/s:9Alamofire7SessionC17cancelAllRequests17completingOnQueue10completionySo17OS_dispatch_queueC_yycSgtF"></a>
  1332. <a name="//apple_ref/swift/Method/cancelAllRequests(completingOnQueue:completion:)" class="dashAnchor"></a>
  1333. <a class="token" href="#/s:9Alamofire7SessionC17cancelAllRequests17completingOnQueue10completionySo17OS_dispatch_queueC_yycSgtF">cancelAllRequests(completingOnQueue:<wbr>completion:<wbr>)</a>
  1334. </code>
  1335. </div>
  1336. <div class="height-container">
  1337. <div class="pointer-container"></div>
  1338. <section class="section">
  1339. <div class="pointer"></div>
  1340. <div class="abstract">
  1341. <p>Cancel all active <code><a href="../Classes/Request.html">Request</a></code>s, optionally calling a completion handler when complete.</p>
  1342. <div class="aside aside-note">
  1343. <p class="aside-title">Note</p>
  1344. <p>This is an asynchronous operation and does not block the creation of future <code><a href="../Classes/Request.html">Request</a></code>s. Cancelled
  1345. <code><a href="../Classes/Request.html">Request</a></code>s may not cancel immediately due internal work, and may not cancel at all if they are close to
  1346. completion when cancelled.</p>
  1347. </div>
  1348. </div>
  1349. <div class="declaration">
  1350. <h4>Declaration</h4>
  1351. <div class="language">
  1352. <p class="aside-title">Swift</p>
  1353. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cancelAllRequests</span><span class="p">(</span><span class="n">completingOnQueue</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">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
  1354. </div>
  1355. </div>
  1356. <div>
  1357. <h4>Parameters</h4>
  1358. <table class="graybox">
  1359. <tbody>
  1360. <tr>
  1361. <td>
  1362. <code>
  1363. <em>queue</em>
  1364. </code>
  1365. </td>
  1366. <td>
  1367. <div>
  1368. <p><code>DispatchQueue</code> on which the completion handler is run. <code>.main</code> by default.</p>
  1369. </div>
  1370. </td>
  1371. </tr>
  1372. <tr>
  1373. <td>
  1374. <code>
  1375. <em>completion</em>
  1376. </code>
  1377. </td>
  1378. <td>
  1379. <div>
  1380. <p>Closure to be called when all <code><a href="../Classes/Request.html">Request</a></code>s have been cancelled.</p>
  1381. </div>
  1382. </td>
  1383. </tr>
  1384. </tbody>
  1385. </table>
  1386. </div>
  1387. </section>
  1388. </div>
  1389. </li>
  1390. </ul>
  1391. </div>
  1392. <div class="task-group">
  1393. <div class="task-name-container">
  1394. <a name="/DataRequest"></a>
  1395. <a name="//apple_ref/swift/Section/DataRequest" class="dashAnchor"></a>
  1396. <div class="section-name-container">
  1397. <a class="section-name-link" href="#/DataRequest"></a>
  1398. <h3 class="section-name"><span>DataRequest</span>
  1399. </h3>
  1400. </div>
  1401. </div>
  1402. <ul class="item-container">
  1403. <li class="item">
  1404. <div>
  1405. <code>
  1406. <a name="/s:9Alamofire7SessionC15RequestModifiera"></a>
  1407. <a name="//apple_ref/swift/Alias/RequestModifier" class="dashAnchor"></a>
  1408. <a class="token" href="#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a>
  1409. </code>
  1410. </div>
  1411. <div class="height-container">
  1412. <div class="pointer-container"></div>
  1413. <section class="section">
  1414. <div class="pointer"></div>
  1415. <div class="abstract">
  1416. <p>Closure which provides a <code>URLRequest</code> for mutation.</p>
  1417. </div>
  1418. <div class="declaration">
  1419. <h4>Declaration</h4>
  1420. <div class="language">
  1421. <p class="aside-title">Swift</p>
  1422. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">typealias</span> <span class="kt">RequestModifier</span> <span class="o">=</span> <span class="p">(</span><span class="k">inout</span> <span class="kt">URLRequest</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>
  1423. </div>
  1424. </div>
  1425. </section>
  1426. </div>
  1427. </li>
  1428. <li class="item">
  1429. <div>
  1430. <code>
  1431. <a name="/s:9Alamofire7SessionC7request_6method10parameters8encoding7headers11interceptor0C8ModifierAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSgy10Foundation10URLRequestVzKcSgtF"></a>
  1432. <a name="//apple_ref/swift/Method/request(_:method:parameters:encoding:headers:interceptor:requestModifier:)" class="dashAnchor"></a>
  1433. <a class="token" href="#/s:9Alamofire7SessionC7request_6method10parameters8encoding7headers11interceptor0C8ModifierAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSgy10Foundation10URLRequestVzKcSgtF">request(_:<wbr>method:<wbr>parameters:<wbr>encoding:<wbr>headers:<wbr>interceptor:<wbr>requestModifier:<wbr>)</a>
  1434. </code>
  1435. </div>
  1436. <div class="height-container">
  1437. <div class="pointer-container"></div>
  1438. <section class="section">
  1439. <div class="pointer"></div>
  1440. <div class="abstract">
  1441. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> from a <code>URLRequest</code> created using the passed components and a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1442. </div>
  1443. <div class="declaration">
  1444. <h4>Declaration</h4>
  1445. <div class="language">
  1446. <p class="aside-title">Swift</p>
  1447. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1448. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  1449. <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1450. <span class="nv">encoding</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></span> <span class="o">=</span> <span class="kt"><a href="../Structs/URLEncoding.html">URLEncoding</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  1451. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1452. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1453. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
  1454. </div>
  1455. </div>
  1456. <div>
  1457. <h4>Parameters</h4>
  1458. <table class="graybox">
  1459. <tbody>
  1460. <tr>
  1461. <td>
  1462. <code>
  1463. <em>convertible</em>
  1464. </code>
  1465. </td>
  1466. <td>
  1467. <div>
  1468. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1469. </div>
  1470. </td>
  1471. </tr>
  1472. <tr>
  1473. <td>
  1474. <code>
  1475. <em>method</em>
  1476. </code>
  1477. </td>
  1478. <td>
  1479. <div>
  1480. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
  1481. </div>
  1482. </td>
  1483. </tr>
  1484. <tr>
  1485. <td>
  1486. <code>
  1487. <em>parameters</em>
  1488. </code>
  1489. </td>
  1490. <td>
  1491. <div>
  1492. <p><code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code> (a.k.a. <code>[String: Any]</code>) value to be encoded into the <code>URLRequest</code>. <code>nil</code> by
  1493. default.</p>
  1494. </div>
  1495. </td>
  1496. </tr>
  1497. <tr>
  1498. <td>
  1499. <code>
  1500. <em>encoding</em>
  1501. </code>
  1502. </td>
  1503. <td>
  1504. <div>
  1505. <p><code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code> to be used to encode the <code>parameters</code> value into the <code>URLRequest</code>.
  1506. <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
  1507. </div>
  1508. </td>
  1509. </tr>
  1510. <tr>
  1511. <td>
  1512. <code>
  1513. <em>headers</em>
  1514. </code>
  1515. </td>
  1516. <td>
  1517. <div>
  1518. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1519. </div>
  1520. </td>
  1521. </tr>
  1522. <tr>
  1523. <td>
  1524. <code>
  1525. <em>interceptor</em>
  1526. </code>
  1527. </td>
  1528. <td>
  1529. <div>
  1530. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1531. </div>
  1532. </td>
  1533. </tr>
  1534. <tr>
  1535. <td>
  1536. <code>
  1537. <em>requestModifier</em>
  1538. </code>
  1539. </td>
  1540. <td>
  1541. <div>
  1542. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the provided
  1543. parameters. <code>nil</code> by default.</p>
  1544. </div>
  1545. </td>
  1546. </tr>
  1547. </tbody>
  1548. </table>
  1549. </div>
  1550. <div>
  1551. <h4>Return Value</h4>
  1552. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  1553. </div>
  1554. </section>
  1555. </div>
  1556. </li>
  1557. <li class="item">
  1558. <div>
  1559. <code>
  1560. <a name="/s:9Alamofire7SessionC7request_6method10parameters7encoder7headers11interceptor0C8ModifierAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSgy10Foundation10URLRequestVzKcSgtSERzlF"></a>
  1561. <a name="//apple_ref/swift/Method/request(_:method:parameters:encoder:headers:interceptor:requestModifier:)" class="dashAnchor"></a>
  1562. <a class="token" href="#/s:9Alamofire7SessionC7request_6method10parameters7encoder7headers11interceptor0C8ModifierAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSgy10Foundation10URLRequestVzKcSgtSERzlF">request(_:<wbr>method:<wbr>parameters:<wbr>encoder:<wbr>headers:<wbr>interceptor:<wbr>requestModifier:<wbr>)</a>
  1563. </code>
  1564. </div>
  1565. <div class="height-container">
  1566. <div class="pointer-container"></div>
  1567. <section class="section">
  1568. <div class="pointer"></div>
  1569. <div class="abstract">
  1570. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> from a <code>URLRequest</code> created using the passed components, <code>Encodable</code> parameters, and a
  1571. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1572. </div>
  1573. <div class="declaration">
  1574. <h4>Declaration</h4>
  1575. <div class="language">
  1576. <p class="aside-title">Swift</p>
  1577. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="n">request</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1578. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  1579. <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1580. <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  1581. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1582. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1583. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
  1584. </div>
  1585. </div>
  1586. <div>
  1587. <h4>Parameters</h4>
  1588. <table class="graybox">
  1589. <tbody>
  1590. <tr>
  1591. <td>
  1592. <code>
  1593. <em>convertible</em>
  1594. </code>
  1595. </td>
  1596. <td>
  1597. <div>
  1598. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1599. </div>
  1600. </td>
  1601. </tr>
  1602. <tr>
  1603. <td>
  1604. <code>
  1605. <em>method</em>
  1606. </code>
  1607. </td>
  1608. <td>
  1609. <div>
  1610. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
  1611. </div>
  1612. </td>
  1613. </tr>
  1614. <tr>
  1615. <td>
  1616. <code>
  1617. <em>parameters</em>
  1618. </code>
  1619. </td>
  1620. <td>
  1621. <div>
  1622. <p><code>Encodable</code> value to be encoded into the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1623. </div>
  1624. </td>
  1625. </tr>
  1626. <tr>
  1627. <td>
  1628. <code>
  1629. <em>encoder</em>
  1630. </code>
  1631. </td>
  1632. <td>
  1633. <div>
  1634. <p><code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code> to be used to encode the <code>parameters</code> value into the <code>URLRequest</code>.
  1635. <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
  1636. </div>
  1637. </td>
  1638. </tr>
  1639. <tr>
  1640. <td>
  1641. <code>
  1642. <em>headers</em>
  1643. </code>
  1644. </td>
  1645. <td>
  1646. <div>
  1647. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1648. </div>
  1649. </td>
  1650. </tr>
  1651. <tr>
  1652. <td>
  1653. <code>
  1654. <em>interceptor</em>
  1655. </code>
  1656. </td>
  1657. <td>
  1658. <div>
  1659. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1660. </div>
  1661. </td>
  1662. </tr>
  1663. <tr>
  1664. <td>
  1665. <code>
  1666. <em>requestModifier</em>
  1667. </code>
  1668. </td>
  1669. <td>
  1670. <div>
  1671. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from
  1672. the provided parameters. <code>nil</code> by default.</p>
  1673. </div>
  1674. </td>
  1675. </tr>
  1676. </tbody>
  1677. </table>
  1678. </div>
  1679. <div>
  1680. <h4>Return Value</h4>
  1681. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  1682. </div>
  1683. </section>
  1684. </div>
  1685. </li>
  1686. <li class="item">
  1687. <div>
  1688. <code>
  1689. <a name="/s:9Alamofire7SessionC7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtF"></a>
  1690. <a name="//apple_ref/swift/Method/request(_:interceptor:)" class="dashAnchor"></a>
  1691. <a class="token" href="#/s:9Alamofire7SessionC7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtF">request(_:<wbr>interceptor:<wbr>)</a>
  1692. </code>
  1693. </div>
  1694. <div class="height-container">
  1695. <div class="pointer-container"></div>
  1696. <section class="section">
  1697. <div class="pointer"></div>
  1698. <div class="abstract">
  1699. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> from a <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1700. </div>
  1701. <div class="declaration">
  1702. <h4>Declaration</h4>
  1703. <div class="language">
  1704. <p class="aside-title">Swift</p>
  1705. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
  1706. </div>
  1707. </div>
  1708. <div>
  1709. <h4>Parameters</h4>
  1710. <table class="graybox">
  1711. <tbody>
  1712. <tr>
  1713. <td>
  1714. <code>
  1715. <em>convertible</em>
  1716. </code>
  1717. </td>
  1718. <td>
  1719. <div>
  1720. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  1721. </div>
  1722. </td>
  1723. </tr>
  1724. <tr>
  1725. <td>
  1726. <code>
  1727. <em>interceptor</em>
  1728. </code>
  1729. </td>
  1730. <td>
  1731. <div>
  1732. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1733. </div>
  1734. </td>
  1735. </tr>
  1736. </tbody>
  1737. </table>
  1738. </div>
  1739. <div>
  1740. <h4>Return Value</h4>
  1741. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  1742. </div>
  1743. </section>
  1744. </div>
  1745. </li>
  1746. </ul>
  1747. </div>
  1748. <div class="task-group">
  1749. <div class="task-name-container">
  1750. <a name="/DataStreamRequest"></a>
  1751. <a name="//apple_ref/swift/Section/DataStreamRequest" class="dashAnchor"></a>
  1752. <div class="section-name-container">
  1753. <a class="section-name-link" href="#/DataStreamRequest"></a>
  1754. <h3 class="section-name"><span>DataStreamRequest</span>
  1755. </h3>
  1756. </div>
  1757. </div>
  1758. <ul class="item-container">
  1759. <li class="item">
  1760. <div>
  1761. <code>
  1762. <a name="/s:9Alamofire7SessionC13streamRequest_6method10parameters7encoder7headers32automaticallyCancelOnStreamError11interceptor15requestModifierAA04DatalD0CAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgSbAA0D11Interceptor_pSgy10Foundation10URLRequestVzKcSgtSERzlF"></a>
  1763. <a name="//apple_ref/swift/Method/streamRequest(_:method:parameters:encoder:headers:automaticallyCancelOnStreamError:interceptor:requestModifier:)" class="dashAnchor"></a>
  1764. <a class="token" href="#/s:9Alamofire7SessionC13streamRequest_6method10parameters7encoder7headers32automaticallyCancelOnStreamError11interceptor15requestModifierAA04DatalD0CAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgSbAA0D11Interceptor_pSgy10Foundation10URLRequestVzKcSgtSERzlF">streamRequest(_:<wbr>method:<wbr>parameters:<wbr>encoder:<wbr>headers:<wbr>automaticallyCancelOnStreamError:<wbr>interceptor:<wbr>requestModifier:<wbr>)</a>
  1765. </code>
  1766. </div>
  1767. <div class="height-container">
  1768. <div class="pointer-container"></div>
  1769. <section class="section">
  1770. <div class="pointer"></div>
  1771. <div class="abstract">
  1772. <p>Creates a <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> from the passed components, <code>Encodable</code> parameters, and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1773. </div>
  1774. <div class="declaration">
  1775. <h4>Declaration</h4>
  1776. <div class="language">
  1777. <p class="aside-title">Swift</p>
  1778. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="n">streamRequest</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1779. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  1780. <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1781. <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  1782. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1783. <span class="nv">automaticallyCancelOnStreamError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1784. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1785. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></span></code></pre>
  1786. </div>
  1787. </div>
  1788. <div>
  1789. <h4>Parameters</h4>
  1790. <table class="graybox">
  1791. <tbody>
  1792. <tr>
  1793. <td>
  1794. <code>
  1795. <em>convertible</em>
  1796. </code>
  1797. </td>
  1798. <td>
  1799. <div>
  1800. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1801. </div>
  1802. </td>
  1803. </tr>
  1804. <tr>
  1805. <td>
  1806. <code>
  1807. <em>method</em>
  1808. </code>
  1809. </td>
  1810. <td>
  1811. <div>
  1812. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
  1813. </div>
  1814. </td>
  1815. </tr>
  1816. <tr>
  1817. <td>
  1818. <code>
  1819. <em>parameters</em>
  1820. </code>
  1821. </td>
  1822. <td>
  1823. <div>
  1824. <p><code>Encodable</code> value to be encoded into the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1825. </div>
  1826. </td>
  1827. </tr>
  1828. <tr>
  1829. <td>
  1830. <code>
  1831. <em>encoder</em>
  1832. </code>
  1833. </td>
  1834. <td>
  1835. <div>
  1836. <p><code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code> to be used to encode the <code>parameters</code> value into the
  1837. <code>URLRequest</code>.
  1838. <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
  1839. </div>
  1840. </td>
  1841. </tr>
  1842. <tr>
  1843. <td>
  1844. <code>
  1845. <em>headers</em>
  1846. </code>
  1847. </td>
  1848. <td>
  1849. <div>
  1850. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1851. </div>
  1852. </td>
  1853. </tr>
  1854. <tr>
  1855. <td>
  1856. <code>
  1857. <em>automaticallyCancelOnStreamError</em>
  1858. </code>
  1859. </td>
  1860. <td>
  1861. <div>
  1862. <p><code>Bool</code> indicating whether the instance should be canceled when an <code>Error</code>
  1863. is thrown while serializing stream <code>Data</code>. <code>false</code> by default.</p>
  1864. </div>
  1865. </td>
  1866. </tr>
  1867. <tr>
  1868. <td>
  1869. <code>
  1870. <em>interceptor</em>
  1871. </code>
  1872. </td>
  1873. <td>
  1874. <div>
  1875. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code>
  1876. by default.</p>
  1877. </div>
  1878. </td>
  1879. </tr>
  1880. <tr>
  1881. <td>
  1882. <code>
  1883. <em>requestModifier</em>
  1884. </code>
  1885. </td>
  1886. <td>
  1887. <div>
  1888. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from
  1889. the provided parameters. <code>nil</code> by default.</p>
  1890. </div>
  1891. </td>
  1892. </tr>
  1893. </tbody>
  1894. </table>
  1895. </div>
  1896. <div>
  1897. <h4>Return Value</h4>
  1898. <p>The created <code>DataStream</code> request.</p>
  1899. </div>
  1900. </section>
  1901. </div>
  1902. </li>
  1903. <li class="item">
  1904. <div>
  1905. <code>
  1906. <a name="/s:9Alamofire7SessionC13streamRequest_6method7headers32automaticallyCancelOnStreamError11interceptor15requestModifierAA04DatajD0CAA14URLConvertible_p_AA10HTTPMethodVAA11HTTPHeadersVSgSbAA0D11Interceptor_pSgy10Foundation10URLRequestVzKcSgtF"></a>
  1907. <a name="//apple_ref/swift/Method/streamRequest(_:method:headers:automaticallyCancelOnStreamError:interceptor:requestModifier:)" class="dashAnchor"></a>
  1908. <a class="token" href="#/s:9Alamofire7SessionC13streamRequest_6method7headers32automaticallyCancelOnStreamError11interceptor15requestModifierAA04DatajD0CAA14URLConvertible_p_AA10HTTPMethodVAA11HTTPHeadersVSgSbAA0D11Interceptor_pSgy10Foundation10URLRequestVzKcSgtF">streamRequest(_:<wbr>method:<wbr>headers:<wbr>automaticallyCancelOnStreamError:<wbr>interceptor:<wbr>requestModifier:<wbr>)</a>
  1909. </code>
  1910. </div>
  1911. <div class="height-container">
  1912. <div class="pointer-container"></div>
  1913. <section class="section">
  1914. <div class="pointer"></div>
  1915. <div class="abstract">
  1916. <p>Creates a <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> from the passed components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1917. </div>
  1918. <div class="declaration">
  1919. <h4>Declaration</h4>
  1920. <div class="language">
  1921. <p class="aside-title">Swift</p>
  1922. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">streamRequest</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1923. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  1924. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1925. <span class="nv">automaticallyCancelOnStreamError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  1926. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1927. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></span></code></pre>
  1928. </div>
  1929. </div>
  1930. <div>
  1931. <h4>Parameters</h4>
  1932. <table class="graybox">
  1933. <tbody>
  1934. <tr>
  1935. <td>
  1936. <code>
  1937. <em>convertible</em>
  1938. </code>
  1939. </td>
  1940. <td>
  1941. <div>
  1942. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1943. </div>
  1944. </td>
  1945. </tr>
  1946. <tr>
  1947. <td>
  1948. <code>
  1949. <em>method</em>
  1950. </code>
  1951. </td>
  1952. <td>
  1953. <div>
  1954. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
  1955. </div>
  1956. </td>
  1957. </tr>
  1958. <tr>
  1959. <td>
  1960. <code>
  1961. <em>headers</em>
  1962. </code>
  1963. </td>
  1964. <td>
  1965. <div>
  1966. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1967. </div>
  1968. </td>
  1969. </tr>
  1970. <tr>
  1971. <td>
  1972. <code>
  1973. <em>automaticallyCancelOnStreamError</em>
  1974. </code>
  1975. </td>
  1976. <td>
  1977. <div>
  1978. <p><code>Bool</code> indicating whether the instance should be canceled when an <code>Error</code>
  1979. is thrown while serializing stream <code>Data</code>. <code>false</code> by default.</p>
  1980. </div>
  1981. </td>
  1982. </tr>
  1983. <tr>
  1984. <td>
  1985. <code>
  1986. <em>interceptor</em>
  1987. </code>
  1988. </td>
  1989. <td>
  1990. <div>
  1991. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code>
  1992. by default.</p>
  1993. </div>
  1994. </td>
  1995. </tr>
  1996. <tr>
  1997. <td>
  1998. <code>
  1999. <em>requestModifier</em>
  2000. </code>
  2001. </td>
  2002. <td>
  2003. <div>
  2004. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from
  2005. the provided parameters. <code>nil</code> by default.</p>
  2006. </div>
  2007. </td>
  2008. </tr>
  2009. </tbody>
  2010. </table>
  2011. </div>
  2012. <div>
  2013. <h4>Return Value</h4>
  2014. <p>The created <code>DataStream</code> request.</p>
  2015. </div>
  2016. </section>
  2017. </div>
  2018. </li>
  2019. <li class="item">
  2020. <div>
  2021. <code>
  2022. <a name="/s:9Alamofire7SessionC13streamRequest_32automaticallyCancelOnStreamError11interceptorAA04DatahD0CAA21URLRequestConvertible_p_SbAA0D11Interceptor_pSgtF"></a>
  2023. <a name="//apple_ref/swift/Method/streamRequest(_:automaticallyCancelOnStreamError:interceptor:)" class="dashAnchor"></a>
  2024. <a class="token" href="#/s:9Alamofire7SessionC13streamRequest_32automaticallyCancelOnStreamError11interceptorAA04DatahD0CAA21URLRequestConvertible_p_SbAA0D11Interceptor_pSgtF">streamRequest(_:<wbr>automaticallyCancelOnStreamError:<wbr>interceptor:<wbr>)</a>
  2025. </code>
  2026. </div>
  2027. <div class="height-container">
  2028. <div class="pointer-container"></div>
  2029. <section class="section">
  2030. <div class="pointer"></div>
  2031. <div class="abstract">
  2032. <p>Creates a <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code> from the passed <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2033. </div>
  2034. <div class="declaration">
  2035. <h4>Declaration</h4>
  2036. <div class="language">
  2037. <p class="aside-title">Swift</p>
  2038. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">streamRequest</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  2039. <span class="nv">automaticallyCancelOnStreamError</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
  2040. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></span></code></pre>
  2041. </div>
  2042. </div>
  2043. <div>
  2044. <h4>Parameters</h4>
  2045. <table class="graybox">
  2046. <tbody>
  2047. <tr>
  2048. <td>
  2049. <code>
  2050. <em>convertible</em>
  2051. </code>
  2052. </td>
  2053. <td>
  2054. <div>
  2055. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  2056. </div>
  2057. </td>
  2058. </tr>
  2059. <tr>
  2060. <td>
  2061. <code>
  2062. <em>automaticallyCancelOnStreamError</em>
  2063. </code>
  2064. </td>
  2065. <td>
  2066. <div>
  2067. <p><code>Bool</code> indicating whether the instance should be canceled when an <code>Error</code>
  2068. is thrown while serializing stream <code>Data</code>. <code>false</code> by default.</p>
  2069. </div>
  2070. </td>
  2071. </tr>
  2072. <tr>
  2073. <td>
  2074. <code>
  2075. <em>interceptor</em>
  2076. </code>
  2077. </td>
  2078. <td>
  2079. <div>
  2080. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code>
  2081. by default.</p>
  2082. </div>
  2083. </td>
  2084. </tr>
  2085. </tbody>
  2086. </table>
  2087. </div>
  2088. <div>
  2089. <h4>Return Value</h4>
  2090. <p>The created <code><a href="../Classes/DataStreamRequest.html">DataStreamRequest</a></code>.</p>
  2091. </div>
  2092. </section>
  2093. </div>
  2094. </li>
  2095. </ul>
  2096. </div>
  2097. <div class="task-group">
  2098. <div class="task-name-container">
  2099. <a name="/DownloadRequest"></a>
  2100. <a name="//apple_ref/swift/Section/DownloadRequest" class="dashAnchor"></a>
  2101. <div class="section-name-container">
  2102. <a class="section-name-link" href="#/DownloadRequest"></a>
  2103. <h3 class="section-name"><span>DownloadRequest</span>
  2104. </h3>
  2105. </div>
  2106. </div>
  2107. <ul class="item-container">
  2108. <li class="item">
  2109. <div>
  2110. <code>
  2111. <a name="/s:9Alamofire7SessionC8download_6method10parameters8encoding7headers11interceptor15requestModifier2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0M11Interceptor_pSgy10Foundation10URLRequestVzKcSgAY3URLV011destinationV0_AM7OptionsV7optionstA2__So17NSHTTPURLResponseCtcSgtF"></a>
  2112. <a name="//apple_ref/swift/Method/download(_:method:parameters:encoding:headers:interceptor:requestModifier:to:)" class="dashAnchor"></a>
  2113. <a class="token" href="#/s:9Alamofire7SessionC8download_6method10parameters8encoding7headers11interceptor15requestModifier2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0M11Interceptor_pSgy10Foundation10URLRequestVzKcSgAY3URLV011destinationV0_AM7OptionsV7optionstA2__So17NSHTTPURLResponseCtcSgtF">download(_:<wbr>method:<wbr>parameters:<wbr>encoding:<wbr>headers:<wbr>interceptor:<wbr>requestModifier:<wbr>to:<wbr>)</a>
  2114. </code>
  2115. </div>
  2116. <div class="height-container">
  2117. <div class="pointer-container"></div>
  2118. <section class="section">
  2119. <div class="pointer"></div>
  2120. <div class="abstract">
  2121. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using a <code>URLRequest</code> created using the passed components, <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, and
  2122. <code>Destination</code>.</p>
  2123. </div>
  2124. <div class="declaration">
  2125. <h4>Declaration</h4>
  2126. <div class="language">
  2127. <p class="aside-title">Swift</p>
  2128. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  2129. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  2130. <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2131. <span class="nv">encoding</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></span> <span class="o">=</span> <span class="kt"><a href="../Structs/URLEncoding.html">URLEncoding</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  2132. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2133. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2134. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2135. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  2136. </div>
  2137. </div>
  2138. <div>
  2139. <h4>Parameters</h4>
  2140. <table class="graybox">
  2141. <tbody>
  2142. <tr>
  2143. <td>
  2144. <code>
  2145. <em>convertible</em>
  2146. </code>
  2147. </td>
  2148. <td>
  2149. <div>
  2150. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  2151. </div>
  2152. </td>
  2153. </tr>
  2154. <tr>
  2155. <td>
  2156. <code>
  2157. <em>method</em>
  2158. </code>
  2159. </td>
  2160. <td>
  2161. <div>
  2162. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
  2163. </div>
  2164. </td>
  2165. </tr>
  2166. <tr>
  2167. <td>
  2168. <code>
  2169. <em>parameters</em>
  2170. </code>
  2171. </td>
  2172. <td>
  2173. <div>
  2174. <p><code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code> (a.k.a. <code>[String: Any]</code>) value to be encoded into the <code>URLRequest</code>. <code>nil</code> by
  2175. default.</p>
  2176. </div>
  2177. </td>
  2178. </tr>
  2179. <tr>
  2180. <td>
  2181. <code>
  2182. <em>encoding</em>
  2183. </code>
  2184. </td>
  2185. <td>
  2186. <div>
  2187. <p><code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code> to be used to encode the <code>parameters</code> value into the <code>URLRequest</code>.
  2188. Defaults to <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code>.</p>
  2189. </div>
  2190. </td>
  2191. </tr>
  2192. <tr>
  2193. <td>
  2194. <code>
  2195. <em>headers</em>
  2196. </code>
  2197. </td>
  2198. <td>
  2199. <div>
  2200. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  2201. </div>
  2202. </td>
  2203. </tr>
  2204. <tr>
  2205. <td>
  2206. <code>
  2207. <em>interceptor</em>
  2208. </code>
  2209. </td>
  2210. <td>
  2211. <div>
  2212. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2213. </div>
  2214. </td>
  2215. </tr>
  2216. <tr>
  2217. <td>
  2218. <code>
  2219. <em>requestModifier</em>
  2220. </code>
  2221. </td>
  2222. <td>
  2223. <div>
  2224. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the provided
  2225. parameters. <code>nil</code> by default.</p>
  2226. </div>
  2227. </td>
  2228. </tr>
  2229. <tr>
  2230. <td>
  2231. <code>
  2232. <em>destination</em>
  2233. </code>
  2234. </td>
  2235. <td>
  2236. <div>
  2237. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
  2238. should be moved. <code>nil</code> by default.</p>
  2239. </div>
  2240. </td>
  2241. </tr>
  2242. </tbody>
  2243. </table>
  2244. </div>
  2245. <div>
  2246. <h4>Return Value</h4>
  2247. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  2248. </div>
  2249. </section>
  2250. </div>
  2251. </li>
  2252. <li class="item">
  2253. <div>
  2254. <code>
  2255. <a name="/s:9Alamofire7SessionC8download_6method10parameters7encoder7headers11interceptor15requestModifier2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0M11Interceptor_pSgy10Foundation10URLRequestVzKcSgAX3URLV011destinationV0_AM7OptionsV7optionstA1__So17NSHTTPURLResponseCtcSgtSERzlF"></a>
  2256. <a name="//apple_ref/swift/Method/download(_:method:parameters:encoder:headers:interceptor:requestModifier:to:)" class="dashAnchor"></a>
  2257. <a class="token" href="#/s:9Alamofire7SessionC8download_6method10parameters7encoder7headers11interceptor15requestModifier2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0M11Interceptor_pSgy10Foundation10URLRequestVzKcSgAX3URLV011destinationV0_AM7OptionsV7optionstA1__So17NSHTTPURLResponseCtcSgtSERzlF">download(_:<wbr>method:<wbr>parameters:<wbr>encoder:<wbr>headers:<wbr>interceptor:<wbr>requestModifier:<wbr>to:<wbr>)</a>
  2258. </code>
  2259. </div>
  2260. <div class="height-container">
  2261. <div class="pointer-container"></div>
  2262. <section class="section">
  2263. <div class="pointer"></div>
  2264. <div class="abstract">
  2265. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> from a <code>URLRequest</code> created using the passed components, <code>Encodable</code> parameters, and
  2266. a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2267. </div>
  2268. <div class="declaration">
  2269. <h4>Declaration</h4>
  2270. <div class="language">
  2271. <p class="aside-title">Swift</p>
  2272. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="n">download</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  2273. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  2274. <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2275. <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  2276. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2277. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2278. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2279. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  2280. </div>
  2281. </div>
  2282. <div>
  2283. <h4>Parameters</h4>
  2284. <table class="graybox">
  2285. <tbody>
  2286. <tr>
  2287. <td>
  2288. <code>
  2289. <em>convertible</em>
  2290. </code>
  2291. </td>
  2292. <td>
  2293. <div>
  2294. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  2295. </div>
  2296. </td>
  2297. </tr>
  2298. <tr>
  2299. <td>
  2300. <code>
  2301. <em>method</em>
  2302. </code>
  2303. </td>
  2304. <td>
  2305. <div>
  2306. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
  2307. </div>
  2308. </td>
  2309. </tr>
  2310. <tr>
  2311. <td>
  2312. <code>
  2313. <em>parameters</em>
  2314. </code>
  2315. </td>
  2316. <td>
  2317. <div>
  2318. <p>Value conforming to <code>Encodable</code> to be encoded into the <code>URLRequest</code>. <code>nil</code> by default.</p>
  2319. </div>
  2320. </td>
  2321. </tr>
  2322. <tr>
  2323. <td>
  2324. <code>
  2325. <em>encoder</em>
  2326. </code>
  2327. </td>
  2328. <td>
  2329. <div>
  2330. <p><code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code> to be used to encode the <code>parameters</code> value into the <code>URLRequest</code>.
  2331. Defaults to <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code>.</p>
  2332. </div>
  2333. </td>
  2334. </tr>
  2335. <tr>
  2336. <td>
  2337. <code>
  2338. <em>headers</em>
  2339. </code>
  2340. </td>
  2341. <td>
  2342. <div>
  2343. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  2344. </div>
  2345. </td>
  2346. </tr>
  2347. <tr>
  2348. <td>
  2349. <code>
  2350. <em>interceptor</em>
  2351. </code>
  2352. </td>
  2353. <td>
  2354. <div>
  2355. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2356. </div>
  2357. </td>
  2358. </tr>
  2359. <tr>
  2360. <td>
  2361. <code>
  2362. <em>requestModifier</em>
  2363. </code>
  2364. </td>
  2365. <td>
  2366. <div>
  2367. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the provided
  2368. parameters. <code>nil</code> by default.</p>
  2369. </div>
  2370. </td>
  2371. </tr>
  2372. <tr>
  2373. <td>
  2374. <code>
  2375. <em>destination</em>
  2376. </code>
  2377. </td>
  2378. <td>
  2379. <div>
  2380. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
  2381. should be moved. <code>nil</code> by default.</p>
  2382. </div>
  2383. </td>
  2384. </tr>
  2385. </tbody>
  2386. </table>
  2387. </div>
  2388. <div>
  2389. <h4>Return Value</h4>
  2390. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  2391. </div>
  2392. </section>
  2393. </div>
  2394. </li>
  2395. <li class="item">
  2396. <div>
  2397. <code>
  2398. <a name="/s:9Alamofire7SessionC8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtF"></a>
  2399. <a name="//apple_ref/swift/Method/download(_:interceptor:to:)" class="dashAnchor"></a>
  2400. <a class="token" href="#/s:9Alamofire7SessionC8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtF">download(_:<wbr>interceptor:<wbr>to:<wbr>)</a>
  2401. </code>
  2402. </div>
  2403. <div class="height-container">
  2404. <div class="pointer-container"></div>
  2405. <section class="section">
  2406. <div class="pointer"></div>
  2407. <div class="abstract">
  2408. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> from a <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value, a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, and a <code>Destination</code>.</p>
  2409. </div>
  2410. <div class="declaration">
  2411. <h4>Declaration</h4>
  2412. <div class="language">
  2413. <p class="aside-title">Swift</p>
  2414. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">_</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  2415. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2416. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  2417. </div>
  2418. </div>
  2419. <div>
  2420. <h4>Parameters</h4>
  2421. <table class="graybox">
  2422. <tbody>
  2423. <tr>
  2424. <td>
  2425. <code>
  2426. <em>convertible</em>
  2427. </code>
  2428. </td>
  2429. <td>
  2430. <div>
  2431. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  2432. </div>
  2433. </td>
  2434. </tr>
  2435. <tr>
  2436. <td>
  2437. <code>
  2438. <em>interceptor</em>
  2439. </code>
  2440. </td>
  2441. <td>
  2442. <div>
  2443. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2444. </div>
  2445. </td>
  2446. </tr>
  2447. <tr>
  2448. <td>
  2449. <code>
  2450. <em>destination</em>
  2451. </code>
  2452. </td>
  2453. <td>
  2454. <div>
  2455. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
  2456. should be moved. <code>nil</code> by default.</p>
  2457. </div>
  2458. </td>
  2459. </tr>
  2460. </tbody>
  2461. </table>
  2462. </div>
  2463. <div>
  2464. <h4>Return Value</h4>
  2465. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  2466. </div>
  2467. </section>
  2468. </div>
  2469. </li>
  2470. <li class="item">
  2471. <div>
  2472. <code>
  2473. <a name="/s:9Alamofire7SessionC8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtF"></a>
  2474. <a name="//apple_ref/swift/Method/download(resumingWith:interceptor:to:)" class="dashAnchor"></a>
  2475. <a class="token" href="#/s:9Alamofire7SessionC8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:<wbr>interceptor:<wbr>to:<wbr>)</a>
  2476. </code>
  2477. </div>
  2478. <div class="height-container">
  2479. <div class="pointer-container"></div>
  2480. <section class="section">
  2481. <div class="pointer"></div>
  2482. <div class="abstract">
  2483. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> from the <code>resumeData</code> produced from a previously cancelled <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>, as
  2484. well as a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, and a <code>Destination</code>.</p>
  2485. <div class="aside aside-note">
  2486. <p class="aside-title">Note</p>
  2487. <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by
  2488. Alamofire. The file will not be deleted until the system purges the temporary files.</p>
  2489. </div><div class="aside aside-note">
  2490. <p class="aside-title">Note</p>
  2491. <p>On some versions of all Apple platforms (iOS 10 - 10.2, macOS 10.12 - 10.12.2, tvOS 10 - 10.1, watchOS 3 - 3.1.1),
  2492. <code>resumeData</code> is broken on background URL session configurations. There&rsquo;s an underlying bug in the <code>resumeData</code>
  2493. generation logic where the data is written incorrectly and will always fail to resume the download. For more
  2494. information about the bug and possible workarounds, please refer to the <a href="http://stackoverflow.com/a/39347461/1342462">this Stack Overflow post</a>.</p>
  2495. </div>
  2496. </div>
  2497. <div class="declaration">
  2498. <h4>Declaration</h4>
  2499. <div class="language">
  2500. <p class="aside-title">Swift</p>
  2501. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">resumingWith</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
  2502. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2503. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  2504. </div>
  2505. </div>
  2506. <div>
  2507. <h4>Parameters</h4>
  2508. <table class="graybox">
  2509. <tbody>
  2510. <tr>
  2511. <td>
  2512. <code>
  2513. <em>data</em>
  2514. </code>
  2515. </td>
  2516. <td>
  2517. <div>
  2518. <p>The resume data from a previously cancelled <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> or <code>URLSessionDownloadTask</code>.</p>
  2519. </div>
  2520. </td>
  2521. </tr>
  2522. <tr>
  2523. <td>
  2524. <code>
  2525. <em>interceptor</em>
  2526. </code>
  2527. </td>
  2528. <td>
  2529. <div>
  2530. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2531. </div>
  2532. </td>
  2533. </tr>
  2534. <tr>
  2535. <td>
  2536. <code>
  2537. <em>destination</em>
  2538. </code>
  2539. </td>
  2540. <td>
  2541. <div>
  2542. <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
  2543. should be moved. <code>nil</code> by default.</p>
  2544. </div>
  2545. </td>
  2546. </tr>
  2547. </tbody>
  2548. </table>
  2549. </div>
  2550. <div>
  2551. <h4>Return Value</h4>
  2552. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  2553. </div>
  2554. </section>
  2555. </div>
  2556. </li>
  2557. </ul>
  2558. </div>
  2559. <div class="task-group">
  2560. <div class="task-name-container">
  2561. <a name="/Data"></a>
  2562. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  2563. <div class="section-name-container">
  2564. <a class="section-name-link" href="#/Data"></a>
  2565. <h3 class="section-name"><span>Data</span>
  2566. </h3>
  2567. </div>
  2568. </div>
  2569. <ul class="item-container">
  2570. <li class="item">
  2571. <div>
  2572. <code>
  2573. <a name="/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0M11Interceptor_pSgSo06NSFileI0CyAM10URLRequestVzKcSgtF"></a>
  2574. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:requestModifier:)" class="dashAnchor"></a>
  2575. <a class="token" href="#/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0M11Interceptor_pSgSo06NSFileI0CyAM10URLRequestVzKcSgtF">upload(_:<wbr>to:<wbr>method:<wbr>headers:<wbr>interceptor:<wbr>fileManager:<wbr>requestModifier:<wbr>)</a>
  2576. </code>
  2577. </div>
  2578. <div class="height-container">
  2579. <div class="pointer-container"></div>
  2580. <section class="section">
  2581. <div class="pointer"></div>
  2582. <div class="abstract">
  2583. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the given <code>Data</code>, <code>URLRequest</code> components, and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2584. </div>
  2585. <div class="declaration">
  2586. <h4>Declaration</h4>
  2587. <div class="language">
  2588. <p class="aside-title">Swift</p>
  2589. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
  2590. <span class="n">to</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  2591. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  2592. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2593. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2594. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
  2595. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2596. </div>
  2597. </div>
  2598. <div>
  2599. <h4>Parameters</h4>
  2600. <table class="graybox">
  2601. <tbody>
  2602. <tr>
  2603. <td>
  2604. <code>
  2605. <em>data</em>
  2606. </code>
  2607. </td>
  2608. <td>
  2609. <div>
  2610. <p>The <code>Data</code> to upload.</p>
  2611. </div>
  2612. </td>
  2613. </tr>
  2614. <tr>
  2615. <td>
  2616. <code>
  2617. <em>convertible</em>
  2618. </code>
  2619. </td>
  2620. <td>
  2621. <div>
  2622. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  2623. </div>
  2624. </td>
  2625. </tr>
  2626. <tr>
  2627. <td>
  2628. <code>
  2629. <em>method</em>
  2630. </code>
  2631. </td>
  2632. <td>
  2633. <div>
  2634. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  2635. </div>
  2636. </td>
  2637. </tr>
  2638. <tr>
  2639. <td>
  2640. <code>
  2641. <em>headers</em>
  2642. </code>
  2643. </td>
  2644. <td>
  2645. <div>
  2646. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  2647. </div>
  2648. </td>
  2649. </tr>
  2650. <tr>
  2651. <td>
  2652. <code>
  2653. <em>interceptor</em>
  2654. </code>
  2655. </td>
  2656. <td>
  2657. <div>
  2658. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2659. </div>
  2660. </td>
  2661. </tr>
  2662. <tr>
  2663. <td>
  2664. <code>
  2665. <em>fileManager</em>
  2666. </code>
  2667. </td>
  2668. <td>
  2669. <div>
  2670. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  2671. default.</p>
  2672. </div>
  2673. </td>
  2674. </tr>
  2675. <tr>
  2676. <td>
  2677. <code>
  2678. <em>requestModifier</em>
  2679. </code>
  2680. </td>
  2681. <td>
  2682. <div>
  2683. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the provided
  2684. parameters. <code>nil</code> by default.</p>
  2685. </div>
  2686. </td>
  2687. </tr>
  2688. </tbody>
  2689. </table>
  2690. </div>
  2691. <div>
  2692. <h4>Return Value</h4>
  2693. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  2694. </div>
  2695. </section>
  2696. </div>
  2697. </li>
  2698. <li class="item">
  2699. <div>
  2700. <code>
  2701. <a name="/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF"></a>
  2702. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
  2703. <a class="token" href="#/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF">upload(_:<wbr>with:<wbr>interceptor:<wbr>fileManager:<wbr>)</a>
  2704. </code>
  2705. </div>
  2706. <div class="height-container">
  2707. <div class="pointer-container"></div>
  2708. <section class="section">
  2709. <div class="pointer"></div>
  2710. <div class="abstract">
  2711. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the given <code>Data</code> using the <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2712. </div>
  2713. <div class="declaration">
  2714. <h4>Declaration</h4>
  2715. <div class="language">
  2716. <p class="aside-title">Swift</p>
  2717. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
  2718. <span class="n">with</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  2719. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2720. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2721. </div>
  2722. </div>
  2723. <div>
  2724. <h4>Parameters</h4>
  2725. <table class="graybox">
  2726. <tbody>
  2727. <tr>
  2728. <td>
  2729. <code>
  2730. <em>data</em>
  2731. </code>
  2732. </td>
  2733. <td>
  2734. <div>
  2735. <p>The <code>Data</code> to upload.</p>
  2736. </div>
  2737. </td>
  2738. </tr>
  2739. <tr>
  2740. <td>
  2741. <code>
  2742. <em>convertible</em>
  2743. </code>
  2744. </td>
  2745. <td>
  2746. <div>
  2747. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  2748. </div>
  2749. </td>
  2750. </tr>
  2751. <tr>
  2752. <td>
  2753. <code>
  2754. <em>interceptor</em>
  2755. </code>
  2756. </td>
  2757. <td>
  2758. <div>
  2759. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2760. </div>
  2761. </td>
  2762. </tr>
  2763. <tr>
  2764. <td>
  2765. <code>
  2766. <em>fileManager</em>
  2767. </code>
  2768. </td>
  2769. <td>
  2770. <div>
  2771. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  2772. default.</p>
  2773. </div>
  2774. </td>
  2775. </tr>
  2776. </tbody>
  2777. </table>
  2778. </div>
  2779. <div>
  2780. <h4>Return Value</h4>
  2781. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  2782. </div>
  2783. </section>
  2784. </div>
  2785. </li>
  2786. </ul>
  2787. </div>
  2788. <div class="task-group">
  2789. <div class="task-name-container">
  2790. <a name="/File"></a>
  2791. <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
  2792. <div class="section-name-container">
  2793. <a class="section-name-link" href="#/File"></a>
  2794. <h3 class="section-name"><span>File</span>
  2795. </h3>
  2796. </div>
  2797. </div>
  2798. <ul class="item-container">
  2799. <li class="item">
  2800. <div>
  2801. <code>
  2802. <a name="/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0M11Interceptor_pSgSo06NSFileI0CyAM10URLRequestVzKcSgtF"></a>
  2803. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:requestModifier:)" class="dashAnchor"></a>
  2804. <a class="token" href="#/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0M11Interceptor_pSgSo06NSFileI0CyAM10URLRequestVzKcSgtF">upload(_:<wbr>to:<wbr>method:<wbr>headers:<wbr>interceptor:<wbr>fileManager:<wbr>requestModifier:<wbr>)</a>
  2805. </code>
  2806. </div>
  2807. <div class="height-container">
  2808. <div class="pointer-container"></div>
  2809. <section class="section">
  2810. <div class="pointer"></div>
  2811. <div class="abstract">
  2812. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the file at the given file <code>URL</code>, using a <code>URLRequest</code> from the provided
  2813. components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2814. </div>
  2815. <div class="declaration">
  2816. <h4>Declaration</h4>
  2817. <div class="language">
  2818. <p class="aside-title">Swift</p>
  2819. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
  2820. <span class="n">to</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  2821. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  2822. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2823. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2824. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
  2825. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2826. </div>
  2827. </div>
  2828. <div>
  2829. <h4>Parameters</h4>
  2830. <table class="graybox">
  2831. <tbody>
  2832. <tr>
  2833. <td>
  2834. <code>
  2835. <em>fileURL</em>
  2836. </code>
  2837. </td>
  2838. <td>
  2839. <div>
  2840. <p>The <code>URL</code> of the file to upload.</p>
  2841. </div>
  2842. </td>
  2843. </tr>
  2844. <tr>
  2845. <td>
  2846. <code>
  2847. <em>convertible</em>
  2848. </code>
  2849. </td>
  2850. <td>
  2851. <div>
  2852. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  2853. </div>
  2854. </td>
  2855. </tr>
  2856. <tr>
  2857. <td>
  2858. <code>
  2859. <em>method</em>
  2860. </code>
  2861. </td>
  2862. <td>
  2863. <div>
  2864. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  2865. </div>
  2866. </td>
  2867. </tr>
  2868. <tr>
  2869. <td>
  2870. <code>
  2871. <em>headers</em>
  2872. </code>
  2873. </td>
  2874. <td>
  2875. <div>
  2876. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  2877. </div>
  2878. </td>
  2879. </tr>
  2880. <tr>
  2881. <td>
  2882. <code>
  2883. <em>interceptor</em>
  2884. </code>
  2885. </td>
  2886. <td>
  2887. <div>
  2888. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>nil</code> by default.</p>
  2889. </div>
  2890. </td>
  2891. </tr>
  2892. <tr>
  2893. <td>
  2894. <code>
  2895. <em>fileManager</em>
  2896. </code>
  2897. </td>
  2898. <td>
  2899. <div>
  2900. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  2901. default.</p>
  2902. </div>
  2903. </td>
  2904. </tr>
  2905. <tr>
  2906. <td>
  2907. <code>
  2908. <em>requestModifier</em>
  2909. </code>
  2910. </td>
  2911. <td>
  2912. <div>
  2913. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the provided
  2914. parameters. <code>nil</code> by default.</p>
  2915. </div>
  2916. </td>
  2917. </tr>
  2918. </tbody>
  2919. </table>
  2920. </div>
  2921. <div>
  2922. <h4>Return Value</h4>
  2923. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  2924. </div>
  2925. </section>
  2926. </div>
  2927. </li>
  2928. <li class="item">
  2929. <div>
  2930. <code>
  2931. <a name="/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF"></a>
  2932. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
  2933. <a class="token" href="#/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF">upload(_:<wbr>with:<wbr>interceptor:<wbr>fileManager:<wbr>)</a>
  2934. </code>
  2935. </div>
  2936. <div class="height-container">
  2937. <div class="pointer-container"></div>
  2938. <section class="section">
  2939. <div class="pointer"></div>
  2940. <div class="abstract">
  2941. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the file at the given file <code>URL</code> using the <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and
  2942. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2943. </div>
  2944. <div class="declaration">
  2945. <h4>Declaration</h4>
  2946. <div class="language">
  2947. <p class="aside-title">Swift</p>
  2948. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
  2949. <span class="n">with</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  2950. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2951. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2952. </div>
  2953. </div>
  2954. <div>
  2955. <h4>Parameters</h4>
  2956. <table class="graybox">
  2957. <tbody>
  2958. <tr>
  2959. <td>
  2960. <code>
  2961. <em>fileURL</em>
  2962. </code>
  2963. </td>
  2964. <td>
  2965. <div>
  2966. <p>The <code>URL</code> of the file to upload.</p>
  2967. </div>
  2968. </td>
  2969. </tr>
  2970. <tr>
  2971. <td>
  2972. <code>
  2973. <em>convertible</em>
  2974. </code>
  2975. </td>
  2976. <td>
  2977. <div>
  2978. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  2979. </div>
  2980. </td>
  2981. </tr>
  2982. <tr>
  2983. <td>
  2984. <code>
  2985. <em>interceptor</em>
  2986. </code>
  2987. </td>
  2988. <td>
  2989. <div>
  2990. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2991. </div>
  2992. </td>
  2993. </tr>
  2994. <tr>
  2995. <td>
  2996. <code>
  2997. <em>fileManager</em>
  2998. </code>
  2999. </td>
  3000. <td>
  3001. <div>
  3002. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  3003. default.</p>
  3004. </div>
  3005. </td>
  3006. </tr>
  3007. </tbody>
  3008. </table>
  3009. </div>
  3010. <div>
  3011. <h4>Return Value</h4>
  3012. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3013. </div>
  3014. </section>
  3015. </div>
  3016. </li>
  3017. </ul>
  3018. </div>
  3019. <div class="task-group">
  3020. <div class="task-name-container">
  3021. <a name="/InputStream"></a>
  3022. <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
  3023. <div class="section-name-container">
  3024. <a class="section-name-link" href="#/InputStream"></a>
  3025. <h3 class="section-name"><span>InputStream</span>
  3026. </h3>
  3027. </div>
  3028. </div>
  3029. <ul class="item-container">
  3030. <li class="item">
  3031. <div>
  3032. <code>
  3033. <a name="/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0M11Interceptor_pSgSo06NSFileI0Cy10Foundation10URLRequestVzKcSgtF"></a>
  3034. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:requestModifier:)" class="dashAnchor"></a>
  3035. <a class="token" href="#/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0M11Interceptor_pSgSo06NSFileI0Cy10Foundation10URLRequestVzKcSgtF">upload(_:<wbr>to:<wbr>method:<wbr>headers:<wbr>interceptor:<wbr>fileManager:<wbr>requestModifier:<wbr>)</a>
  3036. </code>
  3037. </div>
  3038. <div class="height-container">
  3039. <div class="pointer-container"></div>
  3040. <section class="section">
  3041. <div class="pointer"></div>
  3042. <div class="abstract">
  3043. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> from the <code>InputStream</code> provided using a <code>URLRequest</code> from the provided components and
  3044. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  3045. </div>
  3046. <div class="declaration">
  3047. <h4>Declaration</h4>
  3048. <div class="language">
  3049. <p class="aside-title">Swift</p>
  3050. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span>
  3051. <span class="n">to</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  3052. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  3053. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3054. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3055. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
  3056. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  3057. </div>
  3058. </div>
  3059. <div>
  3060. <h4>Parameters</h4>
  3061. <table class="graybox">
  3062. <tbody>
  3063. <tr>
  3064. <td>
  3065. <code>
  3066. <em>stream</em>
  3067. </code>
  3068. </td>
  3069. <td>
  3070. <div>
  3071. <p>The <code>InputStream</code> that provides the data to upload.</p>
  3072. </div>
  3073. </td>
  3074. </tr>
  3075. <tr>
  3076. <td>
  3077. <code>
  3078. <em>convertible</em>
  3079. </code>
  3080. </td>
  3081. <td>
  3082. <div>
  3083. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  3084. </div>
  3085. </td>
  3086. </tr>
  3087. <tr>
  3088. <td>
  3089. <code>
  3090. <em>method</em>
  3091. </code>
  3092. </td>
  3093. <td>
  3094. <div>
  3095. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  3096. </div>
  3097. </td>
  3098. </tr>
  3099. <tr>
  3100. <td>
  3101. <code>
  3102. <em>headers</em>
  3103. </code>
  3104. </td>
  3105. <td>
  3106. <div>
  3107. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  3108. </div>
  3109. </td>
  3110. </tr>
  3111. <tr>
  3112. <td>
  3113. <code>
  3114. <em>interceptor</em>
  3115. </code>
  3116. </td>
  3117. <td>
  3118. <div>
  3119. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  3120. </div>
  3121. </td>
  3122. </tr>
  3123. <tr>
  3124. <td>
  3125. <code>
  3126. <em>fileManager</em>
  3127. </code>
  3128. </td>
  3129. <td>
  3130. <div>
  3131. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  3132. default.</p>
  3133. </div>
  3134. </td>
  3135. </tr>
  3136. <tr>
  3137. <td>
  3138. <code>
  3139. <em>requestModifier</em>
  3140. </code>
  3141. </td>
  3142. <td>
  3143. <div>
  3144. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the provided
  3145. parameters. <code>nil</code> by default.</p>
  3146. </div>
  3147. </td>
  3148. </tr>
  3149. </tbody>
  3150. </table>
  3151. </div>
  3152. <div>
  3153. <h4>Return Value</h4>
  3154. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3155. </div>
  3156. </section>
  3157. </div>
  3158. </li>
  3159. <li class="item">
  3160. <div>
  3161. <code>
  3162. <a name="/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF"></a>
  3163. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
  3164. <a class="token" href="#/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF">upload(_:<wbr>with:<wbr>interceptor:<wbr>fileManager:<wbr>)</a>
  3165. </code>
  3166. </div>
  3167. <div class="height-container">
  3168. <div class="pointer-container"></div>
  3169. <section class="section">
  3170. <div class="pointer"></div>
  3171. <div class="abstract">
  3172. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> from the provided <code>InputStream</code> using the <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and
  3173. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  3174. </div>
  3175. <div class="declaration">
  3176. <h4>Declaration</h4>
  3177. <div class="language">
  3178. <p class="aside-title">Swift</p>
  3179. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span>
  3180. <span class="n">with</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  3181. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3182. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  3183. </div>
  3184. </div>
  3185. <div>
  3186. <h4>Parameters</h4>
  3187. <table class="graybox">
  3188. <tbody>
  3189. <tr>
  3190. <td>
  3191. <code>
  3192. <em>stream</em>
  3193. </code>
  3194. </td>
  3195. <td>
  3196. <div>
  3197. <p>The <code>InputStream</code> that provides the data to upload.</p>
  3198. </div>
  3199. </td>
  3200. </tr>
  3201. <tr>
  3202. <td>
  3203. <code>
  3204. <em>convertible</em>
  3205. </code>
  3206. </td>
  3207. <td>
  3208. <div>
  3209. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  3210. </div>
  3211. </td>
  3212. </tr>
  3213. <tr>
  3214. <td>
  3215. <code>
  3216. <em>interceptor</em>
  3217. </code>
  3218. </td>
  3219. <td>
  3220. <div>
  3221. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  3222. </div>
  3223. </td>
  3224. </tr>
  3225. <tr>
  3226. <td>
  3227. <code>
  3228. <em>fileManager</em>
  3229. </code>
  3230. </td>
  3231. <td>
  3232. <div>
  3233. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  3234. default.</p>
  3235. </div>
  3236. </td>
  3237. </tr>
  3238. </tbody>
  3239. </table>
  3240. </div>
  3241. <div>
  3242. <h4>Return Value</h4>
  3243. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3244. </div>
  3245. </section>
  3246. </div>
  3247. </li>
  3248. </ul>
  3249. </div>
  3250. <div class="task-group">
  3251. <div class="task-name-container">
  3252. <a name="/MultipartFormData"></a>
  3253. <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
  3254. <div class="section-name-container">
  3255. <a class="section-name-link" href="#/MultipartFormData"></a>
  3256. <h3 class="section-name"><span>MultipartFormData</span>
  3257. </h3>
  3258. </div>
  3259. </div>
  3260. <ul class="item-container">
  3261. <li class="item">
  3262. <div>
  3263. <code>
  3264. <a name="/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestCyAA09MultiparteF0Cc_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0R11Interceptor_pSgSo06NSFileN0Cy10Foundation10URLRequestVzKcSgtF"></a>
  3265. <a name="//apple_ref/swift/Method/upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:requestModifier:)" class="dashAnchor"></a>
  3266. <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestCyAA09MultiparteF0Cc_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0R11Interceptor_pSgSo06NSFileN0Cy10Foundation10URLRequestVzKcSgtF">upload(multipartFormData:<wbr>to:<wbr>usingThreshold:<wbr>method:<wbr>headers:<wbr>interceptor:<wbr>fileManager:<wbr>requestModifier:<wbr>)</a>
  3267. </code>
  3268. </div>
  3269. <div class="height-container">
  3270. <div class="pointer-container"></div>
  3271. <section class="section">
  3272. <div class="pointer"></div>
  3273. <div class="abstract">
  3274. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the multipart form data built using a closure and sent using the provided
  3275. <code>URLRequest</code> components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  3276. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  3277. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  3278. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  3279. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  3280. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  3281. used for larger payloads such as video content.</p>
  3282. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  3283. or stream from disk. If the content length of the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> is below the <code>encodingMemoryThreshold</code>,
  3284. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  3285. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  3286. technique was used.</p>
  3287. </div>
  3288. <div class="declaration">
  3289. <h4>Declaration</h4>
  3290. <div class="language">
  3291. <p class="aside-title">Swift</p>
  3292. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
  3293. <span class="n">to</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  3294. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  3295. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  3296. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3297. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3298. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
  3299. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  3300. </div>
  3301. </div>
  3302. <div>
  3303. <h4>Parameters</h4>
  3304. <table class="graybox">
  3305. <tbody>
  3306. <tr>
  3307. <td>
  3308. <code>
  3309. <em>multipartFormData</em>
  3310. </code>
  3311. </td>
  3312. <td>
  3313. <div>
  3314. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
  3315. </div>
  3316. </td>
  3317. </tr>
  3318. <tr>
  3319. <td>
  3320. <code>
  3321. <em>url</em>
  3322. </code>
  3323. </td>
  3324. <td>
  3325. <div>
  3326. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  3327. </div>
  3328. </td>
  3329. </tr>
  3330. <tr>
  3331. <td>
  3332. <code>
  3333. <em>encodingMemoryThreshold</em>
  3334. </code>
  3335. </td>
  3336. <td>
  3337. <div>
  3338. <p>Byte threshold used to determine whether the form data is encoded into memory or
  3339. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  3340. default.</p>
  3341. </div>
  3342. </td>
  3343. </tr>
  3344. <tr>
  3345. <td>
  3346. <code>
  3347. <em>method</em>
  3348. </code>
  3349. </td>
  3350. <td>
  3351. <div>
  3352. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  3353. </div>
  3354. </td>
  3355. </tr>
  3356. <tr>
  3357. <td>
  3358. <code>
  3359. <em>headers</em>
  3360. </code>
  3361. </td>
  3362. <td>
  3363. <div>
  3364. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  3365. </div>
  3366. </td>
  3367. </tr>
  3368. <tr>
  3369. <td>
  3370. <code>
  3371. <em>interceptor</em>
  3372. </code>
  3373. </td>
  3374. <td>
  3375. <div>
  3376. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  3377. </div>
  3378. </td>
  3379. </tr>
  3380. <tr>
  3381. <td>
  3382. <code>
  3383. <em>fileManager</em>
  3384. </code>
  3385. </td>
  3386. <td>
  3387. <div>
  3388. <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
  3389. written to disk before being uploaded. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by default.</p>
  3390. </div>
  3391. </td>
  3392. </tr>
  3393. <tr>
  3394. <td>
  3395. <code>
  3396. <em>requestModifier</em>
  3397. </code>
  3398. </td>
  3399. <td>
  3400. <div>
  3401. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the
  3402. provided parameters. <code>nil</code> by default.</p>
  3403. </div>
  3404. </td>
  3405. </tr>
  3406. </tbody>
  3407. </table>
  3408. </div>
  3409. <div>
  3410. <h4>Return Value</h4>
  3411. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3412. </div>
  3413. </section>
  3414. </div>
  3415. </li>
  3416. <li class="item">
  3417. <div>
  3418. <code>
  3419. <a name="/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF"></a>
  3420. <a name="//apple_ref/swift/Method/upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)" class="dashAnchor"></a>
  3421. <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF">upload(multipartFormData:<wbr>with:<wbr>usingThreshold:<wbr>interceptor:<wbr>fileManager:<wbr>)</a>
  3422. </code>
  3423. </div>
  3424. <div class="height-container">
  3425. <div class="pointer-container"></div>
  3426. <section class="section">
  3427. <div class="pointer"></div>
  3428. <div class="abstract">
  3429. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using a <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure, the provided <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>
  3430. value, and a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  3431. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  3432. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  3433. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  3434. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  3435. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  3436. used for larger payloads such as video content.</p>
  3437. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  3438. or stream from disk. If the content length of the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> is below the <code>encodingMemoryThreshold</code>,
  3439. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  3440. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  3441. technique was used.</p>
  3442. </div>
  3443. <div class="declaration">
  3444. <h4>Declaration</h4>
  3445. <div class="language">
  3446. <p class="aside-title">Swift</p>
  3447. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
  3448. <span class="n">with</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  3449. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  3450. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3451. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  3452. </div>
  3453. </div>
  3454. <div>
  3455. <h4>Parameters</h4>
  3456. <table class="graybox">
  3457. <tbody>
  3458. <tr>
  3459. <td>
  3460. <code>
  3461. <em>multipartFormData</em>
  3462. </code>
  3463. </td>
  3464. <td>
  3465. <div>
  3466. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
  3467. </div>
  3468. </td>
  3469. </tr>
  3470. <tr>
  3471. <td>
  3472. <code>
  3473. <em>request</em>
  3474. </code>
  3475. </td>
  3476. <td>
  3477. <div>
  3478. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  3479. </div>
  3480. </td>
  3481. </tr>
  3482. <tr>
  3483. <td>
  3484. <code>
  3485. <em>encodingMemoryThreshold</em>
  3486. </code>
  3487. </td>
  3488. <td>
  3489. <div>
  3490. <p>Byte threshold used to determine whether the form data is encoded into memory or
  3491. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  3492. default.</p>
  3493. </div>
  3494. </td>
  3495. </tr>
  3496. <tr>
  3497. <td>
  3498. <code>
  3499. <em>interceptor</em>
  3500. </code>
  3501. </td>
  3502. <td>
  3503. <div>
  3504. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  3505. </div>
  3506. </td>
  3507. </tr>
  3508. <tr>
  3509. <td>
  3510. <code>
  3511. <em>fileManager</em>
  3512. </code>
  3513. </td>
  3514. <td>
  3515. <div>
  3516. <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
  3517. written to disk before being uploaded. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by default.</p>
  3518. </div>
  3519. </td>
  3520. </tr>
  3521. </tbody>
  3522. </table>
  3523. </div>
  3524. <div>
  3525. <h4>Return Value</h4>
  3526. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3527. </div>
  3528. </section>
  3529. </div>
  3530. </li>
  3531. <li class="item">
  3532. <div>
  3533. <code>
  3534. <a name="/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestCAA09MultiparteF0C_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0R11Interceptor_pSgSo06NSFileN0Cy10Foundation10URLRequestVzKcSgtF"></a>
  3535. <a name="//apple_ref/swift/Method/upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:requestModifier:)" class="dashAnchor"></a>
  3536. <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManager15requestModifierAA13UploadRequestCAA09MultiparteF0C_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0R11Interceptor_pSgSo06NSFileN0Cy10Foundation10URLRequestVzKcSgtF">upload(multipartFormData:<wbr>to:<wbr>usingThreshold:<wbr>method:<wbr>headers:<wbr>interceptor:<wbr>fileManager:<wbr>requestModifier:<wbr>)</a>
  3537. </code>
  3538. </div>
  3539. <div class="height-container">
  3540. <div class="pointer-container"></div>
  3541. <section class="section">
  3542. <div class="pointer"></div>
  3543. <div class="abstract">
  3544. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the prebuilt <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> value using the provided <code>URLRequest</code> components
  3545. and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  3546. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  3547. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  3548. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  3549. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  3550. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  3551. used for larger payloads such as video content.</p>
  3552. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  3553. or stream from disk. If the content length of the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> is below the <code>encodingMemoryThreshold</code>,
  3554. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  3555. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  3556. technique was used.</p>
  3557. </div>
  3558. <div class="declaration">
  3559. <h4>Declaration</h4>
  3560. <div class="language">
  3561. <p class="aside-title">Swift</p>
  3562. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">,</span>
  3563. <span class="n">to</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  3564. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  3565. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  3566. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3567. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3568. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
  3569. <span class="nv">requestModifier</span><span class="p">:</span> <span class="kt"><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  3570. </div>
  3571. </div>
  3572. <div>
  3573. <h4>Parameters</h4>
  3574. <table class="graybox">
  3575. <tbody>
  3576. <tr>
  3577. <td>
  3578. <code>
  3579. <em>multipartFormData</em>
  3580. </code>
  3581. </td>
  3582. <td>
  3583. <div>
  3584. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
  3585. </div>
  3586. </td>
  3587. </tr>
  3588. <tr>
  3589. <td>
  3590. <code>
  3591. <em>url</em>
  3592. </code>
  3593. </td>
  3594. <td>
  3595. <div>
  3596. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  3597. </div>
  3598. </td>
  3599. </tr>
  3600. <tr>
  3601. <td>
  3602. <code>
  3603. <em>encodingMemoryThreshold</em>
  3604. </code>
  3605. </td>
  3606. <td>
  3607. <div>
  3608. <p>Byte threshold used to determine whether the form data is encoded into memory or
  3609. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  3610. default.</p>
  3611. </div>
  3612. </td>
  3613. </tr>
  3614. <tr>
  3615. <td>
  3616. <code>
  3617. <em>method</em>
  3618. </code>
  3619. </td>
  3620. <td>
  3621. <div>
  3622. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  3623. </div>
  3624. </td>
  3625. </tr>
  3626. <tr>
  3627. <td>
  3628. <code>
  3629. <em>headers</em>
  3630. </code>
  3631. </td>
  3632. <td>
  3633. <div>
  3634. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  3635. </div>
  3636. </td>
  3637. </tr>
  3638. <tr>
  3639. <td>
  3640. <code>
  3641. <em>interceptor</em>
  3642. </code>
  3643. </td>
  3644. <td>
  3645. <div>
  3646. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  3647. </div>
  3648. </td>
  3649. </tr>
  3650. <tr>
  3651. <td>
  3652. <code>
  3653. <em>fileManager</em>
  3654. </code>
  3655. </td>
  3656. <td>
  3657. <div>
  3658. <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
  3659. written to disk before being uploaded. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by default.</p>
  3660. </div>
  3661. </td>
  3662. </tr>
  3663. <tr>
  3664. <td>
  3665. <code>
  3666. <em>requestModifier</em>
  3667. </code>
  3668. </td>
  3669. <td>
  3670. <div>
  3671. <p><code><a href="../Classes/Session.html#/s:9Alamofire7SessionC15RequestModifiera">RequestModifier</a></code> which will be applied to the <code>URLRequest</code> created from the
  3672. provided parameters. <code>nil</code> by default.</p>
  3673. </div>
  3674. </td>
  3675. </tr>
  3676. </tbody>
  3677. </table>
  3678. </div>
  3679. <div>
  3680. <h4>Return Value</h4>
  3681. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3682. </div>
  3683. </section>
  3684. </div>
  3685. </li>
  3686. <li class="item">
  3687. <div>
  3688. <code>
  3689. <a name="/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF"></a>
  3690. <a name="//apple_ref/swift/Method/upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)" class="dashAnchor"></a>
  3691. <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF">upload(multipartFormData:<wbr>with:<wbr>usingThreshold:<wbr>interceptor:<wbr>fileManager:<wbr>)</a>
  3692. </code>
  3693. </div>
  3694. <div class="height-container">
  3695. <div class="pointer-container"></div>
  3696. <section class="section">
  3697. <div class="pointer"></div>
  3698. <div class="abstract">
  3699. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the prebuilt <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> value using the providing <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>
  3700. value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  3701. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  3702. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  3703. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  3704. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  3705. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  3706. used for larger payloads such as video content.</p>
  3707. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  3708. or stream from disk. If the content length of the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> is below the <code>encodingMemoryThreshold</code>,
  3709. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  3710. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  3711. technique was used.</p>
  3712. </div>
  3713. <div class="declaration">
  3714. <h4>Declaration</h4>
  3715. <div class="language">
  3716. <p class="aside-title">Swift</p>
  3717. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">,</span>
  3718. <span class="n">with</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  3719. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  3720. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  3721. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  3722. </div>
  3723. </div>
  3724. <div>
  3725. <h4>Parameters</h4>
  3726. <table class="graybox">
  3727. <tbody>
  3728. <tr>
  3729. <td>
  3730. <code>
  3731. <em>multipartFormData</em>
  3732. </code>
  3733. </td>
  3734. <td>
  3735. <div>
  3736. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
  3737. </div>
  3738. </td>
  3739. </tr>
  3740. <tr>
  3741. <td>
  3742. <code>
  3743. <em>request</em>
  3744. </code>
  3745. </td>
  3746. <td>
  3747. <div>
  3748. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  3749. </div>
  3750. </td>
  3751. </tr>
  3752. <tr>
  3753. <td>
  3754. <code>
  3755. <em>encodingMemoryThreshold</em>
  3756. </code>
  3757. </td>
  3758. <td>
  3759. <div>
  3760. <p>Byte threshold used to determine whether the form data is encoded into memory or
  3761. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  3762. default.</p>
  3763. </div>
  3764. </td>
  3765. </tr>
  3766. <tr>
  3767. <td>
  3768. <code>
  3769. <em>interceptor</em>
  3770. </code>
  3771. </td>
  3772. <td>
  3773. <div>
  3774. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  3775. </div>
  3776. </td>
  3777. </tr>
  3778. <tr>
  3779. <td>
  3780. <code>
  3781. <em>fileManager</em>
  3782. </code>
  3783. </td>
  3784. <td>
  3785. <div>
  3786. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by
  3787. default.</p>
  3788. </div>
  3789. </td>
  3790. </tr>
  3791. </tbody>
  3792. </table>
  3793. </div>
  3794. <div>
  3795. <h4>Return Value</h4>
  3796. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  3797. </div>
  3798. </section>
  3799. </div>
  3800. </li>
  3801. </ul>
  3802. </div>
  3803. <div class="task-group">
  3804. <div class="task-name-container">
  3805. <a name="/RequestDelegate"></a>
  3806. <a name="//apple_ref/swift/Section/RequestDelegate" class="dashAnchor"></a>
  3807. <div class="section-name-container">
  3808. <a class="section-name-link" href="#/RequestDelegate"></a>
  3809. <h3 class="section-name"><span>RequestDelegate</span>
  3810. </h3>
  3811. </div>
  3812. </div>
  3813. <ul class="item-container">
  3814. <li class="item">
  3815. <div>
  3816. <code>
  3817. <a name="/s:9Alamofire15RequestDelegateP20sessionConfigurationSo012NSURLSessionE0Cvp"></a>
  3818. <a name="//apple_ref/swift/Property/sessionConfiguration" class="dashAnchor"></a>
  3819. <a class="token" href="#/s:9Alamofire15RequestDelegateP20sessionConfigurationSo012NSURLSessionE0Cvp">sessionConfiguration</a>
  3820. </code>
  3821. </div>
  3822. <div class="height-container">
  3823. <div class="pointer-container"></div>
  3824. <section class="section">
  3825. <div class="pointer"></div>
  3826. <div class="abstract">
  3827. </div>
  3828. <div class="declaration">
  3829. <h4>Declaration</h4>
  3830. <div class="language">
  3831. <p class="aside-title">Swift</p>
  3832. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">sessionConfiguration</span><span class="p">:</span> <span class="kt">URLSessionConfiguration</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  3833. </div>
  3834. </div>
  3835. </section>
  3836. </div>
  3837. </li>
  3838. <li class="item">
  3839. <div>
  3840. <code>
  3841. <a name="/s:9Alamofire15RequestDelegateP16startImmediatelySbvp"></a>
  3842. <a name="//apple_ref/swift/Property/startImmediately" class="dashAnchor"></a>
  3843. <a class="token" href="#/s:9Alamofire15RequestDelegateP16startImmediatelySbvp">startImmediately</a>
  3844. </code>
  3845. </div>
  3846. <div class="height-container">
  3847. <div class="pointer-container"></div>
  3848. <section class="section">
  3849. <div class="pointer"></div>
  3850. <div class="abstract">
  3851. </div>
  3852. <div class="declaration">
  3853. <h4>Declaration</h4>
  3854. <div class="language">
  3855. <p class="aside-title">Swift</p>
  3856. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startImmediately</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>
  3857. </div>
  3858. </div>
  3859. </section>
  3860. </div>
  3861. </li>
  3862. <li class="item">
  3863. <div>
  3864. <code>
  3865. <a name="/s:9Alamofire15RequestDelegateP7cleanup5afteryAA0B0C_tF"></a>
  3866. <a name="//apple_ref/swift/Method/cleanup(after:)" class="dashAnchor"></a>
  3867. <a class="token" href="#/s:9Alamofire15RequestDelegateP7cleanup5afteryAA0B0C_tF">cleanup(after:<wbr>)</a>
  3868. </code>
  3869. </div>
  3870. <div class="height-container">
  3871. <div class="pointer-container"></div>
  3872. <section class="section">
  3873. <div class="pointer"></div>
  3874. <div class="abstract">
  3875. </div>
  3876. <div class="declaration">
  3877. <h4>Declaration</h4>
  3878. <div class="language">
  3879. <p class="aside-title">Swift</p>
  3880. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">cleanup</span><span class="p">(</span><span class="n">after</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="p">)</span></code></pre>
  3881. </div>
  3882. </div>
  3883. </section>
  3884. </div>
  3885. </li>
  3886. <li class="item">
  3887. <div>
  3888. <code>
  3889. <a name="/s:9Alamofire15RequestDelegateP11retryResult3for5dueTo10completionyAA0B0C_AA7AFErrorOyAA05RetryE0OctF"></a>
  3890. <a name="//apple_ref/swift/Method/retryResult(for:dueTo:completion:)" class="dashAnchor"></a>
  3891. <a class="token" href="#/s:9Alamofire15RequestDelegateP11retryResult3for5dueTo10completionyAA0B0C_AA7AFErrorOyAA05RetryE0OctF">retryResult(for:<wbr>dueTo:<wbr>completion:<wbr>)</a>
  3892. </code>
  3893. </div>
  3894. <div class="height-container">
  3895. <div class="pointer-container"></div>
  3896. <section class="section">
  3897. <div class="pointer"></div>
  3898. <div class="abstract">
  3899. </div>
  3900. <div class="declaration">
  3901. <h4>Declaration</h4>
  3902. <div class="language">
  3903. <p class="aside-title">Swift</p>
  3904. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">retryResult</span><span class="p">(</span><span class="k">for</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="p">,</span> <span class="n">dueTo</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="nv">completion</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Enums/RetryResult.html">RetryResult</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  3905. </div>
  3906. </div>
  3907. </section>
  3908. </div>
  3909. </li>
  3910. <li class="item">
  3911. <div>
  3912. <code>
  3913. <a name="/s:9Alamofire15RequestDelegateP05retryB0_9withDelayyAA0B0C_SdSgtF"></a>
  3914. <a name="//apple_ref/swift/Method/retryRequest(_:withDelay:)" class="dashAnchor"></a>
  3915. <a class="token" href="#/s:9Alamofire15RequestDelegateP05retryB0_9withDelayyAA0B0C_SdSgtF">retryRequest(_:<wbr>withDelay:<wbr>)</a>
  3916. </code>
  3917. </div>
  3918. <div class="height-container">
  3919. <div class="pointer-container"></div>
  3920. <section class="section">
  3921. <div class="pointer"></div>
  3922. <div class="abstract">
  3923. </div>
  3924. <div class="declaration">
  3925. <h4>Declaration</h4>
  3926. <div class="language">
  3927. <p class="aside-title">Swift</p>
  3928. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">retryRequest</span><span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/Request.html">Request</a></span><span class="p">,</span> <span class="n">withDelay</span> <span class="nv">timeDelay</span><span class="p">:</span> <span class="kt">TimeInterval</span><span class="p">?)</span></code></pre>
  3929. </div>
  3930. </div>
  3931. </section>
  3932. </div>
  3933. </li>
  3934. </ul>
  3935. </div>
  3936. </div>
  3937. </section>
  3938. </article>
  3939. </div>
  3940. <section class="footer">
  3941. <p>&copy; 2022 <a class="link" href="http://alamofire.org/" target="_blank" rel="external noopener">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2022-11-21)</p>
  3942. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
  3943. </section>
  3944. </body>
  3945. </html>