MultipartFormData.html 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238
  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. (97% 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/Adapter.html">Adapter</a>
  55. </li>
  56. <li class="nav-group-task">
  57. <a class="nav-group-task-link" href="../Classes/AlamofireNotifications.html">AlamofireNotifications</a>
  58. </li>
  59. <li class="nav-group-task">
  60. <a class="nav-group-task-link" href="../Classes/ClosureEventMonitor.html">ClosureEventMonitor</a>
  61. </li>
  62. <li class="nav-group-task">
  63. <a class="nav-group-task-link" href="../Classes/CompositeEventMonitor.html">CompositeEventMonitor</a>
  64. </li>
  65. <li class="nav-group-task">
  66. <a class="nav-group-task-link" href="../Classes/CompositeTrustEvaluator.html">CompositeTrustEvaluator</a>
  67. </li>
  68. <li class="nav-group-task">
  69. <a class="nav-group-task-link" href="../Classes/ConnectionLostRetryPolicy.html">ConnectionLostRetryPolicy</a>
  70. </li>
  71. <li class="nav-group-task">
  72. <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a>
  73. </li>
  74. <li class="nav-group-task">
  75. <a class="nav-group-task-link" href="../Classes/DataResponseSerializer.html">DataResponseSerializer</a>
  76. </li>
  77. <li class="nav-group-task">
  78. <a class="nav-group-task-link" href="../Classes/DecodableResponseSerializer.html">DecodableResponseSerializer</a>
  79. </li>
  80. <li class="nav-group-task">
  81. <a class="nav-group-task-link" href="../Classes/DefaultTrustEvaluator.html">DefaultTrustEvaluator</a>
  82. </li>
  83. <li class="nav-group-task">
  84. <a class="nav-group-task-link" href="../Classes/DisabledEvaluator.html">DisabledEvaluator</a>
  85. </li>
  86. <li class="nav-group-task">
  87. <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a>
  88. </li>
  89. <li class="nav-group-task">
  90. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Options.html">– Options</a>
  91. </li>
  92. <li class="nav-group-task">
  93. <a class="nav-group-task-link" href="../Classes/DownloadRequest/Downloadable.html">– Downloadable</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a class="nav-group-task-link" href="../Classes/Interceptor.html">Interceptor</a>
  97. </li>
  98. <li class="nav-group-task">
  99. <a class="nav-group-task-link" href="../Classes/JSONParameterEncoder.html">JSONParameterEncoder</a>
  100. </li>
  101. <li class="nav-group-task">
  102. <a class="nav-group-task-link" href="../Classes/JSONResponseSerializer.html">JSONResponseSerializer</a>
  103. </li>
  104. <li class="nav-group-task">
  105. <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a>
  106. </li>
  107. <li class="nav-group-task">
  108. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a>
  109. </li>
  110. <li class="nav-group-task">
  111. <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a>
  112. </li>
  113. <li class="nav-group-task">
  114. <a class="nav-group-task-link" href="../Classes/PinnedCertificatesTrustEvaluator.html">PinnedCertificatesTrustEvaluator</a>
  115. </li>
  116. <li class="nav-group-task">
  117. <a class="nav-group-task-link" href="../Classes/PublicKeysTrustEvaluator.html">PublicKeysTrustEvaluator</a>
  118. </li>
  119. <li class="nav-group-task">
  120. <a class="nav-group-task-link" href="../Classes/Request.html">Request</a>
  121. </li>
  122. <li class="nav-group-task">
  123. <a class="nav-group-task-link" href="../Classes/Request/State.html">– State</a>
  124. </li>
  125. <li class="nav-group-task">
  126. <a class="nav-group-task-link" href="../Classes/Retrier.html">Retrier</a>
  127. </li>
  128. <li class="nav-group-task">
  129. <a class="nav-group-task-link" href="../Classes/RetryPolicy.html">RetryPolicy</a>
  130. </li>
  131. <li class="nav-group-task">
  132. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator.html">RevocationTrustEvaluator</a>
  133. </li>
  134. <li class="nav-group-task">
  135. <a class="nav-group-task-link" href="../Classes/RevocationTrustEvaluator/Options.html">– Options</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a class="nav-group-task-link" href="../Classes/ServerTrustManager.html">ServerTrustManager</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a class="nav-group-task-link" href="../Classes/Session.html">Session</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a class="nav-group-task-link" href="../Classes/StringResponseSerializer.html">StringResponseSerializer</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder.html">URLEncodedFormEncoder</a>
  151. </li>
  152. <li class="nav-group-task">
  153. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/ArrayEncoding.html">– ArrayEncoding</a>
  154. </li>
  155. <li class="nav-group-task">
  156. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/BoolEncoding.html">– BoolEncoding</a>
  157. </li>
  158. <li class="nav-group-task">
  159. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DataEncoding.html">– DataEncoding</a>
  160. </li>
  161. <li class="nav-group-task">
  162. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/DateEncoding.html">– DateEncoding</a>
  163. </li>
  164. <li class="nav-group-task">
  165. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/KeyEncoding.html">– KeyEncoding</a>
  166. </li>
  167. <li class="nav-group-task">
  168. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/SpaceEncoding.html">– SpaceEncoding</a>
  169. </li>
  170. <li class="nav-group-task">
  171. <a class="nav-group-task-link" href="../Classes/URLEncodedFormEncoder/Error.html">– Error</a>
  172. </li>
  173. <li class="nav-group-task">
  174. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder.html">URLEncodedFormParameterEncoder</a>
  175. </li>
  176. <li class="nav-group-task">
  177. <a class="nav-group-task-link" href="../Classes/URLEncodedFormParameterEncoder/Destination.html">– Destination</a>
  178. </li>
  179. <li class="nav-group-task">
  180. <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a>
  181. </li>
  182. <li class="nav-group-task">
  183. <a class="nav-group-task-link" href="../Classes/UploadRequest/Uploadable.html">– Uploadable</a>
  184. </li>
  185. </ul>
  186. </li>
  187. <li class="nav-group-name">
  188. <a class="nav-group-name-link" href="../Global%20Variables.html">Global Variables</a>
  189. <ul class="nav-group-tasks">
  190. <li class="nav-group-task">
  191. <a class="nav-group-task-link" href="../Global%20Variables.html#/s:9Alamofire2AFAA7SessionCvp">AF</a>
  192. </li>
  193. </ul>
  194. </li>
  195. <li class="nav-group-name">
  196. <a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
  197. <ul class="nav-group-tasks">
  198. <li class="nav-group-task">
  199. <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a>
  200. </li>
  201. <li class="nav-group-task">
  202. <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a>
  203. </li>
  204. <li class="nav-group-task">
  205. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a>
  206. </li>
  207. <li class="nav-group-task">
  208. <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncoderFailureReason.html">– ParameterEncoderFailureReason</a>
  209. </li>
  210. <li class="nav-group-task">
  211. <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a>
  212. </li>
  213. <li class="nav-group-task">
  214. <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a>
  215. </li>
  216. <li class="nav-group-task">
  217. <a class="nav-group-task-link" href="../Enums/AFError/ServerTrustFailureReason.html">– ServerTrustFailureReason</a>
  218. </li>
  219. <li class="nav-group-task">
  220. <a class="nav-group-task-link" href="../Enums/AFError/URLRequestValidationFailureReason.html">– URLRequestValidationFailureReason</a>
  221. </li>
  222. <li class="nav-group-task">
  223. <a class="nav-group-task-link" href="../Enums/RetryResult.html">RetryResult</a>
  224. </li>
  225. </ul>
  226. </li>
  227. <li class="nav-group-name">
  228. <a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
  229. <ul class="nav-group-tasks">
  230. <li class="nav-group-task">
  231. <a class="nav-group-task-link" href="../Extensions/Array.html">Array</a>
  232. </li>
  233. <li class="nav-group-task">
  234. <a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSBundle">Bundle</a>
  235. </li>
  236. <li class="nav-group-task">
  237. <a class="nav-group-task-link" href="../Extensions/CharacterSet.html">CharacterSet</a>
  238. </li>
  239. <li class="nav-group-task">
  240. <a class="nav-group-task-link" href="../Extensions/Error.html">Error</a>
  241. </li>
  242. <li class="nav-group-task">
  243. <a class="nav-group-task-link" href="../Extensions/HTTPURLResponse.html">HTTPURLResponse</a>
  244. </li>
  245. <li class="nav-group-task">
  246. <a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation11JSONDecoderC">JSONDecoder</a>
  247. </li>
  248. <li class="nav-group-task">
  249. <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a>
  250. </li>
  251. <li class="nav-group-task">
  252. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@OSStatus">OSStatus</a>
  253. </li>
  254. <li class="nav-group-task">
  255. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecCertificateRef">SecCertificate</a>
  256. </li>
  257. <li class="nav-group-task">
  258. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecPolicyRef">SecPolicy</a>
  259. </li>
  260. <li class="nav-group-task">
  261. <a class="nav-group-task-link" href="../Extensions.html#/c:@T@SecTrustRef">SecTrust</a>
  262. </li>
  263. <li class="nav-group-task">
  264. <a class="nav-group-task-link" href="../Extensions.html#/c:@E@SecTrustResultType">SecTrustResultType</a>
  265. </li>
  266. <li class="nav-group-task">
  267. <a class="nav-group-task-link" href="../Extensions/String.html">String</a>
  268. </li>
  269. <li class="nav-group-task">
  270. <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a>
  271. </li>
  272. <li class="nav-group-task">
  273. <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a>
  274. </li>
  275. <li class="nav-group-task">
  276. <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a>
  277. </li>
  278. <li class="nav-group-task">
  279. <a class="nav-group-task-link" href="../Extensions/URLSessionConfiguration.html">URLSessionConfiguration</a>
  280. </li>
  281. </ul>
  282. </li>
  283. <li class="nav-group-name">
  284. <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
  285. <ul class="nav-group-tasks">
  286. <li class="nav-group-task">
  287. <a class="nav-group-task-link" href="../Protocols/AlamofireExtended.html">AlamofireExtended</a>
  288. </li>
  289. <li class="nav-group-task">
  290. <a class="nav-group-task-link" href="../Protocols/CachedResponseHandler.html">CachedResponseHandler</a>
  291. </li>
  292. <li class="nav-group-task">
  293. <a class="nav-group-task-link" href="../Protocols/DataDecoder.html">DataDecoder</a>
  294. </li>
  295. <li class="nav-group-task">
  296. <a class="nav-group-task-link" href="../Protocols/DataPreprocessor.html">DataPreprocessor</a>
  297. </li>
  298. <li class="nav-group-task">
  299. <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a>
  300. </li>
  301. <li class="nav-group-task">
  302. <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a>
  303. </li>
  304. <li class="nav-group-task">
  305. <a class="nav-group-task-link" href="../Protocols/EmptyResponse.html">EmptyResponse</a>
  306. </li>
  307. <li class="nav-group-task">
  308. <a class="nav-group-task-link" href="../Protocols/EventMonitor.html">EventMonitor</a>
  309. </li>
  310. <li class="nav-group-task">
  311. <a class="nav-group-task-link" href="../Protocols/ParameterEncoder.html">ParameterEncoder</a>
  312. </li>
  313. <li class="nav-group-task">
  314. <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a>
  315. </li>
  316. <li class="nav-group-task">
  317. <a class="nav-group-task-link" href="../Protocols/RedirectHandler.html">RedirectHandler</a>
  318. </li>
  319. <li class="nav-group-task">
  320. <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a>
  321. </li>
  322. <li class="nav-group-task">
  323. <a class="nav-group-task-link" href="../Protocols/RequestDelegate.html">RequestDelegate</a>
  324. </li>
  325. <li class="nav-group-task">
  326. <a class="nav-group-task-link" href="../Protocols/RequestInterceptor.html">RequestInterceptor</a>
  327. </li>
  328. <li class="nav-group-task">
  329. <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a>
  330. </li>
  331. <li class="nav-group-task">
  332. <a class="nav-group-task-link" href="../Protocols/ResponseSerializer.html">ResponseSerializer</a>
  333. </li>
  334. <li class="nav-group-task">
  335. <a class="nav-group-task-link" href="../Protocols/ServerTrustEvaluating.html">ServerTrustEvaluating</a>
  336. </li>
  337. <li class="nav-group-task">
  338. <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a>
  339. </li>
  340. <li class="nav-group-task">
  341. <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
  342. </li>
  343. <li class="nav-group-task">
  344. <a class="nav-group-task-link" href="../Protocols.html#/s:9Alamofire17UploadConvertibleP">UploadConvertible</a>
  345. </li>
  346. <li class="nav-group-task">
  347. <a class="nav-group-task-link" href="../Protocols/UploadableConvertible.html">UploadableConvertible</a>
  348. </li>
  349. </ul>
  350. </li>
  351. <li class="nav-group-name">
  352. <a class="nav-group-name-link" href="../Structs.html">Structures</a>
  353. <ul class="nav-group-tasks">
  354. <li class="nav-group-task">
  355. <a class="nav-group-task-link" href="../Structs/AlamofireExtension.html">AlamofireExtension</a>
  356. </li>
  357. <li class="nav-group-task">
  358. <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a>
  359. </li>
  360. <li class="nav-group-task">
  361. <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a>
  362. </li>
  363. <li class="nav-group-task">
  364. <a class="nav-group-task-link" href="../Structs/Empty.html">Empty</a>
  365. </li>
  366. <li class="nav-group-task">
  367. <a class="nav-group-task-link" href="../Structs/GoogleXSSIPreprocessor.html">GoogleXSSIPreprocessor</a>
  368. </li>
  369. <li class="nav-group-task">
  370. <a class="nav-group-task-link" href="../Structs/HTTPHeader.html">HTTPHeader</a>
  371. </li>
  372. <li class="nav-group-task">
  373. <a class="nav-group-task-link" href="../Structs/HTTPHeaders.html">HTTPHeaders</a>
  374. </li>
  375. <li class="nav-group-task">
  376. <a class="nav-group-task-link" href="../Structs/HTTPMethod.html">HTTPMethod</a>
  377. </li>
  378. <li class="nav-group-task">
  379. <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a>
  380. </li>
  381. <li class="nav-group-task">
  382. <a class="nav-group-task-link" href="../Structs/PassthroughPreprocessor.html">PassthroughPreprocessor</a>
  383. </li>
  384. <li class="nav-group-task">
  385. <a class="nav-group-task-link" href="../Structs/Redirector.html">Redirector</a>
  386. </li>
  387. <li class="nav-group-task">
  388. <a class="nav-group-task-link" href="../Structs/Redirector/Behavior.html">– Behavior</a>
  389. </li>
  390. <li class="nav-group-task">
  391. <a class="nav-group-task-link" href="../Structs/ResponseCacher.html">ResponseCacher</a>
  392. </li>
  393. <li class="nav-group-task">
  394. <a class="nav-group-task-link" href="../Structs/ResponseCacher/Behavior.html">– Behavior</a>
  395. </li>
  396. <li class="nav-group-task">
  397. <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a>
  398. </li>
  399. <li class="nav-group-task">
  400. <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a>
  401. </li>
  402. <li class="nav-group-task">
  403. <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a>
  404. </li>
  405. <li class="nav-group-task">
  406. <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a>
  407. </li>
  408. </ul>
  409. </li>
  410. <li class="nav-group-name">
  411. <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a>
  412. <ul class="nav-group-tasks">
  413. <li class="nav-group-task">
  414. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire14AFDataResponsea">AFDataResponse</a>
  415. </li>
  416. <li class="nav-group-task">
  417. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire18AFDownloadResponsea">AFDownloadResponse</a>
  418. </li>
  419. <li class="nav-group-task">
  420. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire8AFResulta">AFResult</a>
  421. </li>
  422. <li class="nav-group-task">
  423. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12AdaptHandlera">AdaptHandler</a>
  424. </li>
  425. <li class="nav-group-task">
  426. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a>
  427. </li>
  428. <li class="nav-group-task">
  429. <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire12RetryHandlera">RetryHandler</a>
  430. </li>
  431. </ul>
  432. </li>
  433. </ul>
  434. </nav>
  435. <article class="main-content">
  436. <section class="section">
  437. <div class="section-content top-matter">
  438. <h1>MultipartFormData</h1>
  439. <div class="declaration">
  440. <div class="language">
  441. <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">MultipartFormData</span></code></pre>
  442. </div>
  443. </div>
  444. <p>Constructs <code>multipart/form-data</code> for uploads within an HTTP or HTTPS body. There are currently two ways to encode
  445. multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead
  446. to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the
  447. data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for
  448. larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.</p>
  449. <p>For more information on <code>multipart/form-data</code> in general, please refer to the RFC-2388 and RFC-2045 specs as well
  450. and the w3 form documentation.</p>
  451. <ul>
  452. <li><a href="https://www.ietf.org/rfc/rfc2388.txt">https://www.ietf.org/rfc/rfc2388.txt</a></li>
  453. <li><a href="https://www.ietf.org/rfc/rfc2045.txt">https://www.ietf.org/rfc/rfc2045.txt</a></li>
  454. <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>
  455. </ul>
  456. </div>
  457. </section>
  458. <section class="section">
  459. <div class="section-content">
  460. <div class="task-group">
  461. <div class="task-name-container">
  462. <a name="/Properties"></a>
  463. <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
  464. <div class="section-name-container">
  465. <a class="section-name-link" href="#/Properties"></a>
  466. <h3 class="section-name"><p>Properties</p>
  467. </h3>
  468. </div>
  469. </div>
  470. <ul class="item-container">
  471. <li class="item">
  472. <div>
  473. <code>
  474. <a name="/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ"></a>
  475. <a name="//apple_ref/swift/Variable/encodingMemoryThreshold" class="dashAnchor"></a>
  476. <a class="token" href="#/s:9Alamofire17MultipartFormDataC23encodingMemoryThresholds6UInt64VvpZ">encodingMemoryThreshold</a>
  477. </code>
  478. </div>
  479. <div class="height-container">
  480. <div class="pointer-container"></div>
  481. <section class="section">
  482. <div class="pointer"></div>
  483. <div class="abstract">
  484. <p>Default memory threshold used when encoding <code>MultipartFormData</code>, in bytes.</p>
  485. </div>
  486. <div class="declaration">
  487. <h4>Declaration</h4>
  488. <div class="language">
  489. <p class="aside-title">Swift</p>
  490. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">encodingMemoryThreshold</span><span class="p">:</span> <span class="kt">UInt64</span></code></pre>
  491. </div>
  492. </div>
  493. </section>
  494. </div>
  495. </li>
  496. <li class="item">
  497. <div>
  498. <code>
  499. <a name="/s:9Alamofire17MultipartFormDataC11contentTypeSSvp"></a>
  500. <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a>
  501. <a class="token" href="#/s:9Alamofire17MultipartFormDataC11contentTypeSSvp">contentType</a>
  502. </code>
  503. </div>
  504. <div class="height-container">
  505. <div class="pointer-container"></div>
  506. <section class="section">
  507. <div class="pointer"></div>
  508. <div class="abstract">
  509. <p>The <code>Content-Type</code> header value containing the boundary used to generate the <code>multipart/form-data</code>.</p>
  510. </div>
  511. <div class="declaration">
  512. <h4>Declaration</h4>
  513. <div class="language">
  514. <p class="aside-title">Swift</p>
  515. <pre class="highlight swift"><code><span class="kd">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="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  516. </div>
  517. </div>
  518. </section>
  519. </div>
  520. </li>
  521. <li class="item">
  522. <div>
  523. <code>
  524. <a name="/s:9Alamofire17MultipartFormDataC13contentLengths6UInt64Vvp"></a>
  525. <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a>
  526. <a class="token" href="#/s:9Alamofire17MultipartFormDataC13contentLengths6UInt64Vvp">contentLength</a>
  527. </code>
  528. </div>
  529. <div class="height-container">
  530. <div class="pointer-container"></div>
  531. <section class="section">
  532. <div class="pointer"></div>
  533. <div class="abstract">
  534. <p>The content length of all body parts used to generate the <code>multipart/form-data</code> not including the boundaries.</p>
  535. </div>
  536. <div class="declaration">
  537. <h4>Declaration</h4>
  538. <div class="language">
  539. <p class="aside-title">Swift</p>
  540. <pre class="highlight swift"><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> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  541. </div>
  542. </div>
  543. </section>
  544. </div>
  545. </li>
  546. <li class="item">
  547. <div>
  548. <code>
  549. <a name="/s:9Alamofire17MultipartFormDataC8boundarySSvp"></a>
  550. <a name="//apple_ref/swift/Property/boundary" class="dashAnchor"></a>
  551. <a class="token" href="#/s:9Alamofire17MultipartFormDataC8boundarySSvp">boundary</a>
  552. </code>
  553. </div>
  554. <div class="height-container">
  555. <div class="pointer-container"></div>
  556. <section class="section">
  557. <div class="pointer"></div>
  558. <div class="abstract">
  559. <p>The boundary used to separate the body parts in the encoded form data.</p>
  560. </div>
  561. <div class="declaration">
  562. <h4>Declaration</h4>
  563. <div class="language">
  564. <p class="aside-title">Swift</p>
  565. <pre class="highlight swift"><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>
  566. </div>
  567. </div>
  568. </section>
  569. </div>
  570. </li>
  571. </ul>
  572. </div>
  573. <div class="task-group">
  574. <div class="task-name-container">
  575. <a name="/Lifecycle"></a>
  576. <a name="//apple_ref/swift/Section/Lifecycle" class="dashAnchor"></a>
  577. <div class="section-name-container">
  578. <a class="section-name-link" href="#/Lifecycle"></a>
  579. <h3 class="section-name"><p>Lifecycle</p>
  580. </h3>
  581. </div>
  582. </div>
  583. <ul class="item-container">
  584. <li class="item">
  585. <div>
  586. <code>
  587. <a name="/s:9Alamofire17MultipartFormDataC11fileManager8boundaryACSo06NSFileF0C_SSSgtcfc"></a>
  588. <a name="//apple_ref/swift/Method/init(fileManager:boundary:)" class="dashAnchor"></a>
  589. <a class="token" href="#/s:9Alamofire17MultipartFormDataC11fileManager8boundaryACSo06NSFileF0C_SSSgtcfc">init(fileManager:boundary:)</a>
  590. </code>
  591. </div>
  592. <div class="height-container">
  593. <div class="pointer-container"></div>
  594. <section class="section">
  595. <div class="pointer"></div>
  596. <div class="abstract">
  597. <p>Creates an instance.</p>
  598. </div>
  599. <div class="declaration">
  600. <h4>Declaration</h4>
  601. <div class="language">
  602. <p class="aside-title">Swift</p>
  603. <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><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> <span class="nv">boundary</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
  604. </div>
  605. </div>
  606. <div>
  607. <h4>Parameters</h4>
  608. <table class="graybox">
  609. <tbody>
  610. <tr>
  611. <td>
  612. <code>
  613. <em>fileManager</em>
  614. </code>
  615. </td>
  616. <td>
  617. <div>
  618. <p><code>FileManager</code> to use for file operations, if needed.</p>
  619. </div>
  620. </td>
  621. </tr>
  622. <tr>
  623. <td>
  624. <code>
  625. <em>boundary</em>
  626. </code>
  627. </td>
  628. <td>
  629. <div>
  630. <p>Boundary <code>String</code> used to separate body parts.</p>
  631. </div>
  632. </td>
  633. </tr>
  634. </tbody>
  635. </table>
  636. </div>
  637. </section>
  638. </div>
  639. </li>
  640. </ul>
  641. </div>
  642. <div class="task-group">
  643. <div class="task-name-container">
  644. <a name="/Body%20Parts"></a>
  645. <a name="//apple_ref/swift/Section/Body Parts" class="dashAnchor"></a>
  646. <div class="section-name-container">
  647. <a class="section-name-link" href="#/Body%20Parts"></a>
  648. <h3 class="section-name"><p>Body Parts</p>
  649. </h3>
  650. </div>
  651. </div>
  652. <ul class="item-container">
  653. <li class="item">
  654. <div>
  655. <code>
  656. <a name="/s:9Alamofire17MultipartFormDataC6append_8withName04fileG08mimeTypey10Foundation0D0V_S2SSgAKtF"></a>
  657. <a name="//apple_ref/swift/Method/append(_:withName:fileName:mimeType:)" class="dashAnchor"></a>
  658. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6append_8withName04fileG08mimeTypey10Foundation0D0V_S2SSgAKtF">append(_:withName:fileName:mimeType:)</a>
  659. </code>
  660. </div>
  661. <div class="height-container">
  662. <div class="pointer-container"></div>
  663. <section class="section">
  664. <div class="pointer"></div>
  665. <div class="abstract">
  666. <p>Creates a body part from the data and appends it to the instance.</p>
  667. <p>The body part data will be encoded using the following format:</p>
  668. <ul>
  669. <li><code>Content-Disposition: form-data; name=#{name}; filename=#{filename}</code> (HTTP Header)</li>
  670. <li><code>Content-Type: #{mimeType}</code> (HTTP Header)</li>
  671. <li>Encoded file data</li>
  672. <li><p>Multipart form boundary</p></li>
  673. </ul>
  674. </div>
  675. <div class="declaration">
  676. <h4>Declaration</h4>
  677. <div class="language">
  678. <p class="aside-title">Swift</p>
  679. <pre class="highlight swift"><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="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
  680. </div>
  681. </div>
  682. <div>
  683. <h4>Parameters</h4>
  684. <table class="graybox">
  685. <tbody>
  686. <tr>
  687. <td>
  688. <code>
  689. <em>data</em>
  690. </code>
  691. </td>
  692. <td>
  693. <div>
  694. <p><code>Data</code> to encoding into the instance.</p>
  695. </div>
  696. </td>
  697. </tr>
  698. <tr>
  699. <td>
  700. <code>
  701. <em>name</em>
  702. </code>
  703. </td>
  704. <td>
  705. <div>
  706. <p>Name to associate with the <code>Data</code> in the <code>Content-Disposition</code> HTTP header.</p>
  707. </div>
  708. </td>
  709. </tr>
  710. <tr>
  711. <td>
  712. <code>
  713. <em>fileName</em>
  714. </code>
  715. </td>
  716. <td>
  717. <div>
  718. <p>Filename to associate with the <code>Data</code> in the <code>Content-Disposition</code> HTTP header.</p>
  719. </div>
  720. </td>
  721. </tr>
  722. <tr>
  723. <td>
  724. <code>
  725. <em>mimeType</em>
  726. </code>
  727. </td>
  728. <td>
  729. <div>
  730. <p>MIME type to associate with the data in the <code>Content-Type</code> HTTP header.</p>
  731. </div>
  732. </td>
  733. </tr>
  734. </tbody>
  735. </table>
  736. </div>
  737. </section>
  738. </div>
  739. </li>
  740. <li class="item">
  741. <div>
  742. <code>
  743. <a name="/s:9Alamofire17MultipartFormDataC6append_8withNamey10Foundation3URLV_SStF"></a>
  744. <a name="//apple_ref/swift/Method/append(_:withName:)" class="dashAnchor"></a>
  745. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6append_8withNamey10Foundation3URLV_SStF">append(_:withName:)</a>
  746. </code>
  747. </div>
  748. <div class="height-container">
  749. <div class="pointer-container"></div>
  750. <section class="section">
  751. <div class="pointer"></div>
  752. <div class="abstract">
  753. <p>Creates a body part from the file and appends it to the instance.</p>
  754. <p>The body part data will be encoded using the following format:</p>
  755. <ul>
  756. <li><code>Content-Disposition: form-data; name=#{name}; filename=#{generated filename}</code> (HTTP Header)</li>
  757. <li><code>Content-Type: #{generated mimeType}</code> (HTTP Header)</li>
  758. <li>Encoded file data</li>
  759. <li>Multipart form boundary</li>
  760. </ul>
  761. <p>The filename in the <code>Content-Disposition</code> HTTP header is generated from the last path component of the
  762. <code>fileURL</code>. The <code>Content-Type</code> HTTP header MIME type is generated by mapping the <code>fileURL</code> extension to the
  763. system associated MIME type.</p>
  764. </div>
  765. <div class="declaration">
  766. <h4>Declaration</h4>
  767. <div class="language">
  768. <p class="aside-title">Swift</p>
  769. <pre class="highlight swift"><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>
  770. </div>
  771. </div>
  772. <div>
  773. <h4>Parameters</h4>
  774. <table class="graybox">
  775. <tbody>
  776. <tr>
  777. <td>
  778. <code>
  779. <em>fileURL</em>
  780. </code>
  781. </td>
  782. <td>
  783. <div>
  784. <p><code>URL</code> of the file whose content will be encoded into the instance.</p>
  785. </div>
  786. </td>
  787. </tr>
  788. <tr>
  789. <td>
  790. <code>
  791. <em>name</em>
  792. </code>
  793. </td>
  794. <td>
  795. <div>
  796. <p>Name to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p>
  797. </div>
  798. </td>
  799. </tr>
  800. </tbody>
  801. </table>
  802. </div>
  803. </section>
  804. </div>
  805. </li>
  806. <li class="item">
  807. <div>
  808. <code>
  809. <a name="/s:9Alamofire17MultipartFormDataC6append_8withName04fileG08mimeTypey10Foundation3URLV_S3StF"></a>
  810. <a name="//apple_ref/swift/Method/append(_:withName:fileName:mimeType:)" class="dashAnchor"></a>
  811. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6append_8withName04fileG08mimeTypey10Foundation3URLV_S3StF">append(_:withName:fileName:mimeType:)</a>
  812. </code>
  813. </div>
  814. <div class="height-container">
  815. <div class="pointer-container"></div>
  816. <section class="section">
  817. <div class="pointer"></div>
  818. <div class="abstract">
  819. <p>Creates a body part from the file and appends it to the instance.</p>
  820. <p>The body part data will be encoded using the following format:</p>
  821. <ul>
  822. <li>Content-Disposition: form-data; name=#{name}; filename=#{filename} (HTTP Header)</li>
  823. <li>Content-Type: #{mimeType} (HTTP Header)</li>
  824. <li>Encoded file data</li>
  825. <li><p>Multipart form boundary</p></li>
  826. </ul>
  827. </div>
  828. <div class="declaration">
  829. <h4>Declaration</h4>
  830. <div class="language">
  831. <p class="aside-title">Swift</p>
  832. <pre class="highlight swift"><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>
  833. </div>
  834. </div>
  835. <div>
  836. <h4>Parameters</h4>
  837. <table class="graybox">
  838. <tbody>
  839. <tr>
  840. <td>
  841. <code>
  842. <em>fileURL</em>
  843. </code>
  844. </td>
  845. <td>
  846. <div>
  847. <p><code>URL</code> of the file whose content will be encoded into the instance.</p>
  848. </div>
  849. </td>
  850. </tr>
  851. <tr>
  852. <td>
  853. <code>
  854. <em>name</em>
  855. </code>
  856. </td>
  857. <td>
  858. <div>
  859. <p>Name to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p>
  860. </div>
  861. </td>
  862. </tr>
  863. <tr>
  864. <td>
  865. <code>
  866. <em>fileName</em>
  867. </code>
  868. </td>
  869. <td>
  870. <div>
  871. <p>Filename to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p>
  872. </div>
  873. </td>
  874. </tr>
  875. <tr>
  876. <td>
  877. <code>
  878. <em>mimeType</em>
  879. </code>
  880. </td>
  881. <td>
  882. <div>
  883. <p>MIME type to associate with the file content in the <code>Content-Type</code> HTTP header.</p>
  884. </div>
  885. </td>
  886. </tr>
  887. </tbody>
  888. </table>
  889. </div>
  890. </section>
  891. </div>
  892. </li>
  893. <li class="item">
  894. <div>
  895. <code>
  896. <a name="/s:9Alamofire17MultipartFormDataC6append_10withLength4name8fileName8mimeTypeySo13NSInputStreamC_s6UInt64VS3StF"></a>
  897. <a name="//apple_ref/swift/Method/append(_:withLength:name:fileName:mimeType:)" class="dashAnchor"></a>
  898. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6append_10withLength4name8fileName8mimeTypeySo13NSInputStreamC_s6UInt64VS3StF">append(_:withLength:name:fileName:mimeType:)</a>
  899. </code>
  900. </div>
  901. <div class="height-container">
  902. <div class="pointer-container"></div>
  903. <section class="section">
  904. <div class="pointer"></div>
  905. <div class="abstract">
  906. <p>Creates a body part from the stream and appends it to the instance.</p>
  907. <p>The body part data will be encoded using the following format:</p>
  908. <ul>
  909. <li><code>Content-Disposition: form-data; name=#{name}; filename=#{filename}</code> (HTTP Header)</li>
  910. <li><code>Content-Type: #{mimeType}</code> (HTTP Header)</li>
  911. <li>Encoded stream data</li>
  912. <li><p>Multipart form boundary</p></li>
  913. </ul>
  914. </div>
  915. <div class="declaration">
  916. <h4>Declaration</h4>
  917. <div class="language">
  918. <p class="aside-title">Swift</p>
  919. <pre class="highlight swift"><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>
  920. <span class="n">withLength</span> <span class="nv">length</span><span class="p">:</span> <span class="kt">UInt64</span><span class="p">,</span>
  921. <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
  922. <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
  923. <span class="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  924. </div>
  925. </div>
  926. <div>
  927. <h4>Parameters</h4>
  928. <table class="graybox">
  929. <tbody>
  930. <tr>
  931. <td>
  932. <code>
  933. <em>stream</em>
  934. </code>
  935. </td>
  936. <td>
  937. <div>
  938. <p><code>InputStream</code> to encode into the instance.</p>
  939. </div>
  940. </td>
  941. </tr>
  942. <tr>
  943. <td>
  944. <code>
  945. <em>length</em>
  946. </code>
  947. </td>
  948. <td>
  949. <div>
  950. <p>Length, in bytes, of the stream.</p>
  951. </div>
  952. </td>
  953. </tr>
  954. <tr>
  955. <td>
  956. <code>
  957. <em>name</em>
  958. </code>
  959. </td>
  960. <td>
  961. <div>
  962. <p>Name to associate with the stream content in the <code>Content-Disposition</code> HTTP header.</p>
  963. </div>
  964. </td>
  965. </tr>
  966. <tr>
  967. <td>
  968. <code>
  969. <em>fileName</em>
  970. </code>
  971. </td>
  972. <td>
  973. <div>
  974. <p>Filename to associate with the stream content in the <code>Content-Disposition</code> HTTP header.</p>
  975. </div>
  976. </td>
  977. </tr>
  978. <tr>
  979. <td>
  980. <code>
  981. <em>mimeType</em>
  982. </code>
  983. </td>
  984. <td>
  985. <div>
  986. <p>MIME type to associate with the stream content in the <code>Content-Type</code> HTTP header.</p>
  987. </div>
  988. </td>
  989. </tr>
  990. </tbody>
  991. </table>
  992. </div>
  993. </section>
  994. </div>
  995. </li>
  996. <li class="item">
  997. <div>
  998. <code>
  999. <a name="/s:9Alamofire17MultipartFormDataC6append_10withLength7headersySo13NSInputStreamC_s6UInt64VAA11HTTPHeadersVtF"></a>
  1000. <a name="//apple_ref/swift/Method/append(_:withLength:headers:)" class="dashAnchor"></a>
  1001. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6append_10withLength7headersySo13NSInputStreamC_s6UInt64VAA11HTTPHeadersVtF">append(_:withLength:headers:)</a>
  1002. </code>
  1003. </div>
  1004. <div class="height-container">
  1005. <div class="pointer-container"></div>
  1006. <section class="section">
  1007. <div class="pointer"></div>
  1008. <div class="abstract">
  1009. <p>Creates a body part with the stream, length, and headers and appends it to the instance.</p>
  1010. <p>The body part data will be encoded using the following format:</p>
  1011. <ul>
  1012. <li>HTTP headers</li>
  1013. <li>Encoded stream data</li>
  1014. <li><p>Multipart form boundary</p></li>
  1015. </ul>
  1016. </div>
  1017. <div class="declaration">
  1018. <h4>Declaration</h4>
  1019. <div class="language">
  1020. <p class="aside-title">Swift</p>
  1021. <pre class="highlight swift"><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="../Structs/HTTPHeaders.html">HTTPHeaders</a></span><span class="p">)</span></code></pre>
  1022. </div>
  1023. </div>
  1024. <div>
  1025. <h4>Parameters</h4>
  1026. <table class="graybox">
  1027. <tbody>
  1028. <tr>
  1029. <td>
  1030. <code>
  1031. <em>stream</em>
  1032. </code>
  1033. </td>
  1034. <td>
  1035. <div>
  1036. <p><code>InputStream</code> to encode into the instance.</p>
  1037. </div>
  1038. </td>
  1039. </tr>
  1040. <tr>
  1041. <td>
  1042. <code>
  1043. <em>length</em>
  1044. </code>
  1045. </td>
  1046. <td>
  1047. <div>
  1048. <p>Length, in bytes, of the stream.</p>
  1049. </div>
  1050. </td>
  1051. </tr>
  1052. <tr>
  1053. <td>
  1054. <code>
  1055. <em>headers</em>
  1056. </code>
  1057. </td>
  1058. <td>
  1059. <div>
  1060. <p><code><a href="../Structs/HTTPHeaders.html">HTTPHeaders</a></code> for the body part.</p>
  1061. </div>
  1062. </td>
  1063. </tr>
  1064. </tbody>
  1065. </table>
  1066. </div>
  1067. </section>
  1068. </div>
  1069. </li>
  1070. </ul>
  1071. </div>
  1072. <div class="task-group">
  1073. <div class="task-name-container">
  1074. <a name="/Data%20Encoding"></a>
  1075. <a name="//apple_ref/swift/Section/Data Encoding" class="dashAnchor"></a>
  1076. <div class="section-name-container">
  1077. <a class="section-name-link" href="#/Data%20Encoding"></a>
  1078. <h3 class="section-name"><p>Data Encoding</p>
  1079. </h3>
  1080. </div>
  1081. </div>
  1082. <ul class="item-container">
  1083. <li class="item">
  1084. <div>
  1085. <code>
  1086. <a name="/s:9Alamofire17MultipartFormDataC6encode10Foundation0D0VyKF"></a>
  1087. <a name="//apple_ref/swift/Method/encode()" class="dashAnchor"></a>
  1088. <a class="token" href="#/s:9Alamofire17MultipartFormDataC6encode10Foundation0D0VyKF">encode()</a>
  1089. </code>
  1090. </div>
  1091. <div class="height-container">
  1092. <div class="pointer-container"></div>
  1093. <section class="section">
  1094. <div class="pointer"></div>
  1095. <div class="abstract">
  1096. <p>Encodes all appended body parts into a single <code>Data</code> value.</p>
  1097. <div class="aside aside-note">
  1098. <p class="aside-title">Note</p>
  1099. <p>This method will load all the appended body parts into memory all at the same time. This method should
  1100. only be used when the encoded data will have a small memory footprint. For large data cases, please use
  1101. the <code>writeEncodedData(to:))</code> method.</p>
  1102. </div><div class="aside aside-throws">
  1103. <p class="aside-title">Throws</p>
  1104. <p>An <code><a href="../Enums/AFError.html">AFError</a></code> if encoding encounters an error.</p>
  1105. </div>
  1106. </div>
  1107. <div class="declaration">
  1108. <h4>Declaration</h4>
  1109. <div class="language">
  1110. <p class="aside-title">Swift</p>
  1111. <pre class="highlight swift"><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>
  1112. </div>
  1113. </div>
  1114. <div>
  1115. <h4>Return Value</h4>
  1116. <p>The encoded <code>Data</code>, if encoding is successful.</p>
  1117. </div>
  1118. </section>
  1119. </div>
  1120. </li>
  1121. <li class="item">
  1122. <div>
  1123. <code>
  1124. <a name="/s:9Alamofire17MultipartFormDataC012writeEncodedD02toy10Foundation3URLV_tKF"></a>
  1125. <a name="//apple_ref/swift/Method/writeEncodedData(to:)" class="dashAnchor"></a>
  1126. <a class="token" href="#/s:9Alamofire17MultipartFormDataC012writeEncodedD02toy10Foundation3URLV_tKF">writeEncodedData(to:)</a>
  1127. </code>
  1128. </div>
  1129. <div class="height-container">
  1130. <div class="pointer-container"></div>
  1131. <section class="section">
  1132. <div class="pointer"></div>
  1133. <div class="abstract">
  1134. <p>Writes all appended body parts to the given file <code>URL</code>.</p>
  1135. <p>This process is facilitated by reading and writing with input and output streams, respectively. Thus,
  1136. this approach is very memory efficient and should be used for large body part data.</p>
  1137. <div class="aside aside-throws">
  1138. <p class="aside-title">Throws</p>
  1139. An <code><a href="../Enums/AFError.html">AFError</a></code> if encoding encounters an error.
  1140. </div>
  1141. </div>
  1142. <div class="declaration">
  1143. <h4>Declaration</h4>
  1144. <div class="language">
  1145. <p class="aside-title">Swift</p>
  1146. <pre class="highlight swift"><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>
  1147. </div>
  1148. </div>
  1149. <div>
  1150. <h4>Parameters</h4>
  1151. <table class="graybox">
  1152. <tbody>
  1153. <tr>
  1154. <td>
  1155. <code>
  1156. <em>fileURL</em>
  1157. </code>
  1158. </td>
  1159. <td>
  1160. <div>
  1161. <p>File <code>URL</code> to which to write the form data.</p>
  1162. </div>
  1163. </td>
  1164. </tr>
  1165. </tbody>
  1166. </table>
  1167. </div>
  1168. </section>
  1169. </div>
  1170. </li>
  1171. </ul>
  1172. </div>
  1173. </div>
  1174. </section>
  1175. </article>
  1176. </div>
  1177. <section class="footer">
  1178. <p>&copy; 2020 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2020-02-23)</p>
  1179. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1180. </section>
  1181. </body>
  1182. </div>
  1183. </html>