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

Functions.html 97 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748 
  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.     <a name="//apple_ref/swift/Section/Functions" class="dashAnchor"></a>
    18. 

  18. 

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

  20. 

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

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

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

  24.           Alamofire Docs
    25. 

  25.         </a>
    26. 

  26.          (86% documented)
    27. 

  27.       </p>
    28. 

  28.     
    29. 

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

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

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

  32.         </form>
    33. 

  33.       </p>
    34. 

  34.     
    35. 

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

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

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

  38.             View on GitHub
    39. 

  39.           </a>
    40. 

  40.         </p>
    41. 

  41.     
    42. 

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

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

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

  45.             Install in Dash
    46. 

  46.           </a>
    47. 

  47.         </p>
    48. 

  48.     </header>
    49. 

  49. 

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

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

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

  53.       Functions  Reference
    54. 

  54.     </p>
    55. 

  55. 

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

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

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

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

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

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

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

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

  64.               </li>
    65. 

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

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

  67.               </li>
    68. 

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

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

  70.               </li>
    71. 

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

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

  73.               </li>
    74. 

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

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

  76.               </li>
    77. 

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

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

  79.               </li>
    80. 

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

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

  82.               </li>
    83. 

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

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

  85.               </li>
    86. 

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

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

  88.               </li>
    89. 

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

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

  91.               </li>
    92. 

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

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

  94.               </li>
    95. 

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

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

  97.               </li>
    98. 

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

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

  100.               </li>
    101. 

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

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

  103.               </li>
    104. 

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

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

  106.               </li>
    107. 

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

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

  109.               </li>
    110. 

  110.             </ul>
    111. 

  111.           </li>
    112. 

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

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

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

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

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

  117.               </li>
    118. 

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

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

  120.               </li>
    121. 

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

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

  123.               </li>
    124. 

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

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

  126.               </li>
    127. 

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

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

  129.               </li>
    130. 

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

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

  132.               </li>
    133. 

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

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

  135.               </li>
    136. 

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

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

  138.               </li>
    139. 

  139.             </ul>
    140. 

  140.           </li>
    141. 

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

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

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

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

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

  146.               </li>
    147. 

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

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

  149.               </li>
    150. 

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

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

  152.               </li>
    153. 

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

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

  155.               </li>
    156. 

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

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

  158.               </li>
    159. 

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

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

  161.               </li>
    162. 

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

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

  164.               </li>
    165. 

  165.             </ul>
    166. 

  166.           </li>
    167. 

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

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

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

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

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

  172.               </li>
    173. 

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

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

  175.               </li>
    176. 

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

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

  178.               </li>
    179. 

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

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

  181.               </li>
    182. 

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

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

  184.               </li>
    185. 

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

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

  187.               </li>
    188. 

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

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

  190.               </li>
    191. 

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

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

  193.               </li>
    194. 

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

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

  196.               </li>
    197. 

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

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

  199.               </li>
    200. 

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

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

  202.               </li>
    203. 

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

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

  205.               </li>
    206. 

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

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

  208.               </li>
    209. 

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

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

  211.               </li>
    212. 

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

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

  214.               </li>
    215. 

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

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

  217.               </li>
    218. 

  218.             </ul>
    219. 

  219.           </li>
    220. 

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

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

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

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

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

  225.               </li>
    226. 

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

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

  228.               </li>
    229. 

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

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

  231.               </li>
    232. 

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

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

  234.               </li>
    235. 

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

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

  237.               </li>
    238. 

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

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

  240.               </li>
    241. 

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

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

  243.               </li>
    244. 

  244.             </ul>
    245. 

  245.           </li>
    246. 

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

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

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

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

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

  251.               </li>
    252. 

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

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

  254.               </li>
    255. 

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

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

  257.               </li>
    258. 

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

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

  260.               </li>
    261. 

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

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

  263.               </li>
    264. 

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

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

  266.               </li>
    267. 

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

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

  269.               </li>
    270. 

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

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

  272.               </li>
    273. 

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

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

  275.               </li>
    276. 

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

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

  278.               </li>
    279. 

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

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

  281.               </li>
    282. 

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

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

  284.               </li>
    285. 

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

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

  287.               </li>
    288. 

  288.             </ul>
    289. 

  289.           </li>
    290. 

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

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

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

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

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

  295.               </li>
    296. 

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

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

  298.               </li>
    299. 

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

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

  301.               </li>
    302. 

  302.             </ul>
    303. 

  303.           </li>
    304. 

  304.         </ul>
    305. 

  305.       </nav>
    306. 

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

  307. 

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

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

  310.             <h1>Functions</h1>
    311. 

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

  312. 

  313.           </div>
    314. 

  314.         </section>
    315. 

  315. 

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

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

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

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

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

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

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

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

  324.                 </a>
    325. 

  325.               </div>
    326. 

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

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

  328.                   <div>
    329. 

  329.                     <code>
    330. 

  330.                     <a name="/s:9Alamofire7request_6method10parameters8encoding7headersAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSgtF"></a>
    331. 

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

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

  333.                     </code>
    334. 

  334.                   </div>
    335. 

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

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

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

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

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

  340.                         <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>,
    341. 

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

  342. 

  343.                       </div>
    344. 

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

  345.                         <h4>Declaration</h4>
    346. 

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

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

  348.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    349. 

  349. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span>
    350. 

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

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

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

  353.     <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>
    354. 

  354.     <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>
    355. 

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

  356. 

  357.                         </div>
    358. 

  358.                       </div>
    359. 

  359.                       <div>
    360. 

  360.                         <h4>Parameters</h4>
    361. 

  361.                         <table class="graybox">
    362. 

  362.                           <tbody>
    363. 

  363.                             <tr>
    364. 

  364.                               <td>
    365. 

  365.                                 <code>
    366. 

  366.                                 <em>url</em>
    367. 

  367.                                 </code>
    368. 

  368.                               </td>
    369. 

  369.                               <td>
    370. 

  370.                                 <div>
    371. 

  371.                                   <p>The URL.</p>
    372. 

  372.                                 </div>
    373. 

  373.                               </td>
    374. 

  374.                             </tr>
    375. 

  375.                             <tr>
    376. 

  376.                               <td>
    377. 

  377.                                 <code>
    378. 

  378.                                 <em>method</em>
    379. 

  379.                                 </code>
    380. 

  380.                               </td>
    381. 

  381.                               <td>
    382. 

  382.                                 <div>
    383. 

  383.                                   <p>The HTTP method. <code>.get</code> by default.</p>
    384. 

  384.                                 </div>
    385. 

  385.                               </td>
    386. 

  386.                             </tr>
    387. 

  387.                             <tr>
    388. 

  388.                               <td>
    389. 

  389.                                 <code>
    390. 

  390.                                 <em>parameters</em>
    391. 

  391.                                 </code>
    392. 

  392.                               </td>
    393. 

  393.                               <td>
    394. 

  394.                                 <div>
    395. 

  395.                                   <p>The parameters. <code>nil</code> by default.</p>
    396. 

  396.                                 </div>
    397. 

  397.                               </td>
    398. 

  398.                             </tr>
    399. 

  399.                             <tr>
    400. 

  400.                               <td>
    401. 

  401.                                 <code>
    402. 

  402.                                 <em>encoding</em>
    403. 

  403.                                 </code>
    404. 

  404.                               </td>
    405. 

  405.                               <td>
    406. 

  406.                                 <div>
    407. 

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

  408.                                 </div>
    409. 

  409.                               </td>
    410. 

  410.                             </tr>
    411. 

  411.                             <tr>
    412. 

  412.                               <td>
    413. 

  413.                                 <code>
    414. 

  414.                                 <em>headers</em>
    415. 

  415.                                 </code>
    416. 

  416.                               </td>
    417. 

  417.                               <td>
    418. 

  418.                                 <div>
    419. 

  419.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    420. 

  420.                                 </div>
    421. 

  421.                               </td>
    422. 

  422.                             </tr>
    423. 

  423.                           </tbody>
    424. 

  424.                         </table>
    425. 

  425.                       </div>
    426. 

  426.                       <div>
    427. 

  427.                         <h4>Return Value</h4>
    428. 

  428.                         <p>The created <code><a href="Classes/DataRequest.html">DataRequest</a></code>.</p>
    429. 

  429.                       </div>
    430. 

  430.                     </section>
    431. 

  431.                   </div>
    432. 

  432.                 </li>
    433. 

  433.                 <li class="item">
    434. 

  434.                   <div>
    435. 

  435.                     <code>
    436. 

  436.                     <a name="/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF"></a>
    437. 

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

  438.                     <a class="token" href="#/s:9Alamofire7requestyAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
    439. 

  439.                     </code>
    440. 

  440.                   </div>
    441. 

  441.                   <div class="height-container">
    442. 

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

  443.                     <section class="section">
    444. 

  444.                       <div class="pointer"></div>
    445. 

  445.                       <div class="abstract">
    446. 

  446.                         <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
    447. 

  447. specified <code>urlRequest</code>.</p>
    448. 

  448. 

  449.                       </div>
    450. 

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

  451.                         <h4>Declaration</h4>
    452. 

  452.                         <div class="language">
    453. 

  453.                           <p class="aside-title">Swift</p>
    454. 

  454.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    455. 

  455. <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>
    456. 

  456. 

  457.                         </div>
    458. 

  458.                       </div>
    459. 

  459.                       <div>
    460. 

  460.                         <h4>Parameters</h4>
    461. 

  461.                         <table class="graybox">
    462. 

  462.                           <tbody>
    463. 

  463.                             <tr>
    464. 

  464.                               <td>
    465. 

  465.                                 <code>
    466. 

  466.                                 <em>urlRequest</em>
    467. 

  467.                                 </code>
    468. 

  468.                               </td>
    469. 

  469.                               <td>
    470. 

  470.                                 <div>
    471. 

  471.                                   <p>The URL request</p>
    472. 

  472.                                 </div>
    473. 

  473.                               </td>
    474. 

  474.                             </tr>
    475. 

  475.                           </tbody>
    476. 

  476.                         </table>
    477. 

  477.                       </div>
    478. 

  478.                       <div>
    479. 

  479.                         <h4>Return Value</h4>
    480. 

  480.                         <p>The created <code><a href="Classes/DataRequest.html">DataRequest</a></code>.</p>
    481. 

  481.                       </div>
    482. 

  482.                     </section>
    483. 

  483.                   </div>
    484. 

  484.                 </li>
    485. 

  485.               </ul>
    486. 

  486.             </div>
    487. 

  487.             <div class="task-group">
    488. 

  488.               <div class="task-name-container">
    489. 

  489.                 <a name="/URL%20Request"></a>
    490. 

  490.                 <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a>
    491. 

  491.                 <a href="#/URL%20Request">
    492. 

  492.                   <h3 class="section-name">URL Request</h3>
    493. 

  493.                 </a>
    494. 

  494.               </div>
    495. 

  495.               <ul class="item-container">
    496. 

  496.                 <li class="item">
    497. 

  497.                   <div>
    498. 

  498.                     <code>
    499. 

  499.                     <a name="/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF"></a>
    500. 

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

  501.                     <a class="token" href="#/s:9Alamofire8download_6method10parameters8encoding7headers2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pSDyS2SGSg10Foundation3URLV011destinationO0_AI0H7OptionsV7optionstAT_So17NSHTTPURLResponseCtcSgtF">download(_:method:parameters:encoding:headers:to:)</a>
    502. 

  502.                     </code>
    503. 

  503.                   </div>
    504. 

  504.                   <div class="height-container">
    505. 

  505.                     <div class="pointer-container"></div>
    506. 

  506.                     <section class="section">
    507. 

  507.                       <div class="pointer"></div>
    508. 

  508.                       <div class="abstract">
    509. 

  509.                         <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>,
    510. 

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

  511. 

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

  513. underlying URL session.</p>
    514. 

  514. 

  515.                       </div>
    516. 

  516.                       <div class="declaration">
    517. 

  517.                         <h4>Declaration</h4>
    518. 

  518.                         <div class="language">
    519. 

  519.                           <p class="aside-title">Swift</p>
    520. 

  520.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    521. 

  521. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
    522. 

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

  523.     <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>
    524. 

  524.     <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>
    525. 

  525.     <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>
    526. 

  526.     <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>
    527. 

  527.     <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>
    528. 

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

  529. 

  530.                         </div>
    531. 

  531.                       </div>
    532. 

  532.                       <div>
    533. 

  533.                         <h4>Parameters</h4>
    534. 

  534.                         <table class="graybox">
    535. 

  535.                           <tbody>
    536. 

  536.                             <tr>
    537. 

  537.                               <td>
    538. 

  538.                                 <code>
    539. 

  539.                                 <em>url</em>
    540. 

  540.                                 </code>
    541. 

  541.                               </td>
    542. 

  542.                               <td>
    543. 

  543.                                 <div>
    544. 

  544.                                   <p>The URL.</p>
    545. 

  545.                                 </div>
    546. 

  546.                               </td>
    547. 

  547.                             </tr>
    548. 

  548.                             <tr>
    549. 

  549.                               <td>
    550. 

  550.                                 <code>
    551. 

  551.                                 <em>method</em>
    552. 

  552.                                 </code>
    553. 

  553.                               </td>
    554. 

  554.                               <td>
    555. 

  555.                                 <div>
    556. 

  556.                                   <p>The HTTP method. <code>.get</code> by default.</p>
    557. 

  557.                                 </div>
    558. 

  558.                               </td>
    559. 

  559.                             </tr>
    560. 

  560.                             <tr>
    561. 

  561.                               <td>
    562. 

  562.                                 <code>
    563. 

  563.                                 <em>parameters</em>
    564. 

  564.                                 </code>
    565. 

  565.                               </td>
    566. 

  566.                               <td>
    567. 

  567.                                 <div>
    568. 

  568.                                   <p>The parameters. <code>nil</code> by default.</p>
    569. 

  569.                                 </div>
    570. 

  570.                               </td>
    571. 

  571.                             </tr>
    572. 

  572.                             <tr>
    573. 

  573.                               <td>
    574. 

  574.                                 <code>
    575. 

  575.                                 <em>encoding</em>
    576. 

  576.                                 </code>
    577. 

  577.                               </td>
    578. 

  578.                               <td>
    579. 

  579.                                 <div>
    580. 

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

  581.                                 </div>
    582. 

  582.                               </td>
    583. 

  583.                             </tr>
    584. 

  584.                             <tr>
    585. 

  585.                               <td>
    586. 

  586.                                 <code>
    587. 

  587.                                 <em>headers</em>
    588. 

  588.                                 </code>
    589. 

  589.                               </td>
    590. 

  590.                               <td>
    591. 

  591.                                 <div>
    592. 

  592.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    593. 

  593.                                 </div>
    594. 

  594.                               </td>
    595. 

  595.                             </tr>
    596. 

  596.                             <tr>
    597. 

  597.                               <td>
    598. 

  598.                                 <code>
    599. 

  599.                                 <em>destination</em>
    600. 

  600.                                 </code>
    601. 

  601.                               </td>
    602. 

  602.                               <td>
    603. 

  603.                                 <div>
    604. 

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

  605.                                 </div>
    606. 

  606.                               </td>
    607. 

  607.                             </tr>
    608. 

  608.                           </tbody>
    609. 

  609.                         </table>
    610. 

  610.                       </div>
    611. 

  611.                       <div>
    612. 

  612.                         <h4>Return Value</h4>
    613. 

  613.                         <p>The created <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    614. 

  614.                       </div>
    615. 

  615.                     </section>
    616. 

  616.                   </div>
    617. 

  617.                 </li>
    618. 

  618.                 <li class="item">
    619. 

  619.                   <div>
    620. 

  620.                     <code>
    621. 

  621.                     <a name="/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF"></a>
    622. 

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

  623.                     <a class="token" href="#/s:9Alamofire8download_2toAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationI0_AE0D7OptionsV7optionstAI_So17NSHTTPURLResponseCtcSgtF">download(_:to:)</a>
    624. 

  624.                     </code>
    625. 

  625.                   </div>
    626. 

  626.                   <div class="height-container">
    627. 

  627.                     <div class="pointer-container"></div>
    628. 

  628.                     <section class="section">
    629. 

  629.                       <div class="pointer"></div>
    630. 

  630.                       <div class="abstract">
    631. 

  631.                         <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
    632. 

  632. specified <code>urlRequest</code> and save them to the <code>destination</code>.</p>
    633. 

  633. 

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

  635. underlying URL session.</p>
    636. 

  636. 

  637.                       </div>
    638. 

  638.                       <div class="declaration">
    639. 

  639.                         <h4>Declaration</h4>
    640. 

  640.                         <div class="language">
    641. 

  641.                           <p class="aside-title">Swift</p>
    642. 

  642.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    643. 

  643. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
    644. 

  644.     <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>
    645. 

  645.     <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>
    646. 

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

  647. 

  648.                         </div>
    649. 

  649.                       </div>
    650. 

  650.                       <div>
    651. 

  651.                         <h4>Parameters</h4>
    652. 

  652.                         <table class="graybox">
    653. 

  653.                           <tbody>
    654. 

  654.                             <tr>
    655. 

  655.                               <td>
    656. 

  656.                                 <code>
    657. 

  657.                                 <em>urlRequest</em>
    658. 

  658.                                 </code>
    659. 

  659.                               </td>
    660. 

  660.                               <td>
    661. 

  661.                                 <div>
    662. 

  662.                                   <p>The URL request.</p>
    663. 

  663.                                 </div>
    664. 

  664.                               </td>
    665. 

  665.                             </tr>
    666. 

  666.                             <tr>
    667. 

  667.                               <td>
    668. 

  668.                                 <code>
    669. 

  669.                                 <em>destination</em>
    670. 

  670.                                 </code>
    671. 

  671.                               </td>
    672. 

  672.                               <td>
    673. 

  673.                                 <div>
    674. 

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

  675.                                 </div>
    676. 

  676.                               </td>
    677. 

  677.                             </tr>
    678. 

  678.                           </tbody>
    679. 

  679.                         </table>
    680. 

  680.                       </div>
    681. 

  681.                       <div>
    682. 

  682.                         <h4>Return Value</h4>
    683. 

  683.                         <p>The created <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    684. 

  684.                       </div>
    685. 

  685.                     </section>
    686. 

  686.                   </div>
    687. 

  687.                 </li>
    688. 

  688.               </ul>
    689. 

  689.             </div>
    690. 

  690.             <div class="task-group">
    691. 

  691.               <div class="task-name-container">
    692. 

  692.                 <a name="/Resume%20Data"></a>
    693. 

  693.                 <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
    694. 

  694.                 <a href="#/Resume%20Data">
    695. 

  695.                   <h3 class="section-name">Resume Data</h3>
    696. 

  696.                 </a>
    697. 

  697.               </div>
    698. 

  698.               <ul class="item-container">
    699. 

  699.                 <li class="item">
    700. 

  700.                   <div>
    701. 

  701.                     <code>
    702. 

  702.                     <a name="/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF"></a>
    703. 

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

  704.                     <a class="token" href="#/s:9Alamofire8download12resumingWith2toAA15DownloadRequestC10Foundation4DataV_AG3URLV011destinationJ0_AF0F7OptionsV7optionstAK_So17NSHTTPURLResponseCtcSgtF">download(resumingWith:to:)</a>
    705. 

  705.                     </code>
    706. 

  706.                   </div>
    707. 

  707.                   <div class="height-container">
    708. 

  708.                     <div class="pointer-container"></div>
    709. 

  709.                     <section class="section">
    710. 

  710.                       <div class="pointer"></div>
    711. 

  711.                       <div class="abstract">
    712. 

  712.                         <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
    713. 

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

  714. 

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

  716. underlying URL session.</p>
    717. 

  717. 

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

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

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

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

  722. 

  723. <ul>
    724. 

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

  725. </ul>
    726. 

  726. 

  727.                       </div>
    728. 

  728.                       <div class="declaration">
    729. 

  729.                         <h4>Declaration</h4>
    730. 

  730.                         <div class="language">
    731. 

  731.                           <p class="aside-title">Swift</p>
    732. 

  732.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    733. 

  733. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span>
    734. 

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

  735.     <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>
    736. 

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

  737. 

  738.                         </div>
    739. 

  739.                       </div>
    740. 

  740.                       <div>
    741. 

  741.                         <h4>Parameters</h4>
    742. 

  742.                         <table class="graybox">
    743. 

  743.                           <tbody>
    744. 

  744.                             <tr>
    745. 

  745.                               <td>
    746. 

  746.                                 <code>
    747. 

  747.                                 <em>resumeData</em>
    748. 

  748.                                 </code>
    749. 

  749.                               </td>
    750. 

  750.                               <td>
    751. 

  751.                                 <div>
    752. 

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

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

  754.                  information.</p>
    755. 

  755.                                 </div>
    756. 

  756.                               </td>
    757. 

  757.                             </tr>
    758. 

  758.                             <tr>
    759. 

  759.                               <td>
    760. 

  760.                                 <code>
    761. 

  761.                                 <em>destination</em>
    762. 

  762.                                 </code>
    763. 

  763.                               </td>
    764. 

  764.                               <td>
    765. 

  765.                                 <div>
    766. 

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

  767.                                 </div>
    768. 

  768.                               </td>
    769. 

  769.                             </tr>
    770. 

  770.                           </tbody>
    771. 

  771.                         </table>
    772. 

  772.                       </div>
    773. 

  773.                       <div>
    774. 

  774.                         <h4>Return Value</h4>
    775. 

  775.                         <p>The created <code><a href="Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    776. 

  776.                       </div>
    777. 

  777.                     </section>
    778. 

  778.                   </div>
    779. 

  779.                 </li>
    780. 

  780.               </ul>
    781. 

  781.             </div>
    782. 

  782.             <div class="task-group">
    783. 

  783.               <div class="task-name-container">
    784. 

  784.                 <a name="/File"></a>
    785. 

  785.                 <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
    786. 

  786.                 <a href="#/File">
    787. 

  787.                   <h3 class="section-name">File</h3>
    788. 

  788.                 </a>
    789. 

  789.               </div>
    790. 

  790.               <ul class="item-container">
    791. 

  791.                 <li class="item">
    792. 

  792.                   <div>
    793. 

  793.                     <code>
    794. 

  794.                     <a name="/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF"></a>
    795. 

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

  796.                     <a class="token" href="#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
    797. 

  797.                     </code>
    798. 

  798.                   </div>
    799. 

  799.                   <div class="height-container">
    800. 

  800.                     <div class="pointer-container"></div>
    801. 

  801.                     <section class="section">
    802. 

  802.                       <div class="pointer"></div>
    803. 

  803.                       <div class="abstract">
    804. 

  804.                         <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>
    805. 

  805. for uploading the <code>file</code>.</p>
    806. 

  806. 

  807.                       </div>
    808. 

  808.                       <div class="declaration">
    809. 

  809.                         <h4>Declaration</h4>
    810. 

  810.                         <div class="language">
    811. 

  811.                           <p class="aside-title">Swift</p>
    812. 

  812.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    813. 

  813. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    814. 

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

  815.     <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>
    816. 

  816.     <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>
    817. 

  817.     <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>
    818. 

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

  819. 

  820.                         </div>
    821. 

  821.                       </div>
    822. 

  822.                       <div>
    823. 

  823.                         <h4>Parameters</h4>
    824. 

  824.                         <table class="graybox">
    825. 

  825.                           <tbody>
    826. 

  826.                             <tr>
    827. 

  827.                               <td>
    828. 

  828.                                 <code>
    829. 

  829.                                 <em>file</em>
    830. 

  830.                                 </code>
    831. 

  831.                               </td>
    832. 

  832.                               <td>
    833. 

  833.                                 <div>
    834. 

  834.                                   <p>The file to upload.</p>
    835. 

  835.                                 </div>
    836. 

  836.                               </td>
    837. 

  837.                             </tr>
    838. 

  838.                             <tr>
    839. 

  839.                               <td>
    840. 

  840.                                 <code>
    841. 

  841.                                 <em>url</em>
    842. 

  842.                                 </code>
    843. 

  843.                               </td>
    844. 

  844.                               <td>
    845. 

  845.                                 <div>
    846. 

  846.                                   <p>The URL.</p>
    847. 

  847.                                 </div>
    848. 

  848.                               </td>
    849. 

  849.                             </tr>
    850. 

  850.                             <tr>
    851. 

  851.                               <td>
    852. 

  852.                                 <code>
    853. 

  853.                                 <em>method</em>
    854. 

  854.                                 </code>
    855. 

  855.                               </td>
    856. 

  856.                               <td>
    857. 

  857.                                 <div>
    858. 

  858.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    859. 

  859.                                 </div>
    860. 

  860.                               </td>
    861. 

  861.                             </tr>
    862. 

  862.                             <tr>
    863. 

  863.                               <td>
    864. 

  864.                                 <code>
    865. 

  865.                                 <em>headers</em>
    866. 

  866.                                 </code>
    867. 

  867.                               </td>
    868. 

  868.                               <td>
    869. 

  869.                                 <div>
    870. 

  870.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    871. 

  871.                                 </div>
    872. 

  872.                               </td>
    873. 

  873.                             </tr>
    874. 

  874.                           </tbody>
    875. 

  875.                         </table>
    876. 

  876.                       </div>
    877. 

  877.                       <div>
    878. 

  878.                         <h4>Return Value</h4>
    879. 

  879.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    880. 

  880.                       </div>
    881. 

  881.                     </section>
    882. 

  882.                   </div>
    883. 

  883.                 </li>
    884. 

  884.                 <li class="item">
    885. 

  885.                   <div>
    886. 

  886.                     <code>
    887. 

  887.                     <a name="/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF"></a>
    888. 

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

  889.                     <a class="token" href="#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
    890. 

  890.                     </code>
    891. 

  891.                   </div>
    892. 

  892.                   <div class="height-container">
    893. 

  893.                     <div class="pointer-container"></div>
    894. 

  894.                     <section class="section">
    895. 

  895.                       <div class="pointer"></div>
    896. 

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

  897.                         <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
    898. 

  898. uploading the <code>file</code>.</p>
    899. 

  899. 

  900.                       </div>
    901. 

  901.                       <div class="declaration">
    902. 

  902.                         <h4>Declaration</h4>
    903. 

  903.                         <div class="language">
    904. 

  904.                           <p class="aside-title">Swift</p>
    905. 

  905.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    906. 

  906. <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>
    907. 

  907. 

  908.                         </div>
    909. 

  909.                       </div>
    910. 

  910.                       <div>
    911. 

  911.                         <h4>Parameters</h4>
    912. 

  912.                         <table class="graybox">
    913. 

  913.                           <tbody>
    914. 

  914.                             <tr>
    915. 

  915.                               <td>
    916. 

  916.                                 <code>
    917. 

  917.                                 <em>file</em>
    918. 

  918.                                 </code>
    919. 

  919.                               </td>
    920. 

  920.                               <td>
    921. 

  921.                                 <div>
    922. 

  922.                                   <p>The file to upload.</p>
    923. 

  923.                                 </div>
    924. 

  924.                               </td>
    925. 

  925.                             </tr>
    926. 

  926.                             <tr>
    927. 

  927.                               <td>
    928. 

  928.                                 <code>
    929. 

  929.                                 <em>urlRequest</em>
    930. 

  930.                                 </code>
    931. 

  931.                               </td>
    932. 

  932.                               <td>
    933. 

  933.                                 <div>
    934. 

  934.                                   <p>The URL request.</p>
    935. 

  935.                                 </div>
    936. 

  936.                               </td>
    937. 

  937.                             </tr>
    938. 

  938.                           </tbody>
    939. 

  939.                         </table>
    940. 

  940.                       </div>
    941. 

  941.                       <div>
    942. 

  942.                         <h4>Return Value</h4>
    943. 

  943.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    944. 

  944.                       </div>
    945. 

  945.                     </section>
    946. 

  946.                   </div>
    947. 

  947.                 </li>
    948. 

  948.               </ul>
    949. 

  949.             </div>
    950. 

  950.             <div class="task-group">
    951. 

  951.               <div class="task-name-container">
    952. 

  952.                 <a name="/Data"></a>
    953. 

  953.                 <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
    954. 

  954.                 <a href="#/Data">
    955. 

  955.                   <h3 class="section-name">Data</h3>
    956. 

  956.                 </a>
    957. 

  957.               </div>
    958. 

  958.               <ul class="item-container">
    959. 

  959.                 <li class="item">
    960. 

  960.                   <div>
    961. 

  961.                     <code>
    962. 

  962.                     <a name="/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF"></a>
    963. 

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

  964.                     <a class="token" href="#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
    965. 

  965.                     </code>
    966. 

  966.                   </div>
    967. 

  967.                   <div class="height-container">
    968. 

  968.                     <div class="pointer-container"></div>
    969. 

  969.                     <section class="section">
    970. 

  970.                       <div class="pointer"></div>
    971. 

  971.                       <div class="abstract">
    972. 

  972.                         <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>
    973. 

  973. for uploading the <code>data</code>.</p>
    974. 

  974. 

  975.                       </div>
    976. 

  976.                       <div class="declaration">
    977. 

  977.                         <h4>Declaration</h4>
    978. 

  978.                         <div class="language">
    979. 

  979.                           <p class="aside-title">Swift</p>
    980. 

  980.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    981. 

  981. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    982. 

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

  983.     <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>
    984. 

  984.     <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>
    985. 

  985.     <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>
    986. 

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

  987. 

  988.                         </div>
    989. 

  989.                       </div>
    990. 

  990.                       <div>
    991. 

  991.                         <h4>Parameters</h4>
    992. 

  992.                         <table class="graybox">
    993. 

  993.                           <tbody>
    994. 

  994.                             <tr>
    995. 

  995.                               <td>
    996. 

  996.                                 <code>
    997. 

  997.                                 <em>data</em>
    998. 

  998.                                 </code>
    999. 

  999.                               </td>
    1000. 

  1000.                               <td>
    1001. 

  1001.                                 <div>
    1002. 

  1002.                                   <p>The data to upload.</p>
    1003. 

  1003.                                 </div>
    1004. 

  1004.                               </td>
    1005. 

  1005.                             </tr>
    1006. 

  1006.                             <tr>
    1007. 

  1007.                               <td>
    1008. 

  1008.                                 <code>
    1009. 

  1009.                                 <em>url</em>
    1010. 

  1010.                                 </code>
    1011. 

  1011.                               </td>
    1012. 

  1012.                               <td>
    1013. 

  1013.                                 <div>
    1014. 

  1014.                                   <p>The URL.</p>
    1015. 

  1015.                                 </div>
    1016. 

  1016.                               </td>
    1017. 

  1017.                             </tr>
    1018. 

  1018.                             <tr>
    1019. 

  1019.                               <td>
    1020. 

  1020.                                 <code>
    1021. 

  1021.                                 <em>method</em>
    1022. 

  1022.                                 </code>
    1023. 

  1023.                               </td>
    1024. 

  1024.                               <td>
    1025. 

  1025.                                 <div>
    1026. 

  1026.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    1027. 

  1027.                                 </div>
    1028. 

  1028.                               </td>
    1029. 

  1029.                             </tr>
    1030. 

  1030.                             <tr>
    1031. 

  1031.                               <td>
    1032. 

  1032.                                 <code>
    1033. 

  1033.                                 <em>headers</em>
    1034. 

  1034.                                 </code>
    1035. 

  1035.                               </td>
    1036. 

  1036.                               <td>
    1037. 

  1037.                                 <div>
    1038. 

  1038.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    1039. 

  1039.                                 </div>
    1040. 

  1040.                               </td>
    1041. 

  1041.                             </tr>
    1042. 

  1042.                           </tbody>
    1043. 

  1043.                         </table>
    1044. 

  1044.                       </div>
    1045. 

  1045.                       <div>
    1046. 

  1046.                         <h4>Return Value</h4>
    1047. 

  1047.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1048. 

  1048.                       </div>
    1049. 

  1049.                     </section>
    1050. 

  1050.                   </div>
    1051. 

  1051.                 </li>
    1052. 

  1052.                 <li class="item">
    1053. 

  1053.                   <div>
    1054. 

  1054.                     <code>
    1055. 

  1055.                     <a name="/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF"></a>
    1056. 

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

  1057.                     <a class="token" href="#/s:9Alamofire6upload_4withAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
    1058. 

  1058.                     </code>
    1059. 

  1059.                   </div>
    1060. 

  1060.                   <div class="height-container">
    1061. 

  1061.                     <div class="pointer-container"></div>
    1062. 

  1062.                     <section class="section">
    1063. 

  1063.                       <div class="pointer"></div>
    1064. 

  1064.                       <div class="abstract">
    1065. 

  1065.                         <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
    1066. 

  1066. uploading the <code>data</code>.</p>
    1067. 

  1067. 

  1068.                       </div>
    1069. 

  1069.                       <div class="declaration">
    1070. 

  1070.                         <h4>Declaration</h4>
    1071. 

  1071.                         <div class="language">
    1072. 

  1072.                           <p class="aside-title">Swift</p>
    1073. 

  1073.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    1074. 

  1074. <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>
    1075. 

  1075. 

  1076.                         </div>
    1077. 

  1077.                       </div>
    1078. 

  1078.                       <div>
    1079. 

  1079.                         <h4>Parameters</h4>
    1080. 

  1080.                         <table class="graybox">
    1081. 

  1081.                           <tbody>
    1082. 

  1082.                             <tr>
    1083. 

  1083.                               <td>
    1084. 

  1084.                                 <code>
    1085. 

  1085.                                 <em>data</em>
    1086. 

  1086.                                 </code>
    1087. 

  1087.                               </td>
    1088. 

  1088.                               <td>
    1089. 

  1089.                                 <div>
    1090. 

  1090.                                   <p>The data to upload.</p>
    1091. 

  1091.                                 </div>
    1092. 

  1092.                               </td>
    1093. 

  1093.                             </tr>
    1094. 

  1094.                             <tr>
    1095. 

  1095.                               <td>
    1096. 

  1096.                                 <code>
    1097. 

  1097.                                 <em>urlRequest</em>
    1098. 

  1098.                                 </code>
    1099. 

  1099.                               </td>
    1100. 

  1100.                               <td>
    1101. 

  1101.                                 <div>
    1102. 

  1102.                                   <p>The URL request.</p>
    1103. 

  1103.                                 </div>
    1104. 

  1104.                               </td>
    1105. 

  1105.                             </tr>
    1106. 

  1106.                           </tbody>
    1107. 

  1107.                         </table>
    1108. 

  1108.                       </div>
    1109. 

  1109.                       <div>
    1110. 

  1110.                         <h4>Return Value</h4>
    1111. 

  1111.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1112. 

  1112.                       </div>
    1113. 

  1113.                     </section>
    1114. 

  1114.                   </div>
    1115. 

  1115.                 </li>
    1116. 

  1116.               </ul>
    1117. 

  1117.             </div>
    1118. 

  1118.             <div class="task-group">
    1119. 

  1119.               <div class="task-name-container">
    1120. 

  1120.                 <a name="/InputStream"></a>
    1121. 

  1121.                 <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
    1122. 

  1122.                 <a href="#/InputStream">
    1123. 

  1123.                   <h3 class="section-name">InputStream</h3>
    1124. 

  1124.                 </a>
    1125. 

  1125.               </div>
    1126. 

  1126.               <ul class="item-container">
    1127. 

  1127.                 <li class="item">
    1128. 

  1128.                   <div>
    1129. 

  1129.                     <code>
    1130. 

  1130.                     <a name="/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF"></a>
    1131. 

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

  1132.                     <a class="token" href="#/s:9Alamofire6upload_2to6method7headersAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgtF">upload(_:to:method:headers:)</a>
    1133. 

  1133.                     </code>
    1134. 

  1134.                   </div>
    1135. 

  1135.                   <div class="height-container">
    1136. 

  1136.                     <div class="pointer-container"></div>
    1137. 

  1137.                     <section class="section">
    1138. 

  1138.                       <div class="pointer"></div>
    1139. 

  1139.                       <div class="abstract">
    1140. 

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

  1141. for uploading the <code>stream</code>.</p>
    1142. 

  1142. 

  1143.                       </div>
    1144. 

  1144.                       <div class="declaration">
    1145. 

  1145.                         <h4>Declaration</h4>
    1146. 

  1146.                         <div class="language">
    1147. 

  1147.                           <p class="aside-title">Swift</p>
    1148. 

  1148.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    1149. 

  1149. <span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span>
    1150. 

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

  1151.     <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>
    1152. 

  1152.     <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>
    1153. 

  1153.     <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>
    1154. 

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

  1155. 

  1156.                         </div>
    1157. 

  1157.                       </div>
    1158. 

  1158.                       <div>
    1159. 

  1159.                         <h4>Parameters</h4>
    1160. 

  1160.                         <table class="graybox">
    1161. 

  1161.                           <tbody>
    1162. 

  1162.                             <tr>
    1163. 

  1163.                               <td>
    1164. 

  1164.                                 <code>
    1165. 

  1165.                                 <em>stream</em>
    1166. 

  1166.                                 </code>
    1167. 

  1167.                               </td>
    1168. 

  1168.                               <td>
    1169. 

  1169.                                 <div>
    1170. 

  1170.                                   <p>The stream to upload.</p>
    1171. 

  1171.                                 </div>
    1172. 

  1172.                               </td>
    1173. 

  1173.                             </tr>
    1174. 

  1174.                             <tr>
    1175. 

  1175.                               <td>
    1176. 

  1176.                                 <code>
    1177. 

  1177.                                 <em>url</em>
    1178. 

  1178.                                 </code>
    1179. 

  1179.                               </td>
    1180. 

  1180.                               <td>
    1181. 

  1181.                                 <div>
    1182. 

  1182.                                   <p>The URL.</p>
    1183. 

  1183.                                 </div>
    1184. 

  1184.                               </td>
    1185. 

  1185.                             </tr>
    1186. 

  1186.                             <tr>
    1187. 

  1187.                               <td>
    1188. 

  1188.                                 <code>
    1189. 

  1189.                                 <em>method</em>
    1190. 

  1190.                                 </code>
    1191. 

  1191.                               </td>
    1192. 

  1192.                               <td>
    1193. 

  1193.                                 <div>
    1194. 

  1194.                                   <p>The HTTP method. <code>.post</code> by default.</p>
    1195. 

  1195.                                 </div>
    1196. 

  1196.                               </td>
    1197. 

  1197.                             </tr>
    1198. 

  1198.                             <tr>
    1199. 

  1199.                               <td>
    1200. 

  1200.                                 <code>
    1201. 

  1201.                                 <em>headers</em>
    1202. 

  1202.                                 </code>
    1203. 

  1203.                               </td>
    1204. 

  1204.                               <td>
    1205. 

  1205.                                 <div>
    1206. 

  1206.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    1207. 

  1207.                                 </div>
    1208. 

  1208.                               </td>
    1209. 

  1209.                             </tr>
    1210. 

  1210.                           </tbody>
    1211. 

  1211.                         </table>
    1212. 

  1212.                       </div>
    1213. 

  1213.                       <div>
    1214. 

  1214.                         <h4>Return Value</h4>
    1215. 

  1215.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1216. 

  1216.                       </div>
    1217. 

  1217.                     </section>
    1218. 

  1218.                   </div>
    1219. 

  1219.                 </li>
    1220. 

  1220.                 <li class="item">
    1221. 

  1221.                   <div>
    1222. 

  1222.                     <code>
    1223. 

  1223.                     <a name="/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF"></a>
    1224. 

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

  1225.                     <a class="token" href="#/s:9Alamofire6upload_4withAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_ptF">upload(_:with:)</a>
    1226. 

  1226.                     </code>
    1227. 

  1227.                   </div>
    1228. 

  1228.                   <div class="height-container">
    1229. 

  1229.                     <div class="pointer-container"></div>
    1230. 

  1230.                     <section class="section">
    1231. 

  1231.                       <div class="pointer"></div>
    1232. 

  1232.                       <div class="abstract">
    1233. 

  1233.                         <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
    1234. 

  1234. uploading the <code>stream</code>.</p>
    1235. 

  1235. 

  1236.                       </div>
    1237. 

  1237.                       <div class="declaration">
    1238. 

  1238.                         <h4>Declaration</h4>
    1239. 

  1239.                         <div class="language">
    1240. 

  1240.                           <p class="aside-title">Swift</p>
    1241. 

  1241.                           <pre class="highlight swift"><code><span class="kd">@discardableResult</span>
    1242. 

  1242. <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>
    1243. 

  1243. 

  1244.                         </div>
    1245. 

  1245.                       </div>
    1246. 

  1246.                       <div>
    1247. 

  1247.                         <h4>Parameters</h4>
    1248. 

  1248.                         <table class="graybox">
    1249. 

  1249.                           <tbody>
    1250. 

  1250.                             <tr>
    1251. 

  1251.                               <td>
    1252. 

  1252.                                 <code>
    1253. 

  1253.                                 <em>urlRequest</em>
    1254. 

  1254.                                 </code>
    1255. 

  1255.                               </td>
    1256. 

  1256.                               <td>
    1257. 

  1257.                                 <div>
    1258. 

  1258.                                   <p>The URL request.</p>
    1259. 

  1259.                                 </div>
    1260. 

  1260.                               </td>
    1261. 

  1261.                             </tr>
    1262. 

  1262.                             <tr>
    1263. 

  1263.                               <td>
    1264. 

  1264.                                 <code>
    1265. 

  1265.                                 <em>stream</em>
    1266. 

  1266.                                 </code>
    1267. 

  1267.                               </td>
    1268. 

  1268.                               <td>
    1269. 

  1269.                                 <div>
    1270. 

  1270.                                   <p>The stream to upload.</p>
    1271. 

  1271.                                 </div>
    1272. 

  1272.                               </td>
    1273. 

  1273.                             </tr>
    1274. 

  1274.                           </tbody>
    1275. 

  1275.                         </table>
    1276. 

  1276.                       </div>
    1277. 

  1277.                       <div>
    1278. 

  1278.                         <h4>Return Value</h4>
    1279. 

  1279.                         <p>The created <code><a href="Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1280. 

  1280.                       </div>
    1281. 

  1281.                     </section>
    1282. 

  1282.                   </div>
    1283. 

  1283.                 </li>
    1284. 

  1284.               </ul>
    1285. 

  1285.             </div>
    1286. 

  1286.             <div class="task-group">
    1287. 

  1287.               <div class="task-name-container">
    1288. 

  1288.                 <a name="/MultipartFormData"></a>
    1289. 

  1289.                 <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
    1290. 

  1290.                 <a href="#/MultipartFormData">
    1291. 

  1291.                   <h3 class="section-name">MultipartFormData</h3>
    1292. 

  1292.                 </a>
    1293. 

  1293.               </div>
    1294. 

  1294.               <ul class="item-container">
    1295. 

  1295.                 <li class="item">
    1296. 

  1296.                   <div>
    1297. 

  1297.                     <code>
    1298. 

  1298.                     <a name="/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF"></a>
    1299. 

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

  1300.                     <a class="token" href="#/s:9Alamofire6upload17multipartFormData14usingThreshold2to6method7headers18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOSDyS2SGSgyAA14SessionManagerC0mdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
    1301. 

  1301.                     </code>
    1302. 

  1302.                   </div>
    1303. 

  1303.                   <div class="height-container">
    1304. 

  1304.                     <div class="pointer-container"></div>
    1305. 

  1305.                     <section class="section">
    1306. 

  1306.                       <div class="pointer"></div>
    1307. 

  1307.                       <div class="abstract">
    1308. 

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

  1309. <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>
    1310. 

  1310. 

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

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

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

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

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

  1316. used for larger payloads such as video content.</p>
    1317. 

  1317. 

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

  1319. 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>,
    1320. 

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

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

  1322. technique was used.</p>
    1323. 

  1323. 

  1324.                       </div>
    1325. 

  1325.                       <div class="declaration">
    1326. 

  1326.                         <h4>Declaration</h4>
    1327. 

  1327.                         <div class="language">
    1328. 

  1328.                           <p class="aside-title">Swift</p>
    1329. 

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

  1330.     <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>
    1331. 

  1331.     <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>
    1332. 

  1332.     <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>
    1333. 

  1333.     <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>
    1334. 

  1334.     <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>
    1335. 

  1335.     <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>
    1336. 

  1336. 

  1337.                         </div>
    1338. 

  1338.                       </div>
    1339. 

  1339.                       <div>
    1340. 

  1340.                         <h4>Parameters</h4>
    1341. 

  1341.                         <table class="graybox">
    1342. 

  1342.                           <tbody>
    1343. 

  1343.                             <tr>
    1344. 

  1344.                               <td>
    1345. 

  1345.                                 <code>
    1346. 

  1346.                                 <em>multipartFormData</em>
    1347. 

  1347.                                 </code>
    1348. 

  1348.                               </td>
    1349. 

  1349.                               <td>
    1350. 

  1350.                                 <div>
    1351. 

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

  1352.                                 </div>
    1353. 

  1353.                               </td>
    1354. 

  1354.                             </tr>
    1355. 

  1355.                             <tr>
    1356. 

  1356.                               <td>
    1357. 

  1357.                                 <code>
    1358. 

  1358.                                 <em>encodingMemoryThreshold</em>
    1359. 

  1359.                                 </code>
    1360. 

  1360.                               </td>
    1361. 

  1361.                               <td>
    1362. 

  1362.                                 <div>
    1363. 

  1363.                                   <p>The encoding memory threshold in bytes.
    1364. 

  1364.                                  <code>multipartFormDataEncodingMemoryThreshold</code> by default.</p>
    1365. 

  1365.                                 </div>
    1366. 

  1366.                               </td>
    1367. 

  1367.                             </tr>
    1368. 

  1368.                             <tr>
    1369. 

  1369.                               <td>
    1370. 

  1370.                                 <code>
    1371. 

  1371.                                 <em>url</em>
    1372. 

  1372.                                 </code>
    1373. 

  1373.                               </td>
    1374. 

  1374.                               <td>
    1375. 

  1375.                                 <div>
    1376. 

  1376.                                   <p>The URL.</p>
    1377. 

  1377.                                 </div>
    1378. 

  1378.                               </td>
    1379. 

  1379.                             </tr>
    1380. 

  1380.                             <tr>
    1381. 

  1381.                               <td>
    1382. 

  1382.                                 <code>
    1383. 

  1383.                                 <em>method</em>
    1384. 

  1384.                                 </code>
    1385. 

  1385.                               </td>
    1386. 

  1386.                               <td>
    1387. 

  1387.                                 <div>
    1388. 

  1388.                                   <p>The HTTP method. <code>.post</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>headers</em>
    1396. 

  1396.                                 </code>
    1397. 

  1397.                               </td>
    1398. 

  1398.                               <td>
    1399. 

  1399.                                 <div>
    1400. 

  1400.                                   <p>The HTTP headers. <code>nil</code> by default.</p>
    1401. 

  1401.                                 </div>
    1402. 

  1402.                               </td>
    1403. 

  1403.                             </tr>
    1404. 

  1404.                             <tr>
    1405. 

  1405.                               <td>
    1406. 

  1406.                                 <code>
    1407. 

  1407.                                 <em>encodingCompletion</em>
    1408. 

  1408.                                 </code>
    1409. 

  1409.                               </td>
    1410. 

  1410.                               <td>
    1411. 

  1411.                                 <div>
    1412. 

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

  1413.                                 </div>
    1414. 

  1414.                               </td>
    1415. 

  1415.                             </tr>
    1416. 

  1416.                           </tbody>
    1417. 

  1417.                         </table>
    1418. 

  1418.                       </div>
    1419. 

  1419.                     </section>
    1420. 

  1420.                   </div>
    1421. 

  1421.                 </li>
    1422. 

  1422.                 <li class="item">
    1423. 

  1423.                   <div>
    1424. 

  1424.                     <code>
    1425. 

  1425.                     <a name="/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF"></a>
    1426. 

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

  1427.                     <a class="token" href="#/s:9Alamofire6upload17multipartFormData14usingThreshold4with18encodingCompletionyyAA09MultipartdE0Cc_s6UInt64VAA21URLRequestConvertible_pyAA14SessionManagerC0kdE14EncodingResultOcSgtF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
    1428. 

  1428.                     </code>
    1429. 

  1429.                   </div>
    1430. 

  1430.                   <div class="height-container">
    1431. 

  1431.                     <div class="pointer-container"></div>
    1432. 

  1432.                     <section class="section">
    1433. 

  1433.                       <div class="pointer"></div>
    1434. 

  1434.                       <div class="abstract">
    1435. 

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

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

  1437. 

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

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

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

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

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

  1443. used for larger payloads such as video content.</p>
    1444. 

  1444. 

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

  1446. 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>,
    1447. 

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

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

  1449. technique was used.</p>
    1450. 

  1450. 

  1451.                       </div>
    1452. 

  1452.                       <div class="declaration">
    1453. 

  1453.                         <h4>Declaration</h4>
    1454. 

  1454.                         <div class="language">
    1455. 

  1455.                           <p class="aside-title">Swift</p>
    1456. 

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

  1457.     <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>
    1458. 

  1458.     <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>
    1459. 

  1459.     <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>
    1460. 

  1460.     <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>
    1461. 

  1461. 

  1462.                         </div>
    1463. 

  1463.                       </div>
    1464. 

  1464.                       <div>
    1465. 

  1465.                         <h4>Parameters</h4>
    1466. 

  1466.                         <table class="graybox">
    1467. 

  1467.                           <tbody>
    1468. 

  1468.                             <tr>
    1469. 

  1469.                               <td>
    1470. 

  1470.                                 <code>
    1471. 

  1471.                                 <em>multipartFormData</em>
    1472. 

  1472.                                 </code>
    1473. 

  1473.                               </td>
    1474. 

  1474.                               <td>
    1475. 

  1475.                                 <div>
    1476. 

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

  1477.                                 </div>
    1478. 

  1478.                               </td>
    1479. 

  1479.                             </tr>
    1480. 

  1480.                             <tr>
    1481. 

  1481.                               <td>
    1482. 

  1482.                                 <code>
    1483. 

  1483.                                 <em>encodingMemoryThreshold</em>
    1484. 

  1484.                                 </code>
    1485. 

  1485.                               </td>
    1486. 

  1486.                               <td>
    1487. 

  1487.                                 <div>
    1488. 

  1488.                                   <p>The encoding memory threshold in bytes.
    1489. 

  1489.                                  <code>multipartFormDataEncodingMemoryThreshold</code> by default.</p>
    1490. 

  1490.                                 </div>
    1491. 

  1491.                               </td>
    1492. 

  1492.                             </tr>
    1493. 

  1493.                             <tr>
    1494. 

  1494.                               <td>
    1495. 

  1495.                                 <code>
    1496. 

  1496.                                 <em>urlRequest</em>
    1497. 

  1497.                                 </code>
    1498. 

  1498.                               </td>
    1499. 

  1499.                               <td>
    1500. 

  1500.                                 <div>
    1501. 

  1501.                                   <p>The URL request.</p>
    1502. 

  1502.                                 </div>
    1503. 

  1503.                               </td>
    1504. 

  1504.                             </tr>
    1505. 

  1505.                             <tr>
    1506. 

  1506.                               <td>
    1507. 

  1507.                                 <code>
    1508. 

  1508.                                 <em>encodingCompletion</em>
    1509. 

  1509.                                 </code>
    1510. 

  1510.                               </td>
    1511. 

  1511.                               <td>
    1512. 

  1512.                                 <div>
    1513. 

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

  1514.                                 </div>
    1515. 

  1515.                               </td>
    1516. 

  1516.                             </tr>
    1517. 

  1517.                           </tbody>
    1518. 

  1518.                         </table>
    1519. 

  1519.                       </div>
    1520. 

  1520.                     </section>
    1521. 

  1521.                   </div>
    1522. 

  1522.                 </li>
    1523. 

  1523.               </ul>
    1524. 

  1524.             </div>
    1525. 

  1525.             <div class="task-group">
    1526. 

  1526.               <div class="task-name-container">
    1527. 

  1527.                 <a name="/Hostname%20and%20Port"></a>
    1528. 

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

  1529.                 <a href="#/Hostname%20and%20Port">
    1530. 

  1530.                   <h3 class="section-name">Hostname and Port</h3>
    1531. 

  1531.                 </a>
    1532. 

  1532.               </div>
    1533. 

  1533.               <ul class="item-container">
    1534. 

  1534.                 <li class="item">
    1535. 

  1535.                   <div>
    1536. 

  1536.                     <code>
    1537. 

  1537.                     <a name="/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF"></a>
    1538. 

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

  1539.                     <a class="token" href="#/s:9Alamofire6stream12withHostName4portAA13StreamRequestCSS_SitF">stream(withHostName:port:)</a>
    1540. 

  1540.                     </code>
    1541. 

  1541.                   </div>
    1542. 

  1542.                   <div class="height-container">
    1543. 

  1543.                     <div class="pointer-container"></div>
    1544. 

  1544.                     <section class="section">
    1545. 

  1545.                       <div class="pointer"></div>
    1546. 

  1546.                       <div class="abstract">
    1547. 

  1547.                         <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>
    1548. 

  1548. and <code>port</code>.</p>
    1549. 

  1549. 

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

  1551. 

  1552.                       </div>
    1553. 

  1553.                       <div class="declaration">
    1554. 

  1554.                         <h4>Declaration</h4>
    1555. 

  1555.                         <div class="language">
    1556. 

  1556.                           <p class="aside-title">Swift</p>
    1557. 

  1557.                           <pre class="highlight swift"><code><span class="kd">@available(iOS 9.0, OSX 10.11, tvOS 9.0, *)</span>
    1558. 

  1558. <span class="kd">@discardableResult</span>
    1559. 

  1559. <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>
    1560. 

  1560. 

  1561.                         </div>
    1562. 

  1562.                       </div>
    1563. 

  1563.                       <div>
    1564. 

  1564.                         <h4>Parameters</h4>
    1565. 

  1565.                         <table class="graybox">
    1566. 

  1566.                           <tbody>
    1567. 

  1567.                             <tr>
    1568. 

  1568.                               <td>
    1569. 

  1569.                                 <code>
    1570. 

  1570.                                 <em>hostName</em>
    1571. 

  1571.                                 </code>
    1572. 

  1572.                               </td>
    1573. 

  1573.                               <td>
    1574. 

  1574.                                 <div>
    1575. 

  1575.                                   <p>The hostname of the server to connect to.</p>
    1576. 

  1576.                                 </div>
    1577. 

  1577.                               </td>
    1578. 

  1578.                             </tr>
    1579. 

  1579.                             <tr>
    1580. 

  1580.                               <td>
    1581. 

  1581.                                 <code>
    1582. 

  1582.                                 <em>port</em>
    1583. 

  1583.                                 </code>
    1584. 

  1584.                               </td>
    1585. 

  1585.                               <td>
    1586. 

  1586.                                 <div>
    1587. 

  1587.                                   <p>The port of the server to connect to.</p>
    1588. 

  1588.                                 </div>
    1589. 

  1589.                               </td>
    1590. 

  1590.                             </tr>
    1591. 

  1591.                           </tbody>
    1592. 

  1592.                         </table>
    1593. 

  1593.                       </div>
    1594. 

  1594.                       <div>
    1595. 

  1595.                         <h4>Return Value</h4>
    1596. 

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

  1597.                       </div>
    1598. 

  1598.                     </section>
    1599. 

  1599.                   </div>
    1600. 

  1600.                 </li>
    1601. 

  1601.               </ul>
    1602. 

  1602.             </div>
    1603. 

  1603.             <div class="task-group">
    1604. 

  1604.               <div class="task-name-container">
    1605. 

  1605.                 <a name="/NetService"></a>
    1606. 

  1606.                 <a name="//apple_ref/swift/Section/NetService" class="dashAnchor"></a>
    1607. 

  1607.                 <a href="#/NetService">
    1608. 

  1608.                   <h3 class="section-name">NetService</h3>
    1609. 

  1609.                 </a>
    1610. 

  1610.               </div>
    1611. 

  1611.               <ul class="item-container">
    1612. 

  1612.                 <li class="item">
    1613. 

  1613.                   <div>
    1614. 

  1614.                     <code>
    1615. 

  1615.                     <a name="/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF"></a>
    1616. 

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

  1617.                     <a class="token" href="#/s:9Alamofire6stream4withAA13StreamRequestCSo12NSNetServiceC_tF">stream(with:)</a>
    1618. 

  1618.                     </code>
    1619. 

  1619.                   </div>
    1620. 

  1620.                   <div class="height-container">
    1621. 

  1621.                     <div class="pointer-container"></div>
    1622. 

  1622.                     <section class="section">
    1623. 

  1623.                       <div class="pointer"></div>
    1624. 

  1624.                       <div class="abstract">
    1625. 

  1625.                         <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>
    1626. 

  1626. 

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

  1628. 

  1629.                       </div>
    1630. 

  1630.                       <div class="declaration">
    1631. 

  1631.                         <h4>Declaration</h4>
    1632. 

  1632.                         <div class="language">
    1633. 

  1633.                           <p class="aside-title">Swift</p>
    1634. 

  1634.                           <pre class="highlight swift"><code><span class="kd">@available(iOS 9.0, OSX 10.11, tvOS 9.0, *)</span>
    1635. 

  1635. <span class="kd">@discardableResult</span>
    1636. 

  1636. <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>
    1637. 

  1637. 

  1638.                         </div>
    1639. 

  1639.                       </div>
    1640. 

  1640.                       <div>
    1641. 

  1641.                         <h4>Parameters</h4>
    1642. 

  1642.                         <table class="graybox">
    1643. 

  1643.                           <tbody>
    1644. 

  1644.                             <tr>
    1645. 

  1645.                               <td>
    1646. 

  1646.                                 <code>
    1647. 

  1647.                                 <em>netService</em>
    1648. 

  1648.                                 </code>
    1649. 

  1649.                               </td>
    1650. 

  1650.                               <td>
    1651. 

  1651.                                 <div>
    1652. 

  1652.                                   <p>The net service used to identify the endpoint.</p>
    1653. 

  1653.                                 </div>
    1654. 

  1654.                               </td>
    1655. 

  1655.                             </tr>
    1656. 

  1656.                           </tbody>
    1657. 

  1657.                         </table>
    1658. 

  1658.                       </div>
    1659. 

  1659.                       <div>
    1660. 

  1660.                         <h4>Return Value</h4>
    1661. 

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

  1662.                       </div>
    1663. 

  1663.                     </section>
    1664. 

  1664.                   </div>
    1665. 

  1665.                 </li>
    1666. 

  1666.               </ul>
    1667. 

  1667.             </div>
    1668. 

  1668.             <div class="task-group">
    1669. 

  1669.               <ul class="item-container">
    1670. 

  1670.                 <li class="item">
    1671. 

  1671.                   <div>
    1672. 

  1672.                     <code>
    1673. 

  1673.                     <a name="/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF"></a>
    1674. 

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

  1675.                     <a class="token" href="#/s:9Alamofire2eeoiySbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
    1676. 

  1676.                     </code>
    1677. 

  1677.                   </div>
    1678. 

  1678.                   <div class="height-container">
    1679. 

  1679.                     <div class="pointer-container"></div>
    1680. 

  1680.                     <section class="section">
    1681. 

  1681.                       <div class="pointer"></div>
    1682. 

  1682.                       <div class="abstract">
    1683. 

  1683.                         <p>Returns whether the two network reachability status values are equal.</p>
    1684. 

  1684. 

  1685.                       </div>
    1686. 

  1686.                       <div class="declaration">
    1687. 

  1687.                         <h4>Declaration</h4>
    1688. 

  1688.                         <div class="language">
    1689. 

  1689.                           <p class="aside-title">Swift</p>
    1690. 

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

  1691.     <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>
    1692. 

  1692.     <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>
    1693. 

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

  1694. 

  1695.                         </div>
    1696. 

  1696.                       </div>
    1697. 

  1697.                       <div>
    1698. 

  1698.                         <h4>Parameters</h4>
    1699. 

  1699.                         <table class="graybox">
    1700. 

  1700.                           <tbody>
    1701. 

  1701.                             <tr>
    1702. 

  1702.                               <td>
    1703. 

  1703.                                 <code>
    1704. 

  1704.                                 <em>lhs</em>
    1705. 

  1705.                                 </code>
    1706. 

  1706.                               </td>
    1707. 

  1707.                               <td>
    1708. 

  1708.                                 <div>
    1709. 

  1709.                                   <p>The left-hand side value to compare.</p>
    1710. 

  1710.                                 </div>
    1711. 

  1711.                               </td>
    1712. 

  1712.                             </tr>
    1713. 

  1713.                             <tr>
    1714. 

  1714.                               <td>
    1715. 

  1715.                                 <code>
    1716. 

  1716.                                 <em>rhs</em>
    1717. 

  1717.                                 </code>
    1718. 

  1718.                               </td>
    1719. 

  1719.                               <td>
    1720. 

  1720.                                 <div>
    1721. 

  1721.                                   <p>The right-hand side value to compare.</p>
    1722. 

  1722.                                 </div>
    1723. 

  1723.                               </td>
    1724. 

  1724.                             </tr>
    1725. 

  1725.                           </tbody>
    1726. 

  1726.                         </table>
    1727. 

  1727.                       </div>
    1728. 

  1728.                       <div>
    1729. 

  1729.                         <h4>Return Value</h4>
    1730. 

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

  1731.                       </div>
    1732. 

  1732.                     </section>
    1733. 

  1733.                   </div>
    1734. 

  1734.                 </li>
    1735. 

  1735.               </ul>
    1736. 

  1736.             </div>
    1737. 

  1737.           </div>
    1738. 

  1738.         </section>
    1739. 

  1739. 

  1740.       </article>
    1741. 

  1741.     </div>
    1742. 

  1742.     <section class="footer">
    1743. 

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

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

  1745.     </section>
    1746. 

  1746.   </body>
    1747. 

  1747. </div>
    1748. 

  1748. </html>
    1749.