MultipartFormData.html 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>MultipartFormData Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset="utf-8">
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/MultipartFormData" class="dashAnchor"></a>
  16. <a title="MultipartFormData Class Reference"></a>
  17. <header class="header">
  18. <p class="header-col header-col--primary">
  19. <a class="header-link" href="../index.html">
  20. Alamofire Docs
  21. </a>
  22. (87% documented)
  23. </p>
  24. <p class="header-col--secondary">
  25. <form role="search" action="../search.json">
  26. <input type="text" placeholder="Search documentation" data-typeahead>
  27. </form>
  28. </p>
  29. <p class="header-col header-col--secondary">
  30. <a class="header-link" href="https://github.com/Alamofire/Alamofire">
  31. <img class="header-icon" src="../img/gh.png"/>
  32. View on GitHub
  33. </a>
  34. </p>
  35. <p class="header-col header-col--secondary">
  36. <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml">
  37. <img class="header-icon" src="../img/dash.png"/>
  38. Install in Dash
  39. </a>
  40. </p>
  41. </header>
  42. <p class="breadcrumbs">
  43. <a class="breadcrumb" href="../index.html">Alamofire Reference</a>
  44. <img class="carat" src="../img/carat.png" />
  45. MultipartFormData Class Reference
  46. </p>
  47. <div class="content-wrapper">
  48. <nav class="navigation">
  49. <ul class="nav-groups">
  50. <li class="nav-group-name">
  51. <a class="nav-group-name-link" href="../Classes.html">Classes</a>
  52. <ul class="nav-group-tasks">
  53. <li class="nav-group-task">
  54. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  100. </li>
  101. </ul>
  102. </li>
  103. <li class="nav-group-name">
  104. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  105. <ul class="nav-group-tasks">
  106. <li class="nav-group-task">
  107. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  108. </li>
  109. <li class="nav-group-task">
  110. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  111. </li>
  112. <li class="nav-group-task">
  113. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  114. </li>
  115. <li class="nav-group-task">
  116. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  117. </li>
  118. <li class="nav-group-task">
  119. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  120. </li>
  121. <li class="nav-group-task">
  122. <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a>
  123. </li>
  124. <li class="nav-group-task">
  125. <a class="nav-group-task-link" href="../Enums/Result.html">Result</a>
  126. </li>
  127. <li class="nav-group-task">
  128. <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a>
  129. </li>
  130. </ul>
  131. </li>
  132. <li class="nav-group-name">
  133. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  134. <ul class="nav-group-tasks">
  135. <li class="nav-group-task">
  136. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  137. </li>
  138. <li class="nav-group-task">
  139. <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a>
  140. </li>
  141. <li class="nav-group-task">
  142. <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a>
  143. </li>
  144. <li class="nav-group-task">
  145. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  146. </li>
  147. <li class="nav-group-task">
  148. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  149. </li>
  150. <li class="nav-group-task">
  151. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  152. </li>
  153. <li class="nav-group-task">
  154. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  155. </li>
  156. </ul>
  157. </li>
  158. <li class="nav-group-name">
  159. <a class="nav-group-name-link" href="../Functions.html">Functions</a>
  160. <ul class="nav-group-tasks">
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a>
  184. </li>
  185. <li class="nav-group-task">
  186. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  187. </li>
  188. <li class="nav-group-task">
  189. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  190. </li>
  191. <li class="nav-group-task">
  192. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a>
  193. </li>
  194. <li class="nav-group-task">
  195. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  196. </li>
  197. <li class="nav-group-task">
  198. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  199. </li>
  200. <li class="nav-group-task">
  201. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a>
  202. </li>
  203. <li class="nav-group-task">
  204. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a>
  205. </li>
  206. <li class="nav-group-task">
  207. <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a>
  208. </li>
  209. </ul>
  210. </li>
  211. <li class="nav-group-name">
  212. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  213. <ul class="nav-group-tasks">
  214. <li class="nav-group-task">
  215. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  216. </li>
  217. <li class="nav-group-task">
  218. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  219. </li>
  220. <li class="nav-group-task">
  221. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  222. </li>
  223. <li class="nav-group-task">
  224. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  225. </li>
  226. <li class="nav-group-task">
  227. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  228. </li>
  229. <li class="nav-group-task">
  230. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  231. </li>
  232. <li class="nav-group-task">
  233. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  234. </li>
  235. </ul>
  236. </li>
  237. <li class="nav-group-name">
  238. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  239. <ul class="nav-group-tasks">
  240. <li class="nav-group-task">
  241. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  242. </li>
  243. <li class="nav-group-task">
  244. <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a>
  245. </li>
  246. <li class="nav-group-task">
  247. <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a>
  248. </li>
  249. <li class="nav-group-task">
  250. <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a>
  251. </li>
  252. <li class="nav-group-task">
  253. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  254. </li>
  255. <li class="nav-group-task">
  256. <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a>
  257. </li>
  258. <li class="nav-group-task">
  259. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  260. </li>
  261. <li class="nav-group-task">
  262. <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a>
  263. </li>
  264. <li class="nav-group-task">
  265. <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a>
  266. </li>
  267. <li class="nav-group-task">
  268. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  269. </li>
  270. <li class="nav-group-task">
  271. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  272. </li>
  273. </ul>
  274. </li>
  275. <li class="nav-group-name">
  276. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  277. <ul class="nav-group-tasks">
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a>
  280. </li>
  281. <li class="nav-group-task">
  282. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  283. </li>
  284. <li class="nav-group-task">
  285. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a>
  286. </li>
  287. </ul>
  288. </li>
  289. </ul>
  290. </nav>
  291. <article class="main-content">
  292. <section class="section">
  293. <div class="section-content">
  294. <h1>MultipartFormData</h1>
  295. <div class="declaration">
  296. <div class="language">
  297. <pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">MultipartFormData</span></code></pre>
  298. </div>
  299. </div>
  300. <p>Constructs <code>multipart/form-data</code> for uploads within an HTTP or HTTPS body. There are currently two ways to encode
  301. multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead
  302. to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the
  303. data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for
  304. larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.</p>
  305. <p>For more information on <code>multipart/form-data</code> in general, please refer to the RFC-2388 and RFC-2045 specs as well
  306. and the w3 form documentation.</p>
  307. <ul>
  308. <li><a href="https://www.ietf.org/rfc/rfc2388.txt">https://www.ietf.org/rfc/rfc2388.txt</a></li>
  309. <li><a href="https://www.ietf.org/rfc/rfc2045.txt">https://www.ietf.org/rfc/rfc2045.txt</a></li>
  310. <li><a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13">https://www.w3.org/TR/html401/interact/forms.html#h-17.13</a></li>
  311. </ul>
  312. </div>
  313. </section>
  314. <section class="section">
  315. <div class="section-content">
  316. <div class="task-group">
  317. <div class="task-name-container">
  318. <a name="/Properties"></a>
  319. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  320. <a href="#/Properties">
  321. <h3 class="section-name">Properties</h3>
  322. </a>
  323. </div>
  324. <ul class="item-container">
  325. <li class="item">
  326. <div>
  327. <code>
  328. <a name="/s:9Alamofire17MultipartFormDataC11contentTypeSSv"></a>
  329. <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a>
  330. <a class="token" href="#/s:9Alamofire17MultipartFormDataC11contentTypeSSv">contentType</a>
  331. </code>
  332. </div>
  333. <div class="height-container">
  334. <div class="pointer-container"></div>
  335. <section class="section">
  336. <div class="pointer"></div>
  337. <div class="abstract">
  338. <p>The <code>Content-Type</code> header value containing the boundary used to generate the <code>multipart/form-data</code>.</p>
  339. </div>
  340. <div class="declaration">
  341. <h4>Declaration</h4>
  342. <div class="language">
  343. <p class="aside-title">Swift</p>
  344. <pre class="highlight"><code><span class="n">open</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">contentType</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"multipart/form-data; boundary=</span><span class="se">\(</span><span class="k">self</span><span class="o">.</span><span class="n"><a href="../Classes/MultipartFormData.html#/s:9Alamofire17MultipartFormDataC8boundarySSv">boundary</a></span><span class="se">)</span><span class="s">"</span></code></pre>
  345. </div>
  346. </div>
  347. </section>
  348. </div>
  349. </li>
  350. <li class="item">
  351. <div>
  352. <code>
  353. <a name="/s:9Alamofire17MultipartFormDataC13contentLengths6UInt64Vv"></a>
  354. <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a>
  355. <a class="token" href="#/s:9Alamofire17MultipartFormDataC13contentLengths6UInt64Vv">contentLength</a>
  356. </code>
  357. </div>
  358. <div class="height-container">
  359. <div class="pointer-container"></div>
  360. <section class="section">
  361. <div class="pointer"></div>
  362. <div class="abstract">
  363. <p>The content length of all body parts used to generate the <code>multipart/form-data</code> not including the boundaries.</p>
  364. </div>
  365. <div class="declaration">
  366. <h4>Declaration</h4>
  367. <div class="language">
  368. <p class="aside-title">Swift</p>
  369. <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">contentLength</span><span class="p">:</span> <span class="kt">UInt64</span></code></pre>
  370. </div>
  371. </div>
  372. </section>
  373. </div>
  374. </li>
  375. <li class="item">
  376. <div>
  377. <code>
  378. <a name="/s:9Alamofire17MultipartFormDataC8boundarySSv"></a>
  379. <a name="//apple_ref/swift/Property/boundary" class="dashAnchor"></a>
  380. <a class="token" href="#/s:9Alamofire17MultipartFormDataC8boundarySSv">boundary</a>
  381. </code>
  382. </div>
  383. <div class="height-container">
  384. <div class="pointer-container"></div>
  385. <section class="section">
  386. <div class="pointer"></div>
  387. <div class="abstract">
  388. <p>The boundary used to separate the body parts in the encoded form data.</p>
  389. </div>
  390. <div class="declaration">
  391. <h4>Declaration</h4>
  392. <div class="language">
  393. <p class="aside-title">Swift</p>
  394. <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">boundary</span><span class="p">:</span> <span class="kt">String</span></code></pre>
  395. </div>
  396. </div>
  397. </section>
  398. </div>
  399. </li>
  400. </ul>
  401. </div>
  402. <div class="task-group">
  403. <div class="task-name-container">
  404. <a name="/Lifecycle"></a>
  405. <a name="//apple_ref/swift/Section/Lifecycle" class="dashAnchor"></a>
  406. <a href="#/Lifecycle">
  407. <h3 class="section-name">Lifecycle</h3>
  408. </a>
  409. </div>
  410. <ul class="item-container">
  411. <li class="item">
  412. <div>
  413. <code>
  414. <a name="/s:9Alamofire17MultipartFormDataCACycfc"></a>
  415. <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
  416. <a class="token" href="#/s:9Alamofire17MultipartFormDataCACycfc">init()</a>
  417. </code>
  418. </div>
  419. <div class="height-container">
  420. <div class="pointer-container"></div>
  421. <section class="section">
  422. <div class="pointer"></div>
  423. <div class="abstract">
  424. <p>Creates a multipart form data object.</p>
  425. </div>
  426. <div class="declaration">
  427. <h4>Declaration</h4>
  428. <div class="language">
  429. <p class="aside-title">Swift</p>
  430. <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>
  431. </div>
  432. </div>
  433. <div>
  434. <h4>Return Value</h4>
  435. <p>The multipart form data object.</p>
  436. </div>
  437. </section>
  438. </div>
  439. </li>
  440. </ul>
  441. </div>
  442. <div class="task-group">
  443. <div class="task-name-container">
  444. <a name="/Body%20Parts"></a>
  445. <a name="//apple_ref/swift/Section/Body Parts" class="dashAnchor"></a>
  446. <a href="#/Body%20Parts">
  447. <h3 class="section-name">Body Parts</h3>
  448. </a>
  449. </div>
  450. <ul class="item-container">
  451. <li class="item">
  452. <div>
  453. <code>
  454. <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNametF"></a>
  455. <a name="//apple_ref/swift/Method/append(_:withName:)" class="dashAnchor"></a>
  456. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNametF">append(_:withName:)</a>
  457. </code>
  458. </div>
  459. <div class="height-container">
  460. <div class="pointer-container"></div>
  461. <section class="section">
  462. <div class="pointer"></div>
  463. <div class="abstract">
  464. <p>Creates a body part from the data and appends it to the multipart form data object.</p>
  465. <p>The body part data will be encoded using the following format:</p>
  466. <ul>
  467. <li><code>Content-Disposition: form-data; name=#{name}</code> (HTTP Header)</li>
  468. <li>Encoded data</li>
  469. <li><p>Multipart form boundary</p></li>
  470. </ul>
  471. </div>
  472. <div class="declaration">
  473. <h4>Declaration</h4>
  474. <div class="language">
  475. <p class="aside-title">Swift</p>
  476. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">withName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  477. </div>
  478. </div>
  479. <div>
  480. <h4>Parameters</h4>
  481. <table class="graybox">
  482. <tbody>
  483. <tr>
  484. <td>
  485. <code>
  486. <em>data</em>
  487. </code>
  488. </td>
  489. <td>
  490. <div>
  491. <p>The data to encode into the multipart form data.</p>
  492. </div>
  493. </td>
  494. </tr>
  495. <tr>
  496. <td>
  497. <code>
  498. <em>name</em>
  499. </code>
  500. </td>
  501. <td>
  502. <div>
  503. <p>The name to associate with the data in the <code>Content-Disposition</code> HTTP header.</p>
  504. </div>
  505. </td>
  506. </tr>
  507. </tbody>
  508. </table>
  509. </div>
  510. </section>
  511. </div>
  512. </li>
  513. <li class="item">
  514. <div>
  515. <code>
  516. <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS8mimeTypetF"></a>
  517. <a name="//apple_ref/swift/Method/append(_:withName:mimeType:)" class="dashAnchor"></a>
  518. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS8mimeTypetF">append(_:withName:mimeType:)</a>
  519. </code>
  520. </div>
  521. <div class="height-container">
  522. <div class="pointer-container"></div>
  523. <section class="section">
  524. <div class="pointer"></div>
  525. <div class="abstract">
  526. <p>Creates a body part from the data and appends it to the multipart form data object.</p>
  527. <p>The body part data will be encoded using the following format:</p>
  528. <ul>
  529. <li><code>Content-Disposition: form-data; name=#{name}</code> (HTTP Header)</li>
  530. <li><code>Content-Type: #{generated mimeType}</code> (HTTP Header)</li>
  531. <li>Encoded data</li>
  532. <li><p>Multipart form boundary</p></li>
  533. </ul>
  534. </div>
  535. <div class="declaration">
  536. <h4>Declaration</h4>
  537. <div class="language">
  538. <p class="aside-title">Swift</p>
  539. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">withName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  540. </div>
  541. </div>
  542. <div>
  543. <h4>Parameters</h4>
  544. <table class="graybox">
  545. <tbody>
  546. <tr>
  547. <td>
  548. <code>
  549. <em>data</em>
  550. </code>
  551. </td>
  552. <td>
  553. <div>
  554. <p>The data to encode into the multipart form data.</p>
  555. </div>
  556. </td>
  557. </tr>
  558. <tr>
  559. <td>
  560. <code>
  561. <em>name</em>
  562. </code>
  563. </td>
  564. <td>
  565. <div>
  566. <p>The name to associate with the data in the <code>Content-Disposition</code> HTTP header.</p>
  567. </div>
  568. </td>
  569. </tr>
  570. <tr>
  571. <td>
  572. <code>
  573. <em>mimeType</em>
  574. </code>
  575. </td>
  576. <td>
  577. <div>
  578. <p>The MIME type to associate with the data content type in the <code>Content-Type</code> HTTP header.</p>
  579. </div>
  580. </td>
  581. </tr>
  582. </tbody>
  583. </table>
  584. </div>
  585. </section>
  586. </div>
  587. </li>
  588. <li class="item">
  589. <div>
  590. <code>
  591. <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS04fileH0SS8mimeTypetF"></a>
  592. <a name="//apple_ref/swift/Method/append(_:withName:fileName:mimeType:)" class="dashAnchor"></a>
  593. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS04fileH0SS8mimeTypetF">append(_:withName:fileName:mimeType:)</a>
  594. </code>
  595. </div>
  596. <div class="height-container">
  597. <div class="pointer-container"></div>
  598. <section class="section">
  599. <div class="pointer"></div>
  600. <div class="abstract">
  601. <p>Creates a body part from the data and appends it to the multipart form data object.</p>
  602. <p>The body part data will be encoded using the following format:</p>
  603. <ul>
  604. <li><code>Content-Disposition: form-data; name=#{name}; filename=#{filename}</code> (HTTP Header)</li>
  605. <li><code>Content-Type: #{mimeType}</code> (HTTP Header)</li>
  606. <li>Encoded file data</li>
  607. <li><p>Multipart form boundary</p></li>
  608. </ul>
  609. </div>
  610. <div class="declaration">
  611. <h4>Declaration</h4>
  612. <div class="language">
  613. <p class="aside-title">Swift</p>
  614. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">withName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  615. </div>
  616. </div>
  617. <div>
  618. <h4>Parameters</h4>
  619. <table class="graybox">
  620. <tbody>
  621. <tr>
  622. <td>
  623. <code>
  624. <em>data</em>
  625. </code>
  626. </td>
  627. <td>
  628. <div>
  629. <p>The data to encode into the multipart form data.</p>
  630. </div>
  631. </td>
  632. </tr>
  633. <tr>
  634. <td>
  635. <code>
  636. <em>name</em>
  637. </code>
  638. </td>
  639. <td>
  640. <div>
  641. <p>The name to associate with the data in the <code>Content-Disposition</code> HTTP header.</p>
  642. </div>
  643. </td>
  644. </tr>
  645. <tr>
  646. <td>
  647. <code>
  648. <em>fileName</em>
  649. </code>
  650. </td>
  651. <td>
  652. <div>
  653. <p>The filename to associate with the data in the <code>Content-Disposition</code> HTTP header.</p>
  654. </div>
  655. </td>
  656. </tr>
  657. <tr>
  658. <td>
  659. <code>
  660. <em>mimeType</em>
  661. </code>
  662. </td>
  663. <td>
  664. <div>
  665. <p>The MIME type to associate with the data in the <code>Content-Type</code> HTTP header.</p>
  666. </div>
  667. </td>
  668. </tr>
  669. </tbody>
  670. </table>
  671. </div>
  672. </section>
  673. </div>
  674. </li>
  675. <li class="item">
  676. <div>
  677. <code>
  678. <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNametF"></a>
  679. <a name="//apple_ref/swift/Method/append(_:withName:)" class="dashAnchor"></a>
  680. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNametF">append(_:withName:)</a>
  681. </code>
  682. </div>
  683. <div class="height-container">
  684. <div class="pointer-container"></div>
  685. <section class="section">
  686. <div class="pointer"></div>
  687. <div class="abstract">
  688. <p>Creates a body part from the file and appends it to the multipart form data object.</p>
  689. <p>The body part data will be encoded using the following format:</p>
  690. <ul>
  691. <li><code>Content-Disposition: form-data; name=#{name}; filename=#{generated filename}</code> (HTTP Header)</li>
  692. <li><code>Content-Type: #{generated mimeType}</code> (HTTP Header)</li>
  693. <li>Encoded file data</li>
  694. <li>Multipart form boundary</li>
  695. </ul>
  696. <p>The filename in the <code>Content-Disposition</code> HTTP header is generated from the last path component of the
  697. <code>fileURL</code>. The <code>Content-Type</code> HTTP header MIME type is generated by mapping the <code>fileURL</code> extension to the
  698. system associated MIME type.</p>
  699. </div>
  700. <div class="declaration">
  701. <h4>Declaration</h4>
  702. <div class="language">
  703. <p class="aside-title">Swift</p>
  704. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">withName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  705. </div>
  706. </div>
  707. <div>
  708. <h4>Parameters</h4>
  709. <table class="graybox">
  710. <tbody>
  711. <tr>
  712. <td>
  713. <code>
  714. <em>fileURL</em>
  715. </code>
  716. </td>
  717. <td>
  718. <div>
  719. <p>The URL of the file whose content will be encoded into the multipart form data.</p>
  720. </div>
  721. </td>
  722. </tr>
  723. <tr>
  724. <td>
  725. <code>
  726. <em>name</em>
  727. </code>
  728. </td>
  729. <td>
  730. <div>
  731. <p>The name to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p>
  732. </div>
  733. </td>
  734. </tr>
  735. </tbody>
  736. </table>
  737. </div>
  738. </section>
  739. </div>
  740. </li>
  741. <li class="item">
  742. <div>
  743. <code>
  744. <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNameSS04fileI0SS8mimeTypetF"></a>
  745. <a name="//apple_ref/swift/Method/append(_:withName:fileName:mimeType:)" class="dashAnchor"></a>
  746. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNameSS04fileI0SS8mimeTypetF">append(_:withName:fileName:mimeType:)</a>
  747. </code>
  748. </div>
  749. <div class="height-container">
  750. <div class="pointer-container"></div>
  751. <section class="section">
  752. <div class="pointer"></div>
  753. <div class="abstract">
  754. <p>Creates a body part from the file and appends it to the multipart form data object.</p>
  755. <p>The body part data will be encoded using the following format:</p>
  756. <ul>
  757. <li>Content-Disposition: form-data; name=#{name}; filename=#{filename} (HTTP Header)</li>
  758. <li>Content-Type: #{mimeType} (HTTP Header)</li>
  759. <li>Encoded file data</li>
  760. <li><p>Multipart form boundary</p></li>
  761. </ul>
  762. </div>
  763. <div class="declaration">
  764. <h4>Declaration</h4>
  765. <div class="language">
  766. <p class="aside-title">Swift</p>
  767. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="n">withName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  768. </div>
  769. </div>
  770. <div>
  771. <h4>Parameters</h4>
  772. <table class="graybox">
  773. <tbody>
  774. <tr>
  775. <td>
  776. <code>
  777. <em>fileURL</em>
  778. </code>
  779. </td>
  780. <td>
  781. <div>
  782. <p>The URL of the file whose content will be encoded into the multipart form data.</p>
  783. </div>
  784. </td>
  785. </tr>
  786. <tr>
  787. <td>
  788. <code>
  789. <em>name</em>
  790. </code>
  791. </td>
  792. <td>
  793. <div>
  794. <p>The name to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p>
  795. </div>
  796. </td>
  797. </tr>
  798. <tr>
  799. <td>
  800. <code>
  801. <em>fileName</em>
  802. </code>
  803. </td>
  804. <td>
  805. <div>
  806. <p>The filename to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p>
  807. </div>
  808. </td>
  809. </tr>
  810. <tr>
  811. <td>
  812. <code>
  813. <em>mimeType</em>
  814. </code>
  815. </td>
  816. <td>
  817. <div>
  818. <p>The MIME type to associate with the file content in the <code>Content-Type</code> HTTP header.</p>
  819. </div>
  820. </td>
  821. </tr>
  822. </tbody>
  823. </table>
  824. </div>
  825. </section>
  826. </div>
  827. </li>
  828. <li class="item">
  829. <div>
  830. <code>
  831. <a name="/s:9Alamofire17MultipartFormDataC6appendySo11InputStreamC_s6UInt64V10withLengthSS4nameSS8fileNameSS8mimeTypetF"></a>
  832. <a name="//apple_ref/swift/Method/append(_:withLength:name:fileName:mimeType:)" class="dashAnchor"></a>
  833. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendySo11InputStreamC_s6UInt64V10withLengthSS4nameSS8fileNameSS8mimeTypetF">append(_:withLength:name:fileName:mimeType:)</a>
  834. </code>
  835. </div>
  836. <div class="height-container">
  837. <div class="pointer-container"></div>
  838. <section class="section">
  839. <div class="pointer"></div>
  840. <div class="abstract">
  841. <p>Creates a body part from the stream and appends it to the multipart form data object.</p>
  842. <p>The body part data will be encoded using the following format:</p>
  843. <ul>
  844. <li><code>Content-Disposition: form-data; name=#{name}; filename=#{filename}</code> (HTTP Header)</li>
  845. <li><code>Content-Type: #{mimeType}</code> (HTTP Header)</li>
  846. <li>Encoded stream data</li>
  847. <li><p>Multipart form boundary</p></li>
  848. </ul>
  849. </div>
  850. <div class="declaration">
  851. <h4>Declaration</h4>
  852. <div class="language">
  853. <p class="aside-title">Swift</p>
  854. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span>
  855. <span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span>
  856. <span class="n">withLength</span> <span class="nv">length</span><span class="p">:</span> <span class="kt">UInt64</span><span class="p">,</span>
  857. <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
  858. <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
  859. <span class="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  860. </div>
  861. </div>
  862. <div>
  863. <h4>Parameters</h4>
  864. <table class="graybox">
  865. <tbody>
  866. <tr>
  867. <td>
  868. <code>
  869. <em>stream</em>
  870. </code>
  871. </td>
  872. <td>
  873. <div>
  874. <p>The input stream to encode in the multipart form data.</p>
  875. </div>
  876. </td>
  877. </tr>
  878. <tr>
  879. <td>
  880. <code>
  881. <em>length</em>
  882. </code>
  883. </td>
  884. <td>
  885. <div>
  886. <p>The content length of the stream.</p>
  887. </div>
  888. </td>
  889. </tr>
  890. <tr>
  891. <td>
  892. <code>
  893. <em>name</em>
  894. </code>
  895. </td>
  896. <td>
  897. <div>
  898. <p>The name to associate with the stream content in the <code>Content-Disposition</code> HTTP header.</p>
  899. </div>
  900. </td>
  901. </tr>
  902. <tr>
  903. <td>
  904. <code>
  905. <em>fileName</em>
  906. </code>
  907. </td>
  908. <td>
  909. <div>
  910. <p>The filename to associate with the stream content in the <code>Content-Disposition</code> HTTP header.</p>
  911. </div>
  912. </td>
  913. </tr>
  914. <tr>
  915. <td>
  916. <code>
  917. <em>mimeType</em>
  918. </code>
  919. </td>
  920. <td>
  921. <div>
  922. <p>The MIME type to associate with the stream content in the <code>Content-Type</code> HTTP header.</p>
  923. </div>
  924. </td>
  925. </tr>
  926. </tbody>
  927. </table>
  928. </div>
  929. </section>
  930. </div>
  931. </li>
  932. <li class="item">
  933. <div>
  934. <code>
  935. <a name="/s:9Alamofire17MultipartFormDataC6appendySo11InputStreamC_s6UInt64V10withLengths10DictionaryVyS2SG7headerstF"></a>
  936. <a name="//apple_ref/swift/Method/append(_:withLength:headers:)" class="dashAnchor"></a>
  937. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendySo11InputStreamC_s6UInt64V10withLengths10DictionaryVyS2SG7headerstF">append(_:withLength:headers:)</a>
  938. </code>
  939. </div>
  940. <div class="height-container">
  941. <div class="pointer-container"></div>
  942. <section class="section">
  943. <div class="pointer"></div>
  944. <div class="abstract">
  945. <p>Creates a body part with the headers, stream and length and appends it to the multipart form data object.</p>
  946. <p>The body part data will be encoded using the following format:</p>
  947. <ul>
  948. <li>HTTP headers</li>
  949. <li>Encoded stream data</li>
  950. <li><p>Multipart form boundary</p></li>
  951. </ul>
  952. </div>
  953. <div class="declaration">
  954. <h4>Declaration</h4>
  955. <div class="language">
  956. <p class="aside-title">Swift</p>
  957. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">append</span><span class="p">(</span><span class="n">_</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span> <span class="n">withLength</span> <span class="nv">length</span><span class="p">:</span> <span class="kt">UInt64</span><span class="p">,</span> <span class="nv">headers</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a></span><span class="p">)</span></code></pre>
  958. </div>
  959. </div>
  960. <div>
  961. <h4>Parameters</h4>
  962. <table class="graybox">
  963. <tbody>
  964. <tr>
  965. <td>
  966. <code>
  967. <em>stream</em>
  968. </code>
  969. </td>
  970. <td>
  971. <div>
  972. <p>The input stream to encode in the multipart form data.</p>
  973. </div>
  974. </td>
  975. </tr>
  976. <tr>
  977. <td>
  978. <code>
  979. <em>length</em>
  980. </code>
  981. </td>
  982. <td>
  983. <div>
  984. <p>The content length of the stream.</p>
  985. </div>
  986. </td>
  987. </tr>
  988. <tr>
  989. <td>
  990. <code>
  991. <em>headers</em>
  992. </code>
  993. </td>
  994. <td>
  995. <div>
  996. <p>The HTTP headers for the body part.</p>
  997. </div>
  998. </td>
  999. </tr>
  1000. </tbody>
  1001. </table>
  1002. </div>
  1003. </section>
  1004. </div>
  1005. </li>
  1006. </ul>
  1007. </div>
  1008. <div class="task-group">
  1009. <div class="task-name-container">
  1010. <a name="/Data%20Encoding"></a>
  1011. <a name="//apple_ref/swift/Section/Data Encoding" class="dashAnchor"></a>
  1012. <a href="#/Data%20Encoding">
  1013. <h3 class="section-name">Data Encoding</h3>
  1014. </a>
  1015. </div>
  1016. <ul class="item-container">
  1017. <li class="item">
  1018. <div>
  1019. <code>
  1020. <a name="/s:9Alamofire17MultipartFormDataC6encode10Foundation0D0VyKF"></a>
  1021. <a name="//apple_ref/swift/Method/encode()" class="dashAnchor"></a>
  1022. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6encode10Foundation0D0VyKF">encode()</a>
  1023. </code>
  1024. </div>
  1025. <div class="height-container">
  1026. <div class="pointer-container"></div>
  1027. <section class="section">
  1028. <div class="pointer"></div>
  1029. <div class="abstract">
  1030. <p>Encodes all the appended body parts into a single <code>Data</code> value.</p>
  1031. <p>It is important to note that this method will load all the appended body parts into memory all at the same
  1032. time. This method should only be used when the encoded data will have a small memory footprint. For large data
  1033. cases, please use the <code>writeEncodedDataToDisk(fileURL:completionHandler:)</code> method.</p>
  1034. <div class="aside aside-throws">
  1035. <p class="aside-title">Throws</p>
  1036. <p>An <code><a href="../Enums/AFError.html">AFError</a></code> if encoding encounters an error.</p>
  1037. </div>
  1038. </div>
  1039. <div class="declaration">
  1040. <h4>Declaration</h4>
  1041. <div class="language">
  1042. <p class="aside-title">Swift</p>
  1043. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">encode</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">Data</span></code></pre>
  1044. </div>
  1045. </div>
  1046. <div>
  1047. <h4>Return Value</h4>
  1048. <p>The encoded <code>Data</code> if encoding is successful.</p>
  1049. </div>
  1050. </section>
  1051. </div>
  1052. </li>
  1053. <li class="item">
  1054. <div>
  1055. <code>
  1056. <a name="/s:9Alamofire17MultipartFormDataC012writeEncodedD0y10Foundation3URLV2to_tKF"></a>
  1057. <a name="//apple_ref/swift/Method/writeEncodedData(to:)" class="dashAnchor"></a>
  1058. <a class="token" href="#/s:9Alamofire17MultipartFormDataC012writeEncodedD0y10Foundation3URLV2to_tKF">writeEncodedData(to:)</a>
  1059. </code>
  1060. </div>
  1061. <div class="height-container">
  1062. <div class="pointer-container"></div>
  1063. <section class="section">
  1064. <div class="pointer"></div>
  1065. <div class="abstract">
  1066. <p>Writes the appended body parts into the given file URL.</p>
  1067. <p>This process is facilitated by reading and writing with input and output streams, respectively. Thus,
  1068. this approach is very memory efficient and should be used for large body part data.</p>
  1069. <div class="aside aside-throws">
  1070. <p class="aside-title">Throws</p>
  1071. <p>An <code><a href="../Enums/AFError.html">AFError</a></code> if encoding encounters an error.</p>
  1072. </div>
  1073. </div>
  1074. <div class="declaration">
  1075. <h4>Declaration</h4>
  1076. <div class="language">
  1077. <p class="aside-title">Swift</p>
  1078. <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">writeEncodedData</span><span class="p">(</span><span class="n">to</span> <span class="nv">fileURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">)</span> <span class="k">throws</span></code></pre>
  1079. </div>
  1080. </div>
  1081. <div>
  1082. <h4>Parameters</h4>
  1083. <table class="graybox">
  1084. <tbody>
  1085. <tr>
  1086. <td>
  1087. <code>
  1088. <em>fileURL</em>
  1089. </code>
  1090. </td>
  1091. <td>
  1092. <div>
  1093. <p>The file URL to write the multipart form data into.</p>
  1094. </div>
  1095. </td>
  1096. </tr>
  1097. </tbody>
  1098. </table>
  1099. </div>
  1100. </section>
  1101. </div>
  1102. </li>
  1103. </ul>
  1104. </div>
  1105. </div>
  1106. </section>
  1107. </article>
  1108. </div>
  1109. <section class="footer">
  1110. <p>&copy; 2017 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2017-12-03)</p>
  1111. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1112. </section>
  1113. </body>
  1114. </div>
  1115. </html>