| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>Session Class Reference</title>
- <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
- <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
- <meta charset="utf-8">
- <script src="../js/jquery.min.js" defer></script>
- <script src="../js/jazzy.js" defer></script>
-
- <script src="../js/lunr.min.js" defer></script>
- <script src="../js/typeahead.jquery.js" defer></script>
- <script src="../js/jazzy.search.js" defer></script>
- </head>
- <body>
- <a name="//apple_ref/swift/Class/Session" class="dashAnchor"></a>
- <a title="Session Class Reference"></a>
- <header class="header">
- <p class="header-col header-col--primary">
- <a class="header-link" href="../index.html">
- Alamofire Docs
- </a>
- (98% documented)
- </p>
-
- <p class="header-col--secondary">
- <form role="search" action="../search.json">
- <input type="text" placeholder="Search documentation" data-typeahead>
- </form>
- </p>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="https://github.com/Alamofire/Alamofire">
- <img class="header-icon" src="../img/gh.png"/>
- View on GitHub
- </a>
- </p>
-
- <p class="header-col header-col--secondary">
- <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
- <img class="header-icon" src="../img/dash.png"/>
- Install in Dash
- </a>
- </p>
- </header>
- <p class="breadcrumbs">
- <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
- <img class="carat" src="../img/carat.png" />
- Session Class Reference
- </p>
- <div class="content-wrapper">
- <nav class="navigation">
- <ul class="nav-groups">
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Classes.html">Classes</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Structs.html">Structures</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section class="section">
- <div class="section-content">
- <h1>Session</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Session</span></code></pre>
- </div>
- </div>
- <p><code>Session</code> creates and manages Alamofire’s <code><a href="../Classes/Request.html">Request</a></code> types during their lifetimes. It also provides common
- functionality for all <code><a href="../Classes/Request.html">Request</a></code>s, including queuing, interception, trust management, redirect handling, and response
- cache handling.</p>
- </div>
- </section>
- <section class="section">
- <div class="section-content">
- <div class="task-group">
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC7defaultACvpZ"></a>
- <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC7defaultACvpZ">default</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Shared singleton instance used by all <code>AF.request</code> APIs. Cannot be modified.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp"></a>
- <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp">session</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Underlying <code>URLSession</code> used to create <code>URLSessionTasks</code> for this instance, and for which this instance’s
- <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC8delegateAA0B8DelegateCvp">delegate</a></code> handles <code>URLSessionDelegate</code> callbacks.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC8delegateAA0B8DelegateCvp"></a>
- <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC8delegateAA0B8DelegateCvp">delegate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Instance’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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SessionDelegate.html">SessionDelegate</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp"></a>
- <a name="//apple_ref/swift/Property/rootQueue" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Root <code>DispatchQueue</code> for all internal callbacks and state update. <strong>MUST</strong> be a serial queue.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">rootQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC24startRequestsImmediatelySbvp"></a>
- <a name="//apple_ref/swift/Property/startRequestsImmediately" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC24startRequestsImmediatelySbvp">startRequestsImmediately</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC12requestQueueSo17OS_dispatch_queueCvp"></a>
- <a name="//apple_ref/swift/Property/requestQueue" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC12requestQueueSo17OS_dispatch_queueCvp">requestQueue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code>target</code>, but a separate queue can be used if request creation is determined to be a bottleneck. Always profile
- and test before introducing an additional queue.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">requestQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC18serializationQueueSo17OS_dispatch_queueCvp"></a>
- <a name="//apple_ref/swift/Property/serializationQueue" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC18serializationQueueSo17OS_dispatch_queueCvp">serializationQueue</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><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
- 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
- to be a bottleneck. Always profile and test before introducing an additional queue.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serializationQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC11interceptorAA18RequestInterceptor_pSgvp"></a>
- <a name="//apple_ref/swift/Property/interceptor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC11interceptorAA18RequestInterceptor_pSgvp">interceptor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><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
- per-<code><a href="../Classes/Request.html">Request</a></code> basis, in which case the <code><a href="../Classes/Request.html">Request</a></code>‘s interceptor takes precedence over this value.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC18serverTrustManagerAA06ServerdE0CSgvp"></a>
- <a name="//apple_ref/swift/Property/serverTrustManager" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC18serverTrustManagerAA06ServerdE0CSgvp">serverTrustManager</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></code> instance used to evaluate all trust challenges and provide certificate and key pinning.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">serverTrustManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></span><span class="p">?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC15redirectHandlerAA08RedirectD0_pSgvp"></a>
- <a name="//apple_ref/swift/Property/redirectHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC15redirectHandlerAA08RedirectD0_pSgvp">redirectHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></code> instance used to provide customization for request redirection.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">redirectHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RedirectHandler.html">RedirectHandler</a></span><span class="p">?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC21cachedResponseHandlerAA06CacheddE0_pSgvp"></a>
- <a name="//apple_ref/swift/Property/cachedResponseHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC21cachedResponseHandlerAA06CacheddE0_pSgvp">cachedResponseHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></code> instance used to provide customization of cached response handling.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">cachedResponseHandler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a></span><span class="p">?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC12eventMonitorAA014CompositeEventD0Cvp"></a>
- <a name="//apple_ref/swift/Property/eventMonitor" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC12eventMonitorAA014CompositeEventD0Cvp">eventMonitor</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a></code> used to compose Alamofire’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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">eventMonitor</span><span class="p">:</span> <span class="kt"><a href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC20defaultEventMonitorsSayAA0D7Monitor_pGvp"></a>
- <a name="//apple_ref/swift/Property/defaultEventMonitors" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC20defaultEventMonitorsSayAA0D7Monitor_pGvp">defaultEventMonitors</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p><code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s included in all instances. <code>[AlamofireNotifications()]</code> by default.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC7session8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo12NSURLSessionC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc"></a>
- <a name="//apple_ref/swift/Method/init(session:delegate:rootQueue:startRequestsImmediately:requestQueue:serializationQueue:interceptor:serverTrustManager:redirectHandler:cachedResponseHandler:eventMonitors:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC7session8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo12NSURLSessionC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc">init(session:delegate:rootQueue:startRequestsImmediately:requestQueue:serializationQueue:interceptor:serverTrustManager:redirectHandler:cachedResponseHandler:eventMonitors:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code>Session</code> from a <code>URLSession</code> and other parameters.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>When passing a <code>URLSession</code>, you must create the <code>URLSession</code> with a specific <code>delegateQueue</code> value and
- pass the <code>delegateQueue</code>‘s <code>underlyingQueue</code> as the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC9rootQueueSo17OS_dispatch_queueCvp">rootQueue</a></code> parameter of this initializer.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SessionDelegate.html">SessionDelegate</a></span><span class="p">,</span>
- <span class="nv">rootQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">,</span>
- <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>
- <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>
- <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>
- <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="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>
- <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>
- <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>
- <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>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>session</em>
- </code>
- </td>
- <td>
- <div>
- <p>Underlying <code>URLSession</code> for this instance.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>delegate</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/SessionDelegate.html">SessionDelegate</a></code> that handles <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp">session</a></code>‘s delegate callbacks as well as <code><a href="../Classes/Request.html">Request</a></code>
- interaction.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>rootQueue</em>
- </code>
- </td>
- <td>
- <div>
- <p>Root <code>DispatchQueue</code> for all internal callbacks and state updates. <strong>MUST</strong> be a
- serial queue.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>startRequestsImmediately</em>
- </code>
- </td>
- <td>
- <div>
- <p>Determines whether this instance will automatically start all <code><a href="../Classes/Request.html">Request</a></code>s. <code>true</code>
- 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.
- on them for them to start.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>requestQueue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which to perform <code>URLRequest</code> creation. By default this 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 it’s
- determined request creation is a bottleneck, but that should only be done after
- careful testing and profiling. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>serializationQueue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which to perform all response serialization. By default this
- 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
- it’s determined response serialization is a bottleneck, but that should only be
- done after careful testing and profiling. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>serverTrustManager</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></code> to be used for all trust evaluations by this instance. <code>nil</code>
- by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>redirectHandler</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>cachedResponseHandler</em>
- </code>
- </td>
- <td>
- <div>
- <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.
- <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>eventMonitors</em>
- </code>
- </td>
- <td>
- <div>
- <p>Additional <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s used by the instance. Alamofire always adds a
- <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>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC13configuration8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo25NSURLSessionConfigurationC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc"></a>
- <a name="//apple_ref/swift/Method/init(configuration:delegate:rootQueue:startRequestsImmediately:requestQueue:serializationQueue:interceptor:serverTrustManager:redirectHandler:cachedResponseHandler:eventMonitors:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC13configuration8delegate9rootQueue24startRequestsImmediately07requestF0013serializationF011interceptor18serverTrustManager15redirectHandler014cachedResponseQ013eventMonitorsACSo25NSURLSessionConfigurationC_AA0B8DelegateCSo17OS_dispatch_queueCSbATSgAuA18RequestInterceptor_pSgAA06ServernO0CSgAA08RedirectQ0_pSgAA06CachedsQ0_pSgSayAA12EventMonitor_pGtcfc">init(configuration:delegate:rootQueue:startRequestsImmediately:requestQueue:serializationQueue:interceptor:serverTrustManager:redirectHandler:cachedResponseHandler:eventMonitors:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code>Session</code> from a <code>URLSessionConfiguration</code>.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>This initializer lets Alamofire handle the creation of the underlying <code>URLSession</code> and its
- <code>delegateQueue</code>, and is the recommended initializer for most uses.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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="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>
- <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>
- <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>
- <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>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>URLSessionConfiguration</code> to be used to create the underlying <code>URLSession</code>. Changes
- to this value after being passed to this initializer will have no effect.
- <code>URLSessionConfiguration.af.default</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>delegate</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/SessionDelegate.html">SessionDelegate</a></code> that handles <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7sessionSo12NSURLSessionCvp">session</a></code>‘s delegate callbacks as well as <code><a href="../Classes/Request.html">Request</a></code>
- interaction. <code>SessionDelegate()</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>rootQueue</em>
- </code>
- </td>
- <td>
- <div>
- <p>Root <code>DispatchQueue</code> for all internal callbacks and state updates. <strong>MUST</strong> be a
- serial queue. <code>DispatchQueue(label: "org.alamofire.session.rootQueue")</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>startRequestsImmediately</em>
- </code>
- </td>
- <td>
- <div>
- <p>Determines whether this instance will automatically start all <code><a href="../Classes/Request.html">Request</a></code>s. <code>true</code>
- 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.
- on them for them to start.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>requestQueue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which to perform <code>URLRequest</code> creation. By default this 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 it’s
- determined request creation is a bottleneck, but that should only be done after
- careful testing and profiling. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>serializationQueue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which to perform all response serialization. By default this
- 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
- it’s determined response serialization is a bottleneck, but that should only be
- done after careful testing and profiling. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>serverTrustManager</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/ServerTrustManager.html">ServerTrustManager</a></code> to be used for all trust evaluations by this instance. <code>nil</code>
- by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>redirectHandler</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>cachedResponseHandler</em>
- </code>
- </td>
- <td>
- <div>
- <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.
- <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>eventMonitors</em>
- </code>
- </td>
- <td>
- <div>
- <p>Additional <code><a href="../Protocols/EventMonitor.html">EventMonitor</a></code>s used by the instance. Alamofire always adds a
- <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>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Cancellation"></a>
- <a name="//apple_ref/swift/Section/Cancellation" class="dashAnchor"></a>
- <a href="#/Cancellation">
- <h3 class="section-name">Cancellation</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC17cancelAllRequests17completingOnQueue10completionySo17OS_dispatch_queueC_yycSgtF"></a>
- <a name="//apple_ref/swift/Method/cancelAllRequests(completingOnQueue:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC17cancelAllRequests17completingOnQueue10completionySo17OS_dispatch_queueC_yycSgtF">cancelAllRequests(completingOnQueue:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Cancel all active <code><a href="../Classes/Request.html">Request</a></code>s, optionally calling a completion handler when complete.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <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
- <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
- completion when cancelled.</p>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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">-></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>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>queue</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>DispatchQueue</code> on which the completion handler is run. <code>.main</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>completion</em>
- </code>
- </td>
- <td>
- <div>
- <p>Closure to be called when all <code><a href="../Classes/Request.html">Request</a></code>s have been cancelled.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DataRequest"></a>
- <a name="//apple_ref/swift/Section/DataRequest" class="dashAnchor"></a>
- <a href="#/DataRequest">
- <h3 class="section-name">DataRequest</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtF"></a>
- <a name="//apple_ref/swift/Method/request(_:method:parameters:encoding:headers:interceptor:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtF">request(_:method:parameters:encoding:headers:interceptor:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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">-></span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>parameters</em>
- </code>
- </td>
- <td>
- <div>
- <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 default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encoding</em>
- </code>
- </td>
- <td>
- <div>
- <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>.
- <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlF"></a>
- <a name="//apple_ref/swift/Method/request(_:method:parameters:encoder:headers:interceptor:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlF">request(_:method:parameters:encoder:headers:interceptor:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> from a <code>URLRequest</code> created using the passed components, <code>Encodable</code> parameters, and a
- <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="n">request</span><span class="o"><</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">></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>
- <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>
- <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>
- <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>
- <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>
- <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">-></span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>parameters</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>Encodable</code> value to be encoded into the <code>URLRequest</code>. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encoder</em>
- </code>
- </td>
- <td>
- <div>
- <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>.
- <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtF"></a>
- <a name="//apple_ref/swift/Method/request(_:interceptor:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtF">request(_:interceptor:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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">-></span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/DownloadRequest"></a>
- <a name="//apple_ref/swift/Section/DownloadRequest" class="dashAnchor"></a>
- <a href="#/DownloadRequest">
- <h3 class="section-name">DownloadRequest</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtF"></a>
- <a name="//apple_ref/swift/Method/download(_:method:parameters:encoding:headers:interceptor:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:interceptor:to:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../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
- <code>Destination</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>parameters</em>
- </code>
- </td>
- <td>
- <div>
- <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 default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encoding</em>
- </code>
- </td>
- <td>
- <div>
- <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>. Defaults
- to <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
- should be moved. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlF"></a>
- <a name="//apple_ref/swift/Method/download(_:method:parameters:encoder:headers:interceptor:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlF">download(_:method:parameters:encoder:headers:interceptor:to:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> from a <code>URLRequest</code> created using the passed components, <code>Encodable</code> parameters, and
- a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="n">download</span><span class="o"><</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">></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>
- <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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.get</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>parameters</em>
- </code>
- </td>
- <td>
- <div>
- <p>Value conforming to <code>Encodable</code> to be encoded into the <code>URLRequest</code>. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encoder</em>
- </code>
- </td>
- <td>
- <div>
- <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>. Defaults
- to <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
- should be moved. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtF"></a>
- <a name="//apple_ref/swift/Method/download(_:interceptor:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtF">download(_:interceptor:to:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
- should be moved. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtF"></a>
- <a name="//apple_ref/swift/Method/download(resumingWith:interceptor:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:interceptor:to:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates a <code><a href="../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
- well as a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, and a <code>Destination</code>.</p>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by
- Alamofire. The file will not be deleted until the system purges the temporary files.</p>
- </div>
- <div class="aside aside-note">
- <p class="aside-title">Note</p>
- <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),
- <code>resumeData</code> is broken on background URL session configurations. There’s an underlying bug in the <code>resumeData</code>
- generation logic where the data is written incorrectly and will always fail to resume the download. For more
- 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>
- </div>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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="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">-></span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>data</em>
- </code>
- </td>
- <td>
- <div>
- <p>The resume data from a previously cancelled <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> or <code>URLSessionDownloadTask</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine how and where the downloaded file
- should be moved. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Data"></a>
- <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
- <a href="#/Data">
- <h3 class="section-name">Data</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtF">upload(_:to:method:headers:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>data</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>Data</code> to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF">upload(_:with:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>data</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>Data</code> to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/File"></a>
- <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
- <a href="#/File">
- <h3 class="section-name">File</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtF">upload(_:to:method:headers:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>fileURL</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>URL</code> of the file to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF">upload(_:with:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>fileURL</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>URL</code> of the file to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/InputStream"></a>
- <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
- <a href="#/InputStream">
- <h3 class="section-name">InputStream</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtF">upload(_:to:method:headers:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stream</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>InputStream</code> that provides the data to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload_4with11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtF">upload(_:with:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>stream</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>InputStream</code> that provides the data to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/MultipartFormData"></a>
- <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
- <a href="#/MultipartFormData">
- <h3 class="section-name">MultipartFormData</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtF">upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- <code>URLRequest</code> components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
- payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- used for larger payloads such as video content.</p>
- <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
- 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>,
- encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- technique was used.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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">-></span> <span class="kt">Void</span><span class="p">,</span>
- <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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>multipartFormData</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>convertible</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingMemoryThreshold</em>
- </code>
- </td>
- <td>
- <div>
- <p>Byte threshold used to determine whether the form data is encoded into memory or
- onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
- written to disk before being uploaded. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF">upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- value, and a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
- payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- used for larger payloads such as video content.</p>
- <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
- 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>,
- encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- technique was used.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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">-></span> <span class="kt">Void</span><span class="p">,</span>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>multipartFormData</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>request</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingMemoryThreshold</em>
- </code>
- </td>
- <td>
- <div>
- <p>Byte threshold used to determine whether the form data is encoded into memory or
- onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
- written to disk before being uploaded. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtF">upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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
- and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
- payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- used for larger payloads such as video content.</p>
- <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
- 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>,
- encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- technique was used.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>multipartFormData</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>url</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>‘s <code>URL</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingMemoryThreshold</em>
- </code>
- </td>
- <td>
- <div>
- <p>Byte threshold used to determine whether the form data is encoded into memory or
- onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
- written to disk before being uploaded. <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">.default</a></code> instance by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF"></a>
- <a name="//apple_ref/swift/Method/upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire7SessionC6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtF">upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <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>
- value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
- <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
- payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
- efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
- be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
- footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
- used for larger payloads such as video content.</p>
- <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
- 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>,
- encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
- during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
- technique was used.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">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>
- <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>
- <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>
- <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="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">-></span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>multipartFormData</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>request</em>
- </code>
- </td>
- <td>
- <div>
- <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingMemoryThreshold</em>
- </code>
- </td>
- <td>
- <div>
- <p>Byte threshold used to determine whether the form data is encoded into memory or
- onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>interceptor</em>
- </code>
- </td>
- <td>
- <div>
- <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>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileManager</em>
- </code>
- </td>
- <td>
- <div>
- <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
- default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/RequestDelegate"></a>
- <a name="//apple_ref/swift/Section/RequestDelegate" class="dashAnchor"></a>
- <a href="#/RequestDelegate">
- <h3 class="section-name">RequestDelegate</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire15RequestDelegateP20sessionConfigurationSo012NSURLSessionE0Cvp"></a>
- <a name="//apple_ref/swift/Property/sessionConfiguration" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire15RequestDelegateP20sessionConfigurationSo012NSURLSessionE0Cvp">sessionConfiguration</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire15RequestDelegateP7cleanup5afteryAA0B0C_tF"></a>
- <a name="//apple_ref/swift/Method/cleanup(after:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire15RequestDelegateP7cleanup5afteryAA0B0C_tF">cleanup(after:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire15RequestDelegateP11retryResult3for5dueTo10completionyAA0B0C_AA7AFErrorOyAA05RetryE0OctF"></a>
- <a name="//apple_ref/swift/Method/retryResult(for:dueTo:completion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire15RequestDelegateP11retryResult3for5dueTo10completionyAA0B0C_AA7AFErrorOyAA05RetryE0OctF">retryResult(for:dueTo:completion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire15RequestDelegateP05retryB0_9withDelayyAA0B0C_SdSgtF"></a>
- <a name="//apple_ref/swift/Method/retryRequest(_:withDelay:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire15RequestDelegateP05retryB0_9withDelayyAA0B0C_SdSgtF">retryRequest(_:withDelay:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">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>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </div>
- </section>
- </article>
- </div>
- <section class="footer">
- <p>© 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-09-08)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.10.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
- </section>
- </body>
- </div>
- </html>
|