AF.html 151 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>AF Enumeration Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Enum/AF" class="dashAnchor"></a>
  16. <a title="AF Enumeration Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (98% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. AF Enumeration Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  195. </li>
  196. <li class="nav-group-task">
  197. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  198. </li>
  199. <li class="nav-group-task">
  200. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  213. </li>
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  219. </li>
  220. </ul>
  221. </li>
  222. <li class="nav-group-name">
  223. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  224. <ul class="nav-group-tasks">
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  254. </li>
  255. </ul>
  256. </li>
  257. <li class="nav-group-name">
  258. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  259. <ul class="nav-group-tasks">
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  286. </li>
  287. <li class="nav-group-task">
  288. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  289. </li>
  290. <li class="nav-group-task">
  291. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  292. </li>
  293. <li class="nav-group-task">
  294. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  295. </li>
  296. <li class="nav-group-task">
  297. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  298. </li>
  299. <li class="nav-group-task">
  300. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  301. </li>
  302. <li class="nav-group-task">
  303. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  304. </li>
  305. <li class="nav-group-task">
  306. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  307. </li>
  308. <li class="nav-group-task">
  309. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  310. </li>
  311. <li class="nav-group-task">
  312. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  313. </li>
  314. <li class="nav-group-task">
  315. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  316. </li>
  317. <li class="nav-group-task">
  318. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  319. </li>
  320. <li class="nav-group-task">
  321. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  322. </li>
  323. </ul>
  324. </li>
  325. <li class="nav-group-name">
  326. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  327. <ul class="nav-group-tasks">
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  348. </li>
  349. <li class="nav-group-task">
  350. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  351. </li>
  352. <li class="nav-group-task">
  353. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  354. </li>
  355. <li class="nav-group-task">
  356. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  357. </li>
  358. <li class="nav-group-task">
  359. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  360. </li>
  361. <li class="nav-group-task">
  362. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  363. </li>
  364. <li class="nav-group-task">
  365. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  366. </li>
  367. <li class="nav-group-task">
  368. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  369. </li>
  370. <li class="nav-group-task">
  371. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  372. </li>
  373. <li class="nav-group-task">
  374. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  375. </li>
  376. <li class="nav-group-task">
  377. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  378. </li>
  379. <li class="nav-group-task">
  380. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  381. </li>
  382. </ul>
  383. </li>
  384. <li class="nav-group-name">
  385. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  386. <ul class="nav-group-tasks">
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  404. </li>
  405. </ul>
  406. </li>
  407. </ul>
  408. </nav>
  409. <article class="main-content">
  410. <section class="section">
  411. <div class="section-content">
  412. <h1>AF</h1>
  413. <div class="declaration">
  414. <div class="language">
  415. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AF</span></code></pre>
  416. </div>
  417. </div>
  418. <p>Global namespace containing API for the <code>default</code> <code><a href="../Classes/Session.html">Session</a></code> instance.</p>
  419. </div>
  420. </section>
  421. <section class="section">
  422. <div class="section-content">
  423. <div class="task-group">
  424. <div class="task-name-container">
  425. <a name="/Data%20Request"></a>
  426. <a name="//apple_ref/swift/Section/Data Request" class="dashAnchor"></a>
  427. <a href="#/Data%20Request">
  428. <h3 class="section-name">Data Request</h3>
  429. </a>
  430. </div>
  431. <ul class="item-container">
  432. <li class="item">
  433. <div>
  434. <code>
  435. <a name="/s:9Alamofire2AFO7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtFZ"></a>
  436. <a name="//apple_ref/swift/Method/request(_:method:parameters:encoding:headers:interceptor:)" class="dashAnchor"></a>
  437. <a class="token" href="#/s:9Alamofire2AFO7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtFZ">request(_:method:parameters:encoding:headers:interceptor:)</a>
  438. </code>
  439. </div>
  440. <div class="height-container">
  441. <div class="pointer-container"></div>
  442. <section class="section">
  443. <div class="pointer"></div>
  444. <div class="abstract">
  445. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to retrieve the contents of the specified <code>url</code> using the
  446. <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
  447. </div>
  448. <div class="declaration">
  449. <h4>Declaration</h4>
  450. <div class="language">
  451. <p class="aside-title">Swift</p>
  452. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  453. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  454. <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>
  455. <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>
  456. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  457. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
  458. </div>
  459. </div>
  460. <div>
  461. <h4>Parameters</h4>
  462. <table class="graybox">
  463. <tbody>
  464. <tr>
  465. <td>
  466. <code>
  467. <em>url</em>
  468. </code>
  469. </td>
  470. <td>
  471. <div>
  472. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  473. </div>
  474. </td>
  475. </tr>
  476. <tr>
  477. <td>
  478. <code>
  479. <em>method</em>
  480. </code>
  481. </td>
  482. <td>
  483. <div>
  484. <p>The <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  485. </div>
  486. </td>
  487. </tr>
  488. <tr>
  489. <td>
  490. <code>
  491. <em>parameters</em>
  492. </code>
  493. </td>
  494. <td>
  495. <div>
  496. <p>The <code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code>, <code>nil</code> by default.</p>
  497. </div>
  498. </td>
  499. </tr>
  500. <tr>
  501. <td>
  502. <code>
  503. <em>encoding</em>
  504. </code>
  505. </td>
  506. <td>
  507. <div>
  508. <p>The <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>, <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
  509. </div>
  510. </td>
  511. </tr>
  512. <tr>
  513. <td>
  514. <code>
  515. <em>headers</em>
  516. </code>
  517. </td>
  518. <td>
  519. <div>
  520. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  521. </div>
  522. </td>
  523. </tr>
  524. <tr>
  525. <td>
  526. <code>
  527. <em>interceptor</em>
  528. </code>
  529. </td>
  530. <td>
  531. <div>
  532. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  533. </div>
  534. </td>
  535. </tr>
  536. </tbody>
  537. </table>
  538. </div>
  539. <div>
  540. <h4>Return Value</h4>
  541. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  542. </div>
  543. </section>
  544. </div>
  545. </li>
  546. <li class="item">
  547. <div>
  548. <code>
  549. <a name="/s:9Alamofire2AFO7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlFZ"></a>
  550. <a name="//apple_ref/swift/Method/request(_:method:parameters:encoder:headers:interceptor:)" class="dashAnchor"></a>
  551. <a class="token" href="#/s:9Alamofire2AFO7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlFZ">request(_:method:parameters:encoder:headers:interceptor:)</a>
  552. </code>
  553. </div>
  554. <div class="height-container">
  555. <div class="pointer-container"></div>
  556. <section class="section">
  557. <div class="pointer"></div>
  558. <div class="abstract">
  559. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to retrieve the contents of the specified <code>url</code> using the
  560. <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
  561. </div>
  562. <div class="declaration">
  563. <h4>Declaration</h4>
  564. <div class="language">
  565. <p class="aside-title">Swift</p>
  566. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="n">request</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  567. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  568. <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>
  569. <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  570. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  571. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
  572. </div>
  573. </div>
  574. <div>
  575. <h4>Parameters</h4>
  576. <table class="graybox">
  577. <tbody>
  578. <tr>
  579. <td>
  580. <code>
  581. <em>url</em>
  582. </code>
  583. </td>
  584. <td>
  585. <div>
  586. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  587. </div>
  588. </td>
  589. </tr>
  590. <tr>
  591. <td>
  592. <code>
  593. <em>method</em>
  594. </code>
  595. </td>
  596. <td>
  597. <div>
  598. <p>The <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  599. </div>
  600. </td>
  601. </tr>
  602. <tr>
  603. <td>
  604. <code>
  605. <em>parameters</em>
  606. </code>
  607. </td>
  608. <td>
  609. <div>
  610. <p>The <code>Encodable</code> parameters, <code>nil</code> by default.</p>
  611. </div>
  612. </td>
  613. </tr>
  614. <tr>
  615. <td>
  616. <code>
  617. <em>encoding</em>
  618. </code>
  619. </td>
  620. <td>
  621. <div>
  622. <p>The <code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code>, <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
  623. </div>
  624. </td>
  625. </tr>
  626. <tr>
  627. <td>
  628. <code>
  629. <em>headers</em>
  630. </code>
  631. </td>
  632. <td>
  633. <div>
  634. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  635. </div>
  636. </td>
  637. </tr>
  638. <tr>
  639. <td>
  640. <code>
  641. <em>interceptor</em>
  642. </code>
  643. </td>
  644. <td>
  645. <div>
  646. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  647. </div>
  648. </td>
  649. </tr>
  650. </tbody>
  651. </table>
  652. </div>
  653. <div>
  654. <h4>Return Value</h4>
  655. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  656. </div>
  657. </section>
  658. </div>
  659. </li>
  660. <li class="item">
  661. <div>
  662. <code>
  663. <a name="/s:9Alamofire2AFO7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtFZ"></a>
  664. <a name="//apple_ref/swift/Method/request(_:interceptor:)" class="dashAnchor"></a>
  665. <a class="token" href="#/s:9Alamofire2AFO7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtFZ">request(_:interceptor:)</a>
  666. </code>
  667. </div>
  668. <div class="height-container">
  669. <div class="pointer-container"></div>
  670. <section class="section">
  671. <div class="pointer"></div>
  672. <div class="abstract">
  673. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to execute the specified <code>urlRequest</code>.</p>
  674. </div>
  675. <div class="declaration">
  676. <h4>Declaration</h4>
  677. <div class="language">
  678. <p class="aside-title">Swift</p>
  679. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
  680. </div>
  681. </div>
  682. <div>
  683. <h4>Parameters</h4>
  684. <table class="graybox">
  685. <tbody>
  686. <tr>
  687. <td>
  688. <code>
  689. <em>urlRequest</em>
  690. </code>
  691. </td>
  692. <td>
  693. <div>
  694. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  695. </div>
  696. </td>
  697. </tr>
  698. <tr>
  699. <td>
  700. <code>
  701. <em>interceptor</em>
  702. </code>
  703. </td>
  704. <td>
  705. <div>
  706. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  707. </div>
  708. </td>
  709. </tr>
  710. </tbody>
  711. </table>
  712. </div>
  713. <div>
  714. <h4>Return Value</h4>
  715. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  716. </div>
  717. </section>
  718. </div>
  719. </li>
  720. </ul>
  721. </div>
  722. <div class="task-group">
  723. <div class="task-name-container">
  724. <a name="/Download%20Request"></a>
  725. <a name="//apple_ref/swift/Section/Download Request" class="dashAnchor"></a>
  726. <a href="#/Download%20Request">
  727. <h3 class="section-name">Download Request</h3>
  728. </a>
  729. </div>
  730. <ul class="item-container">
  731. <li class="item">
  732. <div>
  733. <code>
  734. <a name="/s:9Alamofire2AFO8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtFZ"></a>
  735. <a name="//apple_ref/swift/Method/download(_:method:parameters:encoding:headers:interceptor:to:)" class="dashAnchor"></a>
  736. <a class="token" href="#/s:9Alamofire2AFO8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtFZ">download(_:method:parameters:encoding:headers:interceptor:to:)</a>
  737. </code>
  738. </div>
  739. <div class="height-container">
  740. <div class="pointer-container"></div>
  741. <section class="section">
  742. <div class="pointer"></div>
  743. <div class="abstract">
  744. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to download the contents of the specified <code>url</code> to
  745. the provided <code>destination</code> using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
  746. <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by Alamofire.</p>
  747. </div>
  748. <div class="declaration">
  749. <h4>Declaration</h4>
  750. <div class="language">
  751. <p class="aside-title">Swift</p>
  752. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  753. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  754. <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>
  755. <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>
  756. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  757. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  758. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  759. </div>
  760. </div>
  761. <div>
  762. <h4>Parameters</h4>
  763. <table class="graybox">
  764. <tbody>
  765. <tr>
  766. <td>
  767. <code>
  768. <em>url</em>
  769. </code>
  770. </td>
  771. <td>
  772. <div>
  773. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  774. </div>
  775. </td>
  776. </tr>
  777. <tr>
  778. <td>
  779. <code>
  780. <em>method</em>
  781. </code>
  782. </td>
  783. <td>
  784. <div>
  785. <p>The <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  786. </div>
  787. </td>
  788. </tr>
  789. <tr>
  790. <td>
  791. <code>
  792. <em>parameters</em>
  793. </code>
  794. </td>
  795. <td>
  796. <div>
  797. <p>The <code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code>, <code>nil</code> by default.</p>
  798. </div>
  799. </td>
  800. </tr>
  801. <tr>
  802. <td>
  803. <code>
  804. <em>encoding</em>
  805. </code>
  806. </td>
  807. <td>
  808. <div>
  809. <p>The <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>, <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
  810. </div>
  811. </td>
  812. </tr>
  813. <tr>
  814. <td>
  815. <code>
  816. <em>headers</em>
  817. </code>
  818. </td>
  819. <td>
  820. <div>
  821. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  822. </div>
  823. </td>
  824. </tr>
  825. <tr>
  826. <td>
  827. <code>
  828. <em>interceptor</em>
  829. </code>
  830. </td>
  831. <td>
  832. <div>
  833. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  834. </div>
  835. </td>
  836. </tr>
  837. <tr>
  838. <td>
  839. <code>
  840. <em>destination</em>
  841. </code>
  842. </td>
  843. <td>
  844. <div>
  845. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
  846. downloaded file. <code>nil</code> by default.</p>
  847. </div>
  848. </td>
  849. </tr>
  850. </tbody>
  851. </table>
  852. </div>
  853. <div>
  854. <h4>Return Value</h4>
  855. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  856. </div>
  857. </section>
  858. </div>
  859. </li>
  860. <li class="item">
  861. <div>
  862. <code>
  863. <a name="/s:9Alamofire2AFO8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlFZ"></a>
  864. <a name="//apple_ref/swift/Method/download(_:method:parameters:encoder:headers:interceptor:to:)" class="dashAnchor"></a>
  865. <a class="token" href="#/s:9Alamofire2AFO8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodVxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlFZ">download(_:method:parameters:encoder:headers:interceptor:to:)</a>
  866. </code>
  867. </div>
  868. <div class="height-container">
  869. <div class="pointer-container"></div>
  870. <section class="section">
  871. <div class="pointer"></div>
  872. <div class="abstract">
  873. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to download the contents of the specified <code>url</code> to the
  874. provided <code>destination</code> using the <code>method</code>, encodable <code>parameters</code>, <code>encoder</code>, and <code>headers</code> provided.</p>
  875. <div class="aside aside-note">
  876. <p class="aside-title">Note</p>
  877. <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by
  878. Alamofire.</p>
  879. </div>
  880. </div>
  881. <div class="declaration">
  882. <h4>Declaration</h4>
  883. <div class="language">
  884. <p class="aside-title">Swift</p>
  885. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="n">download</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  886. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  887. <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>
  888. <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
  889. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  890. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  891. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  892. </div>
  893. </div>
  894. <div>
  895. <h4>Parameters</h4>
  896. <table class="graybox">
  897. <tbody>
  898. <tr>
  899. <td>
  900. <code>
  901. <em>url</em>
  902. </code>
  903. </td>
  904. <td>
  905. <div>
  906. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  907. </div>
  908. </td>
  909. </tr>
  910. <tr>
  911. <td>
  912. <code>
  913. <em>method</em>
  914. </code>
  915. </td>
  916. <td>
  917. <div>
  918. <p>The <code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  919. </div>
  920. </td>
  921. </tr>
  922. <tr>
  923. <td>
  924. <code>
  925. <em>parameters</em>
  926. </code>
  927. </td>
  928. <td>
  929. <div>
  930. <p>The <code>Encodable</code> parameters, <code>nil</code> by default.</p>
  931. </div>
  932. </td>
  933. </tr>
  934. <tr>
  935. <td>
  936. <code>
  937. <em>encoder</em>
  938. </code>
  939. </td>
  940. <td>
  941. <div>
  942. <p>The <code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code>, <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
  943. </div>
  944. </td>
  945. </tr>
  946. <tr>
  947. <td>
  948. <code>
  949. <em>headers</em>
  950. </code>
  951. </td>
  952. <td>
  953. <div>
  954. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  955. </div>
  956. </td>
  957. </tr>
  958. <tr>
  959. <td>
  960. <code>
  961. <em>interceptor</em>
  962. </code>
  963. </td>
  964. <td>
  965. <div>
  966. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  967. </div>
  968. </td>
  969. </tr>
  970. <tr>
  971. <td>
  972. <code>
  973. <em>destination</em>
  974. </code>
  975. </td>
  976. <td>
  977. <div>
  978. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
  979. downloaded file. <code>nil</code> by default.</p>
  980. </div>
  981. </td>
  982. </tr>
  983. </tbody>
  984. </table>
  985. </div>
  986. <div>
  987. <h4>Return Value</h4>
  988. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  989. </div>
  990. </section>
  991. </div>
  992. </li>
  993. </ul>
  994. </div>
  995. <div class="task-group">
  996. <div class="task-name-container">
  997. <a name="/URLRequest"></a>
  998. <a name="//apple_ref/swift/Section/URLRequest" class="dashAnchor"></a>
  999. <a href="#/URLRequest">
  1000. <h3 class="section-name">URLRequest</h3>
  1001. </a>
  1002. </div>
  1003. <ul class="item-container">
  1004. <li class="item">
  1005. <div>
  1006. <code>
  1007. <a name="/s:9Alamofire2AFO8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtFZ"></a>
  1008. <a name="//apple_ref/swift/Method/download(_:interceptor:to:)" class="dashAnchor"></a>
  1009. <a class="token" href="#/s:9Alamofire2AFO8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtFZ">download(_:interceptor:to:)</a>
  1010. </code>
  1011. </div>
  1012. <div class="height-container">
  1013. <div class="pointer-container"></div>
  1014. <section class="section">
  1015. <div class="pointer"></div>
  1016. <div class="abstract">
  1017. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to execute the specified <code>urlRequest</code> and download
  1018. the result to the provided <code>destination</code>.</p>
  1019. </div>
  1020. <div class="declaration">
  1021. <h4>Declaration</h4>
  1022. <div class="language">
  1023. <p class="aside-title">Swift</p>
  1024. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1025. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1026. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  1027. </div>
  1028. </div>
  1029. <div>
  1030. <h4>Parameters</h4>
  1031. <table class="graybox">
  1032. <tbody>
  1033. <tr>
  1034. <td>
  1035. <code>
  1036. <em>urlRequest</em>
  1037. </code>
  1038. </td>
  1039. <td>
  1040. <div>
  1041. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  1042. </div>
  1043. </td>
  1044. </tr>
  1045. <tr>
  1046. <td>
  1047. <code>
  1048. <em>interceptor</em>
  1049. </code>
  1050. </td>
  1051. <td>
  1052. <div>
  1053. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1054. </div>
  1055. </td>
  1056. </tr>
  1057. <tr>
  1058. <td>
  1059. <code>
  1060. <em>destination</em>
  1061. </code>
  1062. </td>
  1063. <td>
  1064. <div>
  1065. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
  1066. downloaded file. <code>nil</code> by default.</p>
  1067. </div>
  1068. </td>
  1069. </tr>
  1070. </tbody>
  1071. </table>
  1072. </div>
  1073. <div>
  1074. <h4>Return Value</h4>
  1075. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  1076. </div>
  1077. </section>
  1078. </div>
  1079. </li>
  1080. </ul>
  1081. </div>
  1082. <div class="task-group">
  1083. <div class="task-name-container">
  1084. <a name="/Resume%20Data"></a>
  1085. <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
  1086. <a href="#/Resume%20Data">
  1087. <h3 class="section-name">Resume Data</h3>
  1088. </a>
  1089. </div>
  1090. <ul class="item-container">
  1091. <li class="item">
  1092. <div>
  1093. <code>
  1094. <a name="/s:9Alamofire2AFO8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtFZ"></a>
  1095. <a name="//apple_ref/swift/Method/download(resumingWith:interceptor:to:)" class="dashAnchor"></a>
  1096. <a class="token" href="#/s:9Alamofire2AFO8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtFZ">download(resumingWith:interceptor:to:)</a>
  1097. </code>
  1098. </div>
  1099. <div class="height-container">
  1100. <div class="pointer-container"></div>
  1101. <section class="section">
  1102. <div class="pointer"></div>
  1103. <div class="abstract">
  1104. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> from the <code>resumeData</code> produced from a previous
  1105. <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> cancellation to retrieve the contents of the original request and save them to the <code>destination</code>.</p>
  1106. <div class="aside aside-note">
  1107. <p class="aside-title">Note</p>
  1108. <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by
  1109. Alamofire.</p>
  1110. </div>
  1111. <div class="aside aside-note">
  1112. <p class="aside-title">Note</p>
  1113. <p>On some versions of all Apple platforms (iOS 10 - 10.2, macOS 10.12 - 10.12.2, tvOS 10 - 10.1, watchOS 3 - 3.1.1),
  1114. <code>resumeData</code> is broken on background URL session configurations. There&rsquo;s an underlying bug in the <code>resumeData</code>
  1115. generation logic where the data is written incorrectly and will always fail to resume the download. For more
  1116. information about the bug and possible workarounds, please refer to the <a href="http://stackoverflow.com/a/39347461/1342462">this Stack Overflow post</a>.</p>
  1117. </div>
  1118. </div>
  1119. <div class="declaration">
  1120. <h4>Declaration</h4>
  1121. <div class="language">
  1122. <p class="aside-title">Swift</p>
  1123. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1124. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1125. <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
  1126. </div>
  1127. </div>
  1128. <div>
  1129. <h4>Parameters</h4>
  1130. <table class="graybox">
  1131. <tbody>
  1132. <tr>
  1133. <td>
  1134. <code>
  1135. <em>resumeData</em>
  1136. </code>
  1137. </td>
  1138. <td>
  1139. <div>
  1140. <p>The resume <code>Data</code>. This is an opaque blob produced by <code>URLSessionDownloadTask</code> when a task is
  1141. cancelled. See <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>
  1142. for more information.</p>
  1143. </div>
  1144. </td>
  1145. </tr>
  1146. <tr>
  1147. <td>
  1148. <code>
  1149. <em>interceptor</em>
  1150. </code>
  1151. </td>
  1152. <td>
  1153. <div>
  1154. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1155. </div>
  1156. </td>
  1157. </tr>
  1158. <tr>
  1159. <td>
  1160. <code>
  1161. <em>destination</em>
  1162. </code>
  1163. </td>
  1164. <td>
  1165. <div>
  1166. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine the destination of the downloaded
  1167. file. <code>nil</code> by default.</p>
  1168. </div>
  1169. </td>
  1170. </tr>
  1171. </tbody>
  1172. </table>
  1173. </div>
  1174. <div>
  1175. <h4>Return Value</h4>
  1176. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  1177. </div>
  1178. </section>
  1179. </div>
  1180. </li>
  1181. </ul>
  1182. </div>
  1183. <div class="task-group">
  1184. <div class="task-name-container">
  1185. <a name="/Data"></a>
  1186. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  1187. <a href="#/Data">
  1188. <h3 class="section-name">Data</h3>
  1189. </a>
  1190. </div>
  1191. <ul class="item-container">
  1192. <li class="item">
  1193. <div>
  1194. <code>
  1195. <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtFZ"></a>
  1196. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
  1197. <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtFZ">upload(_:to:method:headers:interceptor:fileManager:)</a>
  1198. </code>
  1199. </div>
  1200. <div class="height-container">
  1201. <div class="pointer-container"></div>
  1202. <section class="section">
  1203. <div class="pointer"></div>
  1204. <div class="abstract">
  1205. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the given <code>Data</code>, <code>URLRequest</code> components, and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1206. </div>
  1207. <div class="declaration">
  1208. <h4>Declaration</h4>
  1209. <div class="language">
  1210. <p class="aside-title">Swift</p>
  1211. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1212. <span class="n">to</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1213. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1214. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1215. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1216. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1217. </div>
  1218. </div>
  1219. <div>
  1220. <h4>Parameters</h4>
  1221. <table class="graybox">
  1222. <tbody>
  1223. <tr>
  1224. <td>
  1225. <code>
  1226. <em>data</em>
  1227. </code>
  1228. </td>
  1229. <td>
  1230. <div>
  1231. <p>The <code>Data</code> to upload.</p>
  1232. </div>
  1233. </td>
  1234. </tr>
  1235. <tr>
  1236. <td>
  1237. <code>
  1238. <em>convertible</em>
  1239. </code>
  1240. </td>
  1241. <td>
  1242. <div>
  1243. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1244. </div>
  1245. </td>
  1246. </tr>
  1247. <tr>
  1248. <td>
  1249. <code>
  1250. <em>method</em>
  1251. </code>
  1252. </td>
  1253. <td>
  1254. <div>
  1255. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  1256. </div>
  1257. </td>
  1258. </tr>
  1259. <tr>
  1260. <td>
  1261. <code>
  1262. <em>headers</em>
  1263. </code>
  1264. </td>
  1265. <td>
  1266. <div>
  1267. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1268. </div>
  1269. </td>
  1270. </tr>
  1271. <tr>
  1272. <td>
  1273. <code>
  1274. <em>interceptor</em>
  1275. </code>
  1276. </td>
  1277. <td>
  1278. <div>
  1279. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1280. </div>
  1281. </td>
  1282. </tr>
  1283. <tr>
  1284. <td>
  1285. <code>
  1286. <em>fileManager</em>
  1287. </code>
  1288. </td>
  1289. <td>
  1290. <div>
  1291. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  1292. default.</p>
  1293. </div>
  1294. </td>
  1295. </tr>
  1296. </tbody>
  1297. </table>
  1298. </div>
  1299. <div>
  1300. <h4>Return Value</h4>
  1301. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1302. </div>
  1303. </section>
  1304. </div>
  1305. </li>
  1306. <li class="item">
  1307. <div>
  1308. <code>
  1309. <a name="/s:9Alamofire2AFO6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtFZ"></a>
  1310. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
  1311. <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtFZ">upload(_:with:interceptor:fileManager:)</a>
  1312. </code>
  1313. </div>
  1314. <div class="height-container">
  1315. <div class="pointer-container"></div>
  1316. <section class="section">
  1317. <div class="pointer"></div>
  1318. <div class="abstract">
  1319. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the given <code>Data</code> using the <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1320. </div>
  1321. <div class="declaration">
  1322. <h4>Declaration</h4>
  1323. <div class="language">
  1324. <p class="aside-title">Swift</p>
  1325. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1326. <span class="n">with</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1327. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1328. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1329. </div>
  1330. </div>
  1331. <div>
  1332. <h4>Parameters</h4>
  1333. <table class="graybox">
  1334. <tbody>
  1335. <tr>
  1336. <td>
  1337. <code>
  1338. <em>data</em>
  1339. </code>
  1340. </td>
  1341. <td>
  1342. <div>
  1343. <p>The <code>Data</code> to upload.</p>
  1344. </div>
  1345. </td>
  1346. </tr>
  1347. <tr>
  1348. <td>
  1349. <code>
  1350. <em>convertible</em>
  1351. </code>
  1352. </td>
  1353. <td>
  1354. <div>
  1355. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  1356. </div>
  1357. </td>
  1358. </tr>
  1359. <tr>
  1360. <td>
  1361. <code>
  1362. <em>interceptor</em>
  1363. </code>
  1364. </td>
  1365. <td>
  1366. <div>
  1367. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1368. </div>
  1369. </td>
  1370. </tr>
  1371. <tr>
  1372. <td>
  1373. <code>
  1374. <em>fileManager</em>
  1375. </code>
  1376. </td>
  1377. <td>
  1378. <div>
  1379. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  1380. default.</p>
  1381. </div>
  1382. </td>
  1383. </tr>
  1384. </tbody>
  1385. </table>
  1386. </div>
  1387. <div>
  1388. <h4>Return Value</h4>
  1389. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1390. </div>
  1391. </section>
  1392. </div>
  1393. </li>
  1394. </ul>
  1395. </div>
  1396. <div class="task-group">
  1397. <div class="task-name-container">
  1398. <a name="/File"></a>
  1399. <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
  1400. <a href="#/File">
  1401. <h3 class="section-name">File</h3>
  1402. </a>
  1403. </div>
  1404. <ul class="item-container">
  1405. <li class="item">
  1406. <div>
  1407. <code>
  1408. <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtFZ"></a>
  1409. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
  1410. <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtFZ">upload(_:to:method:headers:interceptor:fileManager:)</a>
  1411. </code>
  1412. </div>
  1413. <div class="height-container">
  1414. <div class="pointer-container"></div>
  1415. <section class="section">
  1416. <div class="pointer"></div>
  1417. <div class="abstract">
  1418. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the file at the given file <code>URL</code>, using a <code>URLRequest</code> from the provided
  1419. components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1420. </div>
  1421. <div class="declaration">
  1422. <h4>Declaration</h4>
  1423. <div class="language">
  1424. <p class="aside-title">Swift</p>
  1425. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1426. <span class="n">to</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1427. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1428. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1429. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1430. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1431. </div>
  1432. </div>
  1433. <div>
  1434. <h4>Parameters</h4>
  1435. <table class="graybox">
  1436. <tbody>
  1437. <tr>
  1438. <td>
  1439. <code>
  1440. <em>fileURL</em>
  1441. </code>
  1442. </td>
  1443. <td>
  1444. <div>
  1445. <p>The <code>URL</code> of the file to upload.</p>
  1446. </div>
  1447. </td>
  1448. </tr>
  1449. <tr>
  1450. <td>
  1451. <code>
  1452. <em>convertible</em>
  1453. </code>
  1454. </td>
  1455. <td>
  1456. <div>
  1457. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1458. </div>
  1459. </td>
  1460. </tr>
  1461. <tr>
  1462. <td>
  1463. <code>
  1464. <em>method</em>
  1465. </code>
  1466. </td>
  1467. <td>
  1468. <div>
  1469. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  1470. </div>
  1471. </td>
  1472. </tr>
  1473. <tr>
  1474. <td>
  1475. <code>
  1476. <em>headers</em>
  1477. </code>
  1478. </td>
  1479. <td>
  1480. <div>
  1481. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1482. </div>
  1483. </td>
  1484. </tr>
  1485. <tr>
  1486. <td>
  1487. <code>
  1488. <em>interceptor</em>
  1489. </code>
  1490. </td>
  1491. <td>
  1492. <div>
  1493. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>nil</code> by default.</p>
  1494. </div>
  1495. </td>
  1496. </tr>
  1497. <tr>
  1498. <td>
  1499. <code>
  1500. <em>fileManager</em>
  1501. </code>
  1502. </td>
  1503. <td>
  1504. <div>
  1505. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  1506. default.</p>
  1507. </div>
  1508. </td>
  1509. </tr>
  1510. </tbody>
  1511. </table>
  1512. </div>
  1513. <div>
  1514. <h4>Return Value</h4>
  1515. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1516. </div>
  1517. </section>
  1518. </div>
  1519. </li>
  1520. <li class="item">
  1521. <div>
  1522. <code>
  1523. <a name="/s:9Alamofire2AFO6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtFZ"></a>
  1524. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
  1525. <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptor11fileManagerAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtFZ">upload(_:with:interceptor:fileManager:)</a>
  1526. </code>
  1527. </div>
  1528. <div class="height-container">
  1529. <div class="pointer-container"></div>
  1530. <section class="section">
  1531. <div class="pointer"></div>
  1532. <div class="abstract">
  1533. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the file at the given file <code>URL</code> using the <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and
  1534. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1535. </div>
  1536. <div class="declaration">
  1537. <h4>Declaration</h4>
  1538. <div class="language">
  1539. <p class="aside-title">Swift</p>
  1540. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1541. <span class="n">with</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1542. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1543. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1544. </div>
  1545. </div>
  1546. <div>
  1547. <h4>Parameters</h4>
  1548. <table class="graybox">
  1549. <tbody>
  1550. <tr>
  1551. <td>
  1552. <code>
  1553. <em>fileURL</em>
  1554. </code>
  1555. </td>
  1556. <td>
  1557. <div>
  1558. <p>The <code>URL</code> of the file to upload.</p>
  1559. </div>
  1560. </td>
  1561. </tr>
  1562. <tr>
  1563. <td>
  1564. <code>
  1565. <em>convertible</em>
  1566. </code>
  1567. </td>
  1568. <td>
  1569. <div>
  1570. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  1571. </div>
  1572. </td>
  1573. </tr>
  1574. <tr>
  1575. <td>
  1576. <code>
  1577. <em>interceptor</em>
  1578. </code>
  1579. </td>
  1580. <td>
  1581. <div>
  1582. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1583. </div>
  1584. </td>
  1585. </tr>
  1586. <tr>
  1587. <td>
  1588. <code>
  1589. <em>fileManager</em>
  1590. </code>
  1591. </td>
  1592. <td>
  1593. <div>
  1594. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  1595. default.</p>
  1596. </div>
  1597. </td>
  1598. </tr>
  1599. </tbody>
  1600. </table>
  1601. </div>
  1602. <div>
  1603. <h4>Return Value</h4>
  1604. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1605. </div>
  1606. </section>
  1607. </div>
  1608. </li>
  1609. </ul>
  1610. </div>
  1611. <div class="task-group">
  1612. <div class="task-name-container">
  1613. <a name="/InputStream"></a>
  1614. <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
  1615. <a href="#/InputStream">
  1616. <h3 class="section-name">InputStream</h3>
  1617. </a>
  1618. </div>
  1619. <ul class="item-container">
  1620. <li class="item">
  1621. <div>
  1622. <code>
  1623. <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtFZ"></a>
  1624. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
  1625. <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodVAA11HTTPHeadersVSgAA0K11Interceptor_pSgSo06NSFileI0CtFZ">upload(_:to:method:headers:interceptor:fileManager:)</a>
  1626. </code>
  1627. </div>
  1628. <div class="height-container">
  1629. <div class="pointer-container"></div>
  1630. <section class="section">
  1631. <div class="pointer"></div>
  1632. <div class="abstract">
  1633. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> from the <code>InputStream</code> provided using a <code>URLRequest</code> from the provided components and
  1634. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1635. </div>
  1636. <div class="declaration">
  1637. <h4>Declaration</h4>
  1638. <div class="language">
  1639. <p class="aside-title">Swift</p>
  1640. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1641. <span class="n">to</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
  1642. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1643. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1644. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1645. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1646. </div>
  1647. </div>
  1648. <div>
  1649. <h4>Parameters</h4>
  1650. <table class="graybox">
  1651. <tbody>
  1652. <tr>
  1653. <td>
  1654. <code>
  1655. <em>stream</em>
  1656. </code>
  1657. </td>
  1658. <td>
  1659. <div>
  1660. <p>The <code>InputStream</code> that provides the data to upload.</p>
  1661. </div>
  1662. </td>
  1663. </tr>
  1664. <tr>
  1665. <td>
  1666. <code>
  1667. <em>convertible</em>
  1668. </code>
  1669. </td>
  1670. <td>
  1671. <div>
  1672. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1673. </div>
  1674. </td>
  1675. </tr>
  1676. <tr>
  1677. <td>
  1678. <code>
  1679. <em>method</em>
  1680. </code>
  1681. </td>
  1682. <td>
  1683. <div>
  1684. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  1685. </div>
  1686. </td>
  1687. </tr>
  1688. <tr>
  1689. <td>
  1690. <code>
  1691. <em>headers</em>
  1692. </code>
  1693. </td>
  1694. <td>
  1695. <div>
  1696. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1697. </div>
  1698. </td>
  1699. </tr>
  1700. <tr>
  1701. <td>
  1702. <code>
  1703. <em>interceptor</em>
  1704. </code>
  1705. </td>
  1706. <td>
  1707. <div>
  1708. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1709. </div>
  1710. </td>
  1711. </tr>
  1712. <tr>
  1713. <td>
  1714. <code>
  1715. <em>fileManager</em>
  1716. </code>
  1717. </td>
  1718. <td>
  1719. <div>
  1720. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  1721. default.</p>
  1722. </div>
  1723. </td>
  1724. </tr>
  1725. </tbody>
  1726. </table>
  1727. </div>
  1728. <div>
  1729. <h4>Return Value</h4>
  1730. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1731. </div>
  1732. </section>
  1733. </div>
  1734. </li>
  1735. <li class="item">
  1736. <div>
  1737. <code>
  1738. <a name="/s:9Alamofire2AFO6upload_4with11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtFZ"></a>
  1739. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:fileManager:)" class="dashAnchor"></a>
  1740. <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptor11fileManagerAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0I11Interceptor_pSgSo06NSFileG0CtFZ">upload(_:with:interceptor:fileManager:)</a>
  1741. </code>
  1742. </div>
  1743. <div class="height-container">
  1744. <div class="pointer-container"></div>
  1745. <section class="section">
  1746. <div class="pointer"></div>
  1747. <div class="abstract">
  1748. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> from the provided <code>InputStream</code> using the <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value and
  1749. <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1750. </div>
  1751. <div class="declaration">
  1752. <h4>Declaration</h4>
  1753. <div class="language">
  1754. <p class="aside-title">Swift</p>
  1755. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</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>
  1756. <span class="n">with</span> <span class="nv">convertible</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1757. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1758. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1759. </div>
  1760. </div>
  1761. <div>
  1762. <h4>Parameters</h4>
  1763. <table class="graybox">
  1764. <tbody>
  1765. <tr>
  1766. <td>
  1767. <code>
  1768. <em>stream</em>
  1769. </code>
  1770. </td>
  1771. <td>
  1772. <div>
  1773. <p>The <code>InputStream</code> that provides the data to upload.</p>
  1774. </div>
  1775. </td>
  1776. </tr>
  1777. <tr>
  1778. <td>
  1779. <code>
  1780. <em>convertible</em>
  1781. </code>
  1782. </td>
  1783. <td>
  1784. <div>
  1785. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  1786. </div>
  1787. </td>
  1788. </tr>
  1789. <tr>
  1790. <td>
  1791. <code>
  1792. <em>interceptor</em>
  1793. </code>
  1794. </td>
  1795. <td>
  1796. <div>
  1797. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1798. </div>
  1799. </td>
  1800. </tr>
  1801. <tr>
  1802. <td>
  1803. <code>
  1804. <em>fileManager</em>
  1805. </code>
  1806. </td>
  1807. <td>
  1808. <div>
  1809. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  1810. default.</p>
  1811. </div>
  1812. </td>
  1813. </tr>
  1814. </tbody>
  1815. </table>
  1816. </div>
  1817. <div>
  1818. <h4>Return Value</h4>
  1819. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1820. </div>
  1821. </section>
  1822. </div>
  1823. </li>
  1824. </ul>
  1825. </div>
  1826. <div class="task-group">
  1827. <div class="task-name-container">
  1828. <a name="/MultipartFormData"></a>
  1829. <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
  1830. <a href="#/MultipartFormData">
  1831. <h3 class="section-name">MultipartFormData</h3>
  1832. </a>
  1833. </div>
  1834. <ul class="item-container">
  1835. <li class="item">
  1836. <div>
  1837. <code>
  1838. <a name="/s:9Alamofire2AFO6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtFZ"></a>
  1839. <a name="//apple_ref/swift/Method/upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
  1840. <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtFZ">upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)</a>
  1841. </code>
  1842. </div>
  1843. <div class="height-container">
  1844. <div class="pointer-container"></div>
  1845. <section class="section">
  1846. <div class="pointer"></div>
  1847. <div class="abstract">
  1848. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the multipart form data built using a closure and sent using the provided
  1849. <code>URLRequest</code> components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1850. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  1851. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  1852. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  1853. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  1854. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  1855. used for larger payloads such as video content.</p>
  1856. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  1857. 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>,
  1858. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  1859. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  1860. technique was used.</p>
  1861. </div>
  1862. <div class="declaration">
  1863. <h4>Declaration</h4>
  1864. <div class="language">
  1865. <p class="aside-title">Swift</p>
  1866. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
  1867. <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>
  1868. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  1869. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1870. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1871. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  1872. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  1873. </div>
  1874. </div>
  1875. <div>
  1876. <h4>Parameters</h4>
  1877. <table class="graybox">
  1878. <tbody>
  1879. <tr>
  1880. <td>
  1881. <code>
  1882. <em>multipartFormData</em>
  1883. </code>
  1884. </td>
  1885. <td>
  1886. <div>
  1887. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
  1888. </div>
  1889. </td>
  1890. </tr>
  1891. <tr>
  1892. <td>
  1893. <code>
  1894. <em>convertible</em>
  1895. </code>
  1896. </td>
  1897. <td>
  1898. <div>
  1899. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  1900. </div>
  1901. </td>
  1902. </tr>
  1903. <tr>
  1904. <td>
  1905. <code>
  1906. <em>encodingMemoryThreshold</em>
  1907. </code>
  1908. </td>
  1909. <td>
  1910. <div>
  1911. <p>Byte threshold used to determine whether the form data is encoded into memory or
  1912. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  1913. default.</p>
  1914. </div>
  1915. </td>
  1916. </tr>
  1917. <tr>
  1918. <td>
  1919. <code>
  1920. <em>method</em>
  1921. </code>
  1922. </td>
  1923. <td>
  1924. <div>
  1925. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  1926. </div>
  1927. </td>
  1928. </tr>
  1929. <tr>
  1930. <td>
  1931. <code>
  1932. <em>headers</em>
  1933. </code>
  1934. </td>
  1935. <td>
  1936. <div>
  1937. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  1938. </div>
  1939. </td>
  1940. </tr>
  1941. <tr>
  1942. <td>
  1943. <code>
  1944. <em>interceptor</em>
  1945. </code>
  1946. </td>
  1947. <td>
  1948. <div>
  1949. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  1950. </div>
  1951. </td>
  1952. </tr>
  1953. <tr>
  1954. <td>
  1955. <code>
  1956. <em>fileManager</em>
  1957. </code>
  1958. </td>
  1959. <td>
  1960. <div>
  1961. <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
  1962. written to disk before being uploaded. <code>.default</code> instance by default.</p>
  1963. </div>
  1964. </td>
  1965. </tr>
  1966. </tbody>
  1967. </table>
  1968. </div>
  1969. <div>
  1970. <h4>Return Value</h4>
  1971. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1972. </div>
  1973. </section>
  1974. </div>
  1975. </li>
  1976. <li class="item">
  1977. <div>
  1978. <code>
  1979. <a name="/s:9Alamofire2AFO6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtFZ"></a>
  1980. <a name="//apple_ref/swift/Method/upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)" class="dashAnchor"></a>
  1981. <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCyAA09MultiparteF0Cc_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtFZ">upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)</a>
  1982. </code>
  1983. </div>
  1984. <div class="height-container">
  1985. <div class="pointer-container"></div>
  1986. <section class="section">
  1987. <div class="pointer"></div>
  1988. <div class="abstract">
  1989. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using a <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure, the provided <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>
  1990. value, and a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  1991. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  1992. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  1993. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  1994. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  1995. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  1996. used for larger payloads such as video content.</p>
  1997. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  1998. 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>,
  1999. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  2000. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  2001. technique was used.</p>
  2002. </div>
  2003. <div class="declaration">
  2004. <h4>Declaration</h4>
  2005. <div class="language">
  2006. <p class="aside-title">Swift</p>
  2007. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
  2008. <span class="n">with</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  2009. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  2010. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2011. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2012. </div>
  2013. </div>
  2014. <div>
  2015. <h4>Parameters</h4>
  2016. <table class="graybox">
  2017. <tbody>
  2018. <tr>
  2019. <td>
  2020. <code>
  2021. <em>multipartFormData</em>
  2022. </code>
  2023. </td>
  2024. <td>
  2025. <div>
  2026. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
  2027. </div>
  2028. </td>
  2029. </tr>
  2030. <tr>
  2031. <td>
  2032. <code>
  2033. <em>request</em>
  2034. </code>
  2035. </td>
  2036. <td>
  2037. <div>
  2038. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  2039. </div>
  2040. </td>
  2041. </tr>
  2042. <tr>
  2043. <td>
  2044. <code>
  2045. <em>encodingMemoryThreshold</em>
  2046. </code>
  2047. </td>
  2048. <td>
  2049. <div>
  2050. <p>Byte threshold used to determine whether the form data is encoded into memory or
  2051. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  2052. default.</p>
  2053. </div>
  2054. </td>
  2055. </tr>
  2056. <tr>
  2057. <td>
  2058. <code>
  2059. <em>interceptor</em>
  2060. </code>
  2061. </td>
  2062. <td>
  2063. <div>
  2064. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2065. </div>
  2066. </td>
  2067. </tr>
  2068. <tr>
  2069. <td>
  2070. <code>
  2071. <em>fileManager</em>
  2072. </code>
  2073. </td>
  2074. <td>
  2075. <div>
  2076. <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
  2077. written to disk before being uploaded. <code>.default</code> instance by default.</p>
  2078. </div>
  2079. </td>
  2080. </tr>
  2081. </tbody>
  2082. </table>
  2083. </div>
  2084. <div>
  2085. <h4>Return Value</h4>
  2086. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  2087. </div>
  2088. </section>
  2089. </div>
  2090. </li>
  2091. <li class="item">
  2092. <div>
  2093. <code>
  2094. <a name="/s:9Alamofire2AFO6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtFZ"></a>
  2095. <a name="//apple_ref/swift/Method/upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)" class="dashAnchor"></a>
  2096. <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData2to14usingThreshold6method7headers11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA14URLConvertible_ps6UInt64VAA10HTTPMethodVAA11HTTPHeadersVSgAA0P11Interceptor_pSgSo06NSFileN0CtFZ">upload(multipartFormData:to:usingThreshold:method:headers:interceptor:fileManager:)</a>
  2097. </code>
  2098. </div>
  2099. <div class="height-container">
  2100. <div class="pointer-container"></div>
  2101. <section class="section">
  2102. <div class="pointer"></div>
  2103. <div class="abstract">
  2104. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the prebuilt <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> value using the provided <code>URLRequest</code> components
  2105. and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2106. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  2107. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  2108. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  2109. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  2110. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  2111. used for larger payloads such as video content.</p>
  2112. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  2113. 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>,
  2114. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  2115. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  2116. technique was used.</p>
  2117. </div>
  2118. <div class="declaration">
  2119. <h4>Declaration</h4>
  2120. <div class="language">
  2121. <p class="aside-title">Swift</p>
  2122. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">,</span>
  2123. <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>
  2124. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  2125. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  2126. <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2127. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2128. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2129. </div>
  2130. </div>
  2131. <div>
  2132. <h4>Parameters</h4>
  2133. <table class="graybox">
  2134. <tbody>
  2135. <tr>
  2136. <td>
  2137. <code>
  2138. <em>multipartFormData</em>
  2139. </code>
  2140. </td>
  2141. <td>
  2142. <div>
  2143. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
  2144. </div>
  2145. </td>
  2146. </tr>
  2147. <tr>
  2148. <td>
  2149. <code>
  2150. <em>url</em>
  2151. </code>
  2152. </td>
  2153. <td>
  2154. <div>
  2155. <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
  2156. </div>
  2157. </td>
  2158. </tr>
  2159. <tr>
  2160. <td>
  2161. <code>
  2162. <em>encodingMemoryThreshold</em>
  2163. </code>
  2164. </td>
  2165. <td>
  2166. <div>
  2167. <p>Byte threshold used to determine whether the form data is encoded into memory or
  2168. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  2169. default.</p>
  2170. </div>
  2171. </td>
  2172. </tr>
  2173. <tr>
  2174. <td>
  2175. <code>
  2176. <em>method</em>
  2177. </code>
  2178. </td>
  2179. <td>
  2180. <div>
  2181. <p><code><a href="../Structs/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
  2182. </div>
  2183. </td>
  2184. </tr>
  2185. <tr>
  2186. <td>
  2187. <code>
  2188. <em>headers</em>
  2189. </code>
  2190. </td>
  2191. <td>
  2192. <div>
  2193. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
  2194. </div>
  2195. </td>
  2196. </tr>
  2197. <tr>
  2198. <td>
  2199. <code>
  2200. <em>interceptor</em>
  2201. </code>
  2202. </td>
  2203. <td>
  2204. <div>
  2205. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2206. </div>
  2207. </td>
  2208. </tr>
  2209. <tr>
  2210. <td>
  2211. <code>
  2212. <em>fileManager</em>
  2213. </code>
  2214. </td>
  2215. <td>
  2216. <div>
  2217. <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
  2218. written to disk before being uploaded. <code>.default</code> instance by default.</p>
  2219. </div>
  2220. </td>
  2221. </tr>
  2222. </tbody>
  2223. </table>
  2224. </div>
  2225. <div>
  2226. <h4>Return Value</h4>
  2227. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  2228. </div>
  2229. </section>
  2230. </div>
  2231. </li>
  2232. <li class="item">
  2233. <div>
  2234. <code>
  2235. <a name="/s:9Alamofire2AFO6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtFZ"></a>
  2236. <a name="//apple_ref/swift/Method/upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)" class="dashAnchor"></a>
  2237. <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData4with14usingThreshold11interceptor11fileManagerAA13UploadRequestCAA09MultiparteF0C_AA21URLRequestConvertible_ps6UInt64VAA0N11Interceptor_pSgSo06NSFileL0CtFZ">upload(multipartFormData:with:usingThreshold:interceptor:fileManager:)</a>
  2238. </code>
  2239. </div>
  2240. <div class="height-container">
  2241. <div class="pointer-container"></div>
  2242. <section class="section">
  2243. <div class="pointer"></div>
  2244. <div class="abstract">
  2245. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the prebuilt <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> value using the providing <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>
  2246. value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
  2247. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cumulative
  2248. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  2249. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  2250. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  2251. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  2252. used for larger payloads such as video content.</p>
  2253. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  2254. 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>,
  2255. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  2256. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  2257. technique was used.</p>
  2258. </div>
  2259. <div class="declaration">
  2260. <h4>Declaration</h4>
  2261. <div class="language">
  2262. <p class="aside-title">Swift</p>
  2263. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">,</span>
  2264. <span class="n">with</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  2265. <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
  2266. <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
  2267. <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
  2268. </div>
  2269. </div>
  2270. <div>
  2271. <h4>Parameters</h4>
  2272. <table class="graybox">
  2273. <tbody>
  2274. <tr>
  2275. <td>
  2276. <code>
  2277. <em>multipartFormData</em>
  2278. </code>
  2279. </td>
  2280. <td>
  2281. <div>
  2282. <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
  2283. </div>
  2284. </td>
  2285. </tr>
  2286. <tr>
  2287. <td>
  2288. <code>
  2289. <em>request</em>
  2290. </code>
  2291. </td>
  2292. <td>
  2293. <div>
  2294. <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
  2295. </div>
  2296. </td>
  2297. </tr>
  2298. <tr>
  2299. <td>
  2300. <code>
  2301. <em>encodingMemoryThreshold</em>
  2302. </code>
  2303. </td>
  2304. <td>
  2305. <div>
  2306. <p>Byte threshold used to determine whether the form data is encoded into memory or
  2307. onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
  2308. default.</p>
  2309. </div>
  2310. </td>
  2311. </tr>
  2312. <tr>
  2313. <td>
  2314. <code>
  2315. <em>interceptor</em>
  2316. </code>
  2317. </td>
  2318. <td>
  2319. <div>
  2320. <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
  2321. </div>
  2322. </td>
  2323. </tr>
  2324. <tr>
  2325. <td>
  2326. <code>
  2327. <em>fileManager</em>
  2328. </code>
  2329. </td>
  2330. <td>
  2331. <div>
  2332. <p><code>FileManager</code> instance to be used by the returned <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>. <code>.default</code> instance by
  2333. default.</p>
  2334. </div>
  2335. </td>
  2336. </tr>
  2337. </tbody>
  2338. </table>
  2339. </div>
  2340. <div>
  2341. <h4>Return Value</h4>
  2342. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  2343. </div>
  2344. </section>
  2345. </div>
  2346. </li>
  2347. </ul>
  2348. </div>
  2349. </div>
  2350. </section>
  2351. </article>
  2352. </div>
  2353. <section class="footer">
  2354. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-10-26)</p>
  2355. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  2356. </section>
  2357. </body>
  2358. </div>
  2359. </html>