Home Explore Help
Sign In
mirror
/
Alamofire
mirror of https://github.com/Alamofire/Alamofire.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b2bafc17d3
Branches Tags
Alamofire
/
docs
/
Functions.html

Functions.html 97 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3.   <head>
    4. 

  4.     <title>Functions  Reference</title>
    5. 

  5.     <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    6. 

  6.     <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    7. 

  7.     <meta charset="utf-8">
    8. 

  8.     <script src="js/jquery.min.js" defer></script>
    9. 

  9.     <script src="js/jazzy.js" defer></script>
    10. 

  10.     
    11. 

  11.     <script src="js/lunr.min.js" defer></script>
    12. 

  12.     <script src="js/typeahead.jquery.js" defer></script>
    13. 

  13.     <script src="js/jazzy.search.js" defer></script>
    14. 

  14.   </head>
    15. 

  15.   <body>
    16. 

  16. 

  17. 

  18.     <a title="Functions  Reference"></a>
    19. 

  19. 

  20.     <header class="header">
    21. 

  21.       <p class="header-col header-col--primary">
    22. 

  22.         <a class="header-link" href="index.html">
    23. 

  23.           Alamofire Docs
    24. 

  24.         </a>
    25. 

  25.          (86% documented)
    26. 

  26.       </p>
    27. 

  27.     
    28. 

  28.       <p class="header-col--secondary">
    29. 

  29.         <form role="search" action="search.json">
    30. 

  30.           <input type="text" placeholder="Search documentation" data-typeahead>
    31. 

  31.         </form>
    32. 

  32.       </p>
    33. 

  33.     
    34. 

  34.         <p class="header-col header-col--secondary">
    35. 

  35.           <a class="header-link" href="https://github.com/Alamofire/Alamofire">
    36. 

  36.             <img class="header-icon" src="img/gh.png"/>
    37. 

  37.             View on GitHub
    38. 

  38.           </a>
    39. 

  39.         </p>
    40. 

  40.     
    41. 

  41.         <p class="header-col header-col--secondary">
    42. 

  42.           <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
    43. 

  43.             <img class="header-icon" src="img/dash.png"/>
    44. 

  44.             Install in Dash
    45. 

  45.           </a>
    46. 

  46.         </p>
    47. 

  47.     </header>
    48. 

  48. 

  49.     <p class="breadcrumbs">
    50. 

  50.       <a class="breadcrumb" href="index.html">Alamofire Reference</a>
    51. 

  51.       <img class="carat" src="img/carat.png" />
    52. 

  52.       Functions  Reference
    53. 

  53.     </p>
    54. 

  54. 

  55.     <div class="content-wrapper">
    56. 

  56.       <nav class="navigation">
    57. 

  57.         <ul class="nav-groups">
    58. 

  58.           <li class="nav-group-name">
    59. 

  59.             <a class="nav-group-name-link" href="Classes.html">Classes</a>
    60. 

  60.             <ul class="nav-group-tasks">
    61. 

  61.               <li class="nav-group-task">
    62. 

  62.                 <a class="nav-group-task-link" href="Classes/DataRequest.html">DataRequest</a>
    63. 

  63.               </li>
    64. 

  64.               <li class="nav-group-task">
    65. 

  65.                 <a class="nav-group-task-link" href="Classes/DownloadRequest.html">DownloadRequest</a>
    66. 

  66.               </li>
    67. 

  67.               <li class="nav-group-task">
    68. 

  68.                 <a class="nav-group-task-link" href="Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
    69. 

  69.               </li>
    70. 

  70.               <li class="nav-group-task">
    71. 

  71.                 <a class="nav-group-task-link" href="Classes/MultipartFormData.html">MultipartFormData</a>
    72. 

  72.               </li>
    73. 

  73.               <li class="nav-group-task">
    74. 

  74.                 <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
    75. 

  75.               </li>
    76. 

  76.               <li class="nav-group-task">
    77. 

  77.                 <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
    78. 

  78.               </li>
    79. 

  79.               <li class="nav-group-task">
    80. 

  80.                 <a class="nav-group-task-link" href="Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
    81. 

  81.               </li>
    82. 

  82.               <li class="nav-group-task">
    83. 

  83.                 <a class="nav-group-task-link" href="Classes/Request.html">Request</a>
    84. 

  84.               </li>
    85. 

  85.               <li class="nav-group-task">
    86. 

  86.                 <a class="nav-group-task-link" href="Classes/Request/ValidationResult.html">– ValidationResult</a>
    87. 

  87.               </li>
    88. 

  88.               <li class="nav-group-task">
    89. 

  89.                 <a class="nav-group-task-link" href="Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
    90. 

  90.               </li>
    91. 

  91.               <li class="nav-group-task">
    92. 

  92.                 <a class="nav-group-task-link" href="Classes/SessionDelegate.html">SessionDelegate</a>
    93. 

  93.               </li>
    94. 

  94.               <li class="nav-group-task">
    95. 

  95.                 <a class="nav-group-task-link" href="Classes/SessionManager.html">SessionManager</a>
    96. 

  96.               </li>
    97. 

  97.               <li class="nav-group-task">
    98. 

  98.                 <a class="nav-group-task-link" href="Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
    99. 

  99.               </li>
    100. 

  100.               <li class="nav-group-task">
    101. 

  101.                 <a class="nav-group-task-link" href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
    102. 

  102.               </li>
    103. 

  103.               <li class="nav-group-task">
    104. 

  104.                 <a class="nav-group-task-link" href="Classes/TaskDelegate.html">TaskDelegate</a>
    105. 

  105.               </li>
    106. 

  106.               <li class="nav-group-task">
    107. 

  107.                 <a class="nav-group-task-link" href="Classes/UploadRequest.html">UploadRequest</a>
    108. 

  108.               </li>
    109. 

  109.             </ul>
    110. 

  110.           </li>
    111. 

  111.           <li class="nav-group-name">
    112. 

  112.             <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
    113. 

  113.             <ul class="nav-group-tasks">
    114. 

  114.               <li class="nav-group-task">
    115. 

  115.                 <a class="nav-group-task-link" href="Enums/AFError.html">AFError</a>
    116. 

  116.               </li>
    117. 

  117.               <li class="nav-group-task">
    118. 

  118.                 <a class="nav-group-task-link" href="Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
    119. 

  119.               </li>
    120. 

  120.               <li class="nav-group-task">
    121. 

  121.                 <a class="nav-group-task-link" href="Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
    122. 

  122.               </li>
    123. 

  123.               <li class="nav-group-task">
    124. 

  124.                 <a class="nav-group-task-link" href="Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
    125. 

  125.               </li>
    126. 

  126.               <li class="nav-group-task">
    127. 

  127.                 <a class="nav-group-task-link" href="Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
    128. 

  128.               </li>
    129. 

  129.               <li class="nav-group-task">
    130. 

  130.                 <a class="nav-group-task-link" href="Enums/HTTPMethod.html">HTTPMethod</a>
    131. 

  131.               </li>
    132. 

  132.               <li class="nav-group-task">
    133. 

  133.                 <a class="nav-group-task-link" href="Enums/Result.html">Result</a>
    134. 

  134.               </li>
    135. 

  135.               <li class="nav-group-task">
    136. 

  136.                 <a class="nav-group-task-link" href="Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
    137. 

  137.               </li>
    138. 

  138.             </ul>
    139. 

  139.           </li>
    140. 

  140.           <li class="nav-group-name">
    141. 

  141.             <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
    142. 

  142.             <ul class="nav-group-tasks">
    143. 

  143.               <li class="nav-group-task">
    144. 

  144.                 <a class="nav-group-task-link" href="Extensions/Notification.html">Notification</a>
    145. 

  145.               </li>
    146. 

  146.               <li class="nav-group-task">
    147. 

  147.                 <a class="nav-group-task-link" href="Extensions/Notification/Name.html">– Name</a>
    148. 

  148.               </li>
    149. 

  149.               <li class="nav-group-task">
    150. 

  150.                 <a class="nav-group-task-link" href="Extensions/Notification/Key.html">– Key</a>
    151. 

  151.               </li>
    152. 

  152.               <li class="nav-group-task">
    153. 

  153.                 <a class="nav-group-task-link" href="Extensions/String.html">String</a>
    154. 

  154.               </li>
    155. 

  155.               <li class="nav-group-task">
    156. 

  156.                 <a class="nav-group-task-link" href="Extensions/URL.html">URL</a>
    157. 

  157.               </li>
    158. 

  158.               <li class="nav-group-task">
    159. 

  159.                 <a class="nav-group-task-link" href="Extensions/URLComponents.html">URLComponents</a>
    160. 

  160.               </li>
    161. 

  161.               <li class="nav-group-task">
    162. 

  162.                 <a class="nav-group-task-link" href="Extensions/URLRequest.html">URLRequest</a>
    163. 

  163.               </li>
    164. 

  164.             </ul>
    165. 

  165.           </li>
    166. 

  166.           <li class="nav-group-name">
    167. 

  167.             <a class="nav-group-name-link" href="Functions.html">Functions</a>
    168. 

  168.             <ul class="nav-group-tasks">
    169. 

  169.               <li class="nav-group-task">
    170. 

  170.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
    171. 

  171.               </li>
    172. 

  172.               <li class="nav-group-task">
    173. 

  173.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
    174. 

  174.               </li>
    175. 

  175.               <li class="nav-group-task">
    176. 

  176.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
    177. 

  177.               </li>
    178. 

  178.               <li class="nav-group-task">
    179. 

  179.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
    180. 

  180.               </li>
    181. 

  181.               <li class="nav-group-task">
    182. 

  182.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
    183. 

  183.               </li>
    184. 

  184.               <li class="nav-group-task">
    185. 

  185.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
    186. 

  186.               </li>
    187. 

  187.               <li class="nav-group-task">
    188. 

  188.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
    189. 

  189.               </li>
    190. 

  190.               <li class="nav-group-task">
    191. 

  191.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
    192. 

  192.               </li>
    193. 

  193.               <li class="nav-group-task">
    194. 

  194.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
    195. 

  195.               </li>
    196. 

  196.               <li class="nav-group-task">
    197. 

  197.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
    198. 

  198.               </li>
    199. 

  199.               <li class="nav-group-task">
    200. 

  200.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
    201. 

  201.               </li>
    202. 

  202.               <li class="nav-group-task">
    203. 

  203.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
    204. 

  204.               </li>
    205. 

  205.               <li class="nav-group-task">
    206. 

  206.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
    207. 

  207.               </li>
    208. 

  208.               <li class="nav-group-task">
    209. 

  209.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
    210. 

  210.               </li>
    211. 

  211.               <li class="nav-group-task">
    212. 

  212.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
    213. 

  213.               </li>
    214. 

  214.               <li class="nav-group-task">
    215. 

  215.                 <a class="nav-group-task-link" href="Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
    216. 

  216.               </li>
    217. 

  217.             </ul>
    218. 

  218.           </li>
    219. 

  219.           <li class="nav-group-name">
    220. 

  220.             <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
    221. 

  221.             <ul class="nav-group-tasks">
    222. 

  222.               <li class="nav-group-task">
    223. 

  223.                 <a class="nav-group-task-link" href="Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
    224. 

  224.               </li>
    225. 

  225.               <li class="nav-group-task">
    226. 

  226.                 <a class="nav-group-task-link" href="Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
    227. 

  227.               </li>
    228. 

  228.               <li class="nav-group-task">
    229. 

  229.                 <a class="nav-group-task-link" href="Protocols/ParameterEncoding.html">ParameterEncoding</a>
    230. 

  230.               </li>
    231. 

  231.               <li class="nav-group-task">
    232. 

  232.                 <a class="nav-group-task-link" href="Protocols/RequestAdapter.html">RequestAdapter</a>
    233. 

  233.               </li>
    234. 

  234.               <li class="nav-group-task">
    235. 

  235.                 <a class="nav-group-task-link" href="Protocols/RequestRetrier.html">RequestRetrier</a>
    236. 

  236.               </li>
    237. 

  237.               <li class="nav-group-task">
    238. 

  238.                 <a class="nav-group-task-link" href="Protocols/URLConvertible.html">URLConvertible</a>
    239. 

  239.               </li>
    240. 

  240.               <li class="nav-group-task">
    241. 

  241.                 <a class="nav-group-task-link" href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
    242. 

  242.               </li>
    243. 

  243.             </ul>
    244. 

  244.           </li>
    245. 

  245.           <li class="nav-group-name">
    246. 

  246.             <a class="nav-group-name-link" href="Structs.html">Structures</a>
    247. 

  247.             <ul class="nav-group-tasks">
    248. 

  248.               <li class="nav-group-task">
    249. 

  249.                 <a class="nav-group-task-link" href="Structs/DataResponse.html">DataResponse</a>
    250. 

  250.               </li>
    251. 

  251.               <li class="nav-group-task">
    252. 

  252.                 <a class="nav-group-task-link" href="Structs/DataResponseSerializer.html">DataResponseSerializer</a>
    253. 

  253.               </li>
    254. 

  254.               <li class="nav-group-task">
    255. 

  255.                 <a class="nav-group-task-link" href="Structs/DefaultDataResponse.html">DefaultDataResponse</a>
    256. 

  256.               </li>
    257. 

  257.               <li class="nav-group-task">
    258. 

  258.                 <a class="nav-group-task-link" href="Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
    259. 

  259.               </li>
    260. 

  260.               <li class="nav-group-task">
    261. 

  261.                 <a class="nav-group-task-link" href="Structs/DownloadResponse.html">DownloadResponse</a>
    262. 

  262.               </li>
    263. 

  263.               <li class="nav-group-task">
    264. 

  264.                 <a class="nav-group-task-link" href="Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
    265. 

  265.               </li>
    266. 

  266.               <li class="nav-group-task">
    267. 

  267.                 <a class="nav-group-task-link" href="Structs/JSONEncoding.html">JSONEncoding</a>
    268. 

  268.               </li>
    269. 

  269.               <li class="nav-group-task">
    270. 

  270.                 <a class="nav-group-task-link" href="Structs/PropertyListEncoding.html">PropertyListEncoding</a>
    271. 

  271.               </li>
    272. 

  272.               <li class="nav-group-task">
    273. 

  273.                 <a class="nav-group-task-link" href="Structs/Timeline.html">Timeline</a>
    274. 

  274.               </li>
    275. 

  275.               <li class="nav-group-task">
    276. 

  276.                 <a class="nav-group-task-link" href="Structs/URLEncoding.html">URLEncoding</a>
    277. 

  277.               </li>
    278. 

  278.               <li class="nav-group-task">
    279. 

  279.                 <a class="nav-group-task-link" href="Structs/URLEncoding/Destination.html">– Destination</a>
    280. 

  280.               </li>
    281. 

  281.               <li class="nav-group-task">
    282. 

  282.                 <a class="nav-group-task-link" href="Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
    283. 

  283.               </li>
    284. 

  284.               <li class="nav-group-task">
    285. 

  285.                 <a class="nav-group-task-link" href="Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
    286. 

  286.               </li>
    287. 

  287.             </ul>
    288. 

  288.           </li>
    289. 

  289.           <li class="nav-group-name">
    290. 

  290.             <a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
    291. 

  291.             <ul class="nav-group-tasks">
    292. 

  292.               <li class="nav-group-task">
    293. 

  293.                 <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
    294. 

  294.               </li>
    295. 

  295.               <li class="nav-group-task">
    296. 

  296.                 <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
    297. 

  297.               </li>
    298. 

  298.               <li class="nav-group-task">
    299. 

  299.                 <a class="nav-group-task-link" href="Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
    300. 

  300.               </li>
    301. 

  301.             </ul>
    302. 

  302.           </li>
    303. 

  303.         </ul>
    304. 

  304.       </nav>
    305. 

  305.       <article class="main-content">
    306. 

  306. 

  307.         <section class="section">
    308. 

  308.           <div class="section-content">
    309. 

  309.             <h1>Functions</h1>
    310. 

  310.             <p>The following functions are available globally.</p>
    311. 

  311. 

  312.           </div>
    313. 

  313.         </section>
    314. 

  314. 

  315.         <section class="section">
    316. 

  316.           <div class="section-content">
    317. 

  317.             <div class="task-group">
    318. 

  318.               <div class="task-name-container">
    319. 

  319.                 <a name="/Data%20Request"></a>
    320. 

  320.                 <a name="//apple_ref/swift/Section/Data Request" class="dashAnchor"></a>
    321. 

  321.                 <a href="#/Data%20Request">
    322. 

  322.                   <h3 class="section-name">Data Request</h3>
    323. 

  323.                 </a>
    324. 

  324.               </div>
    325. 

  325.               <ul class="item-container">
    326. 

  326.                 <li class="item">
    327. 

  327.                   <div>
    328. 

  328.                     <code>
    329. 

  329.                     <a name="/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF"></a>
    330. 

  330.                     <a name="//apple_ref/swift/Function/request(_:method:parameters:encoding:headers:)" class="dashAnchor"></a>
    331. 

  331.                     <a class="token" href="#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
    332. 

  332.                     </code>
    333. 

  333.                   </div>
    334. 

  334.                   <div class="height-container">
    335. 

  335.                     <div class="pointer-container"></div>
    336. 

  336.                     <section class="section">
    337. 

  337.                       <div class="pointer"></div>
    338. 

  338.                       <div class="abstract">
    339. 

  339.                         <p>Creates a <code><a href="Classes/DataRequest.html">DataRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> to retrieve the contents of the specified <code>url</code>,
    340. 

  340. <code>method</code>, <code>parameters</code>, <code>encoding</code> and <code>headers</code>.</p>
    341. 

  341. 

  342.                       </div>
    343. 

  343.                       <div class="declaration">
    344. 

  344.                         <h4>Declaration</h4>
    345. 

  345.                         <div class="language">
    346. 

  346.                           <p class="aside-title">Swift</p>
    347. 

  347.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span>
    348. 

  348.     <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>
    349. 

  349.     <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>
    350. 

  350.     <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>
    351. 

  351.     <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>
    352. 

  352.     <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    353. 

  353.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/DataRequest.html">DataRequest</a></span></code></pre>
    354. 

  354. 

  355.                         </div>
    356. 

  356.                       </div>
    357. 

  357.                       <div>
    358. 

  358.                         <h4>Parameters</h4>
    359. 

  359.                         <table class="graybox">
    360. 

  360.                           <tbody>
    361. 

  361.                             <tr>
    362. 

  362.                               <td>
    363. 

  363.                                 <code>
    364. 

  364.                                 <em>url</em>
    365. 

  365.                                 </code>
    366. 

  366.                               </td>
    367. 

  367.                               <td>
    368. 

  368.                                 <div>
    369. 

  369.                                   <p>The URL.</p>
    370. 

  370.                                 </div>
    371. 

  371.                               </td>
    372. 

  372.                             </tr>
    373. 

  373.                             <tr>
    374. 

  374.                               <td>
    375. 

  375.                                 <code>
    376. 

  376.                                 <em>method</em>
    377. 

  377.                                 </code>
    378. 

  378.                               </td>
    379. 

  379.                               <td>
    380. 

  380.                                 <div>
    381. 

  381.                                   <p>The HTTP method. <code>.get</code> by default.</p>
    382. 

  382.                                 </div>
    383. 

  383.                               </td>
    384. 

  384.                             </tr>
    385. 

  385.                             <tr>
    386. 

  386.                               <td>
    387. 

  387.                                 <code>
    388. 

  388.                                 <em>parameters</em>
    389. 

  389.                                 </code>
    390. 

  390.                               </td>
    391. 

  391.                               <td>
    392. 

  392.                                 <div>
    393. 

  393.                                   <p>The parameters. <code>nil</code> by default.</p>
    394. 

  394.                                 </div>
    395. 

  395.                               </td>
    396. 

  396.                             </tr>
    397. 

  397.                             <tr>
    398. 

  398.                               <td>
    399. 

  399.                                 <code>
    400. 

  400.                                 <em>encoding</em>
    401. 

  401.                                 </code>
    402. 

  402.                               </td>
    403. 

  403.                               <td>
    404. 

  404.                                 <div>
    405. 

  405.                                   <p>The parameter encoding. <code><a href="Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
    406. 

  406.                                 </div>
    407. 

  407.                               </td>
    408. 

  408.                             </tr>
    409. 

  409.                             <tr>
    410. 

  410.                               <td>
    411. 

  411.                                 <code>
    412. 

  412.                                 <em>headers</em>
    413. 

  413.                                 </code>
    414. 

  414.                               </td>
    415. 

  415.                               <td>
    416. 

  416.                                 <div>
    417. 

  417.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    418. 

  418.                                 </div>
    419. 

  419.                               </td>
    420. 

  420.                             </tr>
    421. 

  421.                           </tbody>
    422. 

  422.                         </table>
    423. 

  423.                       </div>
    424. 

  424.                       <div>
    425. 

  425.                         <h4>Return Value</h4>
    426. 

  426.                         <p>The created <code><a href="Classes/DataRequest.html">DataRequest</a></code>.</p>
    427. 

  427.                       </div>
    428. 

  428.                     </section>
    429. 

  429.                   </div>
    430. 

  430.                 </li>
    431. 

  431.                 <li class="item">
    432. 

  432.                   <div>
    433. 

  433.                     <code>
    434. 

  434.                     <a name="/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF"></a>
    435. 

  435.                     <a name="//apple_ref/swift/Function/request(_:)" class="dashAnchor"></a>
    436. 

  436.                     <a class="token" href="#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
    437. 

  437.                     </code>
    438. 

  438.                   </div>
    439. 

  439.                   <div class="height-container">
    440. 

  440.                     <div class="pointer-container"></div>
    441. 

  441.                     <section class="section">
    442. 

  442.                       <div class="pointer"></div>
    443. 

  443.                       <div class="abstract">
    444. 

  444.                         <p>Creates a <code><a href="Classes/DataRequest.html">DataRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> to retrieve the contents of a URL based on the
    445. 

  445. specified <code>urlRequest</code>.</p>
    446. 

  446. 

  447.                       </div>
    448. 

  448.                       <div class="declaration">
    449. 

  449.                         <h4>Declaration</h4>
    450. 

  450.                         <div class="language">
    451. 

  451.                           <p class="aside-title">Swift</p>
    452. 

  452.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="Classes/DataRequest.html">DataRequest</a></span></code></pre>
    453. 

  453. 

  454.                         </div>
    455. 

  455.                       </div>
    456. 

  456.                       <div>
    457. 

  457.                         <h4>Parameters</h4>
    458. 

  458.                         <table class="graybox">
    459. 

  459.                           <tbody>
    460. 

  460.                             <tr>
    461. 

  461.                               <td>
    462. 

  462.                                 <code>
    463. 

  463.                                 <em>urlRequest</em>
    464. 

  464.                                 </code>
    465. 

  465.                               </td>
    466. 

  466.                               <td>
    467. 

  467.                                 <div>
    468. 

  468.                                   <p>The URL request</p>
    469. 

  469.                                 </div>
    470. 

  470.                               </td>
    471. 

  471.                             </tr>
    472. 

  472.                           </tbody>
    473. 

  473.                         </table>
    474. 

  474.                       </div>
    475. 

  475.                       <div>
    476. 

  476.                         <h4>Return Value</h4>
    477. 

  477.                         <p>The created <code><a href="Classes/DataRequest.html">DataRequest</a></code>.</p>
    478. 

  478.                       </div>
    479. 

  479.                     </section>
    480. 

  480.                   </div>
    481. 

  481.                 </li>
    482. 

  482.               </ul>
    483. 

  483.             </div>
    484. 

  484.             <div class="task-group">
    485. 

  485.               <div class="task-name-container">
    486. 

  486.                 <a name="/URL%20Request"></a>
    487. 

  487.                 <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a>
    488. 

  488.                 <a href="#/URL%20Request">
    489. 

  489.                   <h3 class="section-name">URL Request</h3>
    490. 

  490.                 </a>
    491. 

  491.               </div>
    492. 

  492.               <ul class="item-container">
    493. 

  493.                 <li class="item">
    494. 

  494.                   <div>
    495. 

  495.                     <code>
    496. 

  496.                     <a name="/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF"></a>
    497. 

  497.                     <a name="//apple_ref/swift/Function/download(_:method:parameters:encoding:headers:to:)" class="dashAnchor"></a>
    498. 

  498.                     <a class="token" href="#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
    499. 

  499.                     </code>
    500. 

  500.                   </div>
    501. 

  501.                   <div class="height-container">
    502. 

  502.                     <div class="pointer-container"></div>
    503. 

  503.                     <section class="section">
    504. 

  504.                       <div class="pointer"></div>
    505. 

  505.                       <div class="abstract">
    506. 

  506.                         <p>Creates a <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> to retrieve the contents of the specified <code>url</code>,
    507. 

  507. <code>method</code>, <code>parameters</code>, <code>encoding</code>, <code>headers</code> and save them to the <code>destination</code>.</p>
    508. 

  508. 

  509. <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
    510. 

  510. underlying URL session.</p>
    511. 

  511. 

  512.                       </div>
    513. 

  513.                       <div class="declaration">
    514. 

  514.                         <h4>Declaration</h4>
    515. 

  515.                         <div class="language">
    516. 

  516.                           <p class="aside-title">Swift</p>
    517. 

  517.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
    518. 

  518.     <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>
    519. 

  519.     <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>
    520. 

  520.     <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>
    521. 

  521.     <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>
    522. 

  522.     <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    523. 

  523.     <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    524. 

  524.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    525. 

  525. 

  526.                         </div>
    527. 

  527.                       </div>
    528. 

  528.                       <div>
    529. 

  529.                         <h4>Parameters</h4>
    530. 

  530.                         <table class="graybox">
    531. 

  531.                           <tbody>
    532. 

  532.                             <tr>
    533. 

  533.                               <td>
    534. 

  534.                                 <code>
    535. 

  535.                                 <em>url</em>
    536. 

  536.                                 </code>
    537. 

  537.                               </td>
    538. 

  538.                               <td>
    539. 

  539.                                 <div>
    540. 

  540.                                   <p>The URL.</p>
    541. 

  541.                                 </div>
    542. 

  542.                               </td>
    543. 

  543.                             </tr>
    544. 

  544.                             <tr>
    545. 

  545.                               <td>
    546. 

  546.                                 <code>
    547. 

  547.                                 <em>method</em>
    548. 

  548.                                 </code>
    549. 

  549.                               </td>
    550. 

  550.                               <td>
    551. 

  551.                                 <div>
    552. 

  552.                                   <p>The HTTP method. <code>.get</code> by default.</p>
    553. 

  553.                                 </div>
    554. 

  554.                               </td>
    555. 

  555.                             </tr>
    556. 

  556.                             <tr>
    557. 

  557.                               <td>
    558. 

  558.                                 <code>
    559. 

  559.                                 <em>parameters</em>
    560. 

  560.                                 </code>
    561. 

  561.                               </td>
    562. 

  562.                               <td>
    563. 

  563.                                 <div>
    564. 

  564.                                   <p>The parameters. <code>nil</code> by default.</p>
    565. 

  565.                                 </div>
    566. 

  566.                               </td>
    567. 

  567.                             </tr>
    568. 

  568.                             <tr>
    569. 

  569.                               <td>
    570. 

  570.                                 <code>
    571. 

  571.                                 <em>encoding</em>
    572. 

  572.                                 </code>
    573. 

  573.                               </td>
    574. 

  574.                               <td>
    575. 

  575.                                 <div>
    576. 

  576.                                   <p>The parameter encoding. <code><a href="Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
    577. 

  577.                                 </div>
    578. 

  578.                               </td>
    579. 

  579.                             </tr>
    580. 

  580.                             <tr>
    581. 

  581.                               <td>
    582. 

  582.                                 <code>
    583. 

  583.                                 <em>headers</em>
    584. 

  584.                                 </code>
    585. 

  585.                               </td>
    586. 

  586.                               <td>
    587. 

  587.                                 <div>
    588. 

  588.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    589. 

  589.                                 </div>
    590. 

  590.                               </td>
    591. 

  591.                             </tr>
    592. 

  592.                             <tr>
    593. 

  593.                               <td>
    594. 

  594.                                 <code>
    595. 

  595.                                 <em>destination</em>
    596. 

  596.                                 </code>
    597. 

  597.                               </td>
    598. 

  598.                               <td>
    599. 

  599.                                 <div>
    600. 

  600.                                   <p>The closure used to determine the destination of the downloaded file. <code>nil</code> by default.</p>
    601. 

  601.                                 </div>
    602. 

  602.                               </td>
    603. 

  603.                             </tr>
    604. 

  604.                           </tbody>
    605. 

  605.                         </table>
    606. 

  606.                       </div>
    607. 

  607.                       <div>
    608. 

  608.                         <h4>Return Value</h4>
    609. 

  609.                         <p>The created <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    610. 

  610.                       </div>
    611. 

  611.                     </section>
    612. 

  612.                   </div>
    613. 

  613.                 </li>
    614. 

  614.                 <li class="item">
    615. 

  615.                   <div>
    616. 

  616.                     <code>
    617. 

  617.                     <a name="/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF"></a>
    618. 

  618.                     <a name="//apple_ref/swift/Function/download(_:to:)" class="dashAnchor"></a>
    619. 

  619.                     <a class="token" href="#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
    620. 

  620.                     </code>
    621. 

  621.                   </div>
    622. 

  622.                   <div class="height-container">
    623. 

  623.                     <div class="pointer-container"></div>
    624. 

  624.                     <section class="section">
    625. 

  625.                       <div class="pointer"></div>
    626. 

  626.                       <div class="abstract">
    627. 

  627.                         <p>Creates a <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> to retrieve the contents of a URL based on the
    628. 

  628. specified <code>urlRequest</code> and save them to the <code>destination</code>.</p>
    629. 

  629. 

  630. <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
    631. 

  631. underlying URL session.</p>
    632. 

  632. 

  633.                       </div>
    634. 

  634.                       <div class="declaration">
    635. 

  635.                         <h4>Declaration</h4>
    636. 

  636.                         <div class="language">
    637. 

  637.                           <p class="aside-title">Swift</p>
    638. 

  638.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
    639. 

  639.     <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>
    640. 

  640.     <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    641. 

  641.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    642. 

  642. 

  643.                         </div>
    644. 

  644.                       </div>
    645. 

  645.                       <div>
    646. 

  646.                         <h4>Parameters</h4>
    647. 

  647.                         <table class="graybox">
    648. 

  648.                           <tbody>
    649. 

  649.                             <tr>
    650. 

  650.                               <td>
    651. 

  651.                                 <code>
    652. 

  652.                                 <em>urlRequest</em>
    653. 

  653.                                 </code>
    654. 

  654.                               </td>
    655. 

  655.                               <td>
    656. 

  656.                                 <div>
    657. 

  657.                                   <p>The URL request.</p>
    658. 

  658.                                 </div>
    659. 

  659.                               </td>
    660. 

  660.                             </tr>
    661. 

  661.                             <tr>
    662. 

  662.                               <td>
    663. 

  663.                                 <code>
    664. 

  664.                                 <em>destination</em>
    665. 

  665.                                 </code>
    666. 

  666.                               </td>
    667. 

  667.                               <td>
    668. 

  668.                                 <div>
    669. 

  669.                                   <p>The closure used to determine the destination of the downloaded file. <code>nil</code> by default.</p>
    670. 

  670.                                 </div>
    671. 

  671.                               </td>
    672. 

  672.                             </tr>
    673. 

  673.                           </tbody>
    674. 

  674.                         </table>
    675. 

  675.                       </div>
    676. 

  676.                       <div>
    677. 

  677.                         <h4>Return Value</h4>
    678. 

  678.                         <p>The created <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    679. 

  679.                       </div>
    680. 

  680.                     </section>
    681. 

  681.                   </div>
    682. 

  682.                 </li>
    683. 

  683.               </ul>
    684. 

  684.             </div>
    685. 

  685.             <div class="task-group">
    686. 

  686.               <div class="task-name-container">
    687. 

  687.                 <a name="/Resume%20Data"></a>
    688. 

  688.                 <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
    689. 

  689.                 <a href="#/Resume%20Data">
    690. 

  690.                   <h3 class="section-name">Resume Data</h3>
    691. 

  691.                 </a>
    692. 

  692.               </div>
    693. 

  693.               <ul class="item-container">
    694. 

  694.                 <li class="item">
    695. 

  695.                   <div>
    696. 

  696.                     <code>
    697. 

  697.                     <a name="/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF"></a>
    698. 

  698.                     <a name="//apple_ref/swift/Function/download(resumingWith:to:)" class="dashAnchor"></a>
    699. 

  699.                     <a class="token" href="#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
    700. 

  700.                     </code>
    701. 

  701.                   </div>
    702. 

  702.                   <div class="height-container">
    703. 

  703.                     <div class="pointer-container"></div>
    704. 

  704.                     <section class="section">
    705. 

  705.                       <div class="pointer"></div>
    706. 

  706.                       <div class="abstract">
    707. 

  707.                         <p>Creates a <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the <code>resumeData</code> produced from a
    708. 

  708. previous request cancellation to retrieve the contents of the original request and save them to the <code>destination</code>.</p>
    709. 

  709. 

  710. <p>If <code>destination</code> is not specified, the contents will remain in the temporary location determined by the
    711. 

  711. underlying URL session.</p>
    712. 

  712. 

  713. <p>On the latest release of all the Apple platforms (iOS 10, macOS 10.12, tvOS 10, watchOS 3), <code>resumeData</code> is broken
    714. 

  714. on background URL session configurations. There&rsquo;s an underlying bug in the <code>resumeData</code> generation logic where the
    715. 

  715. data is written incorrectly and will always fail to resume the download. For more information about the bug and
    716. 

  716. possible workarounds, please refer to the following Stack Overflow post:</p>
    717. 

  717. 

  718. <ul>
    719. 

  719. <li><p><a href="http://stackoverflow.com/a/39347461/1342462">http://stackoverflow.com/a/39347461/1342462</a></p></li>
    720. 

  720. </ul>
    721. 

  721. 

  722.                       </div>
    723. 

  723.                       <div class="declaration">
    724. 

  724.                         <h4>Declaration</h4>
    725. 

  725.                         <div class="language">
    726. 

  726.                           <p class="aside-title">Swift</p>
    727. 

  727.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
    728. 

  728.     <span class="n">resumingWith</span> <span class="nv">resumeData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    729. 

  729.     <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    730. 

  730.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    731. 

  731. 

  732.                         </div>
    733. 

  733.                       </div>
    734. 

  734.                       <div>
    735. 

  735.                         <h4>Parameters</h4>
    736. 

  736.                         <table class="graybox">
    737. 

  737.                           <tbody>
    738. 

  738.                             <tr>
    739. 

  739.                               <td>
    740. 

  740.                                 <code>
    741. 

  741.                                 <em>resumeData</em>
    742. 

  742.                                 </code>
    743. 

  743.                               </td>
    744. 

  744.                               <td>
    745. 

  745.                                 <div>
    746. 

  746.                                   <p>The resume data. This is an opaque data blob produced by <code>URLSessionDownloadTask</code>
    747. 

  747.                  when a task is cancelled. See <code>URLSession -downloadTask(withResumeData:)</code> for additional
    748. 

  748.                  information.</p>
    749. 

  749.                                 </div>
    750. 

  750.                               </td>
    751. 

  751.                             </tr>
    752. 

  752.                             <tr>
    753. 

  753.                               <td>
    754. 

  754.                                 <code>
    755. 

  755.                                 <em>destination</em>
    756. 

  756.                                 </code>
    757. 

  757.                               </td>
    758. 

  758.                               <td>
    759. 

  759.                                 <div>
    760. 

  760.                                   <p>The closure used to determine the destination of the downloaded file. <code>nil</code> by default.</p>
    761. 

  761.                                 </div>
    762. 

  762.                               </td>
    763. 

  763.                             </tr>
    764. 

  764.                           </tbody>
    765. 

  765.                         </table>
    766. 

  766.                       </div>
    767. 

  767.                       <div>
    768. 

  768.                         <h4>Return Value</h4>
    769. 

  769.                         <p>The created <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    770. 

  770.                       </div>
    771. 

  771.                     </section>
    772. 

  772.                   </div>
    773. 

  773.                 </li>
    774. 

  774.               </ul>
    775. 

  775.             </div>
    776. 

  776.             <div class="task-group">
    777. 

  777.               <div class="task-name-container">
    778. 

  778.                 <a name="/File"></a>
    779. 

  779.                 <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
    780. 

  780.                 <a href="#/File">
    781. 

  781.                   <h3 class="section-name">File</h3>
    782. 

  782.                 </a>
    783. 

  783.               </div>
    784. 

  784.               <ul class="item-container">
    785. 

  785.                 <li class="item">
    786. 

  786.                   <div>
    787. 

  787.                     <code>
    788. 

  788.                     <a name="/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF"></a>
    789. 

  789.                     <a name="//apple_ref/swift/Function/upload(_:to:method:headers:)" class="dashAnchor"></a>
    790. 

  790.                     <a class="token" href="#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
    791. 

  791.                     </code>
    792. 

  792.                   </div>
    793. 

  793.                   <div class="height-container">
    794. 

  794.                     <div class="pointer-container"></div>
    795. 

  795.                     <section class="section">
    796. 

  796.                       <div class="pointer"></div>
    797. 

  797.                       <div class="abstract">
    798. 

  798.                         <p>Creates an <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the specified <code>url</code>, <code>method</code> and <code>headers</code>
    799. 

  799. for uploading the <code>file</code>.</p>
    800. 

  800. 

  801.                       </div>
    802. 

  802.                       <div class="declaration">
    803. 

  803.                         <h4>Declaration</h4>
    804. 

  804.                         <div class="language">
    805. 

  805.                           <p class="aside-title">Swift</p>
    806. 

  806.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    807. 

  807.     <span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
    808. 

  808.     <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>
    809. 

  809.     <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>
    810. 

  810.     <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    811. 

  811.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    812. 

  812. 

  813.                         </div>
    814. 

  814.                       </div>
    815. 

  815.                       <div>
    816. 

  816.                         <h4>Parameters</h4>
    817. 

  817.                         <table class="graybox">
    818. 

  818.                           <tbody>
    819. 

  819.                             <tr>
    820. 

  820.                               <td>
    821. 

  821.                                 <code>
    822. 

  822.                                 <em>file</em>
    823. 

  823.                                 </code>
    824. 

  824.                               </td>
    825. 

  825.                               <td>
    826. 

  826.                                 <div>
    827. 

  827.                                   <p>The file to upload.</p>
    828. 

  828.                                 </div>
    829. 

  829.                               </td>
    830. 

  830.                             </tr>
    831. 

  831.                             <tr>
    832. 

  832.                               <td>
    833. 

  833.                                 <code>
    834. 

  834.                                 <em>url</em>
    835. 

  835.                                 </code>
    836. 

  836.                               </td>
    837. 

  837.                               <td>
    838. 

  838.                                 <div>
    839. 

  839.                                   <p>The URL.</p>
    840. 

  840.                                 </div>
    841. 

  841.                               </td>
    842. 

  842.                             </tr>
    843. 

  843.                             <tr>
    844. 

  844.                               <td>
    845. 

  845.                                 <code>
    846. 

  846.                                 <em>method</em>
    847. 

  847.                                 </code>
    848. 

  848.                               </td>
    849. 

  849.                               <td>
    850. 

  850.                                 <div>
    851. 

  851.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    852. 

  852.                                 </div>
    853. 

  853.                               </td>
    854. 

  854.                             </tr>
    855. 

  855.                             <tr>
    856. 

  856.                               <td>
    857. 

  857.                                 <code>
    858. 

  858.                                 <em>headers</em>
    859. 

  859.                                 </code>
    860. 

  860.                               </td>
    861. 

  861.                               <td>
    862. 

  862.                                 <div>
    863. 

  863.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    864. 

  864.                                 </div>
    865. 

  865.                               </td>
    866. 

  866.                             </tr>
    867. 

  867.                           </tbody>
    868. 

  868.                         </table>
    869. 

  869.                       </div>
    870. 

  870.                       <div>
    871. 

  871.                         <h4>Return Value</h4>
    872. 

  872.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    873. 

  873.                       </div>
    874. 

  874.                     </section>
    875. 

  875.                   </div>
    876. 

  876.                 </li>
    877. 

  877.                 <li class="item">
    878. 

  878.                   <div>
    879. 

  879.                     <code>
    880. 

  880.                     <a name="/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF"></a>
    881. 

  881.                     <a name="//apple_ref/swift/Function/upload(_:with:)" class="dashAnchor"></a>
    882. 

  882.                     <a class="token" href="#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
    883. 

  883.                     </code>
    884. 

  884.                   </div>
    885. 

  885.                   <div class="height-container">
    886. 

  886.                     <div class="pointer-container"></div>
    887. 

  887.                     <section class="section">
    888. 

  888.                       <div class="pointer"></div>
    889. 

  889.                       <div class="abstract">
    890. 

  890.                         <p>Creates a <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the specified <code>urlRequest</code> for
    891. 

  891. uploading the <code>file</code>.</p>
    892. 

  892. 

  893.                       </div>
    894. 

  894.                       <div class="declaration">
    895. 

  895.                         <h4>Declaration</h4>
    896. 

  896.                         <div class="language">
    897. 

  897.                           <p class="aside-title">Swift</p>
    898. 

  898.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    899. 

  899. 

  900.                         </div>
    901. 

  901.                       </div>
    902. 

  902.                       <div>
    903. 

  903.                         <h4>Parameters</h4>
    904. 

  904.                         <table class="graybox">
    905. 

  905.                           <tbody>
    906. 

  906.                             <tr>
    907. 

  907.                               <td>
    908. 

  908.                                 <code>
    909. 

  909.                                 <em>file</em>
    910. 

  910.                                 </code>
    911. 

  911.                               </td>
    912. 

  912.                               <td>
    913. 

  913.                                 <div>
    914. 

  914.                                   <p>The file to upload.</p>
    915. 

  915.                                 </div>
    916. 

  916.                               </td>
    917. 

  917.                             </tr>
    918. 

  918.                             <tr>
    919. 

  919.                               <td>
    920. 

  920.                                 <code>
    921. 

  921.                                 <em>urlRequest</em>
    922. 

  922.                                 </code>
    923. 

  923.                               </td>
    924. 

  924.                               <td>
    925. 

  925.                                 <div>
    926. 

  926.                                   <p>The URL request.</p>
    927. 

  927.                                 </div>
    928. 

  928.                               </td>
    929. 

  929.                             </tr>
    930. 

  930.                           </tbody>
    931. 

  931.                         </table>
    932. 

  932.                       </div>
    933. 

  933.                       <div>
    934. 

  934.                         <h4>Return Value</h4>
    935. 

  935.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    936. 

  936.                       </div>
    937. 

  937.                     </section>
    938. 

  938.                   </div>
    939. 

  939.                 </li>
    940. 

  940.               </ul>
    941. 

  941.             </div>
    942. 

  942.             <div class="task-group">
    943. 

  943.               <div class="task-name-container">
    944. 

  944.                 <a name="/Data"></a>
    945. 

  945.                 <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
    946. 

  946.                 <a href="#/Data">
    947. 

  947.                   <h3 class="section-name">Data</h3>
    948. 

  948.                 </a>
    949. 

  949.               </div>
    950. 

  950.               <ul class="item-container">
    951. 

  951.                 <li class="item">
    952. 

  952.                   <div>
    953. 

  953.                     <code>
    954. 

  954.                     <a name="/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF"></a>
    955. 

  955.                     <a name="//apple_ref/swift/Function/upload(_:to:method:headers:)" class="dashAnchor"></a>
    956. 

  956.                     <a class="token" href="#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
    957. 

  957.                     </code>
    958. 

  958.                   </div>
    959. 

  959.                   <div class="height-container">
    960. 

  960.                     <div class="pointer-container"></div>
    961. 

  961.                     <section class="section">
    962. 

  962.                       <div class="pointer"></div>
    963. 

  963.                       <div class="abstract">
    964. 

  964.                         <p>Creates an <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the specified <code>url</code>, <code>method</code> and <code>headers</code>
    965. 

  965. for uploading the <code>data</code>.</p>
    966. 

  966. 

  967.                       </div>
    968. 

  968.                       <div class="declaration">
    969. 

  969.                         <h4>Declaration</h4>
    970. 

  970.                         <div class="language">
    971. 

  971.                           <p class="aside-title">Swift</p>
    972. 

  972.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    973. 

  973.     <span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    974. 

  974.     <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>
    975. 

  975.     <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>
    976. 

  976.     <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    977. 

  977.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    978. 

  978. 

  979.                         </div>
    980. 

  980.                       </div>
    981. 

  981.                       <div>
    982. 

  982.                         <h4>Parameters</h4>
    983. 

  983.                         <table class="graybox">
    984. 

  984.                           <tbody>
    985. 

  985.                             <tr>
    986. 

  986.                               <td>
    987. 

  987.                                 <code>
    988. 

  988.                                 <em>data</em>
    989. 

  989.                                 </code>
    990. 

  990.                               </td>
    991. 

  991.                               <td>
    992. 

  992.                                 <div>
    993. 

  993.                                   <p>The data to upload.</p>
    994. 

  994.                                 </div>
    995. 

  995.                               </td>
    996. 

  996.                             </tr>
    997. 

  997.                             <tr>
    998. 

  998.                               <td>
    999. 

  999.                                 <code>
    1000. 

  1000.                                 <em>url</em>
    1001. 

  1001.                                 </code>
    1002. 

  1002.                               </td>
    1003. 

  1003.                               <td>
    1004. 

  1004.                                 <div>
    1005. 

  1005.                                   <p>The URL.</p>
    1006. 

  1006.                                 </div>
    1007. 

  1007.                               </td>
    1008. 

  1008.                             </tr>
    1009. 

  1009.                             <tr>
    1010. 

  1010.                               <td>
    1011. 

  1011.                                 <code>
    1012. 

  1012.                                 <em>method</em>
    1013. 

  1013.                                 </code>
    1014. 

  1014.                               </td>
    1015. 

  1015.                               <td>
    1016. 

  1016.                                 <div>
    1017. 

  1017.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    1018. 

  1018.                                 </div>
    1019. 

  1019.                               </td>
    1020. 

  1020.                             </tr>
    1021. 

  1021.                             <tr>
    1022. 

  1022.                               <td>
    1023. 

  1023.                                 <code>
    1024. 

  1024.                                 <em>headers</em>
    1025. 

  1025.                                 </code>
    1026. 

  1026.                               </td>
    1027. 

  1027.                               <td>
    1028. 

  1028.                                 <div>
    1029. 

  1029.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    1030. 

  1030.                                 </div>
    1031. 

  1031.                               </td>
    1032. 

  1032.                             </tr>
    1033. 

  1033.                           </tbody>
    1034. 

  1034.                         </table>
    1035. 

  1035.                       </div>
    1036. 

  1036.                       <div>
    1037. 

  1037.                         <h4>Return Value</h4>
    1038. 

  1038.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1039. 

  1039.                       </div>
    1040. 

  1040.                     </section>
    1041. 

  1041.                   </div>
    1042. 

  1042.                 </li>
    1043. 

  1043.                 <li class="item">
    1044. 

  1044.                   <div>
    1045. 

  1045.                     <code>
    1046. 

  1046.                     <a name="/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF"></a>
    1047. 

  1047.                     <a name="//apple_ref/swift/Function/upload(_:with:)" class="dashAnchor"></a>
    1048. 

  1048.                     <a class="token" href="#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
    1049. 

  1049.                     </code>
    1050. 

  1050.                   </div>
    1051. 

  1051.                   <div class="height-container">
    1052. 

  1052.                     <div class="pointer-container"></div>
    1053. 

  1053.                     <section class="section">
    1054. 

  1054.                       <div class="pointer"></div>
    1055. 

  1055.                       <div class="abstract">
    1056. 

  1056.                         <p>Creates an <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the specified <code>urlRequest</code> for
    1057. 

  1057. uploading the <code>data</code>.</p>
    1058. 

  1058. 

  1059.                       </div>
    1060. 

  1060.                       <div class="declaration">
    1061. 

  1061.                         <h4>Declaration</h4>
    1062. 

  1062.                         <div class="language">
    1063. 

  1063.                           <p class="aside-title">Swift</p>
    1064. 

  1064.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1065. 

  1065. 

  1066.                         </div>
    1067. 

  1067.                       </div>
    1068. 

  1068.                       <div>
    1069. 

  1069.                         <h4>Parameters</h4>
    1070. 

  1070.                         <table class="graybox">
    1071. 

  1071.                           <tbody>
    1072. 

  1072.                             <tr>
    1073. 

  1073.                               <td>
    1074. 

  1074.                                 <code>
    1075. 

  1075.                                 <em>data</em>
    1076. 

  1076.                                 </code>
    1077. 

  1077.                               </td>
    1078. 

  1078.                               <td>
    1079. 

  1079.                                 <div>
    1080. 

  1080.                                   <p>The data to upload.</p>
    1081. 

  1081.                                 </div>
    1082. 

  1082.                               </td>
    1083. 

  1083.                             </tr>
    1084. 

  1084.                             <tr>
    1085. 

  1085.                               <td>
    1086. 

  1086.                                 <code>
    1087. 

  1087.                                 <em>urlRequest</em>
    1088. 

  1088.                                 </code>
    1089. 

  1089.                               </td>
    1090. 

  1090.                               <td>
    1091. 

  1091.                                 <div>
    1092. 

  1092.                                   <p>The URL request.</p>
    1093. 

  1093.                                 </div>
    1094. 

  1094.                               </td>
    1095. 

  1095.                             </tr>
    1096. 

  1096.                           </tbody>
    1097. 

  1097.                         </table>
    1098. 

  1098.                       </div>
    1099. 

  1099.                       <div>
    1100. 

  1100.                         <h4>Return Value</h4>
    1101. 

  1101.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1102. 

  1102.                       </div>
    1103. 

  1103.                     </section>
    1104. 

  1104.                   </div>
    1105. 

  1105.                 </li>
    1106. 

  1106.               </ul>
    1107. 

  1107.             </div>
    1108. 

  1108.             <div class="task-group">
    1109. 

  1109.               <div class="task-name-container">
    1110. 

  1110.                 <a name="/InputStream"></a>
    1111. 

  1111.                 <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
    1112. 

  1112.                 <a href="#/InputStream">
    1113. 

  1113.                   <h3 class="section-name">InputStream</h3>
    1114. 

  1114.                 </a>
    1115. 

  1115.               </div>
    1116. 

  1116.               <ul class="item-container">
    1117. 

  1117.                 <li class="item">
    1118. 

  1118.                   <div>
    1119. 

  1119.                     <code>
    1120. 

  1120.                     <a name="/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF"></a>
    1121. 

  1121.                     <a name="//apple_ref/swift/Function/upload(_:to:method:headers:)" class="dashAnchor"></a>
    1122. 

  1122.                     <a class="token" href="#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
    1123. 

  1123.                     </code>
    1124. 

  1124.                   </div>
    1125. 

  1125.                   <div class="height-container">
    1126. 

  1126.                     <div class="pointer-container"></div>
    1127. 

  1127.                     <section class="section">
    1128. 

  1128.                       <div class="pointer"></div>
    1129. 

  1129.                       <div class="abstract">
    1130. 

  1130.                         <p>Creates an <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the specified <code>url</code>, <code>method</code> and <code>headers</code>
    1131. 

  1131. for uploading the <code>stream</code>.</p>
    1132. 

  1132. 

  1133.                       </div>
    1134. 

  1134.                       <div class="declaration">
    1135. 

  1135.                         <h4>Declaration</h4>
    1136. 

  1136.                         <div class="language">
    1137. 

  1137.                           <p class="aside-title">Swift</p>
    1138. 

  1138.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    1139. 

  1139.     <span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span>
    1140. 

  1140.     <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>
    1141. 

  1141.     <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>
    1142. 

  1142.     <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span>
    1143. 

  1143.     <span class="o">-&gt;</span> <span class="kt"><a href="Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1144. 

  1144. 

  1145.                         </div>
    1146. 

  1146.                       </div>
    1147. 

  1147.                       <div>
    1148. 

  1148.                         <h4>Parameters</h4>
    1149. 

  1149.                         <table class="graybox">
    1150. 

  1150.                           <tbody>
    1151. 

  1151.                             <tr>
    1152. 

  1152.                               <td>
    1153. 

  1153.                                 <code>
    1154. 

  1154.                                 <em>stream</em>
    1155. 

  1155.                                 </code>
    1156. 

  1156.                               </td>
    1157. 

  1157.                               <td>
    1158. 

  1158.                                 <div>
    1159. 

  1159.                                   <p>The stream to upload.</p>
    1160. 

  1160.                                 </div>
    1161. 

  1161.                               </td>
    1162. 

  1162.                             </tr>
    1163. 

  1163.                             <tr>
    1164. 

  1164.                               <td>
    1165. 

  1165.                                 <code>
    1166. 

  1166.                                 <em>url</em>
    1167. 

  1167.                                 </code>
    1168. 

  1168.                               </td>
    1169. 

  1169.                               <td>
    1170. 

  1170.                                 <div>
    1171. 

  1171.                                   <p>The URL.</p>
    1172. 

  1172.                                 </div>
    1173. 

  1173.                               </td>
    1174. 

  1174.                             </tr>
    1175. 

  1175.                             <tr>
    1176. 

  1176.                               <td>
    1177. 

  1177.                                 <code>
    1178. 

  1178.                                 <em>method</em>
    1179. 

  1179.                                 </code>
    1180. 

  1180.                               </td>
    1181. 

  1181.                               <td>
    1182. 

  1182.                                 <div>
    1183. 

  1183.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    1184. 

  1184.                                 </div>
    1185. 

  1185.                               </td>
    1186. 

  1186.                             </tr>
    1187. 

  1187.                             <tr>
    1188. 

  1188.                               <td>
    1189. 

  1189.                                 <code>
    1190. 

  1190.                                 <em>headers</em>
    1191. 

  1191.                                 </code>
    1192. 

  1192.                               </td>
    1193. 

  1193.                               <td>
    1194. 

  1194.                                 <div>
    1195. 

  1195.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    1196. 

  1196.                                 </div>
    1197. 

  1197.                               </td>
    1198. 

  1198.                             </tr>
    1199. 

  1199.                           </tbody>
    1200. 

  1200.                         </table>
    1201. 

  1201.                       </div>
    1202. 

  1202.                       <div>
    1203. 

  1203.                         <h4>Return Value</h4>
    1204. 

  1204.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1205. 

  1205.                       </div>
    1206. 

  1206.                     </section>
    1207. 

  1207.                   </div>
    1208. 

  1208.                 </li>
    1209. 

  1209.                 <li class="item">
    1210. 

  1210.                   <div>
    1211. 

  1211.                     <code>
    1212. 

  1212.                     <a name="/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF"></a>
    1213. 

  1213.                     <a name="//apple_ref/swift/Function/upload(_:with:)" class="dashAnchor"></a>
    1214. 

  1214.                     <a class="token" href="#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
    1215. 

  1215.                     </code>
    1216. 

  1216.                   </div>
    1217. 

  1217.                   <div class="height-container">
    1218. 

  1218.                     <div class="pointer-container"></div>
    1219. 

  1219.                     <section class="section">
    1220. 

  1220.                       <div class="pointer"></div>
    1221. 

  1221.                       <div class="abstract">
    1222. 

  1222.                         <p>Creates an <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> from the specified <code>urlRequest</code> for
    1223. 

  1223. uploading the <code>stream</code>.</p>
    1224. 

  1224. 

  1225.                       </div>
    1226. 

  1226.                       <div class="declaration">
    1227. 

  1227.                         <h4>Declaration</h4>
    1228. 

  1228.                         <div class="language">
    1229. 

  1229.                           <p class="aside-title">Swift</p>
    1230. 

  1230.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span> <span class="n">with</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1231. 

  1231. 

  1232.                         </div>
    1233. 

  1233.                       </div>
    1234. 

  1234.                       <div>
    1235. 

  1235.                         <h4>Parameters</h4>
    1236. 

  1236.                         <table class="graybox">
    1237. 

  1237.                           <tbody>
    1238. 

  1238.                             <tr>
    1239. 

  1239.                               <td>
    1240. 

  1240.                                 <code>
    1241. 

  1241.                                 <em>urlRequest</em>
    1242. 

  1242.                                 </code>
    1243. 

  1243.                               </td>
    1244. 

  1244.                               <td>
    1245. 

  1245.                                 <div>
    1246. 

  1246.                                   <p>The URL request.</p>
    1247. 

  1247.                                 </div>
    1248. 

  1248.                               </td>
    1249. 

  1249.                             </tr>
    1250. 

  1250.                             <tr>
    1251. 

  1251.                               <td>
    1252. 

  1252.                                 <code>
    1253. 

  1253.                                 <em>stream</em>
    1254. 

  1254.                                 </code>
    1255. 

  1255.                               </td>
    1256. 

  1256.                               <td>
    1257. 

  1257.                                 <div>
    1258. 

  1258.                                   <p>The stream to upload.</p>
    1259. 

  1259.                                 </div>
    1260. 

  1260.                               </td>
    1261. 

  1261.                             </tr>
    1262. 

  1262.                           </tbody>
    1263. 

  1263.                         </table>
    1264. 

  1264.                       </div>
    1265. 

  1265.                       <div>
    1266. 

  1266.                         <h4>Return Value</h4>
    1267. 

  1267.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1268. 

  1268.                       </div>
    1269. 

  1269.                     </section>
    1270. 

  1270.                   </div>
    1271. 

  1271.                 </li>
    1272. 

  1272.               </ul>
    1273. 

  1273.             </div>
    1274. 

  1274.             <div class="task-group">
    1275. 

  1275.               <div class="task-name-container">
    1276. 

  1276.                 <a name="/MultipartFormData"></a>
    1277. 

  1277.                 <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
    1278. 

  1278.                 <a href="#/MultipartFormData">
    1279. 

  1279.                   <h3 class="section-name">MultipartFormData</h3>
    1280. 

  1280.                 </a>
    1281. 

  1281.               </div>
    1282. 

  1282.               <ul class="item-container">
    1283. 

  1283.                 <li class="item">
    1284. 

  1284.                   <div>
    1285. 

  1285.                     <code>
    1286. 

  1286.                     <a name="/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF"></a>
    1287. 

  1287.                     <a name="//apple_ref/swift/Function/upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)" class="dashAnchor"></a>
    1288. 

  1288.                     <a class="token" href="#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
    1289. 

  1289.                     </code>
    1290. 

  1290.                   </div>
    1291. 

  1291.                   <div class="height-container">
    1292. 

  1292.                     <div class="pointer-container"></div>
    1293. 

  1293.                     <section class="section">
    1294. 

  1294.                       <div class="pointer"></div>
    1295. 

  1295.                       <div class="abstract">
    1296. 

  1296.                         <p>Encodes <code>multipartFormData</code> using <code>encodingMemoryThreshold</code> with the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> and calls
    1297. 

  1297. <code>encodingCompletion</code> with new <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the <code>url</code>, <code>method</code> and <code>headers</code>.</p>
    1298. 

  1298. 

  1299. <p>It is important to understand the memory implications of uploading <code><a href="Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cummulative
    1300. 

  1300. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
    1301. 

  1301. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
    1302. 

  1302. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
    1303. 

  1303. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
    1304. 

  1304. used for larger payloads such as video content.</p>
    1305. 

  1305. 

  1306. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
    1307. 

  1307. 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>,
    1308. 

  1308. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
    1309. 

  1309. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
    1310. 

  1310. technique was used.</p>
    1311. 

  1311. 

  1312.                       </div>
    1313. 

  1313.                       <div class="declaration">
    1314. 

  1314.                         <h4>Declaration</h4>
    1315. 

  1315.                         <div class="language">
    1316. 

  1316.                           <p class="aside-title">Swift</p>
    1317. 

  1317.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    1318. 

  1318.     <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>
    1319. 

  1319.     <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/SessionManager.html">SessionManager</a></span><span class="o">.</span><span class="n">multipartFormDataEncodingMemoryThreshold</span><span class="p">,</span>
    1320. 

  1320.     <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>
    1321. 

  1321.     <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>
    1322. 

  1322.     <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1323. 

  1323.     <span class="nv">encodingCompletion</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="Classes/SessionManager.html">SessionManager</a></span><span class="o">.</span><span class="kt">MultipartFormDataEncodingResult</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?)</span></code></pre>
    1324. 

  1324. 

  1325.                         </div>
    1326. 

  1326.                       </div>
    1327. 

  1327.                       <div>
    1328. 

  1328.                         <h4>Parameters</h4>
    1329. 

  1329.                         <table class="graybox">
    1330. 

  1330.                           <tbody>
    1331. 

  1331.                             <tr>
    1332. 

  1332.                               <td>
    1333. 

  1333.                                 <code>
    1334. 

  1334.                                 <em>multipartFormData</em>
    1335. 

  1335.                                 </code>
    1336. 

  1336.                               </td>
    1337. 

  1337.                               <td>
    1338. 

  1338.                                 <div>
    1339. 

  1339.                                   <p>The closure used to append body parts to the <code><a href="Classes/MultipartFormData.html">MultipartFormData</a></code>.</p>
    1340. 

  1340.                                 </div>
    1341. 

  1341.                               </td>
    1342. 

  1342.                             </tr>
    1343. 

  1343.                             <tr>
    1344. 

  1344.                               <td>
    1345. 

  1345.                                 <code>
    1346. 

  1346.                                 <em>encodingMemoryThreshold</em>
    1347. 

  1347.                                 </code>
    1348. 

  1348.                               </td>
    1349. 

  1349.                               <td>
    1350. 

  1350.                                 <div>
    1351. 

  1351.                                   <p>The encoding memory threshold in bytes.
    1352. 

  1352.                                  <code>multipartFormDataEncodingMemoryThreshold</code> by default.</p>
    1353. 

  1353.                                 </div>
    1354. 

  1354.                               </td>
    1355. 

  1355.                             </tr>
    1356. 

  1356.                             <tr>
    1357. 

  1357.                               <td>
    1358. 

  1358.                                 <code>
    1359. 

  1359.                                 <em>url</em>
    1360. 

  1360.                                 </code>
    1361. 

  1361.                               </td>
    1362. 

  1362.                               <td>
    1363. 

  1363.                                 <div>
    1364. 

  1364.                                   <p>The URL.</p>
    1365. 

  1365.                                 </div>
    1366. 

  1366.                               </td>
    1367. 

  1367.                             </tr>
    1368. 

  1368.                             <tr>
    1369. 

  1369.                               <td>
    1370. 

  1370.                                 <code>
    1371. 

  1371.                                 <em>method</em>
    1372. 

  1372.                                 </code>
    1373. 

  1373.                               </td>
    1374. 

  1374.                               <td>
    1375. 

  1375.                                 <div>
    1376. 

  1376.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    1377. 

  1377.                                 </div>
    1378. 

  1378.                               </td>
    1379. 

  1379.                             </tr>
    1380. 

  1380.                             <tr>
    1381. 

  1381.                               <td>
    1382. 

  1382.                                 <code>
    1383. 

  1383.                                 <em>headers</em>
    1384. 

  1384.                                 </code>
    1385. 

  1385.                               </td>
    1386. 

  1386.                               <td>
    1387. 

  1387.                                 <div>
    1388. 

  1388.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    1389. 

  1389.                                 </div>
    1390. 

  1390.                               </td>
    1391. 

  1391.                             </tr>
    1392. 

  1392.                             <tr>
    1393. 

  1393.                               <td>
    1394. 

  1394.                                 <code>
    1395. 

  1395.                                 <em>encodingCompletion</em>
    1396. 

  1396.                                 </code>
    1397. 

  1397.                               </td>
    1398. 

  1398.                               <td>
    1399. 

  1399.                                 <div>
    1400. 

  1400.                                   <p>The closure called when the <code><a href="Classes/MultipartFormData.html">MultipartFormData</a></code> encoding is complete.</p>
    1401. 

  1401.                                 </div>
    1402. 

  1402.                               </td>
    1403. 

  1403.                             </tr>
    1404. 

  1404.                           </tbody>
    1405. 

  1405.                         </table>
    1406. 

  1406.                       </div>
    1407. 

  1407.                     </section>
    1408. 

  1408.                   </div>
    1409. 

  1409.                 </li>
    1410. 

  1410.                 <li class="item">
    1411. 

  1411.                   <div>
    1412. 

  1412.                     <code>
    1413. 

  1413.                     <a name="/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF"></a>
    1414. 

  1414.                     <a name="//apple_ref/swift/Function/upload(multipartFormData:usingThreshold:with:encodingCompletion:)" class="dashAnchor"></a>
    1415. 

  1415.                     <a class="token" href="#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
    1416. 

  1416.                     </code>
    1417. 

  1417.                   </div>
    1418. 

  1418.                   <div class="height-container">
    1419. 

  1419.                     <div class="pointer-container"></div>
    1420. 

  1420.                     <section class="section">
    1421. 

  1421.                       <div class="pointer"></div>
    1422. 

  1422.                       <div class="abstract">
    1423. 

  1423.                         <p>Encodes <code>multipartFormData</code> using <code>encodingMemoryThreshold</code> and the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> and
    1424. 

  1424. calls <code>encodingCompletion</code> with new <code><a href="Classes/UploadRequest.html">UploadRequest</a></code> using the <code>urlRequest</code>.</p>
    1425. 

  1425. 

  1426. <p>It is important to understand the memory implications of uploading <code><a href="Classes/MultipartFormData.html">MultipartFormData</a></code>. If the cummulative
    1427. 

  1427. payload is small, encoding the data in-memory and directly uploading to a server is the by far the most
    1428. 

  1428. efficient approach. However, if the payload is too large, encoding the data in-memory could cause your app to
    1429. 

  1429. be terminated. Larger payloads must first be written to disk using input and output streams to keep the memory
    1430. 

  1430. footprint low, then the data can be uploaded as a stream from the resulting file. Streaming from disk MUST be
    1431. 

  1431. used for larger payloads such as video content.</p>
    1432. 

  1432. 

  1433. <p>The <code>encodingMemoryThreshold</code> parameter allows Alamofire to automatically determine whether to encode in-memory
    1434. 

  1434. 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>,
    1435. 

  1435. encoding takes place in-memory. If the content length exceeds the threshold, the data is streamed to disk
    1436. 

  1436. during the encoding process. Then the result is uploaded as data or as a stream depending on which encoding
    1437. 

  1437. technique was used.</p>
    1438. 

  1438. 

  1439.                       </div>
    1440. 

  1440.                       <div class="declaration">
    1441. 

  1441.                         <h4>Declaration</h4>
    1442. 

  1442.                         <div class="language">
    1443. 

  1443.                           <p class="aside-title">Swift</p>
    1444. 

  1444.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    1445. 

  1445.     <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>
    1446. 

  1446.     <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/SessionManager.html">SessionManager</a></span><span class="o">.</span><span class="n">multipartFormDataEncodingMemoryThreshold</span><span class="p">,</span>
    1447. 

  1447.     <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>
    1448. 

  1448.     <span class="nv">encodingCompletion</span><span class="p">:</span> <span class="p">((</span><span class="kt"><a href="Classes/SessionManager.html">SessionManager</a></span><span class="o">.</span><span class="kt">MultipartFormDataEncodingResult</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)?)</span></code></pre>
    1449. 

  1449. 

  1450.                         </div>
    1451. 

  1451.                       </div>
    1452. 

  1452.                       <div>
    1453. 

  1453.                         <h4>Parameters</h4>
    1454. 

  1454.                         <table class="graybox">
    1455. 

  1455.                           <tbody>
    1456. 

  1456.                             <tr>
    1457. 

  1457.                               <td>
    1458. 

  1458.                                 <code>
    1459. 

  1459.                                 <em>multipartFormData</em>
    1460. 

  1460.                                 </code>
    1461. 

  1461.                               </td>
    1462. 

  1462.                               <td>
    1463. 

  1463.                                 <div>
    1464. 

  1464.                                   <p>The closure used to append body parts to the <code><a href="Classes/MultipartFormData.html">MultipartFormData</a></code>.</p>
    1465. 

  1465.                                 </div>
    1466. 

  1466.                               </td>
    1467. 

  1467.                             </tr>
    1468. 

  1468.                             <tr>
    1469. 

  1469.                               <td>
    1470. 

  1470.                                 <code>
    1471. 

  1471.                                 <em>encodingMemoryThreshold</em>
    1472. 

  1472.                                 </code>
    1473. 

  1473.                               </td>
    1474. 

  1474.                               <td>
    1475. 

  1475.                                 <div>
    1476. 

  1476.                                   <p>The encoding memory threshold in bytes.
    1477. 

  1477.                                  <code>multipartFormDataEncodingMemoryThreshold</code> by default.</p>
    1478. 

  1478.                                 </div>
    1479. 

  1479.                               </td>
    1480. 

  1480.                             </tr>
    1481. 

  1481.                             <tr>
    1482. 

  1482.                               <td>
    1483. 

  1483.                                 <code>
    1484. 

  1484.                                 <em>urlRequest</em>
    1485. 

  1485.                                 </code>
    1486. 

  1486.                               </td>
    1487. 

  1487.                               <td>
    1488. 

  1488.                                 <div>
    1489. 

  1489.                                   <p>The URL request.</p>
    1490. 

  1490.                                 </div>
    1491. 

  1491.                               </td>
    1492. 

  1492.                             </tr>
    1493. 

  1493.                             <tr>
    1494. 

  1494.                               <td>
    1495. 

  1495.                                 <code>
    1496. 

  1496.                                 <em>encodingCompletion</em>
    1497. 

  1497.                                 </code>
    1498. 

  1498.                               </td>
    1499. 

  1499.                               <td>
    1500. 

  1500.                                 <div>
    1501. 

  1501.                                   <p>The closure called when the <code><a href="Classes/MultipartFormData.html">MultipartFormData</a></code> encoding is complete.</p>
    1502. 

  1502.                                 </div>
    1503. 

  1503.                               </td>
    1504. 

  1504.                             </tr>
    1505. 

  1505.                           </tbody>
    1506. 

  1506.                         </table>
    1507. 

  1507.                       </div>
    1508. 

  1508.                     </section>
    1509. 

  1509.                   </div>
    1510. 

  1510.                 </li>
    1511. 

  1511.               </ul>
    1512. 

  1512.             </div>
    1513. 

  1513.             <div class="task-group">
    1514. 

  1514.               <div class="task-name-container">
    1515. 

  1515.                 <a name="/Hostname%20and%20Port"></a>
    1516. 

  1516.                 <a name="//apple_ref/swift/Section/Hostname and Port" class="dashAnchor"></a>
    1517. 

  1517.                 <a href="#/Hostname%20and%20Port">
    1518. 

  1518.                   <h3 class="section-name">Hostname and Port</h3>
    1519. 

  1519.                 </a>
    1520. 

  1520.               </div>
    1521. 

  1521.               <ul class="item-container">
    1522. 

  1522.                 <li class="item">
    1523. 

  1523.                   <div>
    1524. 

  1524.                     <code>
    1525. 

  1525.                     <a name="/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF"></a>
    1526. 

  1526.                     <a name="//apple_ref/swift/Function/stream(withHostName:port:)" class="dashAnchor"></a>
    1527. 

  1527.                     <a class="token" href="#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
    1528. 

  1528.                     </code>
    1529. 

  1529.                   </div>
    1530. 

  1530.                   <div class="height-container">
    1531. 

  1531.                     <div class="pointer-container"></div>
    1532. 

  1532.                     <section class="section">
    1533. 

  1533.                       <div class="pointer"></div>
    1534. 

  1534.                       <div class="abstract">
    1535. 

  1535.                         <p>Creates a <code><a href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> for bidirectional streaming with the <code>hostname</code>
    1536. 

  1536. and <code>port</code>.</p>
    1537. 

  1537. 

  1538. <p>If <code>startRequestsImmediately</code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
    1539. 

  1539. 

  1540.                       </div>
    1541. 

  1541.                       <div class="declaration">
    1542. 

  1542.                         <h4>Declaration</h4>
    1543. 

  1543.                         <div class="language">
    1544. 

  1544.                           <p class="aside-title">Swift</p>
    1545. 

  1545.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stream</span><span class="p">(</span><span class="n">withHostName</span> <span class="nv">hostName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></span></code></pre>
    1546. 

  1546. 

  1547.                         </div>
    1548. 

  1548.                       </div>
    1549. 

  1549.                       <div>
    1550. 

  1550.                         <h4>Parameters</h4>
    1551. 

  1551.                         <table class="graybox">
    1552. 

  1552.                           <tbody>
    1553. 

  1553.                             <tr>
    1554. 

  1554.                               <td>
    1555. 

  1555.                                 <code>
    1556. 

  1556.                                 <em>hostName</em>
    1557. 

  1557.                                 </code>
    1558. 

  1558.                               </td>
    1559. 

  1559.                               <td>
    1560. 

  1560.                                 <div>
    1561. 

  1561.                                   <p>The hostname of the server to connect to.</p>
    1562. 

  1562.                                 </div>
    1563. 

  1563.                               </td>
    1564. 

  1564.                             </tr>
    1565. 

  1565.                             <tr>
    1566. 

  1566.                               <td>
    1567. 

  1567.                                 <code>
    1568. 

  1568.                                 <em>port</em>
    1569. 

  1569.                                 </code>
    1570. 

  1570.                               </td>
    1571. 

  1571.                               <td>
    1572. 

  1572.                                 <div>
    1573. 

  1573.                                   <p>The port of the server to connect to.</p>
    1574. 

  1574.                                 </div>
    1575. 

  1575.                               </td>
    1576. 

  1576.                             </tr>
    1577. 

  1577.                           </tbody>
    1578. 

  1578.                         </table>
    1579. 

  1579.                       </div>
    1580. 

  1580.                       <div>
    1581. 

  1581.                         <h4>Return Value</h4>
    1582. 

  1582.                         <p>The created <code><a href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code>.</p>
    1583. 

  1583.                       </div>
    1584. 

  1584.                     </section>
    1585. 

  1585.                   </div>
    1586. 

  1586.                 </li>
    1587. 

  1587.               </ul>
    1588. 

  1588.             </div>
    1589. 

  1589.             <div class="task-group">
    1590. 

  1590.               <div class="task-name-container">
    1591. 

  1591.                 <a name="/NetService"></a>
    1592. 

  1592.                 <a name="//apple_ref/swift/Section/NetService" class="dashAnchor"></a>
    1593. 

  1593.                 <a href="#/NetService">
    1594. 

  1594.                   <h3 class="section-name">NetService</h3>
    1595. 

  1595.                 </a>
    1596. 

  1596.               </div>
    1597. 

  1597.               <ul class="item-container">
    1598. 

  1598.                 <li class="item">
    1599. 

  1599.                   <div>
    1600. 

  1600.                     <code>
    1601. 

  1601.                     <a name="/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF"></a>
    1602. 

  1602.                     <a name="//apple_ref/swift/Function/stream(with:)" class="dashAnchor"></a>
    1603. 

  1603.                     <a class="token" href="#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
    1604. 

  1604.                     </code>
    1605. 

  1605.                   </div>
    1606. 

  1606.                   <div class="height-container">
    1607. 

  1607.                     <div class="pointer-container"></div>
    1608. 

  1608.                     <section class="section">
    1609. 

  1609.                       <div class="pointer"></div>
    1610. 

  1610.                       <div class="abstract">
    1611. 

  1611.                         <p>Creates a <code><a href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code> using the default <code><a href="Classes/SessionManager.html">SessionManager</a></code> for bidirectional streaming with the <code>netService</code>.</p>
    1612. 

  1612. 

  1613. <p>If <code>startRequestsImmediately</code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p>
    1614. 

  1614. 

  1615.                       </div>
    1616. 

  1616.                       <div class="declaration">
    1617. 

  1617.                         <h4>Declaration</h4>
    1618. 

  1618.                         <div class="language">
    1619. 

  1619.                           <p class="aside-title">Swift</p>
    1620. 

  1620.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stream</span><span class="p">(</span><span class="n">with</span> <span class="nv">netService</span><span class="p">:</span> <span class="kt">NetService</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></span></code></pre>
    1621. 

  1621. 

  1622.                         </div>
    1623. 

  1623.                       </div>
    1624. 

  1624.                       <div>
    1625. 

  1625.                         <h4>Parameters</h4>
    1626. 

  1626.                         <table class="graybox">
    1627. 

  1627.                           <tbody>
    1628. 

  1628.                             <tr>
    1629. 

  1629.                               <td>
    1630. 

  1630.                                 <code>
    1631. 

  1631.                                 <em>netService</em>
    1632. 

  1632.                                 </code>
    1633. 

  1633.                               </td>
    1634. 

  1634.                               <td>
    1635. 

  1635.                                 <div>
    1636. 

  1636.                                   <p>The net service used to identify the endpoint.</p>
    1637. 

  1637.                                 </div>
    1638. 

  1638.                               </td>
    1639. 

  1639.                             </tr>
    1640. 

  1640.                           </tbody>
    1641. 

  1641.                         </table>
    1642. 

  1642.                       </div>
    1643. 

  1643.                       <div>
    1644. 

  1644.                         <h4>Return Value</h4>
    1645. 

  1645.                         <p>The created <code><a href="Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a></code>.</p>
    1646. 

  1646.                       </div>
    1647. 

  1647.                     </section>
    1648. 

  1648.                   </div>
    1649. 

  1649.                 </li>
    1650. 

  1650.               </ul>
    1651. 

  1651.             </div>
    1652. 

  1652.             <div class="task-group">
    1653. 

  1653.               <ul class="item-container">
    1654. 

  1654.                 <li class="item">
    1655. 

  1655.                   <div>
    1656. 

  1656.                     <code>
    1657. 

  1657.                     <a name="/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF"></a>
    1658. 

  1658.                     <a name="//apple_ref/swift/Function/==(_:_:)" class="dashAnchor"></a>
    1659. 

  1659.                     <a class="token" href="#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
    1660. 

  1660.                     </code>
    1661. 

  1661.                   </div>
    1662. 

  1662.                   <div class="height-container">
    1663. 

  1663.                     <div class="pointer-container"></div>
    1664. 

  1664.                     <section class="section">
    1665. 

  1665.                       <div class="pointer"></div>
    1666. 

  1666.                       <div class="abstract">
    1667. 

  1667.                         <p>Returns whether the two network reachability status values are equal.</p>
    1668. 

  1668. 

  1669.                       </div>
    1670. 

  1670.                       <div class="declaration">
    1671. 

  1671.                         <h4>Declaration</h4>
    1672. 

  1672.                         <div class="language">
    1673. 

  1673.                           <p class="aside-title">Swift</p>
    1674. 

  1674.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="o">==</span><span class="p">(</span>
    1675. 

  1675.     <span class="nv">lhs</span><span class="p">:</span> <span class="kt"><a href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a></span><span class="o">.</span><span class="kt">NetworkReachabilityStatus</span><span class="p">,</span>
    1676. 

  1676.     <span class="nv">rhs</span><span class="p">:</span> <span class="kt"><a href="Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a></span><span class="o">.</span><span class="kt">NetworkReachabilityStatus</span><span class="p">)</span>
    1677. 

  1677.     <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
    1678. 

  1678. 

  1679.                         </div>
    1680. 

  1680.                       </div>
    1681. 

  1681.                       <div>
    1682. 

  1682.                         <h4>Parameters</h4>
    1683. 

  1683.                         <table class="graybox">
    1684. 

  1684.                           <tbody>
    1685. 

  1685.                             <tr>
    1686. 

  1686.                               <td>
    1687. 

  1687.                                 <code>
    1688. 

  1688.                                 <em>lhs</em>
    1689. 

  1689.                                 </code>
    1690. 

  1690.                               </td>
    1691. 

  1691.                               <td>
    1692. 

  1692.                                 <div>
    1693. 

  1693.                                   <p>The left-hand side value to compare.</p>
    1694. 

  1694.                                 </div>
    1695. 

  1695.                               </td>
    1696. 

  1696.                             </tr>
    1697. 

  1697.                             <tr>
    1698. 

  1698.                               <td>
    1699. 

  1699.                                 <code>
    1700. 

  1700.                                 <em>rhs</em>
    1701. 

  1701.                                 </code>
    1702. 

  1702.                               </td>
    1703. 

  1703.                               <td>
    1704. 

  1704.                                 <div>
    1705. 

  1705.                                   <p>The right-hand side value to compare.</p>
    1706. 

  1706.                                 </div>
    1707. 

  1707.                               </td>
    1708. 

  1708.                             </tr>
    1709. 

  1709.                           </tbody>
    1710. 

  1710.                         </table>
    1711. 

  1711.                       </div>
    1712. 

  1712.                       <div>
    1713. 

  1713.                         <h4>Return Value</h4>
    1714. 

  1714.                         <p><code>true</code> if the two values are equal, <code>false</code> otherwise.</p>
    1715. 

  1715.                       </div>
    1716. 

  1716.                     </section>
    1717. 

  1717.                   </div>
    1718. 

  1718.                 </li>
    1719. 

  1719.               </ul>
    1720. 

  1720.             </div>
    1721. 

  1721.           </div>
    1722. 

  1722.         </section>
    1723. 

  1723. 

  1724.       </article>
    1725. 

  1725.     </div>
    1726. 

  1726.     <section class="footer">
    1727. 

  1727.       <p>&copy; 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-04-15)</p>
    1728. 

  1728.       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    1729. 

  1729.     </section>
    1730. 

  1730.   </body>
    1731. 

  1731. </div>
    1732. 

  1732. </html>
    1733.