react-native-c8osdk

<!DOCTYPE html> <html lang="en"> <head> <title>DownloadOptions Structure 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/Struct/DownloadOptions" class="dashAnchor"></a> <a title="DownloadOptions Structure 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" /> DownloadOptions Structure 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>DownloadOptions</h1> <div class="declaration"> <div class="language"> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DownloadOptions</span><span class="p">:</span> <span class="kt">OptionSet</span></code></pre> </div> </div> <p>A collection of options to be executed prior to moving a downloaded file from the temporary URL to the destination URL.</p> </div> </section> <section class="section"> <div class="section-content"> <div class="task-group"> <ul class="item-container"> <li class="item"> <div> <code> <a name="/s:9Alamofire15DownloadRequestC0B7OptionsV8rawValueSuvp"></a> <a name="//apple_ref/swift/Property/rawValue" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV8rawValueSuvp">rawValue</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Returns the raw bitmask value of the option and satisfies the <code>RawRepresentable</code> protocol.</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">rawValue</span><span class="p">:</span> <span class="kt">UInt</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire15DownloadRequestC0B7OptionsV29createIntermediateDirectoriesAEvpZ"></a> <a name="//apple_ref/swift/Variable/createIntermediateDirectories" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV29createIntermediateDirectoriesAEvpZ">createIntermediateDirectories</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>A <code>DownloadOptions</code> flag that creates intermediate directories for the destination URL if specified.</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">static</span> <span class="k">let</span> <span class="nv">createIntermediateDirectories</span> <span class="o">=</span> <span class="kt">DownloadOptions</span><span class="p">(</span><span class="nv">rawValue</span><span class="p">:</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">0</span><span class="p">)</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire15DownloadRequestC0B7OptionsV18removePreviousFileAEvpZ"></a> <a name="//apple_ref/swift/Variable/removePreviousFile" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsV18removePreviousFileAEvpZ">removePreviousFile</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>A <code>DownloadOptions</code> flag that removes a previous file from the destination URL if specified.</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">static</span> <span class="k">let</span> <span class="nv">removePreviousFile</span> <span class="o">=</span> <span class="kt">DownloadOptions</span><span class="p">(</span><span class="nv">rawValue</span><span class="p">:</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">1</span><span class="p">)</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:9Alamofire15DownloadRequestC0B7OptionsVAESu8rawValue_tcfc"></a> <a name="//apple_ref/swift/Method/init(rawValue:)" class="dashAnchor"></a> <a class="token" href="#/s:9Alamofire15DownloadRequestC0B7OptionsVAESu8rawValue_tcfc">init(rawValue:)</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 <code>DownloadFileDestinationOptions</code> instance with the specified raw value.</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><span class="nv">rawValue</span><span class="p">:</span> <span class="kt">UInt</span><span class="p">)</span></code></pre> </div> </div> <div> <h4>Parameters</h4> <table class="graybox"> <tbody> <tr> <td> <code> <em>rawValue</em> </code> </td> <td> <div> <p>The raw bitmask value for the option.</p> </div> </td> </tr> </tbody> </table> </div> <div> <h4>Return Value</h4> <p>A new log level instance.</p> </div> </section> </div> </li> </ul> </div> </div> </section> </article> </div> <section class="footer"> <p>© 2018 <a class="link" href="http://alamofire.org/" target="_blank" rel="external">Alamofire Software Foundation</a>. All rights reserved. (Last updated: 2018-04-15)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p> </section> </body> </div> </html>