react-native-c8osdk

<!DOCTYPE html> <html lang="en"> <head> <title>MultipartFormData Class Reference</title> <link rel="stylesheet" type="text/css" href="../css/jazzy.css" /> <link rel="stylesheet" type="text/css" href="../css/highlight.css" /> <meta charset="utf-8"> <script src="../js/jquery.min.js" defer></script> <script src="../js/jazzy.js" defer></script> <script src="../js/lunr.min.js" defer></script> <script src="../js/typeahead.jquery.js" defer></script> <script src="../js/jazzy.search.js" defer></script> </head> <body> <a name="//apple_ref/swift/Class/MultipartFormData" class="dashAnchor"></a> <a title="MultipartFormData Class Reference"></a> <header class="header"> <p class="header-col header-col--primary"> <a class="header-link" href="../index.html"> Alamofire Docs </a> (86% documented) </p> <p class="header-col--secondary"> <form role="search" action="../search.json"> <input type="text" placeholder="Search documentation" data-typeahead> </form> </p> <p class="header-col header-col--secondary"> <a class="header-link" href="https://github.com/Alamofire/Alamofire"> <img class="header-icon" src="../img/gh.png"/> View on GitHub </a> </p> <p class="header-col header-col--secondary"> <a class="header-link" href="dash-feed://https%3A%2F%2Falamofire%2Egithub%2Eio%2FAlamofire%2Fdocsets%2FAlamofire%2Exml"> <img class="header-icon" src="../img/dash.png"/> Install in Dash </a> </p> </header> <p class="breadcrumbs"> <a class="breadcrumb" href="../index.html">Alamofire Reference</a> <img class="carat" src="../img/carat.png" /> MultipartFormData Class Reference </p> <div class="content-wrapper"> <nav class="navigation"> <ul class="nav-groups"> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Classes.html">Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/DataRequest.html">DataRequest</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/DownloadRequest.html">DownloadRequest</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/DownloadRequest/DownloadOptions.html">– DownloadOptions</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/MultipartFormData.html">MultipartFormData</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager.html">NetworkReachabilityManager</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/NetworkReachabilityStatus.html">– NetworkReachabilityStatus</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/NetworkReachabilityManager/ConnectionType.html">– ConnectionType</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/Request.html">Request</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/Request/ValidationResult.html">– ValidationResult</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/ServerTrustPolicyManager.html">ServerTrustPolicyManager</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/SessionDelegate.html">SessionDelegate</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/SessionManager.html">SessionManager</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/SessionManager/MultipartFormDataEncodingResult.html">– MultipartFormDataEncodingResult</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes.html#/s:9Alamofire13StreamRequestC">StreamRequest</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/TaskDelegate.html">TaskDelegate</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Classes/UploadRequest.html">UploadRequest</a> </li> </ul> </li> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Enums.html">Enumerations</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/AFError.html">AFError</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/AFError/ParameterEncodingFailureReason.html">– ParameterEncodingFailureReason</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/AFError/MultipartEncodingFailureReason.html">– MultipartEncodingFailureReason</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/AFError/ResponseValidationFailureReason.html">– ResponseValidationFailureReason</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/AFError/ResponseSerializationFailureReason.html">– ResponseSerializationFailureReason</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/HTTPMethod.html">HTTPMethod</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/Result.html">Result</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Enums/ServerTrustPolicy.html">ServerTrustPolicy</a> </li> </ul> </li> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Extensions.html">Extensions</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/Notification.html">Notification</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/Notification/Name.html">– Name</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/Notification/Key.html">– Key</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/String.html">String</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/URL.html">URL</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/URLComponents.html">URLComponents</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Extensions/URLRequest.html">URLRequest</a> </li> </ul> </li> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Functions.html">Functions</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire2eeoiSbAA26NetworkReachabilityManagerC0cD6StatusO_AFtF">==(_:_:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headers10Foundation3URLV011destinationO0_AD0C7OptionsV7optionstAU_So15HTTPURLResponseCtcSg2totF">download(_:method:parameters:encoding:headers:to:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestCAA21URLRequestConvertible_p_10Foundation3URLV011destinationH0_AD0C7OptionsV7optionstAH_So15HTTPURLResponseCtcSg2totF">download(_:to:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire8downloadAA15DownloadRequestC10Foundation4DataV12resumingWith_AE3URLV011destinationI0_AD0C7OptionsV7optionstAJ_So15HTTPURLResponseCtcSg2totF">download(resumingWith:to:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA21URLRequestConvertible_pF">request(_:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire7requestAA11DataRequestCAA14URLConvertible_p_AA10HTTPMethodO6methods10DictionaryVySSypGSg10parametersAA17ParameterEncoding_p8encodingAJyS2SGSg7headerstF">request(_:method:parameters:encoding:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSo10NetServiceC4with_tF">stream(with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6streamAA13StreamRequestCSS12withHostName_Si4porttF">stream(withHostName:port:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headerstF">upload(_:to:method:headers:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation3URLV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestC10Foundation4DataV_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadAA13UploadRequestCSo11InputStreamC_AA21URLRequestConvertible_p4withtF">upload(_:with:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA14URLConvertible_p2toAA10HTTPMethodO6methods10DictionaryVyS2SGSg7headersyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:to:method:headers:encodingCompletion:)</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Functions.html#/s:9Alamofire6uploadyyAA17MultipartFormDataCc09multipartdE0_s6UInt64V14usingThresholdAA21URLRequestConvertible_p4withyAA14SessionManagerC0cdE14EncodingResultOcSg18encodingCompletiontF">upload(multipartFormData:usingThreshold:with:encodingCompletion:)</a> </li> </ul> </li> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/DataResponseSerializerProtocol.html">DataResponseSerializerProtocol</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/DownloadResponseSerializerProtocol.html">DownloadResponseSerializerProtocol</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/ParameterEncoding.html">ParameterEncoding</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/RequestAdapter.html">RequestAdapter</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/RequestRetrier.html">RequestRetrier</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/URLConvertible.html">URLConvertible</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a> </li> </ul> </li> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Structs.html">Structures</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/DataResponse.html">DataResponse</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/DataResponseSerializer.html">DataResponseSerializer</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/DefaultDataResponse.html">DefaultDataResponse</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/DefaultDownloadResponse.html">DefaultDownloadResponse</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/DownloadResponse.html">DownloadResponse</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/DownloadResponseSerializer.html">DownloadResponseSerializer</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/JSONEncoding.html">JSONEncoding</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/PropertyListEncoding.html">PropertyListEncoding</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/Timeline.html">Timeline</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/URLEncoding.html">URLEncoding</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/URLEncoding/Destination.html">– Destination</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/URLEncoding/ArrayEncoding.html">– ArrayEncoding</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Structs/URLEncoding/BoolEncoding.html">– BoolEncoding</a> </li> </ul> </li> <li class="nav-group-name"> <a class="nav-group-name-link" href="../Typealiases.html">Type Aliases</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire11HTTPHeadersa">HTTPHeaders</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire10Parametersa">Parameters</a> </li> <li class="nav-group-task"> <a class="nav-group-task-link" href="../Typealiases.html#/s:9Alamofire22RequestRetryCompletiona">RequestRetryCompletion</a> </li> </ul> </li> </ul> </nav> <article class="main-content"> <section class="section"> <div class="section-content"> <h1>MultipartFormData</h1> <div class="declaration"> <div class="language"> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">MultipartFormData</span></code></pre> </div> </div> <p>Constructs <code>multipart/form-data</code> for uploads within an HTTP or HTTPS body. There are currently two ways to encode multipart form data. The first way is to encode the data directly in memory. This is very efficient, but can lead to memory issues if the dataset is too large. The second way is designed for larger datasets and will write all the data to a single file on disk with all the proper boundary segmentation. The second approach MUST be used for larger datasets such as video content, otherwise your app may run out of memory when trying to encode the dataset.</p> <p>For more information on <code>multipart/form-data</code> in general, please refer to the RFC-2388 and RFC-2045 specs as well and the w3 form documentation.</p> <ul> <li><a href="https://www.ietf.org/rfc/rfc2388.txt">https://www.ietf.org/rfc/rfc2388.txt</a></li> <li><a href="https://www.ietf.org/rfc/rfc2045.txt">https://www.ietf.org/rfc/rfc2045.txt</a></li> <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> </ul> </div> </section> <section class="section"> <div class="section-content"> <div class="task-group"> <div class="task-name-container"> <a name="/Properties"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a href="#/Properties"> <h3 class="section-name">Properties</h3> </a> </div> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC11contentTypeSSvp"></a> <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC11contentTypeSSvp">contentType</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>The <code>Content-Type</code> header value containing the boundary used to generate the <code>multipart/form-data</code>.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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="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:9Alamofire17MultipartFormDataC8boundarySSvp">boundary</a></span><span class="se">)</span><span class="s">"</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC13contentLengths6UInt64Vvp"></a> <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC13contentLengths6UInt64Vvp">contentLength</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>The content length of all body parts used to generate the <code>multipart/form-data</code> not including the boundaries.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC8boundarySSvp"></a> <a name="//apple_ref/swift/Property/boundary" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC8boundarySSvp">boundary</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>The boundary used to separate the body parts in the encoded form data.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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> </div> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <div class="task-name-container"> <a name="/Lifecycle"></a> <a name="//apple_ref/swift/Section/Lifecycle" class="dashAnchor"></a> <a href="#/Lifecycle"> <h3 class="section-name">Lifecycle</h3> </a> </div> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataCACycfc"></a> <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataCACycfc">init()</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a multipart form data object.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre> </div> </div> <div> <h4>Return Value</h4> <p>The multipart form data object.</p> </div> </section> </div> </li> </ul> </div> <div class="task-group"> <div class="task-name-container"> <a name="/Body%20Parts"></a> <a name="//apple_ref/swift/Section/Body Parts" class="dashAnchor"></a> <a href="#/Body%20Parts"> <h3 class="section-name">Body Parts</h3> </a> </div> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNametF"></a> <a name="//apple_ref/swift/Method/append(_:withName:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNametF">append(_:withName:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a body part from the data and appends it to the multipart form data object.</p> <p>The body part data will be encoded using the following format:</p> <ul> <li><code>Content-Disposition: form-data; name=#{name}</code> (HTTP Header)</li> <li>Encoded data</li> <li><p>Multipart form boundary</p></li> </ul> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>data</em> </code> </td> <td> <div> <p>The data to encode into the multipart form data.</p> </div> </td> </tr> <tr> <td> <code> <em>name</em> </code> </td> <td> <div> <p>The name to associate with the data in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS8mimeTypetF"></a> <a name="//apple_ref/swift/Method/append(_:withName:mimeType:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS8mimeTypetF">append(_:withName:mimeType:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a body part from the data and appends it to the multipart form data object.</p> <p>The body part data will be encoded using the following format:</p> <ul> <li><code>Content-Disposition: form-data; name=#{name}</code> (HTTP Header)</li> <li><code>Content-Type: #{generated mimeType}</code> (HTTP Header)</li> <li>Encoded data</li> <li><p>Multipart form boundary</p></li> </ul> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>data</em> </code> </td> <td> <div> <p>The data to encode into the multipart form data.</p> </div> </td> </tr> <tr> <td> <code> <em>name</em> </code> </td> <td> <div> <p>The name to associate with the data in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> <tr> <td> <code> <em>mimeType</em> </code> </td> <td> <div> <p>The MIME type to associate with the data content type in the <code>Content-Type</code> HTTP header.</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS04fileH0SS8mimeTypetF"></a> <a name="//apple_ref/swift/Method/append(_:withName:fileName:mimeType:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation0D0V_SS8withNameSS04fileH0SS8mimeTypetF">append(_:withName:fileName:mimeType:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a body part from the data and appends it to the multipart form data object.</p> <p>The body part data will be encoded using the following format:</p> <ul> <li><code>Content-Disposition: form-data; name=#{name}; filename=#{filename}</code> (HTTP Header)</li> <li><code>Content-Type: #{mimeType}</code> (HTTP Header)</li> <li>Encoded file data</li> <li><p>Multipart form boundary</p></li> </ul> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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="nv">mimeType</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>data</em> </code> </td> <td> <div> <p>The data to encode into the multipart form data.</p> </div> </td> </tr> <tr> <td> <code> <em>name</em> </code> </td> <td> <div> <p>The name to associate with the data in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> <tr> <td> <code> <em>fileName</em> </code> </td> <td> <div> <p>The filename to associate with the data in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> <tr> <td> <code> <em>mimeType</em> </code> </td> <td> <div> <p>The MIME type to associate with the data in the <code>Content-Type</code> HTTP header.</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNametF"></a> <a name="//apple_ref/swift/Method/append(_:withName:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNametF">append(_:withName:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a body part from the file and appends it to the multipart form data object.</p> <p>The body part data will be encoded using the following format:</p> <ul> <li><code>Content-Disposition: form-data; name=#{name}; filename=#{generated filename}</code> (HTTP Header)</li> <li><code>Content-Type: #{generated mimeType}</code> (HTTP Header)</li> <li>Encoded file data</li> <li>Multipart form boundary</li> </ul> <p>The filename in the <code>Content-Disposition</code> HTTP header is generated from the last path component of the <code>fileURL</code>. The <code>Content-Type</code> HTTP header MIME type is generated by mapping the <code>fileURL</code> extension to the system associated MIME type.</p> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>fileURL</em> </code> </td> <td> <div> <p>The URL of the file whose content will be encoded into the multipart form data.</p> </div> </td> </tr> <tr> <td> <code> <em>name</em> </code> </td> <td> <div> <p>The name to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNameSS04fileI0SS8mimeTypetF"></a> <a name="//apple_ref/swift/Method/append(_:withName:fileName:mimeType:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendy10Foundation3URLV_SS8withNameSS04fileI0SS8mimeTypetF">append(_:withName:fileName:mimeType:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a body part from the file and appends it to the multipart form data object.</p> <p>The body part data will be encoded using the following format:</p> <ul> <li>Content-Disposition: form-data; name=#{name}; filename=#{filename} (HTTP Header)</li> <li>Content-Type: #{mimeType} (HTTP Header)</li> <li>Encoded file data</li> <li><p>Multipart form boundary</p></li> </ul> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>fileURL</em> </code> </td> <td> <div> <p>The URL of the file whose content will be encoded into the multipart form data.</p> </div> </td> </tr> <tr> <td> <code> <em>name</em> </code> </td> <td> <div> <p>The name to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> <tr> <td> <code> <em>fileName</em> </code> </td> <td> <div> <p>The filename to associate with the file content in the <code>Content-Disposition</code> HTTP header.</p> </div> </td> </tr> <tr> <td> <code> <em>mimeType</em> </code> </td> <td> <div> <p>The MIME type to associate with the file content in the <code>Content-Type</code> HTTP header.</p> </div> </td> </tr> </tbody> </table> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire17MultipartFormDataC6appendySo11InputStreamC_s6UInt64V10withLengthSS4nameSS8fileNameSS8mimeTypetF"></a> <a name="//apple_ref/swift/Method/append(_:withLength:name:fileName:mimeType:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire17MultipartFormDataC6appendySo11InputStreamC_s6UInt64V10withLengthSS4nameSS8fileNameSS8mimeTypetF">append(_:withLength:name:fileName:mimeType:)</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Creates a body part from the stream and appends it to the multipart form data object.</p> <p>The body part data will be encoded using the following format:</p> <ul> <li><code>Content-Disposition: form-data; name=#{name}; filename=#{filename}</code> (HTTP Header)</li> <li><code>Content-Type: #{mimeType}</code> (HTTP Header)</li> <li>Encoded stream data</li> <li><p>Multipart form boundary</p></li> </ul> </div> <div class="declaration"> <h4>Declaration</h4> <div class="language"> <p class="aside-title">Swift</p> <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">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> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>stream</em> </code> </td> <td> <div> <p>The input stream to encode in the multipart form data.</p> </div> </td> </tr> <tr> <td> <code> <em>length</em>