Главная Обзор Помощь
Вход
mirror
/
Alamofire
зеркало из https://github.com/Alamofire/Alamofire.git
2
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: dd53320501
Ветки Метки
Alamofire
/
docs
/
Enums
/
AF.html

AF.html 142 KB
История Исходник

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303 
  1. <!DOCTYPE html>
    2. 

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

  3.   <head>
    4. 

  4.     <title>AF Enumeration 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/Enum/AF" class="dashAnchor"></a>
    18. 

  18. 

  19.     <a title="AF Enumeration 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.          (98% 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.       AF Enumeration 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/Adapter.html">Adapter</a>
    64. 

  64.               </li>
    65. 

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

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

  67.               </li>
    68. 

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

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

  70.               </li>
    71. 

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

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

  73.               </li>
    74. 

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

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

  76.               </li>
    77. 

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

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

  79.               </li>
    80. 

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

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

  82.               </li>
    83. 

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

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

  85.               </li>
    86. 

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

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

  88.               </li>
    89. 

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

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

  91.               </li>
    92. 

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

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

  94.               </li>
    95. 

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

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

  97.               </li>
    98. 

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

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

  100.               </li>
    101. 

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

  102.                 <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
    103. 

  103.               </li>
    104. 

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

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

  106.               </li>
    107. 

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

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

  109.               </li>
    110. 

  110.               <li class="nav-group-task">
    111. 

  111.                 <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
    112. 

  112.               </li>
    113. 

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

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

  115.               </li>
    116. 

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

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

  118.               </li>
    119. 

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

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

  121.               </li>
    122. 

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

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

  124.               </li>
    125. 

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

  126.                 <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
    127. 

  127.               </li>
    128. 

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

  129.                 <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
    130. 

  130.               </li>
    131. 

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

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

  133.               </li>
    134. 

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

  135.                 <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
    136. 

  136.               </li>
    137. 

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

  138.                 <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
    139. 

  139.               </li>
    140. 

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

  141.                 <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
    142. 

  142.               </li>
    143. 

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

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

  145.               </li>
    146. 

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

  147.                 <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
    148. 

  148.               </li>
    149. 

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

  150.                 <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
    151. 

  151.               </li>
    152. 

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

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

  154.               </li>
    155. 

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

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

  157.               </li>
    158. 

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

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

  160.               </li>
    161. 

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

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

  163.               </li>
    164. 

  164.               <li class="nav-group-task">
    165. 

  165.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
    166. 

  166.               </li>
    167. 

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

  168.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
    169. 

  169.               </li>
    170. 

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

  171.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
    172. 

  172.               </li>
    173. 

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

  174.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
    175. 

  175.               </li>
    176. 

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

  177.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
    178. 

  178.               </li>
    179. 

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

  180.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
    181. 

  181.               </li>
    182. 

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

  183.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
    184. 

  184.               </li>
    185. 

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

  186.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
    187. 

  187.               </li>
    188. 

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

  189.                 <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
    190. 

  190.               </li>
    191. 

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

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

  193.               </li>
    194. 

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

  195.                 <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
    196. 

  196.               </li>
    197. 

  197.             </ul>
    198. 

  198.           </li>
    199. 

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

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

  201.             <ul class="nav-group-tasks">
    202. 

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

  203.                 <a class="nav-group-task-link" href="../Enums/AF.html">AF</a>
    204. 

  204.               </li>
    205. 

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

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

  207.               </li>
    208. 

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

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

  210.               </li>
    211. 

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

  212.                 <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
    213. 

  213.               </li>
    214. 

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

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

  216.               </li>
    217. 

  217.               <li class="nav-group-task">
    218. 

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

  219.               </li>
    220. 

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

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

  222.               </li>
    223. 

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

  224.                 <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
    225. 

  225.               </li>
    226. 

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

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

  228.               </li>
    229. 

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

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

  231.               </li>
    232. 

  232.             </ul>
    233. 

  233.           </li>
    234. 

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

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

  236.             <ul class="nav-group-tasks">
    237. 

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

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

  239.               </li>
    240. 

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

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

  242.               </li>
    243. 

  243.               <li class="nav-group-task">
    244. 

  244.                 <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
    245. 

  245.               </li>
    246. 

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

  247.                 <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
    248. 

  248.               </li>
    249. 

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

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

  251.               </li>
    252. 

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

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

  254.               </li>
    255. 

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

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

  257.               </li>
    258. 

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

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

  260.               </li>
    261. 

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

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

  263.               </li>
    264. 

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

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

  266.               </li>
    267. 

  267.             </ul>
    268. 

  268.           </li>
    269. 

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

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

  271.             <ul class="nav-group-tasks">
    272. 

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

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

  274.               </li>
    275. 

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

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

  277.               </li>
    278. 

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

  279.                 <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
    280. 

  280.               </li>
    281. 

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

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

  283.               </li>
    284. 

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

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

  286.               </li>
    287. 

  287.               <li class="nav-group-task">
    288. 

  288.                 <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
    289. 

  289.               </li>
    290. 

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

  291.                 <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
    292. 

  292.               </li>
    293. 

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

  294.                 <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
    295. 

  295.               </li>
    296. 

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

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

  298.               </li>
    299. 

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

  300.                 <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
    301. 

  301.               </li>
    302. 

  302.               <li class="nav-group-task">
    303. 

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

  304.               </li>
    305. 

  305.               <li class="nav-group-task">
    306. 

  306.                 <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
    307. 

  307.               </li>
    308. 

  308.               <li class="nav-group-task">
    309. 

  309.                 <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
    310. 

  310.               </li>
    311. 

  311.               <li class="nav-group-task">
    312. 

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

  313.               </li>
    314. 

  314.               <li class="nav-group-task">
    315. 

  315.                 <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
    316. 

  316.               </li>
    317. 

  317.               <li class="nav-group-task">
    318. 

  318.                 <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
    319. 

  319.               </li>
    320. 

  320.               <li class="nav-group-task">
    321. 

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

  322.               </li>
    323. 

  323.               <li class="nav-group-task">
    324. 

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

  325.               </li>
    326. 

  326.               <li class="nav-group-task">
    327. 

  327.                 <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
    328. 

  328.               </li>
    329. 

  329.               <li class="nav-group-task">
    330. 

  330.                 <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
    331. 

  331.               </li>
    332. 

  332.             </ul>
    333. 

  333.           </li>
    334. 

  334.           <li class="nav-group-name">
    335. 

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

  336.             <ul class="nav-group-tasks">
    337. 

  337.               <li class="nav-group-task">
    338. 

  338.                 <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
    339. 

  339.               </li>
    340. 

  340.               <li class="nav-group-task">
    341. 

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

  342.               </li>
    343. 

  343.               <li class="nav-group-task">
    344. 

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

  345.               </li>
    346. 

  346.               <li class="nav-group-task">
    347. 

  347.                 <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
    348. 

  348.               </li>
    349. 

  349.               <li class="nav-group-task">
    350. 

  350.                 <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
    351. 

  351.               </li>
    352. 

  352.               <li class="nav-group-task">
    353. 

  353.                 <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
    354. 

  354.               </li>
    355. 

  355.               <li class="nav-group-task">
    356. 

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

  357.               </li>
    358. 

  358.               <li class="nav-group-task">
    359. 

  359.                 <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
    360. 

  360.               </li>
    361. 

  361.               <li class="nav-group-task">
    362. 

  362.                 <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
    363. 

  363.               </li>
    364. 

  364.               <li class="nav-group-task">
    365. 

  365.                 <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
    366. 

  366.               </li>
    367. 

  367.               <li class="nav-group-task">
    368. 

  368.                 <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
    369. 

  369.               </li>
    370. 

  370.               <li class="nav-group-task">
    371. 

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

  372.               </li>
    373. 

  373.               <li class="nav-group-task">
    374. 

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

  375.               </li>
    376. 

  376.               <li class="nav-group-task">
    377. 

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

  378.               </li>
    379. 

  379.               <li class="nav-group-task">
    380. 

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

  381.               </li>
    382. 

  382.             </ul>
    383. 

  383.           </li>
    384. 

  384.           <li class="nav-group-name">
    385. 

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

  386.             <ul class="nav-group-tasks">
    387. 

  387.               <li class="nav-group-task">
    388. 

  388.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
    389. 

  389.               </li>
    390. 

  390.               <li class="nav-group-task">
    391. 

  391.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
    392. 

  392.               </li>
    393. 

  393.               <li class="nav-group-task">
    394. 

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

  395.               </li>
    396. 

  396.               <li class="nav-group-task">
    397. 

  397.                 <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
    398. 

  398.               </li>
    399. 

  399.             </ul>
    400. 

  400.           </li>
    401. 

  401.         </ul>
    402. 

  402.       </nav>
    403. 

  403.       <article class="main-content">
    404. 

  404. 

  405.         <section class="section">
    406. 

  406.           <div class="section-content">
    407. 

  407.             <h1>AF</h1>
    408. 

  408.               <div class="declaration">
    409. 

  409.                 <div class="language">
    410. 

  410.                   <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AF</span></code></pre>
    411. 

  411. 

  412.                 </div>
    413. 

  413.               </div>
    414. 

  414.             <p>Global namespace containing API for the <code>default</code> <code><a href="../Classes/Session.html">Session</a></code> instance.</p>
    415. 

  415. 

  416.           </div>
    417. 

  417.         </section>
    418. 

  418. 

  419.         <section class="section">
    420. 

  420.           <div class="section-content">
    421. 

  421.             <div class="task-group">
    422. 

  422.               <div class="task-name-container">
    423. 

  423.                 <a name="/Data%20Request"></a>
    424. 

  424.                 <a name="//apple_ref/swift/Section/Data Request" class="dashAnchor"></a>
    425. 

  425.                 <a href="#/Data%20Request">
    426. 

  426.                   <h3 class="section-name">Data Request</h3>
    427. 

  427.                 </a>
    428. 

  428.               </div>
    429. 

  429.               <ul class="item-container">
    430. 

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

  431.                   <div>
    432. 

  432.                     <code>
    433. 

  433.                     <a name="/s:9Alamofire2AFO7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtFZ"></a>
    434. 

  434.                     <a name="//apple_ref/swift/Method/request(_:method:parameters:encoding:headers:interceptor:)" class="dashAnchor"></a>
    435. 

  435.                     <a class="token" href="#/s:9Alamofire2AFO7request_6method10parameters8encoding7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtFZ">request(_:method:parameters:encoding:headers:interceptor:)</a>
    436. 

  436.                     </code>
    437. 

  437.                   </div>
    438. 

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

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

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

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

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

  443.                         <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to retrive the contents of the specified <code>url</code>
    444. 

  444. using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
    445. 

  445. 

  446.                       </div>
    447. 

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

  448.                         <h4>Declaration</h4>
    449. 

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

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

  451.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="n">_</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
    452. 

  452.                            <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>
    453. 

  453.                            <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>
    454. 

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

  455.                            <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    456. 

  456.                            <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
    457. 

  457. 

  458.                         </div>
    459. 

  459.                       </div>
    460. 

  460.                       <div>
    461. 

  461.                         <h4>Parameters</h4>
    462. 

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

  463.                           <tbody>
    464. 

  464.                             <tr>
    465. 

  465.                               <td>
    466. 

  466.                                 <code>
    467. 

  467.                                 <em>url</em>
    468. 

  468.                                 </code>
    469. 

  469.                               </td>
    470. 

  470.                               <td>
    471. 

  471.                                 <div>
    472. 

  472.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    473. 

  473.                                 </div>
    474. 

  474.                               </td>
    475. 

  475.                             </tr>
    476. 

  476.                             <tr>
    477. 

  477.                               <td>
    478. 

  478.                                 <code>
    479. 

  479.                                 <em>method</em>
    480. 

  480.                                 </code>
    481. 

  481.                               </td>
    482. 

  482.                               <td>
    483. 

  483.                                 <div>
    484. 

  484.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
    485. 

  485.                                 </div>
    486. 

  486.                               </td>
    487. 

  487.                             </tr>
    488. 

  488.                             <tr>
    489. 

  489.                               <td>
    490. 

  490.                                 <code>
    491. 

  491.                                 <em>parameters</em>
    492. 

  492.                                 </code>
    493. 

  493.                               </td>
    494. 

  494.                               <td>
    495. 

  495.                                 <div>
    496. 

  496.                                   <p>The <code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code>, <code>nil</code> by default.</p>
    497. 

  497.                                 </div>
    498. 

  498.                               </td>
    499. 

  499.                             </tr>
    500. 

  500.                             <tr>
    501. 

  501.                               <td>
    502. 

  502.                                 <code>
    503. 

  503.                                 <em>encoding</em>
    504. 

  504.                                 </code>
    505. 

  505.                               </td>
    506. 

  506.                               <td>
    507. 

  507.                                 <div>
    508. 

  508.                                   <p>The <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>, <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
    509. 

  509.                                 </div>
    510. 

  510.                               </td>
    511. 

  511.                             </tr>
    512. 

  512.                             <tr>
    513. 

  513.                               <td>
    514. 

  514.                                 <code>
    515. 

  515.                                 <em>headers</em>
    516. 

  516.                                 </code>
    517. 

  517.                               </td>
    518. 

  518.                               <td>
    519. 

  519.                                 <div>
    520. 

  520.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    521. 

  521.                                 </div>
    522. 

  522.                               </td>
    523. 

  523.                             </tr>
    524. 

  524.                             <tr>
    525. 

  525.                               <td>
    526. 

  526.                                 <code>
    527. 

  527.                                 <em>interceptor</em>
    528. 

  528.                                 </code>
    529. 

  529.                               </td>
    530. 

  530.                               <td>
    531. 

  531.                                 <div>
    532. 

  532.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    533. 

  533.                                 </div>
    534. 

  534.                               </td>
    535. 

  535.                             </tr>
    536. 

  536.                           </tbody>
    537. 

  537.                         </table>
    538. 

  538.                       </div>
    539. 

  539.                       <div>
    540. 

  540.                         <h4>Return Value</h4>
    541. 

  541.                         <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
    542. 

  542.                       </div>
    543. 

  543.                     </section>
    544. 

  544.                   </div>
    545. 

  545.                 </li>
    546. 

  546.                 <li class="item">
    547. 

  547.                   <div>
    548. 

  548.                     <code>
    549. 

  549.                     <a name="/s:9Alamofire2AFO7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlFZ"></a>
    550. 

  550.                     <a name="//apple_ref/swift/Method/request(_:method:parameters:encoder:headers:interceptor:)" class="dashAnchor"></a>
    551. 

  551.                     <a class="token" href="#/s:9Alamofire2AFO7request_6method10parameters7encoder7headers11interceptorAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0J11Interceptor_pSgtSERzlFZ">request(_:method:parameters:encoder:headers:interceptor:)</a>
    552. 

  552.                     </code>
    553. 

  553.                   </div>
    554. 

  554.                   <div class="height-container">
    555. 

  555.                     <div class="pointer-container"></div>
    556. 

  556.                     <section class="section">
    557. 

  557.                       <div class="pointer"></div>
    558. 

  558.                       <div class="abstract">
    559. 

  559.                         <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to retrive the contents of the specified <code>url</code>
    560. 

  560. using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
    561. 

  561. 

  562.                       </div>
    563. 

  563.                       <div class="declaration">
    564. 

  564.                         <h4>Declaration</h4>
    565. 

  565.                         <div class="language">
    566. 

  566.                           <p class="aside-title">Swift</p>
    567. 

  567.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="n">request</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
    568. 

  568.                                                   <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>
    569. 

  569.                                                   <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>
    570. 

  570.                                                   <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
    571. 

  571.                                                   <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    572. 

  572.                                                   <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
    573. 

  573. 

  574.                         </div>
    575. 

  575.                       </div>
    576. 

  576.                       <div>
    577. 

  577.                         <h4>Parameters</h4>
    578. 

  578.                         <table class="graybox">
    579. 

  579.                           <tbody>
    580. 

  580.                             <tr>
    581. 

  581.                               <td>
    582. 

  582.                                 <code>
    583. 

  583.                                 <em>url</em>
    584. 

  584.                                 </code>
    585. 

  585.                               </td>
    586. 

  586.                               <td>
    587. 

  587.                                 <div>
    588. 

  588.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    589. 

  589.                                 </div>
    590. 

  590.                               </td>
    591. 

  591.                             </tr>
    592. 

  592.                             <tr>
    593. 

  593.                               <td>
    594. 

  594.                                 <code>
    595. 

  595.                                 <em>method</em>
    596. 

  596.                                 </code>
    597. 

  597.                               </td>
    598. 

  598.                               <td>
    599. 

  599.                                 <div>
    600. 

  600.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
    601. 

  601.                                 </div>
    602. 

  602.                               </td>
    603. 

  603.                             </tr>
    604. 

  604.                             <tr>
    605. 

  605.                               <td>
    606. 

  606.                                 <code>
    607. 

  607.                                 <em>parameters</em>
    608. 

  608.                                 </code>
    609. 

  609.                               </td>
    610. 

  610.                               <td>
    611. 

  611.                                 <div>
    612. 

  612.                                   <p>The <code>Encodable</code> parameters, <code>nil</code> by default.</p>
    613. 

  613.                                 </div>
    614. 

  614.                               </td>
    615. 

  615.                             </tr>
    616. 

  616.                             <tr>
    617. 

  617.                               <td>
    618. 

  618.                                 <code>
    619. 

  619.                                 <em>encoding</em>
    620. 

  620.                                 </code>
    621. 

  621.                               </td>
    622. 

  622.                               <td>
    623. 

  623.                                 <div>
    624. 

  624.                                   <p>The <code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code>, <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
    625. 

  625.                                 </div>
    626. 

  626.                               </td>
    627. 

  627.                             </tr>
    628. 

  628.                             <tr>
    629. 

  629.                               <td>
    630. 

  630.                                 <code>
    631. 

  631.                                 <em>headers</em>
    632. 

  632.                                 </code>
    633. 

  633.                               </td>
    634. 

  634.                               <td>
    635. 

  635.                                 <div>
    636. 

  636.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    637. 

  637.                                 </div>
    638. 

  638.                               </td>
    639. 

  639.                             </tr>
    640. 

  640.                             <tr>
    641. 

  641.                               <td>
    642. 

  642.                                 <code>
    643. 

  643.                                 <em>interceptor</em>
    644. 

  644.                                 </code>
    645. 

  645.                               </td>
    646. 

  646.                               <td>
    647. 

  647.                                 <div>
    648. 

  648.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    649. 

  649.                                 </div>
    650. 

  650.                               </td>
    651. 

  651.                             </tr>
    652. 

  652.                           </tbody>
    653. 

  653.                         </table>
    654. 

  654.                       </div>
    655. 

  655.                       <div>
    656. 

  656.                         <h4>Return Value</h4>
    657. 

  657.                         <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
    658. 

  658.                       </div>
    659. 

  659.                     </section>
    660. 

  660.                   </div>
    661. 

  661.                 </li>
    662. 

  662.                 <li class="item">
    663. 

  663.                   <div>
    664. 

  664.                     <code>
    665. 

  665.                     <a name="/s:9Alamofire2AFO7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtFZ"></a>
    666. 

  666.                     <a name="//apple_ref/swift/Method/request(_:interceptor:)" class="dashAnchor"></a>
    667. 

  667.                     <a class="token" href="#/s:9Alamofire2AFO7request_11interceptorAA11DataRequestCAA21URLRequestConvertible_p_AA0F11Interceptor_pSgtFZ">request(_:interceptor:)</a>
    668. 

  668.                     </code>
    669. 

  669.                   </div>
    670. 

  670.                   <div class="height-container">
    671. 

  671.                     <div class="pointer-container"></div>
    672. 

  672.                     <section class="section">
    673. 

  673.                       <div class="pointer"></div>
    674. 

  674.                       <div class="abstract">
    675. 

  675.                         <p>Creates a <code><a href="../Classes/DataRequest.html">DataRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to execute the specified <code>urlRequest</code>.</p>
    676. 

  676. 

  677.                       </div>
    678. 

  678.                       <div class="declaration">
    679. 

  679.                         <h4>Declaration</h4>
    680. 

  680.                         <div class="language">
    681. 

  681.                           <p class="aside-title">Swift</p>
    682. 

  682.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span> <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DataRequest.html">DataRequest</a></span></code></pre>
    683. 

  683. 

  684.                         </div>
    685. 

  685.                       </div>
    686. 

  686.                       <div>
    687. 

  687.                         <h4>Parameters</h4>
    688. 

  688.                         <table class="graybox">
    689. 

  689.                           <tbody>
    690. 

  690.                             <tr>
    691. 

  691.                               <td>
    692. 

  692.                                 <code>
    693. 

  693.                                 <em>urlRequest</em>
    694. 

  694.                                 </code>
    695. 

  695.                               </td>
    696. 

  696.                               <td>
    697. 

  697.                                 <div>
    698. 

  698.                                   <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
    699. 

  699.                                 </div>
    700. 

  700.                               </td>
    701. 

  701.                             </tr>
    702. 

  702.                             <tr>
    703. 

  703.                               <td>
    704. 

  704.                                 <code>
    705. 

  705.                                 <em>interceptor</em>
    706. 

  706.                                 </code>
    707. 

  707.                               </td>
    708. 

  708.                               <td>
    709. 

  709.                                 <div>
    710. 

  710.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    711. 

  711.                                 </div>
    712. 

  712.                               </td>
    713. 

  713.                             </tr>
    714. 

  714.                           </tbody>
    715. 

  715.                         </table>
    716. 

  716.                       </div>
    717. 

  717.                       <div>
    718. 

  718.                         <h4>Return Value</h4>
    719. 

  719.                         <p>The created <code><a href="../Classes/DataRequest.html">DataRequest</a></code>.</p>
    720. 

  720.                       </div>
    721. 

  721.                     </section>
    722. 

  722.                   </div>
    723. 

  723.                 </li>
    724. 

  724.               </ul>
    725. 

  725.             </div>
    726. 

  726.             <div class="task-group">
    727. 

  727.               <div class="task-name-container">
    728. 

  728.                 <a name="/Download%20Request"></a>
    729. 

  729.                 <a name="//apple_ref/swift/Section/Download Request" class="dashAnchor"></a>
    730. 

  730.                 <a href="#/Download%20Request">
    731. 

  731.                   <h3 class="section-name">Download Request</h3>
    732. 

  732.                 </a>
    733. 

  733.               </div>
    734. 

  734.               <ul class="item-container">
    735. 

  735.                 <li class="item">
    736. 

  736.                   <div>
    737. 

  737.                     <code>
    738. 

  738.                     <a name="/s:9Alamofire2AFO8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtFZ"></a>
    739. 

  739.                     <a name="//apple_ref/swift/Method/download(_:method:parameters:encoding:headers:interceptor:to:)" class="dashAnchor"></a>
    740. 

  740.                     <a class="token" href="#/s:9Alamofire2AFO8download_6method10parameters8encoding7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOSDySSypGSgAA17ParameterEncoding_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAZ_So17NSHTTPURLResponseCtcSgtFZ">download(_:method:parameters:encoding:headers:interceptor:to:)</a>
    741. 

  741.                     </code>
    742. 

  742.                   </div>
    743. 

  743.                   <div class="height-container">
    744. 

  744.                     <div class="pointer-container"></div>
    745. 

  745.                     <section class="section">
    746. 

  746.                       <div class="pointer"></div>
    747. 

  747.                       <div class="abstract">
    748. 

  748.                         <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to download the contents of the specified <code>url</code> to
    749. 

  749. the provided <code>destination</code> using the <code>method</code>, <code>parameters</code>, <code>encoding</code>, and <code>headers</code> provided.</p>
    750. 

  750. 

  751. <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by Alamofire.</p>
    752. 

  752. 

  753.                       </div>
    754. 

  754.                       <div class="declaration">
    755. 

  755.                         <h4>Declaration</h4>
    756. 

  756.                         <div class="language">
    757. 

  757.                           <p class="aside-title">Swift</p>
    758. 

  758.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">_</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
    759. 

  759.                             <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>
    760. 

  760.                             <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>
    761. 

  761.                             <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>
    762. 

  762.                             <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    763. 

  763.                             <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    764. 

  764.                             <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span>  <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    765. 

  765. 

  766.                         </div>
    767. 

  767.                       </div>
    768. 

  768.                       <div>
    769. 

  769.                         <h4>Parameters</h4>
    770. 

  770.                         <table class="graybox">
    771. 

  771.                           <tbody>
    772. 

  772.                             <tr>
    773. 

  773.                               <td>
    774. 

  774.                                 <code>
    775. 

  775.                                 <em>url</em>
    776. 

  776.                                 </code>
    777. 

  777.                               </td>
    778. 

  778.                               <td>
    779. 

  779.                                 <div>
    780. 

  780.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    781. 

  781.                                 </div>
    782. 

  782.                               </td>
    783. 

  783.                             </tr>
    784. 

  784.                             <tr>
    785. 

  785.                               <td>
    786. 

  786.                                 <code>
    787. 

  787.                                 <em>method</em>
    788. 

  788.                                 </code>
    789. 

  789.                               </td>
    790. 

  790.                               <td>
    791. 

  791.                                 <div>
    792. 

  792.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
    793. 

  793.                                 </div>
    794. 

  794.                               </td>
    795. 

  795.                             </tr>
    796. 

  796.                             <tr>
    797. 

  797.                               <td>
    798. 

  798.                                 <code>
    799. 

  799.                                 <em>parameters</em>
    800. 

  800.                                 </code>
    801. 

  801.                               </td>
    802. 

  802.                               <td>
    803. 

  803.                                 <div>
    804. 

  804.                                   <p>The <code><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></code>, <code>nil</code> by default.</p>
    805. 

  805.                                 </div>
    806. 

  806.                               </td>
    807. 

  807.                             </tr>
    808. 

  808.                             <tr>
    809. 

  809.                               <td>
    810. 

  810.                                 <code>
    811. 

  811.                                 <em>encoding</em>
    812. 

  812.                                 </code>
    813. 

  813.                               </td>
    814. 

  814.                               <td>
    815. 

  815.                                 <div>
    816. 

  816.                                   <p>The <code><a href="../Protocols/ParameterEncoding.html">ParameterEncoding</a></code>, <code><a href="../Structs/URLEncoding.html#/s:9Alamofire11URLEncodingV7defaultACvpZ">URLEncoding.default</a></code> by default.</p>
    817. 

  817.                                 </div>
    818. 

  818.                               </td>
    819. 

  819.                             </tr>
    820. 

  820.                             <tr>
    821. 

  821.                               <td>
    822. 

  822.                                 <code>
    823. 

  823.                                 <em>headers</em>
    824. 

  824.                                 </code>
    825. 

  825.                               </td>
    826. 

  826.                               <td>
    827. 

  827.                                 <div>
    828. 

  828.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    829. 

  829.                                 </div>
    830. 

  830.                               </td>
    831. 

  831.                             </tr>
    832. 

  832.                             <tr>
    833. 

  833.                               <td>
    834. 

  834.                                 <code>
    835. 

  835.                                 <em>interceptor</em>
    836. 

  836.                                 </code>
    837. 

  837.                               </td>
    838. 

  838.                               <td>
    839. 

  839.                                 <div>
    840. 

  840.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    841. 

  841.                                 </div>
    842. 

  842.                               </td>
    843. 

  843.                             </tr>
    844. 

  844.                             <tr>
    845. 

  845.                               <td>
    846. 

  846.                                 <code>
    847. 

  847.                                 <em>destination</em>
    848. 

  848.                                 </code>
    849. 

  849.                               </td>
    850. 

  850.                               <td>
    851. 

  851.                                 <div>
    852. 

  852.                                   <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
    853. 

  853.            downloaded file. <code>nil</code> by default.</p>
    854. 

  854.                                 </div>
    855. 

  855.                               </td>
    856. 

  856.                             </tr>
    857. 

  857.                           </tbody>
    858. 

  858.                         </table>
    859. 

  859.                       </div>
    860. 

  860.                       <div>
    861. 

  861.                         <h4>Return Value</h4>
    862. 

  862.                         <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    863. 

  863.                       </div>
    864. 

  864.                     </section>
    865. 

  865.                   </div>
    866. 

  866.                 </li>
    867. 

  867.                 <li class="item">
    868. 

  868.                   <div>
    869. 

  869.                     <code>
    870. 

  870.                     <a name="/s:9Alamofire2AFO8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlFZ"></a>
    871. 

  871.                     <a name="//apple_ref/swift/Method/download(_:method:parameters:encoder:headers:interceptor:to:)" class="dashAnchor"></a>
    872. 

  872.                     <a class="token" href="#/s:9Alamofire2AFO8download_6method10parameters7encoder7headers11interceptor2toAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodOxSgAA16ParameterEncoder_pAA11HTTPHeadersVSgAA0K11Interceptor_pSg10Foundation3URLV011destinationS0_AL7OptionsV7optionstAY_So17NSHTTPURLResponseCtcSgtSERzlFZ">download(_:method:parameters:encoder:headers:interceptor:to:)</a>
    873. 

  873.                     </code>
    874. 

  874.                   </div>
    875. 

  875.                   <div class="height-container">
    876. 

  876.                     <div class="pointer-container"></div>
    877. 

  877.                     <section class="section">
    878. 

  878.                       <div class="pointer"></div>
    879. 

  879.                       <div class="abstract">
    880. 

  880.                         <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to download the contents of the specified <code>url</code> to the
    881. 

  881. provided <code>destination</code> using the <code>method</code>, encodable <code>parameters</code>, <code>encoder</code>, and <code>headers</code> provided.</p>
    882. 

  882. <div class="aside aside-note">
    883. 

  883.     <p class="aside-title">Note</p>
    884. 

  884.     <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by
    885. 

  885.     Alamofire.</p>
    886. 

  886. 

  887. </div>
    888. 

  888. 

  889.                       </div>
    890. 

  890.                       <div class="declaration">
    891. 

  891.                         <h4>Declaration</h4>
    892. 

  892.                         <div class="language">
    893. 

  893.                           <p class="aside-title">Swift</p>
    894. 

  894.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="n">download</span><span class="o">&lt;</span><span class="kt"><a href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a></span><span class="p">:</span> <span class="kt">Encodable</span><span class="o">&gt;</span><span class="p">(</span><span class="n">_</span> <span class="nv">url</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLConvertible.html">URLConvertible</a></span><span class="p">,</span>
    895. 

  895.                                                    <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>
    896. 

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

  897.                                                    <span class="nv">encoder</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></span> <span class="o">=</span> <span class="kt"><a href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a></span><span class="o">.</span><span class="k">default</span><span class="p">,</span>
    898. 

  898.                                                    <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    899. 

  899.                                                    <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    900. 

  900.                                                    <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    901. 

  901. 

  902.                         </div>
    903. 

  903.                       </div>
    904. 

  904.                       <div>
    905. 

  905.                         <h4>Parameters</h4>
    906. 

  906.                         <table class="graybox">
    907. 

  907.                           <tbody>
    908. 

  908.                             <tr>
    909. 

  909.                               <td>
    910. 

  910.                                 <code>
    911. 

  911.                                 <em>url</em>
    912. 

  912.                                 </code>
    913. 

  913.                               </td>
    914. 

  914.                               <td>
    915. 

  915.                                 <div>
    916. 

  916.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    917. 

  917.                                 </div>
    918. 

  918.                               </td>
    919. 

  919.                             </tr>
    920. 

  920.                             <tr>
    921. 

  921.                               <td>
    922. 

  922.                                 <code>
    923. 

  923.                                 <em>method</em>
    924. 

  924.                                 </code>
    925. 

  925.                               </td>
    926. 

  926.                               <td>
    927. 

  927.                                 <div>
    928. 

  928.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.get</code> by default.</p>
    929. 

  929.                                 </div>
    930. 

  930.                               </td>
    931. 

  931.                             </tr>
    932. 

  932.                             <tr>
    933. 

  933.                               <td>
    934. 

  934.                                 <code>
    935. 

  935.                                 <em>parameters</em>
    936. 

  936.                                 </code>
    937. 

  937.                               </td>
    938. 

  938.                               <td>
    939. 

  939.                                 <div>
    940. 

  940.                                   <p>The <code>Encodable</code> parameters, <code>nil</code> by default.</p>
    941. 

  941.                                 </div>
    942. 

  942.                               </td>
    943. 

  943.                             </tr>
    944. 

  944.                             <tr>
    945. 

  945.                               <td>
    946. 

  946.                                 <code>
    947. 

  947.                                 <em>encoder</em>
    948. 

  948.                                 </code>
    949. 

  949.                               </td>
    950. 

  950.                               <td>
    951. 

  951.                                 <div>
    952. 

  952.                                   <p>The <code><a href="../Protocols/ParameterEncoder.html">ParameterEncoder</a></code>, <code><a href="../Classes/URLEncodedFormParameterEncoder.html#/s:9Alamofire30URLEncodedFormParameterEncoderC7defaultACvpZ">URLEncodedFormParameterEncoder.default</a></code> by default.</p>
    953. 

  953.                                 </div>
    954. 

  954.                               </td>
    955. 

  955.                             </tr>
    956. 

  956.                             <tr>
    957. 

  957.                               <td>
    958. 

  958.                                 <code>
    959. 

  959.                                 <em>headers</em>
    960. 

  960.                                 </code>
    961. 

  961.                               </td>
    962. 

  962.                               <td>
    963. 

  963.                                 <div>
    964. 

  964.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    965. 

  965.                                 </div>
    966. 

  966.                               </td>
    967. 

  967.                             </tr>
    968. 

  968.                             <tr>
    969. 

  969.                               <td>
    970. 

  970.                                 <code>
    971. 

  971.                                 <em>interceptor</em>
    972. 

  972.                                 </code>
    973. 

  973.                               </td>
    974. 

  974.                               <td>
    975. 

  975.                                 <div>
    976. 

  976.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    977. 

  977.                                 </div>
    978. 

  978.                               </td>
    979. 

  979.                             </tr>
    980. 

  980.                             <tr>
    981. 

  981.                               <td>
    982. 

  982.                                 <code>
    983. 

  983.                                 <em>destination</em>
    984. 

  984.                                 </code>
    985. 

  985.                               </td>
    986. 

  986.                               <td>
    987. 

  987.                                 <div>
    988. 

  988.                                   <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
    989. 

  989.            downloaded file. <code>nil</code> by default.</p>
    990. 

  990.                                 </div>
    991. 

  991.                               </td>
    992. 

  992.                             </tr>
    993. 

  993.                           </tbody>
    994. 

  994.                         </table>
    995. 

  995.                       </div>
    996. 

  996.                       <div>
    997. 

  997.                         <h4>Return Value</h4>
    998. 

  998.                         <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    999. 

  999.                       </div>
    1000. 

  1000.                     </section>
    1001. 

  1001.                   </div>
    1002. 

  1002.                 </li>
    1003. 

  1003.               </ul>
    1004. 

  1004.             </div>
    1005. 

  1005.             <div class="task-group">
    1006. 

  1006.               <div class="task-name-container">
    1007. 

  1007.                 <a name="/URLRequest"></a>
    1008. 

  1008.                 <a name="//apple_ref/swift/Section/URLRequest" class="dashAnchor"></a>
    1009. 

  1009.                 <a href="#/URLRequest">
    1010. 

  1010.                   <h3 class="section-name">URLRequest</h3>
    1011. 

  1011.                 </a>
    1012. 

  1012.               </div>
    1013. 

  1013.               <ul class="item-container">
    1014. 

  1014.                 <li class="item">
    1015. 

  1015.                   <div>
    1016. 

  1016.                     <code>
    1017. 

  1017.                     <a name="/s:9Alamofire2AFO8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtFZ"></a>
    1018. 

  1018.                     <a name="//apple_ref/swift/Method/download(_:interceptor:to:)" class="dashAnchor"></a>
    1019. 

  1019.                     <a class="token" href="#/s:9Alamofire2AFO8download_11interceptor2toAA15DownloadRequestCAA21URLRequestConvertible_p_AA0G11Interceptor_pSg10Foundation3URLV011destinationL0_AH7OptionsV7optionstAN_So17NSHTTPURLResponseCtcSgtFZ">download(_:interceptor:to:)</a>
    1020. 

  1020.                     </code>
    1021. 

  1021.                   </div>
    1022. 

  1022.                   <div class="height-container">
    1023. 

  1023.                     <div class="pointer-container"></div>
    1024. 

  1024.                     <section class="section">
    1025. 

  1025.                       <div class="pointer"></div>
    1026. 

  1026.                       <div class="abstract">
    1027. 

  1027.                         <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to execute the specified <code>urlRequest</code> and download
    1028. 

  1028. the result to the provided <code>destination</code>.</p>
    1029. 

  1029. 

  1030.                       </div>
    1031. 

  1031.                       <div class="declaration">
    1032. 

  1032.                         <h4>Declaration</h4>
    1033. 

  1033.                         <div class="language">
    1034. 

  1034.                           <p class="aside-title">Swift</p>
    1035. 

  1035.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">_</span> <span class="nv">urlRequest</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
    1036. 

  1036.                             <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1037. 

  1037.                             <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    1038. 

  1038. 

  1039.                         </div>
    1040. 

  1040.                       </div>
    1041. 

  1041.                       <div>
    1042. 

  1042.                         <h4>Parameters</h4>
    1043. 

  1043.                         <table class="graybox">
    1044. 

  1044.                           <tbody>
    1045. 

  1045.                             <tr>
    1046. 

  1046.                               <td>
    1047. 

  1047.                                 <code>
    1048. 

  1048.                                 <em>urlRequest</em>
    1049. 

  1049.                                 </code>
    1050. 

  1050.                               </td>
    1051. 

  1051.                               <td>
    1052. 

  1052.                                 <div>
    1053. 

  1053.                                   <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
    1054. 

  1054.                                 </div>
    1055. 

  1055.                               </td>
    1056. 

  1056.                             </tr>
    1057. 

  1057.                             <tr>
    1058. 

  1058.                               <td>
    1059. 

  1059.                                 <code>
    1060. 

  1060.                                 <em>interceptor</em>
    1061. 

  1061.                                 </code>
    1062. 

  1062.                               </td>
    1063. 

  1063.                               <td>
    1064. 

  1064.                                 <div>
    1065. 

  1065.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1066. 

  1066.                                 </div>
    1067. 

  1067.                               </td>
    1068. 

  1068.                             </tr>
    1069. 

  1069.                             <tr>
    1070. 

  1070.                               <td>
    1071. 

  1071.                                 <code>
    1072. 

  1072.                                 <em>destination</em>
    1073. 

  1073.                                 </code>
    1074. 

  1074.                               </td>
    1075. 

  1075.                               <td>
    1076. 

  1076.                                 <div>
    1077. 

  1077.                                   <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used the determine the destination of the
    1078. 

  1078.            downloaded file. <code>nil</code> by default.</p>
    1079. 

  1079.                                 </div>
    1080. 

  1080.                               </td>
    1081. 

  1081.                             </tr>
    1082. 

  1082.                           </tbody>
    1083. 

  1083.                         </table>
    1084. 

  1084.                       </div>
    1085. 

  1085.                       <div>
    1086. 

  1086.                         <h4>Return Value</h4>
    1087. 

  1087.                         <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    1088. 

  1088.                       </div>
    1089. 

  1089.                     </section>
    1090. 

  1090.                   </div>
    1091. 

  1091.                 </li>
    1092. 

  1092.               </ul>
    1093. 

  1093.             </div>
    1094. 

  1094.             <div class="task-group">
    1095. 

  1095.               <div class="task-name-container">
    1096. 

  1096.                 <a name="/Resume%20Data"></a>
    1097. 

  1097.                 <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
    1098. 

  1098.                 <a href="#/Resume%20Data">
    1099. 

  1099.                   <h3 class="section-name">Resume Data</h3>
    1100. 

  1100.                 </a>
    1101. 

  1101.               </div>
    1102. 

  1102.               <ul class="item-container">
    1103. 

  1103.                 <li class="item">
    1104. 

  1104.                   <div>
    1105. 

  1105.                     <code>
    1106. 

  1106.                     <a name="/s:9Alamofire2AFO8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtFZ"></a>
    1107. 

  1107.                     <a name="//apple_ref/swift/Method/download(resumingWith:interceptor:to:)" class="dashAnchor"></a>
    1108. 

  1108.                     <a class="token" href="#/s:9Alamofire2AFO8download12resumingWith11interceptor2toAA15DownloadRequestC10Foundation4DataV_AA0I11Interceptor_pSgAJ3URLV011destinationM0_AI7OptionsV7optionstAP_So17NSHTTPURLResponseCtcSgtFZ">download(resumingWith:interceptor:to:)</a>
    1109. 

  1109.                     </code>
    1110. 

  1110.                   </div>
    1111. 

  1111.                   <div class="height-container">
    1112. 

  1112.                     <div class="pointer-container"></div>
    1113. 

  1113.                     <section class="section">
    1114. 

  1114.                       <div class="pointer"></div>
    1115. 

  1115.                       <div class="abstract">
    1116. 

  1116.                         <p>Creates a <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> using the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> from the <code>resumeData</code> produced from a previous
    1117. 

  1117. <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code> cancellation to retrieve the contents of the original request and save them to the <code>destination</code>.</p>
    1118. 

  1118. <div class="aside aside-note">
    1119. 

  1119.     <p class="aside-title">Note</p>
    1120. 

  1120.     <p>If <code>destination</code> is not specified, the download will be moved to a temporary location determined by
    1121. 

  1121.     Alamofire.</p>
    1122. 

  1122. 

  1123. </div>
    1124. 

  1124. <div class="aside aside-note">
    1125. 

  1125.     <p class="aside-title">Note</p>
    1126. 

  1126.     <p>On some versions of all Apple platforms (iOS 10 - 10.2, macOS 10.12 - 10.12.2, tvOS 10 - 10.1, watchOS 3 - 3.1.1),
    1127. 

  1127. <code>resumeData</code> is broken on background URL session configurations. There&rsquo;s an underlying bug in the <code>resumeData</code>
    1128. 

  1128. generation logic where the data is written incorrectly and will always fail to resume the download. For more
    1129. 

  1129. information about the bug and possible workarounds, please refer to the <a href="http://stackoverflow.com/a/39347461/1342462">this Stack Overflow post</a>.</p>
    1130. 

  1130. 

  1131. </div>
    1132. 

  1132. 

  1133.                       </div>
    1134. 

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

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

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

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

  1138.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">resumingWith</span> <span class="nv">resumeData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    1139. 

  1139.                             <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1140. 

  1140.                             <span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span><span class="o">.</span><span class="kt">Destination</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/DownloadRequest.html">DownloadRequest</a></span></code></pre>
    1141. 

  1141. 

  1142.                         </div>
    1143. 

  1143.                       </div>
    1144. 

  1144.                       <div>
    1145. 

  1145.                         <h4>Parameters</h4>
    1146. 

  1146.                         <table class="graybox">
    1147. 

  1147.                           <tbody>
    1148. 

  1148.                             <tr>
    1149. 

  1149.                               <td>
    1150. 

  1150.                                 <code>
    1151. 

  1151.                                 <em>resumeData</em>
    1152. 

  1152.                                 </code>
    1153. 

  1153.                               </td>
    1154. 

  1154.                               <td>
    1155. 

  1155.                                 <div>
    1156. 

  1156.                                   <p>The resume <code>Data</code>. This is an opaque blob produced by <code>URLSessionDownloadTask</code> when a task is
    1157. 

  1157.            cancelled. See <a href="https://developer.apple.com/documentation/foundation/urlsessiondownloadtask/1411634-cancel">Apple&rsquo;s documentation</a>
    1158. 

  1158.            for more information.</p>
    1159. 

  1159.                                 </div>
    1160. 

  1160.                               </td>
    1161. 

  1161.                             </tr>
    1162. 

  1162.                             <tr>
    1163. 

  1163.                               <td>
    1164. 

  1164.                                 <code>
    1165. 

  1165.                                 <em>interceptor</em>
    1166. 

  1166.                                 </code>
    1167. 

  1167.                               </td>
    1168. 

  1168.                               <td>
    1169. 

  1169.                                 <div>
    1170. 

  1170.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1171. 

  1171.                                 </div>
    1172. 

  1172.                               </td>
    1173. 

  1173.                             </tr>
    1174. 

  1174.                             <tr>
    1175. 

  1175.                               <td>
    1176. 

  1176.                                 <code>
    1177. 

  1177.                                 <em>destination</em>
    1178. 

  1178.                                 </code>
    1179. 

  1179.                               </td>
    1180. 

  1180.                               <td>
    1181. 

  1181.                                 <div>
    1182. 

  1182.                                   <p>The <code><a href="../Classes/DownloadRequest.html#/s:9Alamofire15DownloadRequestC11Destinationa">DownloadRequest.Destination</a></code> closure used to determine the destination of the downloaded
    1183. 

  1183.            file. <code>nil</code> by default.</p>
    1184. 

  1184.                                 </div>
    1185. 

  1185.                               </td>
    1186. 

  1186.                             </tr>
    1187. 

  1187.                           </tbody>
    1188. 

  1188.                         </table>
    1189. 

  1189.                       </div>
    1190. 

  1190.                       <div>
    1191. 

  1191.                         <h4>Return Value</h4>
    1192. 

  1192.                         <p>The created <code><a href="../Classes/DownloadRequest.html">DownloadRequest</a></code>.</p>
    1193. 

  1193.                       </div>
    1194. 

  1194.                     </section>
    1195. 

  1195.                   </div>
    1196. 

  1196.                 </li>
    1197. 

  1197.               </ul>
    1198. 

  1198.             </div>
    1199. 

  1199.             <div class="task-group">
    1200. 

  1200.               <div class="task-name-container">
    1201. 

  1201.                 <a name="/File"></a>
    1202. 

  1202.                 <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
    1203. 

  1203.                 <a href="#/File">
    1204. 

  1204.                   <h3 class="section-name">File</h3>
    1205. 

  1205.                 </a>
    1206. 

  1206.               </div>
    1207. 

  1207.               <ul class="item-container">
    1208. 

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

  1209.                   <div>
    1210. 

  1210.                     <code>
    1211. 

  1211.                     <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ"></a>
    1212. 

  1212.                     <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:)" class="dashAnchor"></a>
    1213. 

  1213.                     <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ">upload(_:to:method:headers:interceptor:)</a>
    1214. 

  1214.                     </code>
    1215. 

  1215.                   </div>
    1216. 

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

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

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

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

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

  1221.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to upload the contents of the <code>fileURL</code> specified
    1222. 

  1222. using the <code>url</code>, <code>method</code> and <code>headers</code> provided.</p>
    1223. 

  1223. 

  1224.                       </div>
    1225. 

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

  1226.                         <h4>Declaration</h4>
    1227. 

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

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

  1229.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
    1230. 

  1230.                           <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>
    1231. 

  1231.                           <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>
    1232. 

  1232.                           <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1233. 

  1233.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1234. 

  1234. 

  1235.                         </div>
    1236. 

  1236.                       </div>
    1237. 

  1237.                       <div>
    1238. 

  1238.                         <h4>Parameters</h4>
    1239. 

  1239.                         <table class="graybox">
    1240. 

  1240.                           <tbody>
    1241. 

  1241.                             <tr>
    1242. 

  1242.                               <td>
    1243. 

  1243.                                 <code>
    1244. 

  1244.                                 <em>fileURL</em>
    1245. 

  1245.                                 </code>
    1246. 

  1246.                               </td>
    1247. 

  1247.                               <td>
    1248. 

  1248.                                 <div>
    1249. 

  1249.                                   <p>The <code>URL</code> of the file to upload.</p>
    1250. 

  1250.                                 </div>
    1251. 

  1251.                               </td>
    1252. 

  1252.                             </tr>
    1253. 

  1253.                             <tr>
    1254. 

  1254.                               <td>
    1255. 

  1255.                                 <code>
    1256. 

  1256.                                 <em>url</em>
    1257. 

  1257.                                 </code>
    1258. 

  1258.                               </td>
    1259. 

  1259.                               <td>
    1260. 

  1260.                                 <div>
    1261. 

  1261.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    1262. 

  1262.                                 </div>
    1263. 

  1263.                               </td>
    1264. 

  1264.                             </tr>
    1265. 

  1265.                             <tr>
    1266. 

  1266.                               <td>
    1267. 

  1267.                                 <code>
    1268. 

  1268.                                 <em>method</em>
    1269. 

  1269.                                 </code>
    1270. 

  1270.                               </td>
    1271. 

  1271.                               <td>
    1272. 

  1272.                                 <div>
    1273. 

  1273.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
    1274. 

  1274.                                 </div>
    1275. 

  1275.                               </td>
    1276. 

  1276.                             </tr>
    1277. 

  1277.                             <tr>
    1278. 

  1278.                               <td>
    1279. 

  1279.                                 <code>
    1280. 

  1280.                                 <em>headers</em>
    1281. 

  1281.                                 </code>
    1282. 

  1282.                               </td>
    1283. 

  1283.                               <td>
    1284. 

  1284.                                 <div>
    1285. 

  1285.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    1286. 

  1286.                                 </div>
    1287. 

  1287.                               </td>
    1288. 

  1288.                             </tr>
    1289. 

  1289.                             <tr>
    1290. 

  1290.                               <td>
    1291. 

  1291.                                 <code>
    1292. 

  1292.                                 <em>interceptor</em>
    1293. 

  1293.                                 </code>
    1294. 

  1294.                               </td>
    1295. 

  1295.                               <td>
    1296. 

  1296.                                 <div>
    1297. 

  1297.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1298. 

  1298.                                 </div>
    1299. 

  1299.                               </td>
    1300. 

  1300.                             </tr>
    1301. 

  1301.                           </tbody>
    1302. 

  1302.                         </table>
    1303. 

  1303.                       </div>
    1304. 

  1304.                       <div>
    1305. 

  1305.                         <h4>Return Value</h4>
    1306. 

  1306.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1307. 

  1307.                       </div>
    1308. 

  1308.                     </section>
    1309. 

  1309.                   </div>
    1310. 

  1310.                 </li>
    1311. 

  1311.                 <li class="item">
    1312. 

  1312.                   <div>
    1313. 

  1313.                     <code>
    1314. 

  1314.                     <a name="/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ"></a>
    1315. 

  1315.                     <a name="//apple_ref/swift/Method/upload(_:with:interceptor:)" class="dashAnchor"></a>
    1316. 

  1316.                     <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ">upload(_:with:interceptor:)</a>
    1317. 

  1317.                     </code>
    1318. 

  1318.                   </div>
    1319. 

  1319.                   <div class="height-container">
    1320. 

  1320.                     <div class="pointer-container"></div>
    1321. 

  1321.                     <section class="section">
    1322. 

  1322.                       <div class="pointer"></div>
    1323. 

  1323.                       <div class="abstract">
    1324. 

  1324.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using the <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to upload the contents of the <code>fileURL</code> specificed
    1325. 

  1325. using the <code>urlRequest</code> provided.</p>
    1326. 

  1326. 

  1327.                       </div>
    1328. 

  1328.                       <div class="declaration">
    1329. 

  1329.                         <h4>Declaration</h4>
    1330. 

  1330.                         <div class="language">
    1331. 

  1331.                           <p class="aside-title">Swift</p>
    1332. 

  1332.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
    1333. 

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

  1334.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1335. 

  1335. 

  1336.                         </div>
    1337. 

  1337.                       </div>
    1338. 

  1338.                       <div>
    1339. 

  1339.                         <h4>Parameters</h4>
    1340. 

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

  1341.                           <tbody>
    1342. 

  1342.                             <tr>
    1343. 

  1343.                               <td>
    1344. 

  1344.                                 <code>
    1345. 

  1345.                                 <em>fileURL</em>
    1346. 

  1346.                                 </code>
    1347. 

  1347.                               </td>
    1348. 

  1348.                               <td>
    1349. 

  1349.                                 <div>
    1350. 

  1350.                                   <p>The <code>URL</code> of the file to upload.</p>
    1351. 

  1351.                                 </div>
    1352. 

  1352.                               </td>
    1353. 

  1353.                             </tr>
    1354. 

  1354.                             <tr>
    1355. 

  1355.                               <td>
    1356. 

  1356.                                 <code>
    1357. 

  1357.                                 <em>urlRequest</em>
    1358. 

  1358.                                 </code>
    1359. 

  1359.                               </td>
    1360. 

  1360.                               <td>
    1361. 

  1361.                                 <div>
    1362. 

  1362.                                   <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
    1363. 

  1363.                                 </div>
    1364. 

  1364.                               </td>
    1365. 

  1365.                             </tr>
    1366. 

  1366.                             <tr>
    1367. 

  1367.                               <td>
    1368. 

  1368.                                 <code>
    1369. 

  1369.                                 <em>interceptor</em>
    1370. 

  1370.                                 </code>
    1371. 

  1371.                               </td>
    1372. 

  1372.                               <td>
    1373. 

  1373.                                 <div>
    1374. 

  1374.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1375. 

  1375.                                 </div>
    1376. 

  1376.                               </td>
    1377. 

  1377.                             </tr>
    1378. 

  1378.                           </tbody>
    1379. 

  1379.                         </table>
    1380. 

  1380.                       </div>
    1381. 

  1381.                       <div>
    1382. 

  1382.                         <h4>Return Value</h4>
    1383. 

  1383.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1384. 

  1384.                       </div>
    1385. 

  1385.                     </section>
    1386. 

  1386.                   </div>
    1387. 

  1387.                 </li>
    1388. 

  1388.               </ul>
    1389. 

  1389.             </div>
    1390. 

  1390.             <div class="task-group">
    1391. 

  1391.               <div class="task-name-container">
    1392. 

  1392.                 <a name="/Data"></a>
    1393. 

  1393.                 <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
    1394. 

  1394.                 <a href="#/Data">
    1395. 

  1395.                   <h3 class="section-name">Data</h3>
    1396. 

  1396.                 </a>
    1397. 

  1397.               </div>
    1398. 

  1398.               <ul class="item-container">
    1399. 

  1399.                 <li class="item">
    1400. 

  1400.                   <div>
    1401. 

  1401.                     <code>
    1402. 

  1402.                     <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ"></a>
    1403. 

  1403.                     <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:)" class="dashAnchor"></a>
    1404. 

  1404.                     <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ">upload(_:to:method:headers:interceptor:)</a>
    1405. 

  1405.                     </code>
    1406. 

  1406.                   </div>
    1407. 

  1407.                   <div class="height-container">
    1408. 

  1408.                     <div class="pointer-container"></div>
    1409. 

  1409.                     <section class="section">
    1410. 

  1410.                       <div class="pointer"></div>
    1411. 

  1411.                       <div class="abstract">
    1412. 

  1412.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to upload the contents of the <code>data</code> specified using
    1413. 

  1413. the <code>url</code>, <code>method</code> and <code>headers</code> provided.</p>
    1414. 

  1414. 

  1415.                       </div>
    1416. 

  1416.                       <div class="declaration">
    1417. 

  1417.                         <h4>Declaration</h4>
    1418. 

  1418.                         <div class="language">
    1419. 

  1419.                           <p class="aside-title">Swift</p>
    1420. 

  1420.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    1421. 

  1421.                           <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>
    1422. 

  1422.                           <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>
    1423. 

  1423.                           <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1424. 

  1424.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1425. 

  1425. 

  1426.                         </div>
    1427. 

  1427.                       </div>
    1428. 

  1428.                       <div>
    1429. 

  1429.                         <h4>Parameters</h4>
    1430. 

  1430.                         <table class="graybox">
    1431. 

  1431.                           <tbody>
    1432. 

  1432.                             <tr>
    1433. 

  1433.                               <td>
    1434. 

  1434.                                 <code>
    1435. 

  1435.                                 <em>data</em>
    1436. 

  1436.                                 </code>
    1437. 

  1437.                               </td>
    1438. 

  1438.                               <td>
    1439. 

  1439.                                 <div>
    1440. 

  1440.                                   <p>The <code>Data</code> to upload.</p>
    1441. 

  1441.                                 </div>
    1442. 

  1442.                               </td>
    1443. 

  1443.                             </tr>
    1444. 

  1444.                             <tr>
    1445. 

  1445.                               <td>
    1446. 

  1446.                                 <code>
    1447. 

  1447.                                 <em>url</em>
    1448. 

  1448.                                 </code>
    1449. 

  1449.                               </td>
    1450. 

  1450.                               <td>
    1451. 

  1451.                                 <div>
    1452. 

  1452.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    1453. 

  1453.                                 </div>
    1454. 

  1454.                               </td>
    1455. 

  1455.                             </tr>
    1456. 

  1456.                             <tr>
    1457. 

  1457.                               <td>
    1458. 

  1458.                                 <code>
    1459. 

  1459.                                 <em>method</em>
    1460. 

  1460.                                 </code>
    1461. 

  1461.                               </td>
    1462. 

  1462.                               <td>
    1463. 

  1463.                                 <div>
    1464. 

  1464.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
    1465. 

  1465.                                 </div>
    1466. 

  1466.                               </td>
    1467. 

  1467.                             </tr>
    1468. 

  1468.                             <tr>
    1469. 

  1469.                               <td>
    1470. 

  1470.                                 <code>
    1471. 

  1471.                                 <em>headers</em>
    1472. 

  1472.                                 </code>
    1473. 

  1473.                               </td>
    1474. 

  1474.                               <td>
    1475. 

  1475.                                 <div>
    1476. 

  1476.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    1477. 

  1477.                                 </div>
    1478. 

  1478.                               </td>
    1479. 

  1479.                             </tr>
    1480. 

  1480.                             <tr>
    1481. 

  1481.                               <td>
    1482. 

  1482.                                 <code>
    1483. 

  1483.                                 <em>interceptor</em>
    1484. 

  1484.                                 </code>
    1485. 

  1485.                               </td>
    1486. 

  1486.                               <td>
    1487. 

  1487.                                 <div>
    1488. 

  1488.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1489. 

  1489.                                 </div>
    1490. 

  1490.                               </td>
    1491. 

  1491.                             </tr>
    1492. 

  1492.                             <tr>
    1493. 

  1493.                               <td>
    1494. 

  1494.                                 <code>
    1495. 

  1495.                                 <em>retryPolicies</em>
    1496. 

  1496.                                 </code>
    1497. 

  1497.                               </td>
    1498. 

  1498.                               <td>
    1499. 

  1499.                                 <div>
    1500. 

  1500.                                   <p>The <code><a href="../Classes/RetryPolicy.html">RetryPolicy</a></code> types, <code>[]</code> by default.</p>
    1501. 

  1501.                                 </div>
    1502. 

  1502.                               </td>
    1503. 

  1503.                             </tr>
    1504. 

  1504.                           </tbody>
    1505. 

  1505.                         </table>
    1506. 

  1506.                       </div>
    1507. 

  1507.                       <div>
    1508. 

  1508.                         <h4>Return Value</h4>
    1509. 

  1509.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1510. 

  1510.                       </div>
    1511. 

  1511.                     </section>
    1512. 

  1512.                   </div>
    1513. 

  1513.                 </li>
    1514. 

  1514.                 <li class="item">
    1515. 

  1515.                   <div>
    1516. 

  1516.                     <code>
    1517. 

  1517.                     <a name="/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ"></a>
    1518. 

  1518.                     <a name="//apple_ref/swift/Method/upload(_:with:interceptor:)" class="dashAnchor"></a>
    1519. 

  1519.                     <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ">upload(_:with:interceptor:)</a>
    1520. 

  1520.                     </code>
    1521. 

  1521.                   </div>
    1522. 

  1522.                   <div class="height-container">
    1523. 

  1523.                     <div class="pointer-container"></div>
    1524. 

  1524.                     <section class="section">
    1525. 

  1525.                       <div class="pointer"></div>
    1526. 

  1526.                       <div class="abstract">
    1527. 

  1527.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to upload the contents of the <code>data</code> specified using the
    1528. 

  1528. <code>urlRequest</code> provided.</p>
    1529. 

  1529. 

  1530.                       </div>
    1531. 

  1531.                       <div class="declaration">
    1532. 

  1532.                         <h4>Declaration</h4>
    1533. 

  1533.                         <div class="language">
    1534. 

  1534.                           <p class="aside-title">Swift</p>
    1535. 

  1535.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span>
    1536. 

  1536.                           <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>
    1537. 

  1537.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1538. 

  1538. 

  1539.                         </div>
    1540. 

  1540.                       </div>
    1541. 

  1541.                       <div>
    1542. 

  1542.                         <h4>Parameters</h4>
    1543. 

  1543.                         <table class="graybox">
    1544. 

  1544.                           <tbody>
    1545. 

  1545.                             <tr>
    1546. 

  1546.                               <td>
    1547. 

  1547.                                 <code>
    1548. 

  1548.                                 <em>data</em>
    1549. 

  1549.                                 </code>
    1550. 

  1550.                               </td>
    1551. 

  1551.                               <td>
    1552. 

  1552.                                 <div>
    1553. 

  1553.                                   <p>The <code>Data</code> to upload.</p>
    1554. 

  1554.                                 </div>
    1555. 

  1555.                               </td>
    1556. 

  1556.                             </tr>
    1557. 

  1557.                             <tr>
    1558. 

  1558.                               <td>
    1559. 

  1559.                                 <code>
    1560. 

  1560.                                 <em>urlRequest</em>
    1561. 

  1561.                                 </code>
    1562. 

  1562.                               </td>
    1563. 

  1563.                               <td>
    1564. 

  1564.                                 <div>
    1565. 

  1565.                                   <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
    1566. 

  1566.                                 </div>
    1567. 

  1567.                               </td>
    1568. 

  1568.                             </tr>
    1569. 

  1569.                             <tr>
    1570. 

  1570.                               <td>
    1571. 

  1571.                                 <code>
    1572. 

  1572.                                 <em>interceptor</em>
    1573. 

  1573.                                 </code>
    1574. 

  1574.                               </td>
    1575. 

  1575.                               <td>
    1576. 

  1576.                                 <div>
    1577. 

  1577.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1578. 

  1578.                                 </div>
    1579. 

  1579.                               </td>
    1580. 

  1580.                             </tr>
    1581. 

  1581.                           </tbody>
    1582. 

  1582.                         </table>
    1583. 

  1583.                       </div>
    1584. 

  1584.                       <div>
    1585. 

  1585.                         <h4>Return Value</h4>
    1586. 

  1586.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1587. 

  1587.                       </div>
    1588. 

  1588.                     </section>
    1589. 

  1589.                   </div>
    1590. 

  1590.                 </li>
    1591. 

  1591.               </ul>
    1592. 

  1592.             </div>
    1593. 

  1593.             <div class="task-group">
    1594. 

  1594.               <div class="task-name-container">
    1595. 

  1595.                 <a name="/InputStream"></a>
    1596. 

  1596.                 <a name="//apple_ref/swift/Section/InputStream" class="dashAnchor"></a>
    1597. 

  1597.                 <a href="#/InputStream">
    1598. 

  1598.                   <h3 class="section-name">InputStream</h3>
    1599. 

  1599.                 </a>
    1600. 

  1600.               </div>
    1601. 

  1601.               <ul class="item-container">
    1602. 

  1602.                 <li class="item">
    1603. 

  1603.                   <div>
    1604. 

  1604.                     <code>
    1605. 

  1605.                     <a name="/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ"></a>
    1606. 

  1606.                     <a name="//apple_ref/swift/Method/upload(_:to:method:headers:interceptor:)" class="dashAnchor"></a>
    1607. 

  1607.                     <a class="token" href="#/s:9Alamofire2AFO6upload_2to6method7headers11interceptorAA13UploadRequestCSo13NSInputStreamC_AA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0I11Interceptor_pSgtFZ">upload(_:to:method:headers:interceptor:)</a>
    1608. 

  1608.                     </code>
    1609. 

  1609.                   </div>
    1610. 

  1610.                   <div class="height-container">
    1611. 

  1611.                     <div class="pointer-container"></div>
    1612. 

  1612.                     <section class="section">
    1613. 

  1613.                       <div class="pointer"></div>
    1614. 

  1614.                       <div class="abstract">
    1615. 

  1615.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to upload the content provided by the <code>stream</code> specified
    1616. 

  1616. using the <code>url</code>, <code>method</code> and <code>headers</code> provided.</p>
    1617. 

  1617. 

  1618.                       </div>
    1619. 

  1619.                       <div class="declaration">
    1620. 

  1620.                         <h4>Declaration</h4>
    1621. 

  1621.                         <div class="language">
    1622. 

  1622.                           <p class="aside-title">Swift</p>
    1623. 

  1623.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span>
    1624. 

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

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

  1626.                           <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1627. 

  1627.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1628. 

  1628. 

  1629.                         </div>
    1630. 

  1630.                       </div>
    1631. 

  1631.                       <div>
    1632. 

  1632.                         <h4>Parameters</h4>
    1633. 

  1633.                         <table class="graybox">
    1634. 

  1634.                           <tbody>
    1635. 

  1635.                             <tr>
    1636. 

  1636.                               <td>
    1637. 

  1637.                                 <code>
    1638. 

  1638.                                 <em>stream</em>
    1639. 

  1639.                                 </code>
    1640. 

  1640.                               </td>
    1641. 

  1641.                               <td>
    1642. 

  1642.                                 <div>
    1643. 

  1643.                                   <p>The <code>InputStream</code> to upload.</p>
    1644. 

  1644.                                 </div>
    1645. 

  1645.                               </td>
    1646. 

  1646.                             </tr>
    1647. 

  1647.                             <tr>
    1648. 

  1648.                               <td>
    1649. 

  1649.                                 <code>
    1650. 

  1650.                                 <em>url</em>
    1651. 

  1651.                                 </code>
    1652. 

  1652.                               </td>
    1653. 

  1653.                               <td>
    1654. 

  1654.                                 <div>
    1655. 

  1655.                                   <p>The <code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value.</p>
    1656. 

  1656.                                 </div>
    1657. 

  1657.                               </td>
    1658. 

  1658.                             </tr>
    1659. 

  1659.                             <tr>
    1660. 

  1660.                               <td>
    1661. 

  1661.                                 <code>
    1662. 

  1662.                                 <em>method</em>
    1663. 

  1663.                                 </code>
    1664. 

  1664.                               </td>
    1665. 

  1665.                               <td>
    1666. 

  1666.                                 <div>
    1667. 

  1667.                                   <p>The <code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code>, <code>.post</code> by default.</p>
    1668. 

  1668.                                 </div>
    1669. 

  1669.                               </td>
    1670. 

  1670.                             </tr>
    1671. 

  1671.                             <tr>
    1672. 

  1672.                               <td>
    1673. 

  1673.                                 <code>
    1674. 

  1674.                                 <em>headers</em>
    1675. 

  1675.                                 </code>
    1676. 

  1676.                               </td>
    1677. 

  1677.                               <td>
    1678. 

  1678.                                 <div>
    1679. 

  1679.                                   <p>The <code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code>, <code>nil</code> by default.</p>
    1680. 

  1680.                                 </div>
    1681. 

  1681.                               </td>
    1682. 

  1682.                             </tr>
    1683. 

  1683.                             <tr>
    1684. 

  1684.                               <td>
    1685. 

  1685.                                 <code>
    1686. 

  1686.                                 <em>interceptor</em>
    1687. 

  1687.                                 </code>
    1688. 

  1688.                               </td>
    1689. 

  1689.                               <td>
    1690. 

  1690.                                 <div>
    1691. 

  1691.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1692. 

  1692.                                 </div>
    1693. 

  1693.                               </td>
    1694. 

  1694.                             </tr>
    1695. 

  1695.                           </tbody>
    1696. 

  1696.                         </table>
    1697. 

  1697.                       </div>
    1698. 

  1698.                       <div>
    1699. 

  1699.                         <h4>Return Value</h4>
    1700. 

  1700.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1701. 

  1701.                       </div>
    1702. 

  1702.                     </section>
    1703. 

  1703.                   </div>
    1704. 

  1704.                 </li>
    1705. 

  1705.                 <li class="item">
    1706. 

  1706.                   <div>
    1707. 

  1707.                     <code>
    1708. 

  1708.                     <a name="/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ"></a>
    1709. 

  1709.                     <a name="//apple_ref/swift/Method/upload(_:with:interceptor:)" class="dashAnchor"></a>
    1710. 

  1710.                     <a class="token" href="#/s:9Alamofire2AFO6upload_4with11interceptorAA13UploadRequestCSo13NSInputStreamC_AA21URLRequestConvertible_pAA0G11Interceptor_pSgtFZ">upload(_:with:interceptor:)</a>
    1711. 

  1711.                     </code>
    1712. 

  1712.                   </div>
    1713. 

  1713.                   <div class="height-container">
    1714. 

  1714.                     <div class="pointer-container"></div>
    1715. 

  1715.                     <section class="section">
    1716. 

  1716.                       <div class="pointer"></div>
    1717. 

  1717.                       <div class="abstract">
    1718. 

  1718.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using <code><a href="../Classes/Session.html#/s:9Alamofire7SessionC7defaultACvpZ">Session.default</a></code> to upload the content provided by the <code>stream</code>
    1719. 

  1719. specified using the <code>urlRequest</code> specified.</p>
    1720. 

  1720. 

  1721.                       </div>
    1722. 

  1722.                       <div class="declaration">
    1723. 

  1723.                         <h4>Declaration</h4>
    1724. 

  1724.                         <div class="language">
    1725. 

  1725.                           <p class="aside-title">Swift</p>
    1726. 

  1726.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span>
    1727. 

  1727.                           <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>
    1728. 

  1728.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1729. 

  1729. 

  1730.                         </div>
    1731. 

  1731.                       </div>
    1732. 

  1732.                       <div>
    1733. 

  1733.                         <h4>Parameters</h4>
    1734. 

  1734.                         <table class="graybox">
    1735. 

  1735.                           <tbody>
    1736. 

  1736.                             <tr>
    1737. 

  1737.                               <td>
    1738. 

  1738.                                 <code>
    1739. 

  1739.                                 <em>stream</em>
    1740. 

  1740.                                 </code>
    1741. 

  1741.                               </td>
    1742. 

  1742.                               <td>
    1743. 

  1743.                                 <div>
    1744. 

  1744.                                   <p>The <code>InputStream</code> to upload.</p>
    1745. 

  1745.                                 </div>
    1746. 

  1746.                               </td>
    1747. 

  1747.                             </tr>
    1748. 

  1748.                             <tr>
    1749. 

  1749.                               <td>
    1750. 

  1750.                                 <code>
    1751. 

  1751.                                 <em>urlRequest</em>
    1752. 

  1752.                                 </code>
    1753. 

  1753.                               </td>
    1754. 

  1754.                               <td>
    1755. 

  1755.                                 <div>
    1756. 

  1756.                                   <p>The <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value.</p>
    1757. 

  1757.                                 </div>
    1758. 

  1758.                               </td>
    1759. 

  1759.                             </tr>
    1760. 

  1760.                             <tr>
    1761. 

  1761.                               <td>
    1762. 

  1762.                                 <code>
    1763. 

  1763.                                 <em>interceptor</em>
    1764. 

  1764.                                 </code>
    1765. 

  1765.                               </td>
    1766. 

  1766.                               <td>
    1767. 

  1767.                                 <div>
    1768. 

  1768.                                   <p>The <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>, <code>nil</code> by default.</p>
    1769. 

  1769.                                 </div>
    1770. 

  1770.                               </td>
    1771. 

  1771.                             </tr>
    1772. 

  1772.                           </tbody>
    1773. 

  1773.                         </table>
    1774. 

  1774.                       </div>
    1775. 

  1775.                       <div>
    1776. 

  1776.                         <h4>Return Value</h4>
    1777. 

  1777.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1778. 

  1778.                       </div>
    1779. 

  1779.                     </section>
    1780. 

  1780.                   </div>
    1781. 

  1781.                 </li>
    1782. 

  1782.               </ul>
    1783. 

  1783.             </div>
    1784. 

  1784.             <div class="task-group">
    1785. 

  1785.               <div class="task-name-container">
    1786. 

  1786.                 <a name="/MultipartFormData"></a>
    1787. 

  1787.                 <a name="//apple_ref/swift/Section/MultipartFormData" class="dashAnchor"></a>
    1788. 

  1788.                 <a href="#/MultipartFormData">
    1789. 

  1789.                   <h3 class="section-name">MultipartFormData</h3>
    1790. 

  1790.                 </a>
    1791. 

  1791.               </div>
    1792. 

  1792.               <ul class="item-container">
    1793. 

  1793.                 <li class="item">
    1794. 

  1794.                   <div>
    1795. 

  1795.                     <code>
    1796. 

  1796.                     <a name="/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold11fileManager2to6method7headers11interceptorAA13UploadRequestCyAA09MultiparteF0Cc_s6UInt64VSo06NSFileJ0CAA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0P11Interceptor_pSgtFZ"></a>
    1797. 

  1797.                     <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:fileManager:to:method:headers:interceptor:)" class="dashAnchor"></a>
    1798. 

  1798.                     <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold11fileManager2to6method7headers11interceptorAA13UploadRequestCyAA09MultiparteF0Cc_s6UInt64VSo06NSFileJ0CAA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0P11Interceptor_pSgtFZ">upload(multipartFormData:usingThreshold:fileManager:to:method:headers:interceptor:)</a>
    1799. 

  1799.                     </code>
    1800. 

  1800.                   </div>
    1801. 

  1801.                   <div class="height-container">
    1802. 

  1802.                     <div class="pointer-container"></div>
    1803. 

  1803.                     <section class="section">
    1804. 

  1804.                       <div class="pointer"></div>
    1805. 

  1805.                       <div class="abstract">
    1806. 

  1806.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the multipart form data built using a closure and sent using the provided
    1807. 

  1807. <code>URLRequest</code> components and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
    1808. 

  1808. 

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

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

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

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

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

  1814. used for larger payloads such as video content.</p>
    1815. 

  1815. 

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

  1817. 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>,
    1818. 

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

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

  1820. technique was used.</p>
    1821. 

  1821. 

  1822.                       </div>
    1823. 

  1823.                       <div class="declaration">
    1824. 

  1824.                         <h4>Declaration</h4>
    1825. 

  1825.                         <div class="language">
    1826. 

  1826.                           <p class="aside-title">Swift</p>
    1827. 

  1827.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
    1828. 

  1828.                           <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
    1829. 

  1829.                           <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
    1830. 

  1830.                           <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>
    1831. 

  1831.                           <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>
    1832. 

  1832.                           <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    1833. 

  1833.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1834. 

  1834. 

  1835.                         </div>
    1836. 

  1836.                       </div>
    1837. 

  1837.                       <div>
    1838. 

  1838.                         <h4>Parameters</h4>
    1839. 

  1839.                         <table class="graybox">
    1840. 

  1840.                           <tbody>
    1841. 

  1841.                             <tr>
    1842. 

  1842.                               <td>
    1843. 

  1843.                                 <code>
    1844. 

  1844.                                 <em>multipartFormData</em>
    1845. 

  1845.                                 </code>
    1846. 

  1846.                               </td>
    1847. 

  1847.                               <td>
    1848. 

  1848.                                 <div>
    1849. 

  1849.                                   <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
    1850. 

  1850.                                 </div>
    1851. 

  1851.                               </td>
    1852. 

  1852.                             </tr>
    1853. 

  1853.                             <tr>
    1854. 

  1854.                               <td>
    1855. 

  1855.                                 <code>
    1856. 

  1856.                                 <em>encodingMemoryThreshold</em>
    1857. 

  1857.                                 </code>
    1858. 

  1858.                               </td>
    1859. 

  1859.                               <td>
    1860. 

  1860.                                 <div>
    1861. 

  1861.                                   <p>Byte threshold used to determine whether the form data is encoded into memory or
    1862. 

  1862.                      onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by default.</p>
    1863. 

  1863.                                 </div>
    1864. 

  1864.                               </td>
    1865. 

  1865.                             </tr>
    1866. 

  1866.                             <tr>
    1867. 

  1867.                               <td>
    1868. 

  1868.                                 <code>
    1869. 

  1869.                                 <em>fileManager</em>
    1870. 

  1870.                                 </code>
    1871. 

  1871.                               </td>
    1872. 

  1872.                               <td>
    1873. 

  1873.                                 <div>
    1874. 

  1874.                                   <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
    1875. 

  1875.                      written to disk before being uploaded.</p>
    1876. 

  1876.                                 </div>
    1877. 

  1877.                               </td>
    1878. 

  1878.                             </tr>
    1879. 

  1879.                             <tr>
    1880. 

  1880.                               <td>
    1881. 

  1881.                                 <code>
    1882. 

  1882.                                 <em>convertible</em>
    1883. 

  1883.                                 </code>
    1884. 

  1884.                               </td>
    1885. 

  1885.                               <td>
    1886. 

  1886.                                 <div>
    1887. 

  1887.                                   <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
    1888. 

  1888.                                 </div>
    1889. 

  1889.                               </td>
    1890. 

  1890.                             </tr>
    1891. 

  1891.                             <tr>
    1892. 

  1892.                               <td>
    1893. 

  1893.                                 <code>
    1894. 

  1894.                                 <em>method</em>
    1895. 

  1895.                                 </code>
    1896. 

  1896.                               </td>
    1897. 

  1897.                               <td>
    1898. 

  1898.                                 <div>
    1899. 

  1899.                                   <p><code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
    1900. 

  1900.                                 </div>
    1901. 

  1901.                               </td>
    1902. 

  1902.                             </tr>
    1903. 

  1903.                             <tr>
    1904. 

  1904.                               <td>
    1905. 

  1905.                                 <code>
    1906. 

  1906.                                 <em>headers</em>
    1907. 

  1907.                                 </code>
    1908. 

  1908.                               </td>
    1909. 

  1909.                               <td>
    1910. 

  1910.                                 <div>
    1911. 

  1911.                                   <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
    1912. 

  1912.                                 </div>
    1913. 

  1913.                               </td>
    1914. 

  1914.                             </tr>
    1915. 

  1915.                             <tr>
    1916. 

  1916.                               <td>
    1917. 

  1917.                                 <code>
    1918. 

  1918.                                 <em>interceptor</em>
    1919. 

  1919.                                 </code>
    1920. 

  1920.                               </td>
    1921. 

  1921.                               <td>
    1922. 

  1922.                                 <div>
    1923. 

  1923.                                   <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
    1924. 

  1924.                                 </div>
    1925. 

  1925.                               </td>
    1926. 

  1926.                             </tr>
    1927. 

  1927.                           </tbody>
    1928. 

  1928.                         </table>
    1929. 

  1929.                       </div>
    1930. 

  1930.                       <div>
    1931. 

  1931.                         <h4>Return Value</h4>
    1932. 

  1932.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    1933. 

  1933.                       </div>
    1934. 

  1934.                     </section>
    1935. 

  1935.                   </div>
    1936. 

  1936.                 </li>
    1937. 

  1937.                 <li class="item">
    1938. 

  1938.                   <div>
    1939. 

  1939.                     <code>
    1940. 

  1940.                     <a name="/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold11fileManager4with11interceptorAA13UploadRequestCyAA09MultiparteF0Cc_s6UInt64VSo06NSFileJ0CAA21URLRequestConvertible_pAA0N11Interceptor_pSgtFZ"></a>
    1941. 

  1941.                     <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:fileManager:with:interceptor:)" class="dashAnchor"></a>
    1942. 

  1942.                     <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold11fileManager4with11interceptorAA13UploadRequestCyAA09MultiparteF0Cc_s6UInt64VSo06NSFileJ0CAA21URLRequestConvertible_pAA0N11Interceptor_pSgtFZ">upload(multipartFormData:usingThreshold:fileManager:with:interceptor:)</a>
    1943. 

  1943.                     </code>
    1944. 

  1944.                   </div>
    1945. 

  1945.                   <div class="height-container">
    1946. 

  1946.                     <div class="pointer-container"></div>
    1947. 

  1947.                     <section class="section">
    1948. 

  1948.                       <div class="pointer"></div>
    1949. 

  1949.                       <div class="abstract">
    1950. 

  1950.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> using a <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure, the provided <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>
    1951. 

  1951. value, and a <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
    1952. 

  1952. 

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

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

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

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

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

  1958. used for larger payloads such as video content.</p>
    1959. 

  1959. 

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

  1961. 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>,
    1962. 

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

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

  1964. technique was used.</p>
    1965. 

  1965. 

  1966.                       </div>
    1967. 

  1967.                       <div class="declaration">
    1968. 

  1968.                         <h4>Declaration</h4>
    1969. 

  1969.                         <div class="language">
    1970. 

  1970.                           <p class="aside-title">Swift</p>
    1971. 

  1971.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">,</span>
    1972. 

  1972.                           <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
    1973. 

  1973.                           <span class="nv">fileManager</span><span class="p">:</span> <span class="kt">FileManager</span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span>
    1974. 

  1974.                           <span class="n">with</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
    1975. 

  1975.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    1976. 

  1976. 

  1977.                         </div>
    1978. 

  1978.                       </div>
    1979. 

  1979.                       <div>
    1980. 

  1980.                         <h4>Parameters</h4>
    1981. 

  1981.                         <table class="graybox">
    1982. 

  1982.                           <tbody>
    1983. 

  1983.                             <tr>
    1984. 

  1984.                               <td>
    1985. 

  1985.                                 <code>
    1986. 

  1986.                                 <em>multipartFormData</em>
    1987. 

  1987.                                 </code>
    1988. 

  1988.                               </td>
    1989. 

  1989.                               <td>
    1990. 

  1990.                                 <div>
    1991. 

  1991.                                   <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> building closure.</p>
    1992. 

  1992.                                 </div>
    1993. 

  1993.                               </td>
    1994. 

  1994.                             </tr>
    1995. 

  1995.                             <tr>
    1996. 

  1996.                               <td>
    1997. 

  1997.                                 <code>
    1998. 

  1998.                                 <em>encodingMemoryThreshold</em>
    1999. 

  1999.                                 </code>
    2000. 

  2000.                               </td>
    2001. 

  2001.                               <td>
    2002. 

  2002.                                 <div>
    2003. 

  2003.                                   <p>Byte threshold used to determine whether the form data is encoded into memory or
    2004. 

  2004.                      onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by default.</p>
    2005. 

  2005.                                 </div>
    2006. 

  2006.                               </td>
    2007. 

  2007.                             </tr>
    2008. 

  2008.                             <tr>
    2009. 

  2009.                               <td>
    2010. 

  2010.                                 <code>
    2011. 

  2011.                                 <em>fileManager</em>
    2012. 

  2012.                                 </code>
    2013. 

  2013.                               </td>
    2014. 

  2014.                               <td>
    2015. 

  2015.                                 <div>
    2016. 

  2016.                                   <p><code>FileManager</code> to be used if the form data exceeds the memory threshold and is
    2017. 

  2017.                      written to disk before being uploaded.</p>
    2018. 

  2018.                                 </div>
    2019. 

  2019.                               </td>
    2020. 

  2020.                             </tr>
    2021. 

  2021.                             <tr>
    2022. 

  2022.                               <td>
    2023. 

  2023.                                 <code>
    2024. 

  2024.                                 <em>request</em>
    2025. 

  2025.                                 </code>
    2026. 

  2026.                               </td>
    2027. 

  2027.                               <td>
    2028. 

  2028.                                 <div>
    2029. 

  2029.                                   <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
    2030. 

  2030.                                 </div>
    2031. 

  2031.                               </td>
    2032. 

  2032.                             </tr>
    2033. 

  2033.                             <tr>
    2034. 

  2034.                               <td>
    2035. 

  2035.                                 <code>
    2036. 

  2036.                                 <em>interceptor</em>
    2037. 

  2037.                                 </code>
    2038. 

  2038.                               </td>
    2039. 

  2039.                               <td>
    2040. 

  2040.                                 <div>
    2041. 

  2041.                                   <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
    2042. 

  2042.                                 </div>
    2043. 

  2043.                               </td>
    2044. 

  2044.                             </tr>
    2045. 

  2045.                           </tbody>
    2046. 

  2046.                         </table>
    2047. 

  2047.                       </div>
    2048. 

  2048.                       <div>
    2049. 

  2049.                         <h4>Return Value</h4>
    2050. 

  2050.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    2051. 

  2051.                       </div>
    2052. 

  2052.                     </section>
    2053. 

  2053.                   </div>
    2054. 

  2054.                 </li>
    2055. 

  2055.                 <li class="item">
    2056. 

  2056.                   <div>
    2057. 

  2057.                     <code>
    2058. 

  2058.                     <a name="/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold2to6method7headers11interceptorAA13UploadRequestCAA09MultiparteF0C_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0N11Interceptor_pSgtFZ"></a>
    2059. 

  2059.                     <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:to:method:headers:interceptor:)" class="dashAnchor"></a>
    2060. 

  2060.                     <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold2to6method7headers11interceptorAA13UploadRequestCAA09MultiparteF0C_s6UInt64VAA14URLConvertible_pAA10HTTPMethodOAA11HTTPHeadersVSgAA0N11Interceptor_pSgtFZ">upload(multipartFormData:usingThreshold:to:method:headers:interceptor:)</a>
    2061. 

  2061.                     </code>
    2062. 

  2062.                   </div>
    2063. 

  2063.                   <div class="height-container">
    2064. 

  2064.                     <div class="pointer-container"></div>
    2065. 

  2065.                     <section class="section">
    2066. 

  2066.                       <div class="pointer"></div>
    2067. 

  2067.                       <div class="abstract">
    2068. 

  2068.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the prebuilt <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> value using the provided <code>URLRequest</code> components
    2069. 

  2069. and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
    2070. 

  2070. 

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

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

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

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

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

  2076. used for larger payloads such as video content.</p>
    2077. 

  2077. 

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

  2079. 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>,
    2080. 

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

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

  2082. technique was used.</p>
    2083. 

  2083. 

  2084.                       </div>
    2085. 

  2085.                       <div class="declaration">
    2086. 

  2086.                         <h4>Declaration</h4>
    2087. 

  2087.                         <div class="language">
    2088. 

  2088.                           <p class="aside-title">Swift</p>
    2089. 

  2089.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">,</span>
    2090. 

  2090.                           <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
    2091. 

  2091.                           <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>
    2092. 

  2092.                           <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>
    2093. 

  2093.                           <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
    2094. 

  2094.                           <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    2095. 

  2095. 

  2096.                         </div>
    2097. 

  2097.                       </div>
    2098. 

  2098.                       <div>
    2099. 

  2099.                         <h4>Parameters</h4>
    2100. 

  2100.                         <table class="graybox">
    2101. 

  2101.                           <tbody>
    2102. 

  2102.                             <tr>
    2103. 

  2103.                               <td>
    2104. 

  2104.                                 <code>
    2105. 

  2105.                                 <em>multipartFormData</em>
    2106. 

  2106.                                 </code>
    2107. 

  2107.                               </td>
    2108. 

  2108.                               <td>
    2109. 

  2109.                                 <div>
    2110. 

  2110.                                   <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
    2111. 

  2111.                                 </div>
    2112. 

  2112.                               </td>
    2113. 

  2113.                             </tr>
    2114. 

  2114.                             <tr>
    2115. 

  2115.                               <td>
    2116. 

  2116.                                 <code>
    2117. 

  2117.                                 <em>encodingMemoryThreshold</em>
    2118. 

  2118.                                 </code>
    2119. 

  2119.                               </td>
    2120. 

  2120.                               <td>
    2121. 

  2121.                                 <div>
    2122. 

  2122.                                   <p>Byte threshold used to determine whether the form data is encoded into memory or
    2123. 

  2123.                      onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by default.</p>
    2124. 

  2124.                                 </div>
    2125. 

  2125.                               </td>
    2126. 

  2126.                             </tr>
    2127. 

  2127.                             <tr>
    2128. 

  2128.                               <td>
    2129. 

  2129.                                 <code>
    2130. 

  2130.                                 <em>url</em>
    2131. 

  2131.                                 </code>
    2132. 

  2132.                               </td>
    2133. 

  2133.                               <td>
    2134. 

  2134.                                 <div>
    2135. 

  2135.                                   <p><code><a href="../Protocols/URLConvertible.html">URLConvertible</a></code> value to be used as the <code>URLRequest</code>&lsquo;s <code>URL</code>.</p>
    2136. 

  2136.                                 </div>
    2137. 

  2137.                               </td>
    2138. 

  2138.                             </tr>
    2139. 

  2139.                             <tr>
    2140. 

  2140.                               <td>
    2141. 

  2141.                                 <code>
    2142. 

  2142.                                 <em>method</em>
    2143. 

  2143.                                 </code>
    2144. 

  2144.                               </td>
    2145. 

  2145.                               <td>
    2146. 

  2146.                                 <div>
    2147. 

  2147.                                   <p><code><a href="../Enums/HTTPMethod.html">HTTPMethod</a></code> for the <code>URLRequest</code>. <code>.post</code> by default.</p>
    2148. 

  2148.                                 </div>
    2149. 

  2149.                               </td>
    2150. 

  2150.                             </tr>
    2151. 

  2151.                             <tr>
    2152. 

  2152.                               <td>
    2153. 

  2153.                                 <code>
    2154. 

  2154.                                 <em>headers</em>
    2155. 

  2155.                                 </code>
    2156. 

  2156.                               </td>
    2157. 

  2157.                               <td>
    2158. 

  2158.                                 <div>
    2159. 

  2159.                                   <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> value to be added to the <code>URLRequest</code>. <code>nil</code> by default.</p>
    2160. 

  2160.                                 </div>
    2161. 

  2161.                               </td>
    2162. 

  2162.                             </tr>
    2163. 

  2163.                             <tr>
    2164. 

  2164.                               <td>
    2165. 

  2165.                                 <code>
    2166. 

  2166.                                 <em>interceptor</em>
    2167. 

  2167.                                 </code>
    2168. 

  2168.                               </td>
    2169. 

  2169.                               <td>
    2170. 

  2170.                                 <div>
    2171. 

  2171.                                   <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
    2172. 

  2172.                                 </div>
    2173. 

  2173.                               </td>
    2174. 

  2174.                             </tr>
    2175. 

  2175.                           </tbody>
    2176. 

  2176.                         </table>
    2177. 

  2177.                       </div>
    2178. 

  2178.                       <div>
    2179. 

  2179.                         <h4>Return Value</h4>
    2180. 

  2180.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    2181. 

  2181.                       </div>
    2182. 

  2182.                     </section>
    2183. 

  2183.                   </div>
    2184. 

  2184.                 </li>
    2185. 

  2185.                 <li class="item">
    2186. 

  2186.                   <div>
    2187. 

  2187.                     <code>
    2188. 

  2188.                     <a name="/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold4with11interceptorAA13UploadRequestCAA09MultiparteF0C_s6UInt64VAA21URLRequestConvertible_pAA0L11Interceptor_pSgtFZ"></a>
    2189. 

  2189.                     <a name="//apple_ref/swift/Method/upload(multipartFormData:usingThreshold:with:interceptor:)" class="dashAnchor"></a>
    2190. 

  2190.                     <a class="token" href="#/s:9Alamofire2AFO6upload17multipartFormData14usingThreshold4with11interceptorAA13UploadRequestCAA09MultiparteF0C_s6UInt64VAA21URLRequestConvertible_pAA0L11Interceptor_pSgtFZ">upload(multipartFormData:usingThreshold:with:interceptor:)</a>
    2191. 

  2191.                     </code>
    2192. 

  2192.                   </div>
    2193. 

  2193.                   <div class="height-container">
    2194. 

  2194.                     <div class="pointer-container"></div>
    2195. 

  2195.                     <section class="section">
    2196. 

  2196.                       <div class="pointer"></div>
    2197. 

  2197.                       <div class="abstract">
    2198. 

  2198.                         <p>Creates an <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code> for the prebuilt <code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> value using the providing <code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code>
    2199. 

  2199. value and <code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code>.</p>
    2200. 

  2200. 

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

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

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

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

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

  2206. used for larger payloads such as video content.</p>
    2207. 

  2207. 

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

  2209. 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>,
    2210. 

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

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

  2212. technique was used.</p>
    2213. 

  2213. 

  2214.                       </div>
    2215. 

  2215.                       <div class="declaration">
    2216. 

  2216.                         <h4>Declaration</h4>
    2217. 

  2217.                         <div class="language">
    2218. 

  2218.                           <p class="aside-title">Swift</p>
    2219. 

  2219.                           <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span>  <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">multipartFormData</span><span class="p">:</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="p">,</span>
    2220. 

  2220.                            <span class="n">usingThreshold</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="o">=</span> <span class="kt"><a href="../Classes/MultipartFormData.html">MultipartFormData</a></span><span class="o">.</span><span class="n">encodingMemoryThreshold</span><span class="p">,</span>
    2221. 

  2221.                            <span class="n">with</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></span><span class="p">,</span>
    2222. 

  2222.                            <span class="nv">interceptor</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/UploadRequest.html">UploadRequest</a></span></code></pre>
    2223. 

  2223. 

  2224.                         </div>
    2225. 

  2225.                       </div>
    2226. 

  2226.                       <div>
    2227. 

  2227.                         <h4>Parameters</h4>
    2228. 

  2228.                         <table class="graybox">
    2229. 

  2229.                           <tbody>
    2230. 

  2230.                             <tr>
    2231. 

  2231.                               <td>
    2232. 

  2232.                                 <code>
    2233. 

  2233.                                 <em>multipartFormData</em>
    2234. 

  2234.                                 </code>
    2235. 

  2235.                               </td>
    2236. 

  2236.                               <td>
    2237. 

  2237.                                 <div>
    2238. 

  2238.                                   <p><code><a href="../Classes/MultipartFormData.html">MultipartFormData</a></code> instance to upload.</p>
    2239. 

  2239.                                 </div>
    2240. 

  2240.                               </td>
    2241. 

  2241.                             </tr>
    2242. 

  2242.                             <tr>
    2243. 

  2243.                               <td>
    2244. 

  2244.                                 <code>
    2245. 

  2245.                                 <em>encodingMemoryThreshold</em>
    2246. 

  2246.                                 </code>
    2247. 

  2247.                               </td>
    2248. 

  2248.                               <td>
    2249. 

  2249.                                 <div>
    2250. 

  2250.                                   <p>Byte threshold used to determine whether the form data is encoded into memory or
    2251. 

  2251.                      onto disk before being uploaded. <code><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">MultipartFormData.encodingMemoryThreshold</a></code> by
    2252. 

  2252.                      default.</p>
    2253. 

  2253.                                 </div>
    2254. 

  2254.                               </td>
    2255. 

  2255.                             </tr>
    2256. 

  2256.                             <tr>
    2257. 

  2257.                               <td>
    2258. 

  2258.                                 <code>
    2259. 

  2259.                                 <em>request</em>
    2260. 

  2260.                                 </code>
    2261. 

  2261.                               </td>
    2262. 

  2262.                               <td>
    2263. 

  2263.                                 <div>
    2264. 

  2264.                                   <p><code><a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a></code> value to be used to create the <code>URLRequest</code>.</p>
    2265. 

  2265.                                 </div>
    2266. 

  2266.                               </td>
    2267. 

  2267.                             </tr>
    2268. 

  2268.                             <tr>
    2269. 

  2269.                               <td>
    2270. 

  2270.                                 <code>
    2271. 

  2271.                                 <em>interceptor</em>
    2272. 

  2272.                                 </code>
    2273. 

  2273.                               </td>
    2274. 

  2274.                               <td>
    2275. 

  2275.                                 <div>
    2276. 

  2276.                                   <p><code><a href="../Protocols/RequestInterceptor.html">RequestInterceptor</a></code> value to be used by the returned <code><a href="../Classes/DataRequest.html">DataRequest</a></code>. <code>nil</code> by default.</p>
    2277. 

  2277.                                 </div>
    2278. 

  2278.                               </td>
    2279. 

  2279.                             </tr>
    2280. 

  2280.                           </tbody>
    2281. 

  2281.                         </table>
    2282. 

  2282.                       </div>
    2283. 

  2283.                       <div>
    2284. 

  2284.                         <h4>Return Value</h4>
    2285. 

  2285.                         <p>The created <code><a href="../Classes/UploadRequest.html">UploadRequest</a></code>.</p>
    2286. 

  2286.                       </div>
    2287. 

  2287.                     </section>
    2288. 

  2288.                   </div>
    2289. 

  2289.                 </li>
    2290. 

  2290.               </ul>
    2291. 

  2291.             </div>
    2292. 

  2292.           </div>
    2293. 

  2293.         </section>
    2294. 

  2294. 

  2295.       </article>
    2296. 

  2296.     </div>
    2297. 

  2297.     <section class="footer">
    2298. 

  2298.       <p>&copy; 2019 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2019-07-29)</p>
    2299. 

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

  2300.     </section>
    2301. 

  2301.   </body>
    2302. 

  2302. </div>
    2303. 

  2303. </html>
    2304.