| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>SessionManager 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/SessionManager" class="dashAnchor"></a>
- <a title="SessionManager Class Reference"></a>
- <header class="header">
- <p class="header-col header-col--primary">
- <a class="header-link" href="../index.html">
- Alamofire Docs
- </a>
- (86% 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" />
- SessionManager 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/DataRequest.html">DataRequest</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/DownloadOptions.html">– DownloadOptions</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/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</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/ValidationResult.html">– ValidationResult</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</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/SessionManager.html">SessionManager</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
- </li>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</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/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/HTTPMethod.html">HTTPMethod</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</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/Notification.html">Notification</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</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>
- </ul>
- </li>
- <li class="nav-group-name">
- <a class="nav-group-name-link" href="../Functions.html">Functions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:to:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">request(_:method:parameters:encoding:headers:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</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/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/ParameterEncoding.html">ParameterEncoding</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/RequestRetrier.html">RequestRetrier</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>
- </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/DataResponse.html">DataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</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/DownloadResponseSerializer.html">DownloadResponseSerializer</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/PropertyListEncoding.html">PropertyListEncoding</a>
- </li>
- <li class="nav-group-task">
- <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</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:9Alamofire11HTTPHeadersa">HTTPHeaders</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:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- <article class="main-content">
- <section class="section">
- <div class="section-content">
- <h1>SessionManager</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">SessionManager</span></code></pre>
- </div>
- </div>
- <p>Responsible for creating and managing <code><a href="../Classes/Request.html">Request</a></code> objects, as well as their underlying <code>NSURLSession</code>.</p>
- </div>
- </section>
- <section class="section">
- <div class="section-content">
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Helper%20Types"></a>
- <a name="//apple_ref/swift/Section/Helper Types" class="dashAnchor"></a>
- <a href="#/Helper%20Types">
- <h3 class="section-name">Helper Types</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC31MultipartFormDataEncodingResultO"></a>
- <a name="//apple_ref/swift/Enum/MultipartFormDataEncodingResult" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC31MultipartFormDataEncodingResultO">MultipartFormDataEncodingResult</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Defines whether the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> encoding was successful and contains result of the encoding as
- associated values.</p>
- <ul>
- <li>Success: Represents a successful <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> encoding and contains the new <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> along with
- streaming information.</li>
- <li>Failure: Used to represent a failure in the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> encoding and also contains the encoding
- error.</li>
- </ul>
- <a href="../Classes/SessionManager/MultipartFormDataEncodingResult.html" class="slightly-smaller">See more</a>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MultipartFormDataEncodingResult</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Properties"></a>
- <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
- <a href="#/Properties">
- <h3 class="section-name">Properties</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC7defaultACvpZ"></a>
- <a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7defaultACvpZ">default</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A default instance of <code>SessionManager</code>, used by top-level Alamofire request methods, and suitable for use
- directly for any ad hoc requests.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">let</span> <span class="p">`</span><span class="nv">default</span><span class="p">`:</span> <span class="kt">SessionManager</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC18defaultHTTPHeadersSDyS2SGvpZ"></a>
- <a name="//apple_ref/swift/Variable/defaultHTTPHeaders" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC18defaultHTTPHeadersSDyS2SGvpZ">defaultHTTPHeaders</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Creates default values for the <q>Accept-Encoding</q>, <q>Accept-Language</q> and <q>User-Agent</q> headers.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultHTTPHeaders</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC40multipartFormDataEncodingMemoryThresholds6UInt64VvpZ"></a>
- <a name="//apple_ref/swift/Variable/multipartFormDataEncodingMemoryThreshold" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC40multipartFormDataEncodingMemoryThresholds6UInt64VvpZ">multipartFormDataEncodingMemoryThreshold</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Default memory threshold used when encoding <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> in bytes.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">multipartFormDataEncodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC7sessionSo12NSURLSessionCvp"></a>
- <a name="//apple_ref/swift/Property/session" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7sessionSo12NSURLSessionCvp">session</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The underlying session.</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:9Alamofire14SessionManagerC8delegateAA0B8DelegateCvp"></a>
- <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC8delegateAA0B8DelegateCvp">delegate</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The session delegate handling all the task and session delegate 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">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:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp"></a>
- <a name="//apple_ref/swift/Property/startRequestsImmediately" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Whether to start requests immediately after being constructed. <code>true</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">open</span> <span class="k">var</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:9Alamofire14SessionManagerC7adapterAA14RequestAdapter_pSgvp"></a>
- <a name="//apple_ref/swift/Property/adapter" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7adapterAA14RequestAdapter_pSgvp">adapter</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The request adapter called each time a new request is created.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">adapter</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestAdapter.html">RequestAdapter</a></span><span class="p">?</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC7retrierAA14RequestRetrier_pSgvp"></a>
- <a name="//apple_ref/swift/Property/retrier" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7retrierAA14RequestRetrier_pSgvp">retrier</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The request retrier called each time a request encounters an error to determine whether to retry the request.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">retrier</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestRetrier.html">RequestRetrier</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC27backgroundCompletionHandleryycSgvp"></a>
- <a name="//apple_ref/swift/Property/backgroundCompletionHandler" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC27backgroundCompletionHandleryycSgvp">backgroundCompletionHandler</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The background completion handler closure provided by the UIApplicationDelegate
- <code>application:handleEventsForBackgroundURLSession:completionHandler:</code> method. By setting the background
- completion handler, the SessionDelegate <code>sessionDidFinishEventsForBackgroundURLSession</code> closure implementation
- will automatically call the handler.</p>
- <p>If you need to handle your own events before the handler is called, then you need to override the
- SessionDelegate <code>sessionDidFinishEventsForBackgroundURLSession</code> and manually call the handler when finished.</p>
- <p><code>nil</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">open</span> <span class="k">var</span> <span class="nv">backgroundCompletionHandler</span><span class="p">:</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>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Lifecycle"></a>
- <a name="//apple_ref/swift/Section/Lifecycle" class="dashAnchor"></a>
- <a href="#/Lifecycle">
- <h3 class="section-name">Lifecycle</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC13configuration8delegate017serverTrustPolicyC0ACSo25NSURLSessionConfigurationC_AA0B8DelegateCAA06ServerghC0CSgtcfc"></a>
- <a name="//apple_ref/swift/Method/init(configuration:delegate:serverTrustPolicyManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC13configuration8delegate017serverTrustPolicyC0ACSo25NSURLSessionConfigurationC_AA0B8DelegateCAA06ServerghC0CSgtcfc">init(configuration:delegate:serverTrustPolicyManager:)</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 instance with the specified <code>configuration</code>, <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC8delegateAA0B8DelegateCvp">delegate</a></code> and <code>serverTrustPolicyManager</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="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="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">serverTrustPolicyManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a></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>configuration</em>
- </code>
- </td>
- <td>
- <div>
- <p>The configuration used to construct the managed session.
- <code>URLSessionConfiguration.default</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>delegate</em>
- </code>
- </td>
- <td>
- <div>
- <p>The delegate used when initializing the session. <code>SessionDelegate()</code> by
- default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>serverTrustPolicyManager</em>
- </code>
- </td>
- <td>
- <div>
- <p>The server trust policy manager to use for evaluating all server trust
- challenges. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new <code>SessionManager</code> instance.</p>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC7session8delegate017serverTrustPolicyC0ACSgSo12NSURLSessionC_AA0B8DelegateCAA06ServerghC0CSgtcfc"></a>
- <a name="//apple_ref/swift/Method/init(session:delegate:serverTrustPolicyManager:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7session8delegate017serverTrustPolicyC0ACSgSo12NSURLSessionC_AA0B8DelegateCAA06ServerghC0CSgtcfc">init(session:delegate:serverTrustPolicyManager:)</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 instance with the specified <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC7sessionSo12NSURLSessionCvp">session</a></code>, <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC8delegateAA0B8DelegateCvp">delegate</a></code> and <code>serverTrustPolicyManager</code>.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">public</span> <span class="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">serverTrustPolicyManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a></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>session</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL session.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>delegate</em>
- </code>
- </td>
- <td>
- <div>
- <p>The delegate of the URL session. Must equal the URL session’s delegate.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>serverTrustPolicyManager</em>
- </code>
- </td>
- <td>
- <div>
- <p>The server trust policy manager to use for evaluating all server trust
- challenges. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The new <code>SessionManager</code> instance if the URL session’s delegate matches; <code>nil</code> otherwise.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Data%20Request"></a>
- <a name="//apple_ref/swift/Section/Data Request" class="dashAnchor"></a>
- <a href="#/Data%20Request">
- <h3 class="section-name">Data Request</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF"></a>
- <a name="//apple_ref/swift/Method/request(_:method:parameters:encoding:headers:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF">request(_:method:parameters:encoding:headers:)</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> to retrieve the contents of the specified <code>url</code>, <code>method</code>, <code>parameters</code>, <code>encoding</code>
- and <code>headers</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">@discardableResult</span>
- <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">url</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="../Enums/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="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</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>url</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method. <code>.get</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>parameters</em>
- </code>
- </td>
- <td>
- <div>
- <p>The parameters. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encoding</em>
- </code>
- </td>
- <td>
- <div>
- <p>The parameter encoding. <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>The HTTP headers. <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:9Alamofire14SessionManagerC7requestyAA11DataRequestCAA21URLRequestConvertible_pF"></a>
- <a name="//apple_ref/swift/Method/request(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</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> to retrieve the contents of a URL based on the specified <code>urlRequest</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">open</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></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>urlRequest</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL request.</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="/URL%20Request"></a>
- <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a>
- <a href="#/URL%20Request">
- <h3 class="section-name">URL Request</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationQ0_AK0J7OptionsV7optionstAV_So17NSHTTPURLResponseCtcSgtF"></a>
- <a name="//apple_ref/swift/Method/download(_:method:parameters:encoding:headers:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationQ0_AK0J7OptionsV7optionstAV_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers: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> to retrieve the contents the specified <code>url</code>, <code>method</code>, <code>parameters</code>, <code>encoding</code>,
- <code>headers</code> and save them to the <code>destination</code>.</p>
- <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
- underlying URL session.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">open</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
- <span class="n">_</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="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/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="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</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">DownloadFileDestination</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>url</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method. <code>.get</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>parameters</em>
- </code>
- </td>
- <td>
- <div>
- <p>The parameters. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encoding</em>
- </code>
- </td>
- <td>
- <div>
- <p>The parameter encoding. <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>The HTTP headers. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure used to determine the destination of the downloaded file. <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:9Alamofire14SessionManagerC8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationK0_AG0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF"></a>
- <a name="//apple_ref/swift/Method/download(_:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationK0_AG0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(_: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> to retrieve the contents of a URL based on the specified <code>urlRequest</code> and save
- them to the <code>destination</code>.</p>
- <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
- underlying URL session.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">open</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
- <span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></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">DownloadFileDestination</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>urlRequest</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL request</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure used to determine the destination of the downloaded file. <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="/Resume%20Data"></a>
- <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
- <a href="#/Resume%20Data">
- <h3 class="section-name">Resume Data</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AI3URLV011destinationL0_AH0H7OptionsV7optionstAM_So17NSHTTPURLResponseCtcSgtF"></a>
- <a name="//apple_ref/swift/Method/download(resumingWith:to:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AI3URLV011destinationL0_AH0H7OptionsV7optionstAM_So17NSHTTPURLResponseCtcSgtF">download(resumingWith: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 previous request cancellation to retrieve
- the contents of the original request and save them to the <code>destination</code>.</p>
- <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
- underlying URL session.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- <p>On the latest release of all the Apple platforms (iOS 10, macOS 10.12, tvOS 10, watchOS 3), <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 following Stack Overflow post:</p>
- <ul>
- <li><p><a href="http://stackoverflow.com/a/39347461/1342462">http://stackoverflow.com/a/39347461/1342462</a></p></li>
- </ul>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">open</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
- <span class="n">resumingWith</span> <span class="nv">resumeData</span><span class="p">:</span> <span class="kt">Data</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">DownloadFileDestination</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>resumeData</em>
- </code>
- </td>
- <td>
- <div>
- <p>The resume data. This is an opaque data blob produced by <code>URLSessionDownloadTask</code>
- when a task is cancelled. See <code>URLSession -downloadTask(withResumeData:)</code> for
- additional information.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>destination</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure used to determine the destination of the downloaded file. <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="/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:9Alamofire14SessionManagerC6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:to:method:headers:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</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 specified <code>url</code>, <code>method</code> and <code>headers</code> for uploading the <code>file</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">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">url</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="../Enums/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="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</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/UploadRequest.html">UploadRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>file</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>url</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP headers. <code>nil</code> 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:9Alamofire14SessionManagerC6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF"></a>
- <a name="//apple_ref/swift/Method/upload(_:with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</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/UploadRequest.html">UploadRequest</a></code> from the specified <code>urlRequest</code> for uploading the <code>file</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">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">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></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>file</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>urlRequest</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL request.</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="/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:9Alamofire14SessionManagerC6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:to:method:headers:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</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 specified <code>url</code>, <code>method</code> and <code>headers</code> for uploading the <code>data</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">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">url</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="../Enums/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="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</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/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 data to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>url</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP headers. <code>nil</code> 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:9Alamofire14SessionManagerC6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF"></a>
- <a name="//apple_ref/swift/Method/upload(_:with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</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 specified <code>urlRequest</code> for uploading the <code>data</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">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">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></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 data to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>urlRequest</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL request.</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:9Alamofire14SessionManagerC6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF"></a>
- <a name="//apple_ref/swift/Method/upload(_:to:method:headers:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</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 specified <code>url</code>, <code>method</code> and <code>headers</code> for uploading the <code>stream</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">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">url</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="../Enums/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="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</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/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 stream to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>url</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP headers. <code>nil</code> 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:9Alamofire14SessionManagerC6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF"></a>
- <a name="//apple_ref/swift/Method/upload(_:with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</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 specified <code>urlRequest</code> for uploading the <code>stream</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
- <span class="kd">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">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></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 stream to upload.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>urlRequest</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL request.</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:9Alamofire14SessionManagerC6upload17multipartFormData14usingThreshold2to6method7headers5queue18encodingCompletionyyAA09MultipartfG0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgSo012OS_dispatch_M0CSgyAC0pfG14EncodingResultOcSgtF"></a>
- <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:to:method:headers:queue:encodingCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload17multipartFormData14usingThreshold2to6method7headers5queue18encodingCompletionyyAA09MultipartfG0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgSo012OS_dispatch_M0CSgyAC0pfG14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:queue:encodingCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Encodes <code>multipartFormData</code> using <code>encodingMemoryThreshold</code> and calls <code>encodingCompletion</code> with new
- <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using the <code>url</code>, <code>method</code> and <code>headers</code>.</p>
- <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cummulative
- 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>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</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">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt">SessionManager</span><span class="o">.</span><span class="n"><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC40multipartFormDataEncodingMemoryThresholds6UInt64VvpZ">multipartFormDataEncodingMemoryThreshold</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="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/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="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
- <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
- <span class="nv">encodingCompletion</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">MultipartFormDataEncodingResult</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)?)</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>multipartFormData</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure used to append body parts to the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingMemoryThreshold</em>
- </code>
- </td>
- <td>
- <div>
- <p>The encoding memory threshold in bytes.
- <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC40multipartFormDataEncodingMemoryThresholds6UInt64VvpZ">multipartFormDataEncodingMemoryThreshold</a></code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>url</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>method</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP method. <code>.post</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>headers</em>
- </code>
- </td>
- <td>
- <div>
- <p>The HTTP headers. <code>nil</code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure called when the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> encoding is complete.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC6upload17multipartFormData14usingThreshold4with5queue18encodingCompletionyyAA09MultipartfG0Cc_s6UInt64VAA21URLRequestConvertible_pSo012OS_dispatch_K0CSgyAC0nfG14EncodingResultOcSgtF"></a>
- <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:with:queue:encodingCompletion:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6upload17multipartFormData14usingThreshold4with5queue18encodingCompletionyyAA09MultipartfG0Cc_s6UInt64VAA21URLRequestConvertible_pSo012OS_dispatch_K0CSgyAC0nfG14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:queue:encodingCompletion:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Encodes <code>multipartFormData</code> using <code>encodingMemoryThreshold</code> and calls <code>encodingCompletion</code> with new
- <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using the <code>urlRequest</code>.</p>
- <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cummulative
- 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>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</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">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt">SessionManager</span><span class="o">.</span><span class="n"><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC40multipartFormDataEncodingMemoryThresholds6UInt64VvpZ">multipartFormDataEncodingMemoryThreshold</a></span><span class="p">,</span>
- <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
- <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
- <span class="nv">encodingCompletion</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">MultipartFormDataEncodingResult</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)?)</span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>multipartFormData</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure used to append body parts to the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingMemoryThreshold</em>
- </code>
- </td>
- <td>
- <div>
- <p>The encoding memory threshold in bytes.
- <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC40multipartFormDataEncodingMemoryThresholds6UInt64VvpZ">multipartFormDataEncodingMemoryThreshold</a></code> by default.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>urlRequest</em>
- </code>
- </td>
- <td>
- <div>
- <p>The URL request.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>encodingCompletion</em>
- </code>
- </td>
- <td>
- <div>
- <p>The closure called when the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> encoding is complete.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/Hostname%20and%20Port"></a>
- <a name="//apple_ref/swift/Section/Hostname and Port" class="dashAnchor"></a>
- <a href="#/Hostname%20and%20Port">
- <h3 class="section-name">Hostname and Port</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC6stream12withHostName4portAA13StreamRequestCSS_SitF"></a>
- <a name="//apple_ref/swift/Method/stream(withHostName:port:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</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.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code> for bidirectional streaming using the <code>hostname</code> and <code>port</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</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">@available(iOS 9.0, OSX 10.11, tvOS 9.0, *)</span>
- <span class="kd">@discardableResult</span>
- <span class="kd">open</span> <span class="kd">func</span> <span class="nf">stream</span><span class="p">(</span><span class="n">withHostName</span> <span class="nv">hostName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>hostName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The hostname of the server to connect to.</p>
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>port</em>
- </code>
- </td>
- <td>
- <div>
- <p>The port of the server to connect to.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/NetService"></a>
- <a name="//apple_ref/swift/Section/NetService" class="dashAnchor"></a>
- <a href="#/NetService">
- <h3 class="section-name">NetService</h3>
- </a>
- </div>
- <ul class="item-container">
- <li class="item">
- <div>
- <code>
- <a name="/s:9Alamofire14SessionManagerC6stream4withAA13StreamRequestCSo12NSNetServiceC_tF"></a>
- <a name="//apple_ref/swift/Method/stream(with:)" class="dashAnchor"></a>
- <a class="token" href="#/s:9Alamofire14SessionManagerC6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</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.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code> for bidirectional streaming using the <code>netService</code>.</p>
- <p>If <code><a href="../Classes/SessionManager.html#/s:9Alamofire14SessionManagerC24startRequestsImmediatelySbvp">startRequestsImmediately</a></code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</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">@available(iOS 9.0, OSX 10.11, tvOS 9.0, *)</span>
- <span class="kd">@discardableResult</span>
- <span class="kd">open</span> <span class="kd">func</span> <span class="nf">stream</span><span class="p">(</span><span class="n">with</span> <span class="nv">netService</span><span class="p">:</span> <span class="kt">NetService</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></span></code></pre>
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>netService</em>
- </code>
- </td>
- <td>
- <div>
- <p>The net service used to identify the endpoint.</p>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>The created <code><a href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code>.</p>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </div>
- </section>
- </article>
- </div>
- <section class="footer">
- <p>© 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-11-24)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
- </section>
- </body>
- </div>
- </html>
|