| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>Functions 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 type="text/javascript"> |
| window.jazzy = {'docset': false} |
| if (typeof window.dash != 'undefined') { |
| document.documentElement.className += ' dash' |
| window.jazzy.docset = true |
| } |
| if (navigator.userAgent.match(/xcode/i)) { |
| document.documentElement.className += ' xcode' |
| window.jazzy.docset = true |
| } |
| </script> |
| <script src="js/jquery.min.js" defer></script> |
| <script src="js/jazzy.js" defer></script> |
| </head> |
| <body id="reference" class="Swift"> |
| <a title="Functions Reference"></a> |
| <header> |
| <div class="content-wrapper"> |
| <p class="header-text"><a href="index.html"> Docs</a> (41% documented)</p> |
| <p id="header-links"><a href=""><img id="header-icon" src="img/gh.png" height="16px" width="16px" />View on GitHub</a></p> |
| </div> |
| </header> |
| <section id="valence"> |
| <div class="content-wrapper"> |
| <p id="hierarchial_navigation"> |
| <a href="index.html" id="design_resources_link"> Reference</a> |
| <img id="carat" src="img/carat.png" height="10px" width="6px" /> |
| Functions Reference |
| </p> |
| </div> |
| </section> |
| <div class="content-wrapper"> |
| <nav class="book-parts"> |
| <ul class="nav-parts"> |
| <li class="part-name tasks"> |
| <a href="Classes.html">Classes</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Classes/BaseClient.html">BaseClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Classes/EngineClient.html">EngineClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Classes/EventClient.html">EventClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Classes/Manager.html">Manager</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Classes/Request.html">Request</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="Global Variables.html">Global Variables</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Global Variables.html#/s:v15PredictionIOSDK20AlamofireErrorDomainSS">AlamofireErrorDomain</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="Enums.html">Enums</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Enums.html#/s:O15PredictionIOSDK6Method">Method</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Enums/ParameterEncoding.html">ParameterEncoding</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="Extensions.html">Extensions</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Extensions/EventClient.html">EventClient</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Extensions/Manager.html">Manager</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Extensions/NSURL.html">NSURL</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Extensions/NSURLComponents.html">NSURLComponents</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Extensions/NSURLRequest.html">NSURLRequest</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Extensions/Request.html">Request</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Extensions/String.html">String</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="Functions.html">Functions</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Functions.html#/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="Protocols.html">Protocols</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a> |
| </li> |
| <li class="nav-chapter"> |
| <a href="Protocols/URLStringConvertible.html">URLStringConvertible</a> |
| </li> |
| </ul> |
| </li> |
| <li class="part-name tasks"> |
| <a href="Structs.html">Structs</a> |
| <ul class="nav-chapters"> |
| <li class="nav-chapter"> |
| <a href="Structs/Event.html">Event</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| <div class="pixel-line"></div> |
| <div class="rubber-band-gap"></div> |
| <article class="chapter"> |
| <a name="/"></a> |
| <h1 class="chapter-name">Functions</h1> |
| <section> |
| <section class="section"> |
| <p class="para">The following functions are available globally.</p> |
| </section> |
| <section class="section task-group-section"> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| <hr/> |
| <a name="/Request"></a> |
| <a name="//apple_ref/swift/Section/Request" class="dashAnchor"></a> |
| <a href="#/Request"> |
| <h3 class="section-name">Request</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request"> |
| <a name="//apple_ref/swift/Function/request(_:_:parameters:encoding:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates a request using the shared manager instance for the specified method, URL string, parameters, and parameter encoding.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="o">.</span><span class="kt">URL</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">method</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The HTTP method.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLString</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL string.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">parameters</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The parameters. <code>nil</code> by default.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">encoding</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The parameter encoding. <code>.URL</code> by default.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK7requestFPS_21URLRequestConvertible_CS_7Request"> |
| <a name="//apple_ref/swift/Function/request(_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates a request using the shared manager instance for the specified URL request.If <code>startRequestsImmediately</code> is <code>true</code>, the request will have <code>resume()</code> called before being returned.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLRequest</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL request</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/File"></a> |
| <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a> |
| <a href="#/File"> |
| <h3 class="section-name">File</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request"> |
| <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and file.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">method</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The HTTP method.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLString</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL string.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">file</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The file to upload.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created upload request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request"> |
| <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates an upload request using the shared manager instance for the specified URL request and file.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLRequest</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL request.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">file</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The file to upload.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created upload request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/Data"></a> |
| <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a> |
| <a href="#/Data"> |
| <h3 class="section-name">Data</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request"> |
| <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and data.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">method</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The HTTP method.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLString</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL string.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">data</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The data to upload.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created upload request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request"> |
| <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates an upload request using the shared manager instance for the specified URL request and data.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLRequest</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL request.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">data</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The data to upload.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created upload request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/Stream"></a> |
| <a name="//apple_ref/swift/Section/Stream" class="dashAnchor"></a> |
| <a href="#/Stream"> |
| <h3 class="section-name">Stream</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request"> |
| <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates an upload request using the shared manager instance for the specified method, URL string, and stream.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">method</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The HTTP method.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLString</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL string.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">stream</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The stream to upload.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created upload request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request"> |
| <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates an upload request using the shared manager instance for the specified URL request and stream.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLRequest</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL request.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">stream</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The stream to upload.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created upload request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/URL%20Request"></a> |
| <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a> |
| <a href="#/URL%20Request"> |
| <h3 class="section-name">URL Request</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request"> |
| <a name="//apple_ref/swift/Function/download(_:_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates a download request using the shared manager instance for the specified method and URL string.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">method</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The HTTP method.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLString</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL string.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">destination</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The closure used to determine the destination of the downloaded file.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created download request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request"> |
| <a name="//apple_ref/swift/Function/download(_:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates a download request using the shared manager instance for the specified URL request.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">URLRequest</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The URL request.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">destination</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The closure used to determine the destination of the downloaded file.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created download request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| |
| <a name="/Resume%20Data"></a> |
| <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a> |
| <a href="#/Resume%20Data"> |
| <h3 class="section-name">Resume Data</h3> |
| </a> |
| |
| </div> |
| <ul class="task-group-list"> |
| <li class="item symbol"> |
| <div class="task-group-term"> |
| <code> |
| <a name="/s:F15PredictionIOSDK8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request"> |
| <a name="//apple_ref/swift/Function/download(resumeData:_:)" class="dashAnchor"></a> |
| <a class="x-instance-method Swift" href="#/s:F15PredictionIOSDK8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointy-thing-container"></div> |
| <section class="section instance-method"> |
| <div class="pointy-thing"></div> |
| <div class="abstract"> |
| <p class="para">Creates a request using the shared manager instance for downloading from the resume data produced from a previous request cancellation.</p> |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| |
| <div class="Swift"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">resumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Request</span></code></pre> |
| |
| </div> |
| </div> |
| <div class="parameters"> |
| <h4>Parameters</h4> |
| <table class="graybox" border="0" cellspacing="0" cellpadding="5"> |
| <tbody> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">resumeData</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The resume data. This is an opaque data blob produced by <code>NSURLSessionDownloadTask</code> when a task is cancelled. See <code>NSURLSession -downloadTaskWithResumeData:</code> for additional information.</p> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td scope="row"> |
| <code> |
| <em class="term">destination</em> |
| </code> |
| </td> |
| <td> |
| <div class="definition"> |
| <p class="para">The closure used to determine the destination of the downloaded file.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="result-description"> |
| <h4>Return Value</h4> |
| <p class="para">The created download request.</p> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </section> |
| </section> |
| <section id="footer"> |
| <p class="copyright">© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-02-24)</p> |
| <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.1.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p> |
| </section> |
| </article> |
| </div> |
| </body> |
| </div> |
| </html> |
