You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by mr...@apache.org on 2016/09/01 23:52:13 UTC
[23/51] [partial] usergrid git commit: Moving Swift SDK to
https://github.com/apache/usergrid-swift.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
deleted file mode 100644
index 70c940e..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html
+++ /dev/null
@@ -1,410 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAppAuth 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/UsergridAppAuth" class="dashAnchor"></a>
- <a title="UsergridAppAuth Class Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (100% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAppAuth 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/UsergridAuthMode.html">UsergridAuthMode</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="../Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Extensions/NSDate.html">NSDate</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>UsergridAppAuth</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAppAuth</span> <span class="p">:</span> <span class="kt">UsergridAuth</span></code></pre>
-
- </div>
- </div>
- <p>The <code><a href="../Classes/UsergridAuth.html">UsergridAuth</a></code> subclass used for application level authorization.</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:vC11UsergridSDK15UsergridAppAuth8clientIdSS"></a>
- <a name="//apple_ref/swift/Property/clientId" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK15UsergridAppAuth8clientIdSS">clientId</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The client identifier associated with the application.</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">clientId</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="/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:FC11UsergridSDK15UsergridAppAuthcFT8clientIdSS12clientSecretSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(clientId:clientSecret:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFT8clientIdSS12clientSecretSS_S0_">init(clientId:clientSecret:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Designated initializer for <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</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">clientId</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span><span class="nv">clientSecret</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>clientId</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client identifier associated with the application.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>clientSecret</em>
- </code>
- </td>
- <td>
- <div>
- <p>The client secret associated with the application.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/NSCoding"></a>
- <a name="//apple_ref/swift/Section/NSCoding" class="dashAnchor"></a>
- <a href="#/NSCoding">
- <h3 class="section-name">NSCoding</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK15UsergridAppAuthcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuthcFT5coderCSo7NSCoder_GSqS0__">init(coder:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>NSCoding protocol initializer.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>aDecoder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The decoder.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridAppAuth.html">UsergridAppAuth</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK15UsergridAppAuth15encodeWithCoderFCSo7NSCoderT_">encodeWithCoder(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>NSCoding protocol encoder.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">encodeWithCoder</span><span class="p">(</span><span class="nv">aCoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>aCoder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The encoder.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b 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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html
deleted file mode 100644
index 568d727..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAsset.html
+++ /dev/null
@@ -1,702 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <title>UsergridAsset 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/UsergridAsset" class="dashAnchor"></a>
- <a title="UsergridAsset Class Reference"></a>
- <header>
- <div class="content-wrapper">
- <p><a href="../index.html"> Docs</a> (100% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> Reference</a>
- <img id="carat" src="../img/carat.png" />
- UsergridAsset 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/UsergridAuthMode.html">UsergridAuthMode</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="../Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Extensions/NSDate.html">NSDate</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>UsergridAsset</h1>
- <div class="declaration">
- <div class="language">
- <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">UsergridAsset</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCoding</span></code></pre>
-
- </div>
- </div>
- <p>As Usergrid supports storing binary assets, the SDKs are designed to make uploading assets easier and more robust. Attaching, uploading, and downloading assets is handled by the <code><a href="../Classes/UsergridEntity.html">UsergridEntity</a></code> class.</p>
-
-<p>Unless defined, whenever possible, the content-type will be inferred from the data provided, and the attached file (if not already a byte-array representation) will be binary-encoded.</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:vC11UsergridSDK13UsergridAsset8filenameSS"></a>
- <a name="//apple_ref/swift/Property/filename" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset8filenameSS">filename</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>The filename to be used in the multipart/form-data request.</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">filename</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK13UsergridAsset4dataCSo6NSData"></a>
- <a name="//apple_ref/swift/Property/data" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset4dataCSo6NSData">data</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Binary representation of the asset’s data.</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">data</span><span class="p">:</span> <span class="kt">NSData</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK13UsergridAsset16originalLocationGSqSS_"></a>
- <a name="//apple_ref/swift/Property/originalLocation" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset16originalLocationGSqSS_">originalLocation</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>A representation of the folder location the asset was loaded from, if it was provided in the initialization.</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">originalLocation</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK13UsergridAsset11contentTypeSS"></a>
- <a name="//apple_ref/swift/Property/contentType" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset11contentTypeSS">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 Content-type of the asset to be used when defining content-type inside the multipart/form-data request.</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">contentType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
-
- </div>
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:vC11UsergridSDK13UsergridAsset13contentLengthSi"></a>
- <a name="//apple_ref/swift/Property/contentLength" class="dashAnchor"></a>
- <a class="token" href="#/s:vC11UsergridSDK13UsergridAsset13contentLengthSi">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 the assets data.</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">contentLength</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">length</span> <span class="p">}</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:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_"></a>
- <a name="//apple_ref/swift/Method/init(filename:data:originalLocation:contentType:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_4dataCSo6NSData16originalLocationGSqSS_11contentTypeSS_S0_">init(filename:data:originalLocation:contentType:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Designated initializer for <code><a href="../Classes/UsergridAsset.html">UsergridAsset</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">filename</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="o">.</span><span class="kt">DEFAULT_FILE_NAME</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="nv">originalLocation</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">contentType</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>fileName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file name associated with the file data.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>data</em>
- </code>
- </td>
- <td>
- <div>
- <p>The data of the file.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>originalLocation</em>
- </code>
- </td>
- <td>
- <div>
- <p>An optional original location of the file.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>contentType</em>
- </code>
- </td>
- <td>
- <div>
- <p>The content type of the file.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code>.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(filename:image:imageContentType:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_5imageCSo7UIImage16imageContentTypeOS_24UsergridImageContentType_GSqS0__">init(filename:image:imageContentType:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Convenience initializer for <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> objects dealing with image data.</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="n">convenience</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">filename</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="o">.</span><span class="kt">DEFAULT_FILE_NAME</span><span class="p">,</span> <span class="nv">image</span><span class="p">:</span><span class="kt">UIImage</span><span class="p">,</span> <span class="nv">imageContentType</span><span class="p">:</span><span class="kt">UsergridImageContentType</span> <span class="o">=</span> <span class="o">.</span><span class="kt">Png</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>fileName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file name associated with the file data.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>image</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>UIImage</code> object to upload.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>imageContentType</em>
- </code>
- </td>
- <td>
- <div>
- <p>The content type of the <code>UIImage</code></p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> if the data can be gathered from the passed in <code>UIImage</code>, otherwise nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(filename:fileURL:contentType:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT8filenameGSqSS_7fileURLCSo5NSURL11contentTypeGSqSS__GSqS0__">init(filename:fileURL:contentType:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>Convenience initializer for <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> objects dealing directly with files on disk.</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="n">convenience</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">filename</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kt">UsergridAsset</span><span class="o">.</span><span class="kt">DEFAULT_FILE_NAME</span><span class="p">,</span> <span class="nv">fileURL</span><span class="p">:</span><span class="kt">NSURL</span><span class="p">,</span> <span class="nv">contentType</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>fileName</em>
- </code>
- </td>
- <td>
- <div>
- <p>The file name associated with the file data.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>fileURL</em>
- </code>
- </td>
- <td>
- <div>
- <p>The <code>NSURL</code> object associated with the file.</p>
-
- </div>
- </td>
- </tr>
- <tr>
- <td>
- <code>
- <em>contentType</em>
- </code>
- </td>
- <td>
- <div>
- <p>The content type of the <code>UIImage</code>. If not specified it will try to figure out the type and if it can’t initialization will fail.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A new instance of <code><a href="../Classes/UsergridAsset.html">UsergridAsset</a></code> if the data can be gathered from the passed in <code>NSURL</code>, otherwise nil.</p>
-
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- <div class="task-group">
- <div class="task-name-container">
- <a name="/NSCoding"></a>
- <a name="//apple_ref/swift/Section/NSCoding" class="dashAnchor"></a>
- <a href="#/NSCoding">
- <h3 class="section-name">NSCoding</h3>
- </a>
- </div>
- <ul>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAssetcFT5coderCSo7NSCoder_GSqS0__"></a>
- <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAssetcFT5coderCSo7NSCoder_GSqS0__">init(coder:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>NSCoding protocol initializer.</p>
-
- </div>
- <div class="declaration">
- <h4>Declaration</h4>
- <div class="language">
- <p class="aside-title">Swift</p>
- <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>aDecoder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The decoder.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div>
- <h4>Return Value</h4>
- <p>A decoded <code><a href="../Classes/UsergridUser.html">UsergridUser</a></code> object.</p>
-
- </div>
- </section>
- </div>
- </li>
- <li class="item">
- <div>
- <code>
- <a name="/s:FC11UsergridSDK13UsergridAsset15encodeWithCoderFCSo7NSCoderT_"></a>
- <a name="//apple_ref/swift/Method/encodeWithCoder(_:)" class="dashAnchor"></a>
- <a class="token" href="#/s:FC11UsergridSDK13UsergridAsset15encodeWithCoderFCSo7NSCoderT_">encodeWithCoder(_:)</a>
- </code>
- </div>
- <div class="height-container">
- <div class="pointer-container"></div>
- <section class="section">
- <div class="pointer"></div>
- <div class="abstract">
- <p>NSCoding protocol encoder.</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="kd">func</span> <span class="nf">encodeWithCoder</span><span class="p">(</span><span class="nv">aCoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
-
- </div>
- </div>
- <div>
- <h4>Parameters</h4>
- <table class="graybox">
- <tbody>
- <tr>
- <td>
- <code>
- <em>aCoder</em>
- </code>
- </td>
- <td>
- <div>
- <p>The encoder.</p>
-
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </section>
- </div>
- </li>
- </ul>
- </div>
- </section>
- </section>
- <section id="footer">
- <p>© 2016 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b 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>
http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html
----------------------------------------------------------------------
diff --git a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html b/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html
deleted file mode 100644
index f7a0b00..0000000
--- a/sdks/swift/docs/docsets/.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html
+++ /dev/null
@@ -1,356 +0,0 @@
-<!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"> Docs</a> (100% documented)</p>
- </div>
- </header>
- <div class="content-wrapper">
- <p id="breadcrumbs">
- <a href="../index.html"> 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/UsergridAuthMode.html">UsergridAuthMode</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="../Extensions.html">Extensions</a>
- <ul class="nav-group-tasks">
- <li class="nav-group-task">
- <a href="../Extensions/NSDate.html">NSDate</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:FC11UsergridSDK26UsergridAssetUploadRequestcFT7baseUrlSS5pathsGSqGSaSS__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:FC11UsergridSDK26UsergridAssetUploadRequestcFT7baseUrlSS5pathsGSqGSaSS__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="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2016-04-14)</p>
- <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy \u266a\u266b 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>