AF.html 122 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043
  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. (77% 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/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</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/ArrayEncoding.html">– ArrayEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  178. </li>
  179. </ul>
  180. </li>
  181. <li class="nav-group-name">
  182. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  183. <ul class="nav-group-tasks">
  184. <li class="nav-group-task">
  185. <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
  186. </li>
  187. <li class="nav-group-task">
  188. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  189. </li>
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  192. </li>
  193. <li class="nav-group-task">
  194. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</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/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  201. </li>
  202. <li class="nav-group-task">
  203. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  204. </li>
  205. <li class="nav-group-task">
  206. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  207. </li>
  208. <li class="nav-group-task">
  209. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  210. </li>
  211. <li class="nav-group-task">
  212. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  213. </li>
  214. </ul>
  215. </li>
  216. <li class="nav-group-name">
  217. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  218. <ul class="nav-group-tasks">
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  224. </li>
  225. <li class="nav-group-task">
  226. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  227. </li>
  228. <li class="nav-group-task">
  229. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  230. </li>
  231. <li class="nav-group-task">
  232. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  233. </li>
  234. <li class="nav-group-task">
  235. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  236. </li>
  237. <li class="nav-group-task">
  238. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  239. </li>
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  248. </li>
  249. </ul>
  250. </li>
  251. <li class="nav-group-name">
  252. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  253. <ul class="nav-group-tasks">
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  256. </li>
  257. </ul>
  258. </li>
  259. <li class="nav-group-name">
  260. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  261. <ul class="nav-group-tasks">
  262. <li class="nav-group-task">
  263. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  264. </li>
  265. <li class="nav-group-task">
  266. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  267. </li>
  268. <li class="nav-group-task">
  269. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  270. </li>
  271. <li class="nav-group-task">
  272. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  273. </li>
  274. <li class="nav-group-task">
  275. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  276. </li>
  277. <li class="nav-group-task">
  278. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  279. </li>
  280. <li class="nav-group-task">
  281. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  282. </li>
  283. <li class="nav-group-task">
  284. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  285. </li>
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  321. </li>
  322. </ul>
  323. </li>
  324. <li class="nav-group-name">
  325. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  326. <ul class="nav-group-tasks">
  327. <li class="nav-group-task">
  328. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  329. </li>
  330. <li class="nav-group-task">
  331. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  332. </li>
  333. <li class="nav-group-task">
  334. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  335. </li>
  336. <li class="nav-group-task">
  337. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  338. </li>
  339. <li class="nav-group-task">
  340. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  341. </li>
  342. <li class="nav-group-task">
  343. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  344. </li>
  345. <li class="nav-group-task">
  346. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  347. </li>
  348. <li class="nav-group-task">
  349. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  350. </li>
  351. <li class="nav-group-task">
  352. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  353. </li>
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  371. </li>
  372. </ul>
  373. </li>
  374. <li class="nav-group-name">
  375. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  376. <ul class="nav-group-tasks">
  377. <li class="nav-group-task">
  378. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  379. </li>
  380. <li class="nav-group-task">
  381. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  382. </li>
  383. <li class="nav-group-task">
  384. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  385. </li>
  386. <li class="nav-group-task">
  387. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  388. </li>
  389. </ul>
  390. </li>
  391. </ul>
  392. </nav>
  393. <article class="main-content">
  394. <section class="section">
  395. <div class="section-content">
  396. <h1>AF</h1>
  397. <div class="declaration">
  398. <div class="language">
  399. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AF</span></code></pre>
  400. </div>
  401. </div>
  402. <p>Global namespace containing API for the <code>default</code> <code><a href="../Classes/Session.html">Session</a></code> instance.</p>
  403. </div>
  404. </section>
  405. <section class="section">
  406. <div class="section-content">
  407. <div class="task-group">
  408. <div class="task-name-container">
  409. <a name="/Data%20Request"></a>
  410. <a name="//apple_ref/swift/Section/Data Request" class="dashAnchor"></a>
  411. <a href="#/Data%20Request">
  412. <h3 class="section-name">Data Request</h3>
  413. </a>
  414. </div>
  415. <ul class="item-container">
  416. <li class="item">
  417. <div>
  418. <code>
  419. <a name="/s:9Alamofire2AFO7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtFZ"></a>
  420. <a name="//apple_ref/swift/Method/request(_:method:parameters:encoding:headers:interceptor:)" class="dashAnchor"></a>
  421. <a class="token" href="#/s:9Alamofire2AFO7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtFZ">request(_:method:parameters:encoding:headers:interceptor:)</a>
  422. </code>
  423. </div>
  424. <div class="height-container">
  425. <div class="pointer-container"></div>
  426. <section class="section">
  427. <div class="pointer"></div>
  428. <div class="abstract">
  429. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code>SessionManager.default</code> to retrive the contents of the specified <code>url</code>
  430. using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
  431. </div>
  432. <div class="declaration">
  433. <h4>Declaration</h4>
  434. <div class="language">
  435. <p class="aside-title">Swift</p>
  436. <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>
  437. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  438. <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>
  439. <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>
  440. <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>
  441. <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>
  442. </div>
  443. </div>
  444. <div>
  445. <h4>Parameters</h4>
  446. <table class="graybox">
  447. <tbody>
  448. <tr>
  449. <td>
  450. <code>
  451. <em>url</em>
  452. </code>
  453. </td>
  454. <td>
  455. <div>
  456. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  457. </div>
  458. </td>
  459. </tr>
  460. <tr>
  461. <td>
  462. <code>
  463. <em>method</em>
  464. </code>
  465. </td>
  466. <td>
  467. <div>
  468. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  469. </div>
  470. </td>
  471. </tr>
  472. <tr>
  473. <td>
  474. <code>
  475. <em>parameters</em>
  476. </code>
  477. </td>
  478. <td>
  479. <div>
  480. <p>The <code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code>, <code>nil</code> by default.</p>
  481. </div>
  482. </td>
  483. </tr>
  484. <tr>
  485. <td>
  486. <code>
  487. <em>encoding</em>
  488. </code>
  489. </td>
  490. <td>
  491. <div>
  492. <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>
  493. </div>
  494. </td>
  495. </tr>
  496. <tr>
  497. <td>
  498. <code>
  499. <em>headers</em>
  500. </code>
  501. </td>
  502. <td>
  503. <div>
  504. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  505. </div>
  506. </td>
  507. </tr>
  508. <tr>
  509. <td>
  510. <code>
  511. <em>interceptor</em>
  512. </code>
  513. </td>
  514. <td>
  515. <div>
  516. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  517. </div>
  518. </td>
  519. </tr>
  520. </tbody>
  521. </table>
  522. </div>
  523. <div>
  524. <h4>Return Value</h4>
  525. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  526. </div>
  527. </section>
  528. </div>
  529. </li>
  530. <li class="item">
  531. <div>
  532. <code>
  533. <a name="/s:9Alamofire2AFO7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlFZ"></a>
  534. <a name="//apple_ref/swift/Method/request(_:method:parameters:encoder:headers:interceptor:)" class="dashAnchor"></a>
  535. <a class="token" href="#/s:9Alamofire2AFO7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlFZ">request(_:method:parameters:encoder:headers:interceptor:)</a>
  536. </code>
  537. </div>
  538. <div class="height-container">
  539. <div class="pointer-container"></div>
  540. <section class="section">
  541. <div class="pointer"></div>
  542. <div class="abstract">
  543. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code>SessionManager.default</code> to retrive the contents of the specified <code>url</code>
  544. using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
  545. </div>
  546. <div class="declaration">
  547. <h4>Declaration</h4>
  548. <div class="language">
  549. <p class="aside-title">Swift</p>
  550. <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>
  551. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  552. <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>
  553. <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>
  554. <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>
  555. <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>
  556. </div>
  557. </div>
  558. <div>
  559. <h4>Parameters</h4>
  560. <table class="graybox">
  561. <tbody>
  562. <tr>
  563. <td>
  564. <code>
  565. <em>url</em>
  566. </code>
  567. </td>
  568. <td>
  569. <div>
  570. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  571. </div>
  572. </td>
  573. </tr>
  574. <tr>
  575. <td>
  576. <code>
  577. <em>method</em>
  578. </code>
  579. </td>
  580. <td>
  581. <div>
  582. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  583. </div>
  584. </td>
  585. </tr>
  586. <tr>
  587. <td>
  588. <code>
  589. <em>parameters</em>
  590. </code>
  591. </td>
  592. <td>
  593. <div>
  594. <p>The <code>Encodable</code> parameters, <code>nil</code> by default.</p>
  595. </div>
  596. </td>
  597. </tr>
  598. <tr>
  599. <td>
  600. <code>
  601. <em>encoding</em>
  602. </code>
  603. </td>
  604. <td>
  605. <div>
  606. <p>The <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>, <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
  607. </div>
  608. </td>
  609. </tr>
  610. <tr>
  611. <td>
  612. <code>
  613. <em>headers</em>
  614. </code>
  615. </td>
  616. <td>
  617. <div>
  618. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  619. </div>
  620. </td>
  621. </tr>
  622. <tr>
  623. <td>
  624. <code>
  625. <em>interceptor</em>
  626. </code>
  627. </td>
  628. <td>
  629. <div>
  630. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  631. </div>
  632. </td>
  633. </tr>
  634. </tbody>
  635. </table>
  636. </div>
  637. <div>
  638. <h4>Return Value</h4>
  639. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  640. </div>
  641. </section>
  642. </div>
  643. </li>
  644. <li class="item">
  645. <div>
  646. <code>
  647. <a name="/s:9Alamofire2AFO7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtFZ"></a>
  648. <a name="//apple_ref/swift/Method/request(_:interceptor:)" class="dashAnchor"></a>
  649. <a class="token" href="#/s:9Alamofire2AFO7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtFZ">request(_:interceptor:)</a>
  650. </code>
  651. </div>
  652. <div class="height-container">
  653. <div class="pointer-container"></div>
  654. <section class="section">
  655. <div class="pointer"></div>
  656. <div class="abstract">
  657. <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code>SessionManager.default</code> to execute the specified <code>urlRequest</code>.</p>
  658. </div>
  659. <div class="declaration">
  660. <h4>Declaration</h4>
  661. <div class="language">
  662. <p class="aside-title">Swift</p>
  663. <pre class="highlight swift"><code><span class="kd">public</span> <span class="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>
  664. </div>
  665. </div>
  666. <div>
  667. <h4>Parameters</h4>
  668. <table class="graybox">
  669. <tbody>
  670. <tr>
  671. <td>
  672. <code>
  673. <em>urlRequest</em>
  674. </code>
  675. </td>
  676. <td>
  677. <div>
  678. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  679. </div>
  680. </td>
  681. </tr>
  682. <tr>
  683. <td>
  684. <code>
  685. <em>interceptor</em>
  686. </code>
  687. </td>
  688. <td>
  689. <div>
  690. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  691. </div>
  692. </td>
  693. </tr>
  694. </tbody>
  695. </table>
  696. </div>
  697. <div>
  698. <h4>Return Value</h4>
  699. <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
  700. </div>
  701. </section>
  702. </div>
  703. </li>
  704. </ul>
  705. </div>
  706. <div class="task-group">
  707. <div class="task-name-container">
  708. <a name="/Download%20Request"></a>
  709. <a name="//apple_ref/swift/Section/Download Request" class="dashAnchor"></a>
  710. <a href="#/Download%20Request">
  711. <h3 class="section-name">Download Request</h3>
  712. </a>
  713. </div>
  714. <ul class="item-container">
  715. <li class="item">
  716. <div>
  717. <code>
  718. <a name="/s:9Alamofire2AFO8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtFZ"></a>
  719. <a name="//apple_ref/swift/Method/download(_:method:parameters:encoding:headers:interceptor:to:)" class="dashAnchor"></a>
  720. <a class="token" href="#/s:9Alamofire2AFO8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtFZ">download(_:method:parameters:encoding:headers:interceptor:to:)</a>
  721. </code>
  722. </div>
  723. <div class="height-container">
  724. <div class="pointer-container"></div>
  725. <section class="section">
  726. <div class="pointer"></div>
  727. <div class="abstract">
  728. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code>SessionManager.default</code> to download the contents of the specified <code>url</code> to
  729. the provided <code>destination</code> using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
  730. <p>If <code>destination</code> is not specified, the download will remain at the temporary location determined by the
  731. underlying <code>URLSession</code>.</p>
  732. </div>
  733. <div class="declaration">
  734. <h4>Declaration</h4>
  735. <div class="language">
  736. <p class="aside-title">Swift</p>
  737. <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>
  738. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  739. <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>
  740. <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>
  741. <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>
  742. <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>
  743. <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>
  744. </div>
  745. </div>
  746. <div>
  747. <h4>Parameters</h4>
  748. <table class="graybox">
  749. <tbody>
  750. <tr>
  751. <td>
  752. <code>
  753. <em>url</em>
  754. </code>
  755. </td>
  756. <td>
  757. <div>
  758. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  759. </div>
  760. </td>
  761. </tr>
  762. <tr>
  763. <td>
  764. <code>
  765. <em>method</em>
  766. </code>
  767. </td>
  768. <td>
  769. <div>
  770. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  771. </div>
  772. </td>
  773. </tr>
  774. <tr>
  775. <td>
  776. <code>
  777. <em>parameters</em>
  778. </code>
  779. </td>
  780. <td>
  781. <div>
  782. <p>The <code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code>, <code>nil</code> by default.</p>
  783. </div>
  784. </td>
  785. </tr>
  786. <tr>
  787. <td>
  788. <code>
  789. <em>encoding</em>
  790. </code>
  791. </td>
  792. <td>
  793. <div>
  794. <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>
  795. </div>
  796. </td>
  797. </tr>
  798. <tr>
  799. <td>
  800. <code>
  801. <em>headers</em>
  802. </code>
  803. </td>
  804. <td>
  805. <div>
  806. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  807. </div>
  808. </td>
  809. </tr>
  810. <tr>
  811. <td>
  812. <code>
  813. <em>interceptor</em>
  814. </code>
  815. </td>
  816. <td>
  817. <div>
  818. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  819. </div>
  820. </td>
  821. </tr>
  822. <tr>
  823. <td>
  824. <code>
  825. <em>destination</em>
  826. </code>
  827. </td>
  828. <td>
  829. <div>
  830. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
  831. downloaded file. <code>nil</code> by default.</p>
  832. </div>
  833. </td>
  834. </tr>
  835. </tbody>
  836. </table>
  837. </div>
  838. <div>
  839. <h4>Return Value</h4>
  840. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  841. </div>
  842. </section>
  843. </div>
  844. </li>
  845. <li class="item">
  846. <div>
  847. <code>
  848. <a name="/s:9Alamofire2AFO8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlFZ"></a>
  849. <a name="//apple_ref/swift/Method/download(_:method:parameters:encoder:headers:interceptor:to:)" class="dashAnchor"></a>
  850. <a class="token" href="#/s:9Alamofire2AFO8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlFZ">download(_:method:parameters:encoder:headers:interceptor:to:)</a>
  851. </code>
  852. </div>
  853. <div class="height-container">
  854. <div class="pointer-container"></div>
  855. <section class="section">
  856. <div class="pointer"></div>
  857. <div class="abstract">
  858. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code>SessionManager.default</code> to download the contents of the specified <code>url</code> to
  859. the provided <code>destination</code> using the <code>method</code>, encodable <code>parameters</code>, <code>encoder</code>, and <code>headers</code> provided.</p>
  860. <p>If <code>destination</code> is not specified, the download will remain at the temporary location determined by the
  861. underlying <code>URLSession</code>.</p>
  862. </div>
  863. <div class="declaration">
  864. <h4>Declaration</h4>
  865. <div class="language">
  866. <p class="aside-title">Swift</p>
  867. <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>
  868. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">get</span><span class="p">,</span>
  869. <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>
  870. <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>
  871. <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>
  872. <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>
  873. <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>
  874. </div>
  875. </div>
  876. <div>
  877. <h4>Parameters</h4>
  878. <table class="graybox">
  879. <tbody>
  880. <tr>
  881. <td>
  882. <code>
  883. <em>url</em>
  884. </code>
  885. </td>
  886. <td>
  887. <div>
  888. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  889. </div>
  890. </td>
  891. </tr>
  892. <tr>
  893. <td>
  894. <code>
  895. <em>method</em>
  896. </code>
  897. </td>
  898. <td>
  899. <div>
  900. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
  901. </div>
  902. </td>
  903. </tr>
  904. <tr>
  905. <td>
  906. <code>
  907. <em>parameters</em>
  908. </code>
  909. </td>
  910. <td>
  911. <div>
  912. <p>The <code>Encodable</code> parameters, <code>nil</code> by default.</p>
  913. </div>
  914. </td>
  915. </tr>
  916. <tr>
  917. <td>
  918. <code>
  919. <em>encoder</em>
  920. </code>
  921. </td>
  922. <td>
  923. <div>
  924. <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>
  925. </div>
  926. </td>
  927. </tr>
  928. <tr>
  929. <td>
  930. <code>
  931. <em>headers</em>
  932. </code>
  933. </td>
  934. <td>
  935. <div>
  936. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  937. </div>
  938. </td>
  939. </tr>
  940. <tr>
  941. <td>
  942. <code>
  943. <em>interceptor</em>
  944. </code>
  945. </td>
  946. <td>
  947. <div>
  948. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  949. </div>
  950. </td>
  951. </tr>
  952. <tr>
  953. <td>
  954. <code>
  955. <em>destination</em>
  956. </code>
  957. </td>
  958. <td>
  959. <div>
  960. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
  961. downloaded file. <code>nil</code> by default.</p>
  962. </div>
  963. </td>
  964. </tr>
  965. </tbody>
  966. </table>
  967. </div>
  968. <div>
  969. <h4>Return Value</h4>
  970. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  971. </div>
  972. </section>
  973. </div>
  974. </li>
  975. </ul>
  976. </div>
  977. <div class="task-group">
  978. <div class="task-name-container">
  979. <a name="/URLRequest"></a>
  980. <a name="//apple_ref/swift/Section/URLRequest" class="dashAnchor"></a>
  981. <a href="#/URLRequest">
  982. <h3 class="section-name">URLRequest</h3>
  983. </a>
  984. </div>
  985. <ul class="item-container">
  986. <li class="item">
  987. <div>
  988. <code>
  989. <a name="/s:9Alamofire2AFO8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtFZ"></a>
  990. <a name="//apple_ref/swift/Method/download(_:interceptor:to:)" class="dashAnchor"></a>
  991. <a class="token" href="#/s:9Alamofire2AFO8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtFZ">download(_:interceptor:to:)</a>
  992. </code>
  993. </div>
  994. <div class="height-container">
  995. <div class="pointer-container"></div>
  996. <section class="section">
  997. <div class="pointer"></div>
  998. <div class="abstract">
  999. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code>SessionManager.default</code> to execute the specified <code>urlRequest</code> and download
  1000. the result to the provided <code>destination</code>.</p>
  1001. </div>
  1002. <div class="declaration">
  1003. <h4>Declaration</h4>
  1004. <div class="language">
  1005. <p class="aside-title">Swift</p>
  1006. <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>
  1007. <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>
  1008. <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>
  1009. </div>
  1010. </div>
  1011. <div>
  1012. <h4>Parameters</h4>
  1013. <table class="graybox">
  1014. <tbody>
  1015. <tr>
  1016. <td>
  1017. <code>
  1018. <em>urlRequest</em>
  1019. </code>
  1020. </td>
  1021. <td>
  1022. <div>
  1023. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  1024. </div>
  1025. </td>
  1026. </tr>
  1027. <tr>
  1028. <td>
  1029. <code>
  1030. <em>interceptor</em>
  1031. </code>
  1032. </td>
  1033. <td>
  1034. <div>
  1035. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1036. </div>
  1037. </td>
  1038. </tr>
  1039. <tr>
  1040. <td>
  1041. <code>
  1042. <em>destination</em>
  1043. </code>
  1044. </td>
  1045. <td>
  1046. <div>
  1047. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
  1048. downloaded file. <code>nil</code> by default.</p>
  1049. </div>
  1050. </td>
  1051. </tr>
  1052. </tbody>
  1053. </table>
  1054. </div>
  1055. <div>
  1056. <h4>Return Value</h4>
  1057. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  1058. </div>
  1059. </section>
  1060. </div>
  1061. </li>
  1062. </ul>
  1063. </div>
  1064. <div class="task-group">
  1065. <div class="task-name-container">
  1066. <a name="/Resume%20Data"></a>
  1067. <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
  1068. <a href="#/Resume%20Data">
  1069. <h3 class="section-name">Resume Data</h3>
  1070. </a>
  1071. </div>
  1072. <ul class="item-container">
  1073. <li class="item">
  1074. <div>
  1075. <code>
  1076. <a name="/s:9Alamofire2AFO8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtFZ"></a>
  1077. <a name="//apple_ref/swift/Method/download(resumingWith:interceptor:to:)" class="dashAnchor"></a>
  1078. <a class="token" href="#/s:9Alamofire2AFO8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtFZ">download(resumingWith:interceptor:to:)</a>
  1079. </code>
  1080. </div>
  1081. <div class="height-container">
  1082. <div class="pointer-container"></div>
  1083. <section class="section">
  1084. <div class="pointer"></div>
  1085. <div class="abstract">
  1086. <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using the <code>SessionManager.default</code> from the <code>resumeData</code> produced from a previous
  1087. <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>
  1088. <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
  1089. underlying URL session.</p>
  1090. <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),
  1091. <code>resumeData</code> is broken on background URL session configurations. There&rsquo;s an underlying bug in the <code>resumeData</code>
  1092. generation logic where the data is written incorrectly and will always fail to resume the download. For more
  1093. 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>
  1094. </div>
  1095. <div class="declaration">
  1096. <h4>Declaration</h4>
  1097. <div class="language">
  1098. <p class="aside-title">Swift</p>
  1099. <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>
  1100. <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>
  1101. <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>
  1102. </div>
  1103. </div>
  1104. <div>
  1105. <h4>Parameters</h4>
  1106. <table class="graybox">
  1107. <tbody>
  1108. <tr>
  1109. <td>
  1110. <code>
  1111. <em>resumeData</em>
  1112. </code>
  1113. </td>
  1114. <td>
  1115. <div>
  1116. <p>The resume <code>Data</code>. This is an opaque blob produced by <code>URLSessionDownloadTask</code> when a task is
  1117. cancelled. See <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>
  1118. for more information.</p>
  1119. </div>
  1120. </td>
  1121. </tr>
  1122. <tr>
  1123. <td>
  1124. <code>
  1125. <em>interceptor</em>
  1126. </code>
  1127. </td>
  1128. <td>
  1129. <div>
  1130. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1131. </div>
  1132. </td>
  1133. </tr>
  1134. <tr>
  1135. <td>
  1136. <code>
  1137. <em>destination</em>
  1138. </code>
  1139. </td>
  1140. <td>
  1141. <div>
  1142. <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine the destination of the downloaded
  1143. file. <code>nil</code> by default.</p>
  1144. </div>
  1145. </td>
  1146. </tr>
  1147. </tbody>
  1148. </table>
  1149. </div>
  1150. <div>
  1151. <h4>Return Value</h4>
  1152. <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
  1153. </div>
  1154. </section>
  1155. </div>
  1156. </li>
  1157. </ul>
  1158. </div>
  1159. <div class="task-group">
  1160. <div class="task-name-container">
  1161. <a name="/File"></a>
  1162. <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
  1163. <a href="#/File">
  1164. <h3 class="section-name">File</h3>
  1165. </a>
  1166. </div>
  1167. <ul class="item-container">
  1168. <li class="item">
  1169. <div>
  1170. <code>
  1171. <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ"></a>
  1172. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:)" class="dashAnchor"></a>
  1173. <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ">upload(_:to:method:headers:interceptor:)</a>
  1174. </code>
  1175. </div>
  1176. <div class="height-container">
  1177. <div class="pointer-container"></div>
  1178. <section class="section">
  1179. <div class="pointer"></div>
  1180. <div class="abstract">
  1181. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code>SessionManager.default</code> to upload the contents of the <code>fileURL</code> specified
  1182. using the <code>url</code>, <code>method</code> and <code>headers</code> provided.</p>
  1183. </div>
  1184. <div class="declaration">
  1185. <h4>Declaration</h4>
  1186. <div class="language">
  1187. <p class="aside-title">Swift</p>
  1188. <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>
  1189. <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>
  1190. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1191. <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>
  1192. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1193. </div>
  1194. </div>
  1195. <div>
  1196. <h4>Parameters</h4>
  1197. <table class="graybox">
  1198. <tbody>
  1199. <tr>
  1200. <td>
  1201. <code>
  1202. <em>fileURL</em>
  1203. </code>
  1204. </td>
  1205. <td>
  1206. <div>
  1207. <p>The <code>URL</code> of the file to upload.</p>
  1208. </div>
  1209. </td>
  1210. </tr>
  1211. <tr>
  1212. <td>
  1213. <code>
  1214. <em>url</em>
  1215. </code>
  1216. </td>
  1217. <td>
  1218. <div>
  1219. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  1220. </div>
  1221. </td>
  1222. </tr>
  1223. <tr>
  1224. <td>
  1225. <code>
  1226. <em>method</em>
  1227. </code>
  1228. </td>
  1229. <td>
  1230. <div>
  1231. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
  1232. </div>
  1233. </td>
  1234. </tr>
  1235. <tr>
  1236. <td>
  1237. <code>
  1238. <em>headers</em>
  1239. </code>
  1240. </td>
  1241. <td>
  1242. <div>
  1243. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  1244. </div>
  1245. </td>
  1246. </tr>
  1247. <tr>
  1248. <td>
  1249. <code>
  1250. <em>interceptor</em>
  1251. </code>
  1252. </td>
  1253. <td>
  1254. <div>
  1255. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1256. </div>
  1257. </td>
  1258. </tr>
  1259. </tbody>
  1260. </table>
  1261. </div>
  1262. <div>
  1263. <h4>Return Value</h4>
  1264. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1265. </div>
  1266. </section>
  1267. </div>
  1268. </li>
  1269. <li class="item">
  1270. <div>
  1271. <code>
  1272. <a name="/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ"></a>
  1273. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:)" class="dashAnchor"></a>
  1274. <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ">upload(_:with:interceptor:)</a>
  1275. </code>
  1276. </div>
  1277. <div class="height-container">
  1278. <div class="pointer-container"></div>
  1279. <section class="section">
  1280. <div class="pointer"></div>
  1281. <div class="abstract">
  1282. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using the <code>SessionManager.default</code> to upload the contents of the <code>fileURL</code> specificed
  1283. using the <code>urlRequest</code> provided.</p>
  1284. </div>
  1285. <div class="declaration">
  1286. <h4>Declaration</h4>
  1287. <div class="language">
  1288. <p class="aside-title">Swift</p>
  1289. <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>
  1290. <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1291. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1292. </div>
  1293. </div>
  1294. <div>
  1295. <h4>Parameters</h4>
  1296. <table class="graybox">
  1297. <tbody>
  1298. <tr>
  1299. <td>
  1300. <code>
  1301. <em>fileURL</em>
  1302. </code>
  1303. </td>
  1304. <td>
  1305. <div>
  1306. <p>The <code>URL</code> of the file to upload.</p>
  1307. </div>
  1308. </td>
  1309. </tr>
  1310. <tr>
  1311. <td>
  1312. <code>
  1313. <em>urlRequest</em>
  1314. </code>
  1315. </td>
  1316. <td>
  1317. <div>
  1318. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  1319. </div>
  1320. </td>
  1321. </tr>
  1322. <tr>
  1323. <td>
  1324. <code>
  1325. <em>interceptor</em>
  1326. </code>
  1327. </td>
  1328. <td>
  1329. <div>
  1330. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1331. </div>
  1332. </td>
  1333. </tr>
  1334. </tbody>
  1335. </table>
  1336. </div>
  1337. <div>
  1338. <h4>Return Value</h4>
  1339. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1340. </div>
  1341. </section>
  1342. </div>
  1343. </li>
  1344. </ul>
  1345. </div>
  1346. <div class="task-group">
  1347. <div class="task-name-container">
  1348. <a name="/Data"></a>
  1349. <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
  1350. <a href="#/Data">
  1351. <h3 class="section-name">Data</h3>
  1352. </a>
  1353. </div>
  1354. <ul class="item-container">
  1355. <li class="item">
  1356. <div>
  1357. <code>
  1358. <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ"></a>
  1359. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:)" class="dashAnchor"></a>
  1360. <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ">upload(_:to:method:headers:interceptor:)</a>
  1361. </code>
  1362. </div>
  1363. <div class="height-container">
  1364. <div class="pointer-container"></div>
  1365. <section class="section">
  1366. <div class="pointer"></div>
  1367. <div class="abstract">
  1368. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code>SessionManager.default</code> to upload the contents of the <code>data</code> specified using
  1369. the <code>url</code>, <code>method</code> and <code>headers</code> provided.</p>
  1370. </div>
  1371. <div class="declaration">
  1372. <h4>Declaration</h4>
  1373. <div class="language">
  1374. <p class="aside-title">Swift</p>
  1375. <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>
  1376. <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>
  1377. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1378. <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>
  1379. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1380. </div>
  1381. </div>
  1382. <div>
  1383. <h4>Parameters</h4>
  1384. <table class="graybox">
  1385. <tbody>
  1386. <tr>
  1387. <td>
  1388. <code>
  1389. <em>data</em>
  1390. </code>
  1391. </td>
  1392. <td>
  1393. <div>
  1394. <p>The <code>Data</code> to upload.</p>
  1395. </div>
  1396. </td>
  1397. </tr>
  1398. <tr>
  1399. <td>
  1400. <code>
  1401. <em>url</em>
  1402. </code>
  1403. </td>
  1404. <td>
  1405. <div>
  1406. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  1407. </div>
  1408. </td>
  1409. </tr>
  1410. <tr>
  1411. <td>
  1412. <code>
  1413. <em>method</em>
  1414. </code>
  1415. </td>
  1416. <td>
  1417. <div>
  1418. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
  1419. </div>
  1420. </td>
  1421. </tr>
  1422. <tr>
  1423. <td>
  1424. <code>
  1425. <em>headers</em>
  1426. </code>
  1427. </td>
  1428. <td>
  1429. <div>
  1430. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  1431. </div>
  1432. </td>
  1433. </tr>
  1434. <tr>
  1435. <td>
  1436. <code>
  1437. <em>interceptor</em>
  1438. </code>
  1439. </td>
  1440. <td>
  1441. <div>
  1442. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1443. </div>
  1444. </td>
  1445. </tr>
  1446. <tr>
  1447. <td>
  1448. <code>
  1449. <em>retryPolicies</em>
  1450. </code>
  1451. </td>
  1452. <td>
  1453. <div>
  1454. <p>The <code><a href="../Classes/RetryPolicy.html">RetryPolicy</a></code> types, <code>[]</code> by default.</p>
  1455. </div>
  1456. </td>
  1457. </tr>
  1458. </tbody>
  1459. </table>
  1460. </div>
  1461. <div>
  1462. <h4>Return Value</h4>
  1463. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1464. </div>
  1465. </section>
  1466. </div>
  1467. </li>
  1468. <li class="item">
  1469. <div>
  1470. <code>
  1471. <a name="/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ"></a>
  1472. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:)" class="dashAnchor"></a>
  1473. <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ">upload(_:with:interceptor:)</a>
  1474. </code>
  1475. </div>
  1476. <div class="height-container">
  1477. <div class="pointer-container"></div>
  1478. <section class="section">
  1479. <div class="pointer"></div>
  1480. <div class="abstract">
  1481. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code>SessionManager.default</code> to upload the contents of the <code>data</code> specified using
  1482. the <code>urlRequest</code> provided.</p>
  1483. </div>
  1484. <div class="declaration">
  1485. <h4>Declaration</h4>
  1486. <div class="language">
  1487. <p class="aside-title">Swift</p>
  1488. <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>
  1489. <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1490. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1491. </div>
  1492. </div>
  1493. <div>
  1494. <h4>Parameters</h4>
  1495. <table class="graybox">
  1496. <tbody>
  1497. <tr>
  1498. <td>
  1499. <code>
  1500. <em>data</em>
  1501. </code>
  1502. </td>
  1503. <td>
  1504. <div>
  1505. <p>The <code>Data</code> to upload.</p>
  1506. </div>
  1507. </td>
  1508. </tr>
  1509. <tr>
  1510. <td>
  1511. <code>
  1512. <em>urlRequest</em>
  1513. </code>
  1514. </td>
  1515. <td>
  1516. <div>
  1517. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  1518. </div>
  1519. </td>
  1520. </tr>
  1521. <tr>
  1522. <td>
  1523. <code>
  1524. <em>interceptor</em>
  1525. </code>
  1526. </td>
  1527. <td>
  1528. <div>
  1529. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1530. </div>
  1531. </td>
  1532. </tr>
  1533. </tbody>
  1534. </table>
  1535. </div>
  1536. <div>
  1537. <h4>Return Value</h4>
  1538. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1539. </div>
  1540. </section>
  1541. </div>
  1542. </li>
  1543. </ul>
  1544. </div>
  1545. <div class="task-group">
  1546. <div class="task-name-container">
  1547. <a name="/InputStream"></a>
  1548. <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
  1549. <a href="#/InputStream">
  1550. <h3 class="section-name">InputStream</h3>
  1551. </a>
  1552. </div>
  1553. <ul class="item-container">
  1554. <li class="item">
  1555. <div>
  1556. <code>
  1557. <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ"></a>
  1558. <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:)" class="dashAnchor"></a>
  1559. <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ">upload(_:to:method:headers:interceptor:)</a>
  1560. </code>
  1561. </div>
  1562. <div class="height-container">
  1563. <div class="pointer-container"></div>
  1564. <section class="section">
  1565. <div class="pointer"></div>
  1566. <div class="abstract">
  1567. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code>SessionManager.default</code> to upload the content provided by the <code>stream</code>
  1568. specified using the <code>url</code>, <code>method</code> and <code>headers</code> provided.</p>
  1569. </div>
  1570. <div class="declaration">
  1571. <h4>Declaration</h4>
  1572. <div class="language">
  1573. <p class="aside-title">Swift</p>
  1574. <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>
  1575. <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>
  1576. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1577. <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>
  1578. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1579. </div>
  1580. </div>
  1581. <div>
  1582. <h4>Parameters</h4>
  1583. <table class="graybox">
  1584. <tbody>
  1585. <tr>
  1586. <td>
  1587. <code>
  1588. <em>stream</em>
  1589. </code>
  1590. </td>
  1591. <td>
  1592. <div>
  1593. <p>The <code>InputStream</code> to upload.</p>
  1594. </div>
  1595. </td>
  1596. </tr>
  1597. <tr>
  1598. <td>
  1599. <code>
  1600. <em>url</em>
  1601. </code>
  1602. </td>
  1603. <td>
  1604. <div>
  1605. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  1606. </div>
  1607. </td>
  1608. </tr>
  1609. <tr>
  1610. <td>
  1611. <code>
  1612. <em>method</em>
  1613. </code>
  1614. </td>
  1615. <td>
  1616. <div>
  1617. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
  1618. </div>
  1619. </td>
  1620. </tr>
  1621. <tr>
  1622. <td>
  1623. <code>
  1624. <em>headers</em>
  1625. </code>
  1626. </td>
  1627. <td>
  1628. <div>
  1629. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  1630. </div>
  1631. </td>
  1632. </tr>
  1633. <tr>
  1634. <td>
  1635. <code>
  1636. <em>interceptor</em>
  1637. </code>
  1638. </td>
  1639. <td>
  1640. <div>
  1641. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1642. </div>
  1643. </td>
  1644. </tr>
  1645. </tbody>
  1646. </table>
  1647. </div>
  1648. <div>
  1649. <h4>Return Value</h4>
  1650. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1651. </div>
  1652. </section>
  1653. </div>
  1654. </li>
  1655. <li class="item">
  1656. <div>
  1657. <code>
  1658. <a name="/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ"></a>
  1659. <a name="//apple_ref/swift/Method/upload(_:with:interceptor:)" class="dashAnchor"></a>
  1660. <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ">upload(_:with:interceptor:)</a>
  1661. </code>
  1662. </div>
  1663. <div class="height-container">
  1664. <div class="pointer-container"></div>
  1665. <section class="section">
  1666. <div class="pointer"></div>
  1667. <div class="abstract">
  1668. <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code>SessionManager.default</code> to upload the content provided by the <code>stream</code>
  1669. specified using the <code>urlRequest</code> specified.</p>
  1670. </div>
  1671. <div class="declaration">
  1672. <h4>Declaration</h4>
  1673. <div class="language">
  1674. <p class="aside-title">Swift</p>
  1675. <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>
  1676. <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1677. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1678. </div>
  1679. </div>
  1680. <div>
  1681. <h4>Parameters</h4>
  1682. <table class="graybox">
  1683. <tbody>
  1684. <tr>
  1685. <td>
  1686. <code>
  1687. <em>stream</em>
  1688. </code>
  1689. </td>
  1690. <td>
  1691. <div>
  1692. <p>The <code>InputStream</code> to upload.</p>
  1693. </div>
  1694. </td>
  1695. </tr>
  1696. <tr>
  1697. <td>
  1698. <code>
  1699. <em>urlRequest</em>
  1700. </code>
  1701. </td>
  1702. <td>
  1703. <div>
  1704. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  1705. </div>
  1706. </td>
  1707. </tr>
  1708. <tr>
  1709. <td>
  1710. <code>
  1711. <em>interceptor</em>
  1712. </code>
  1713. </td>
  1714. <td>
  1715. <div>
  1716. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1717. </div>
  1718. </td>
  1719. </tr>
  1720. </tbody>
  1721. </table>
  1722. </div>
  1723. <div>
  1724. <h4>Return Value</h4>
  1725. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1726. </div>
  1727. </section>
  1728. </div>
  1729. </li>
  1730. </ul>
  1731. </div>
  1732. <div class="task-group">
  1733. <div class="task-name-container">
  1734. <a name="/MultipartFormData"></a>
  1735. <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
  1736. <a href="#/MultipartFormData">
  1737. <h3 class="section-name">MultipartFormData</h3>
  1738. </a>
  1739. </div>
  1740. <ul class="item-container">
  1741. <li class="item">
  1742. <div>
  1743. <code>
  1744. <a name="/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold11fileManager2to6method7headers11interceptorAA13UploadRequestCyAA09MultiparteF0Cc_s6UInt64VSo06NSFileJ0CAA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0P11Interceptor_pSgtFZ"></a>
  1745. <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:fileManager:to:method:headers:interceptor:)" class="dashAnchor"></a>
  1746. <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold11fileManager2to6method7headers11interceptorAA13UploadRequestCyAA09MultiparteF0Cc_s6UInt64VSo06NSFileJ0CAA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0P11Interceptor_pSgtFZ">upload(multipartFormData:usingThreshold:fileManager:to:method:headers:interceptor:)</a>
  1747. </code>
  1748. </div>
  1749. <div class="height-container">
  1750. <div class="pointer-container"></div>
  1751. <section class="section">
  1752. <div class="pointer"></div>
  1753. <div class="abstract">
  1754. <p>Encodes <code>multipartFormData</code> using <code>encodingMemoryThreshold</code> and uploads the result using <code>SessionManager.default</code>
  1755. with the <code>url</code>, <code>method</code>, and <code>headers</code> provided.</p>
  1756. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cummulative
  1757. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  1758. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  1759. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  1760. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  1761. used for larger payloads such as video content.</p>
  1762. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  1763. 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>,
  1764. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  1765. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  1766. technique was used.</p>
  1767. </div>
  1768. <div class="declaration">
  1769. <h4>Declaration</h4>
  1770. <div class="language">
  1771. <p class="aside-title">Swift</p>
  1772. <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>
  1773. <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>
  1774. <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>
  1775. <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>
  1776. <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Enums/HTTPMethod.html">HTTPMethod</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">post</span><span class="p">,</span>
  1777. <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>
  1778. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1779. </div>
  1780. </div>
  1781. <div>
  1782. <h4>Parameters</h4>
  1783. <table class="graybox">
  1784. <tbody>
  1785. <tr>
  1786. <td>
  1787. <code>
  1788. <em>multipartFormData</em>
  1789. </code>
  1790. </td>
  1791. <td>
  1792. <div>
  1793. <p>The closure used to append body parts to the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>.</p>
  1794. </div>
  1795. </td>
  1796. </tr>
  1797. <tr>
  1798. <td>
  1799. <code>
  1800. <em>encodingMemoryThreshold</em>
  1801. </code>
  1802. </td>
  1803. <td>
  1804. <div>
  1805. <p>The encoding memory threshold in bytes. <code>10_000_000</code> bytes by default.</p>
  1806. </div>
  1807. </td>
  1808. </tr>
  1809. <tr>
  1810. <td>
  1811. <code>
  1812. <em>fileManager</em>
  1813. </code>
  1814. </td>
  1815. <td>
  1816. <div>
  1817. <p>The <code>FileManager</code> instance to use to manage streaming and encoding.</p>
  1818. </div>
  1819. </td>
  1820. </tr>
  1821. <tr>
  1822. <td>
  1823. <code>
  1824. <em>url</em>
  1825. </code>
  1826. </td>
  1827. <td>
  1828. <div>
  1829. <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
  1830. </div>
  1831. </td>
  1832. </tr>
  1833. <tr>
  1834. <td>
  1835. <code>
  1836. <em>method</em>
  1837. </code>
  1838. </td>
  1839. <td>
  1840. <div>
  1841. <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
  1842. </div>
  1843. </td>
  1844. </tr>
  1845. <tr>
  1846. <td>
  1847. <code>
  1848. <em>headers</em>
  1849. </code>
  1850. </td>
  1851. <td>
  1852. <div>
  1853. <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
  1854. </div>
  1855. </td>
  1856. </tr>
  1857. <tr>
  1858. <td>
  1859. <code>
  1860. <em>interceptor</em>
  1861. </code>
  1862. </td>
  1863. <td>
  1864. <div>
  1865. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1866. </div>
  1867. </td>
  1868. </tr>
  1869. </tbody>
  1870. </table>
  1871. </div>
  1872. <div>
  1873. <h4>Return Value</h4>
  1874. <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
  1875. </div>
  1876. </section>
  1877. </div>
  1878. </li>
  1879. <li class="item">
  1880. <div>
  1881. <code>
  1882. <a name="/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold4with11interceptorAA13UploadRequestCAA09MultiparteF0C_s6UInt64VAA21URLRequestConvertible_pAA0L11Interceptor_pSgtFZ"></a>
  1883. <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:with:interceptor:)" class="dashAnchor"></a>
  1884. <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold4with11interceptorAA13UploadRequestCAA09MultiparteF0C_s6UInt64VAA21URLRequestConvertible_pAA0L11Interceptor_pSgtFZ">upload(multipartFormData:usingThreshold:with:interceptor:)</a>
  1885. </code>
  1886. </div>
  1887. <div class="height-container">
  1888. <div class="pointer-container"></div>
  1889. <section class="section">
  1890. <div class="pointer"></div>
  1891. <div class="abstract">
  1892. <p>Encodes <code>multipartFormData</code> using <code>encodingMemoryThreshold</code> and uploads the result using <code>SessionManager.default</code>
  1893. using the <code>urlRequest</code> provided.</p>
  1894. <p>It is important to understand the memory implications of uploading <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cummulative
  1895. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
  1896. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
  1897. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
  1898. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
  1899. used for larger payloads such as video content.</p>
  1900. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
  1901. 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>,
  1902. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
  1903. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
  1904. technique was used.</p>
  1905. </div>
  1906. <div class="declaration">
  1907. <h4>Declaration</h4>
  1908. <div class="language">
  1909. <p class="aside-title">Swift</p>
  1910. <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
  1911. <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>
  1912. <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>
  1913. <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
  1914. <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/UploadRequest.html">UploadRequest</a></span></code></pre>
  1915. </div>
  1916. </div>
  1917. <div>
  1918. <h4>Parameters</h4>
  1919. <table class="graybox">
  1920. <tbody>
  1921. <tr>
  1922. <td>
  1923. <code>
  1924. <em>multipartFormData</em>
  1925. </code>
  1926. </td>
  1927. <td>
  1928. <div>
  1929. <p>The closure used to append body parts to the <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code>.</p>
  1930. </div>
  1931. </td>
  1932. </tr>
  1933. <tr>
  1934. <td>
  1935. <code>
  1936. <em>encodingMemoryThreshold</em>
  1937. </code>
  1938. </td>
  1939. <td>
  1940. <div>
  1941. <p>The encoding memory threshold in bytes. <code>10_000_000</code> bytes by default.</p>
  1942. </div>
  1943. </td>
  1944. </tr>
  1945. <tr>
  1946. <td>
  1947. <code>
  1948. <em>urlRequest</em>
  1949. </code>
  1950. </td>
  1951. <td>
  1952. <div>
  1953. <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
  1954. </div>
  1955. </td>
  1956. </tr>
  1957. <tr>
  1958. <td>
  1959. <code>
  1960. <em>interceptor</em>
  1961. </code>
  1962. </td>
  1963. <td>
  1964. <div>
  1965. <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
  1966. </div>
  1967. </td>
  1968. </tr>
  1969. </tbody>
  1970. </table>
  1971. </div>
  1972. <div>
  1973. <h4>Return Value</h4>
  1974. <p>The <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> created.</p>
  1975. </div>
  1976. </section>
  1977. </div>
  1978. </li>
  1979. </ul>
  1980. </div>
  1981. </div>
  1982. </section>
  1983. </article>
  1984. </div>
  1985. <section class="footer">
  1986. <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-04-23)</p>
  1987. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1988. </section>
  1989. </body>
  1990. </div>
  1991. </html>