| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <title>UsergridAssetUploadRequest 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> |
| |
| </head> |
| <body> |
| <a name="//apple_ref/swift/Class/UsergridAssetUploadRequest" class="dashAnchor"></a> |
| <a title="UsergridAssetUploadRequest Class Reference"></a> |
| <header> |
| <div class="content-wrapper"> |
| <p><a href="../index.html">UsergridSDK Docs</a> (100% documented)</p> |
| </div> |
| </header> |
| <div class="content-wrapper"> |
| <p id="breadcrumbs"> |
| <a href="../index.html">UsergridSDK Reference</a> |
| <img id="carat" src="../img/carat.png" /> |
| UsergridAssetUploadRequest Class Reference |
| </p> |
| </div> |
| <div class="content-wrapper"> |
| <nav class="sidebar"> |
| <ul class="nav-groups"> |
| <li class="nav-group-name"> |
| <a href="../Classes.html">Classes</a> |
| <ul class="nav-group-tasks"> |
| <li class="nav-group-task"> |
| <a href="../Classes/Usergrid.html">Usergrid</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridAsset.html">UsergridAsset</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridAuth.html">UsergridAuth</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridClient.html">UsergridClient</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridClientConfig.html">UsergridClientConfig</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridDevice.html">UsergridDevice</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridEntity.html">UsergridEntity</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridFileMetaData.html">UsergridFileMetaData</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridQuery.html">UsergridQuery</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridRequest.html">UsergridRequest</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridResponse.html">UsergridResponse</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridResponseError.html">UsergridResponseError</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridUser.html">UsergridUser</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Classes/UsergridUserAuth.html">UsergridUserAuth</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-group-name"> |
| <a href="../Global Variables.html">Global Variables</a> |
| <ul class="nav-group-tasks"> |
| <li class="nav-group-task"> |
| <a href="../Global Variables.html#/s:v11UsergridSDK18UsergridSDKVersionSS">UsergridSDKVersion</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-group-name"> |
| <a href="../Enums.html">Enums</a> |
| <ul class="nav-group-tasks"> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridAuthFallback.html">UsergridAuthFallback</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridDeviceProperties.html">UsergridDeviceProperties</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridDirection.html">UsergridDirection</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridEntityProperties.html">UsergridEntityProperties</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridHttpMethod.html">UsergridHttpMethod</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridImageContentType.html">UsergridImageContentType</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridQueryOperator.html">UsergridQueryOperator</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridQuerySortOrder.html">UsergridQuerySortOrder</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Enums/UsergridUserProperties.html">UsergridUserProperties</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-group-name"> |
| <a href="../Typealiases.html">Typealiases</a> |
| <ul class="nav-group-tasks"> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK30UsergridAppAuthCompletionBlock">UsergridAppAuthCompletionBlock</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK31UsergridAssetDownloadCompletion">UsergridAssetDownloadCompletion</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK28UsergridAssetRequestProgress">UsergridAssetRequestProgress</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK29UsergridAssetUploadCompletion">UsergridAssetUploadCompletion</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK26UsergridResponseCompletion">UsergridResponseCompletion</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK31UsergridUserAuthCompletionBlock">UsergridUserAuthCompletionBlock</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK34UsergridUserAvailabilityCompletion">UsergridUserAvailabilityCompletion</a> |
| </li> |
| <li class="nav-group-task"> |
| <a href="../Typealiases.html#/s:11UsergridSDK35UsergridUserResetPasswordCompletion">UsergridUserResetPasswordCompletion</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| <article class="main-content"> |
| <section> |
| <section class="section"> |
| <h1>UsergridAssetUploadRequest</h1> |
| <div class="declaration"> |
| <div class="language"> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAssetUploadRequest</span><span class="p">:</span> <span class="kt">UsergridRequest</span></code></pre> |
| |
| </div> |
| </div> |
| <p>The <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code> sub class which is used for uploading assets.</p> |
| |
| </section> |
| <section class="section task-group-section"> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| <a name="/Instance%20Properties"></a> |
| <a name="//apple_ref/swift/Section/Instance Properties" class="dashAnchor"></a> |
| <a href="#/Instance%20Properties"> |
| <h3 class="section-name">Instance Properties</h3> |
| </a> |
| </div> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:vC11UsergridSDK26UsergridAssetUploadRequest5assetCS_13UsergridAsset"></a> |
| <a name="//apple_ref/swift/Property/asset" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK26UsergridAssetUploadRequest5assetCS_13UsergridAsset">asset</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The asset to use for uploading.</p> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| <div class="language"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">asset</span><span class="p">:</span> <span class="kt">UsergridAsset</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:vC11UsergridSDK26UsergridAssetUploadRequest17multiPartHTTPBodyCSo6NSData"></a> |
| <a name="//apple_ref/swift/Property/multiPartHTTPBody" class="dashAnchor"></a> |
| <a class="token" href="#/s:vC11UsergridSDK26UsergridAssetUploadRequest17multiPartHTTPBodyCSo6NSData">multiPartHTTPBody</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>A constructed multipart http body for requests to upload.</p> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| <div class="language"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">multiPartHTTPBody</span><span class="p">:</span> <span class="kt">NSData</span></code></pre> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="task-group"> |
| <div class="task-name-container"> |
| <a name="/Initialization"></a> |
| <a name="//apple_ref/swift/Section/Initialization" class="dashAnchor"></a> |
| <a href="#/Initialization"> |
| <h3 class="section-name">Initialization</h3> |
| </a> |
| </div> |
| <ul> |
| <li class="item"> |
| <div> |
| <code> |
| <a name="/s:FC11UsergridSDK26UsergridAssetUploadRequestcFMS0_FT7baseUrlSS5pathsGSqGSaSS__4authGSqCS_12UsergridAuth_5assetCS_13UsergridAsset_S0_"></a> |
| <a name="//apple_ref/swift/Method/init(baseUrl:paths:auth:asset:)" class="dashAnchor"></a> |
| <a class="token" href="#/s:FC11UsergridSDK26UsergridAssetUploadRequestcFMS0_FT7baseUrlSS5pathsGSqGSaSS__4authGSqCS_12UsergridAuth_5assetCS_13UsergridAsset_S0_">init(baseUrl:paths:auth:asset:)</a> |
| </code> |
| </div> |
| <div class="height-container"> |
| <div class="pointer-container"></div> |
| <section class="section"> |
| <div class="pointer"></div> |
| <div class="abstract"> |
| <p>The designated initializer for <code><a href="../Classes/UsergridAssetUploadRequest.html">UsergridAssetUploadRequest</a></code> objects.</p> |
| |
| </div> |
| <div class="declaration"> |
| <h4>Declaration</h4> |
| <div class="language"> |
| <p class="aside-title">Swift</p> |
| <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">baseUrl</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> |
| <span class="nv">paths</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">auth</span><span class="p">:</span><span class="kt">UsergridAuth</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> |
| <span class="k">as</span><span class="nv">set</span><span class="p">:</span><span class="kt">UsergridAsset</span><span class="p">)</span></code></pre> |
| |
| </div> |
| </div> |
| <div> |
| <h4>Parameters</h4> |
| <table class="graybox"> |
| <tbody> |
| <tr> |
| <td> |
| <code> |
| <em>baseUrl</em> |
| </code> |
| </td> |
| <td> |
| <div> |
| <p>The base URL.</p> |
| |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <code> |
| <em>paths</em> |
| </code> |
| </td> |
| <td> |
| <div> |
| <p>The optional paths to append to the base URL.</p> |
| |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <code> |
| <em>auth</em> |
| </code> |
| </td> |
| <td> |
| <div> |
| <p>The optional <code>UsergridAuth</code> that will be used in the Authorization header.</p> |
| |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <code> |
| <em>asset</em> |
| </code> |
| </td> |
| <td> |
| <div> |
| <p>The asset to upload.</p> |
| |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div> |
| <h4>Return Value</h4> |
| <p>A new instance of <code><a href="../Classes/UsergridRequest.html">UsergridRequest</a></code>.</p> |
| |
| </div> |
| </section> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </section> |
| </section> |
| <section id="footer"> |
| <p>© 2016 <a class="link" href="https://github.com/apache/usergrid/tree/master/sdks/swift" target="_blank" rel="external">Robert Walsh</a>. All rights reserved. (Last updated: 2016-02-15)</p> |
| <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p> |
| </section> |
| </article> |
| </div> |
| </body> |
| </div> |
| </html> |
